AgentEndpointExtensions Class

Definition

Namespace:

Microsoft.Agents.Hosting.AspNetCore

Assembly:

Microsoft.Agents.Hosting.AspNetCore.dll

Package:

Microsoft.Agents.Hosting.AspNetCore v1.6.150

Provides extension methods for mapping HTTP endpoints related to Agent applications, including activity protocol endpoints, proactive messaging, and root informational endpoints, to ASP.NET Core applications.

public static class AgentEndpointExtensions

type AgentEndpointExtensions = class

Public Module AgentEndpointExtensions

Inheritance

Object

AgentEndpointExtensions

Remarks

These extension methods simplify the integration of Agent-based bots and services into ASP.NET Core applications by registering standardized endpoints for message processing, proactive operations, and diagnostics. The methods support configuration of authentication requirements, custom request processing delegates, and route patterns. Use these extensions to quickly expose bot functionality over HTTP in a consistent and maintainable manner.

Methods

Name	Description
MapAgentApplicationEndpoints(IEndpointRouteBuilder, Boolean, String)	This adds HTTP endpoints for all AgentApplications defined in the calling assembly using the AgentInterfaceAttribute. Each AgentApplication must have been added using AddAgent<TAgent>(IHostApplicationBuilder).
MapAgentEndpoints(WebApplication, Boolean, String, AgentEndpointExtensions.ProcessRequestDelegate<IAgentHttpAdapter,IAgent>)	Maps Agent Activity Protocol endpoints.
MapAgentEndpoints<TAdapter,TAgent>(WebApplication, Boolean, String, AgentEndpointExtensions.ProcessRequestDelegate<TAdapter,TAgent>)	Maps Agent Activity Protocol endpoints.
MapAgentEndpoints<TAgent>(WebApplication, Boolean, String, AgentEndpointExtensions.ProcessRequestDelegate<IAgentHttpAdapter,TAgent>)	Maps Agent Activity Protocol endpoints.
MapAgentProactiveEndpoints<TAgent>(IEndpointRouteBuilder, Boolean, String)	Maps proactive conversation endpoints using ContinueConversationAttributes on the agent.
MapAgentProactiveEndpoints<TAgent>(IEndpointRouteBuilder, IDictionary<String,ContinueConversationRoute<TAgent>>, Boolean, String)	Maps endpoints for handling proactive messaging operations, such as sending activities to conversations, to the specified route group in the application's endpoint routing pipeline.
MapAgentRootEndpoint(WebApplication)	Maps the root endpoint ('/') of the web application to return the assembly name and version information for the Microsoft Agents SDK.