AgentExecutor Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Base class for agent invokcation.
public abstract class AgentExecutor : Microsoft.Agents.AI.Workflows.Declarative.Kit.ActionExecutortype AgentExecutor = class
inherit ActionExecutorPublic MustInherit Class AgentExecutor
Inherits ActionExecutor- Inheritance
-
Executor<TMessage>AgentExecutor
Constructors
| Name | Description |
|---|---|
| AgentExecutor(String, FormulaSession, ResponseAgentProvider) |
Base class for agent invokcation. |
Properties
| Name | Description |
|---|---|
| Id |
A unique identifier for the executor. (Inherited from Executor) |
| InputTypes |
A set of Types, representing the messages this executor can handle. (Inherited from Executor) |
| Options |
Gets the configuration options for the executor. (Inherited from Executor) |
| OutputTypes |
A set of Types, representing the messages this executor can produce as output. (Inherited from Executor) |
Methods
| Name | Description |
|---|---|
| CanHandle(Type) |
Checks if the executor can handle a specific message type. (Inherited from Executor) |
| ConfigureProtocol(ProtocolBuilder) |
Configures the protocol by setting up routes and declaring the message types used for sending and yielding output. (Inherited from Executor<TInput>) |
| DescribeProtocol() |
Describes the protocol for communication with this Executor. (Inherited from Executor) |
| ExecuteAsync(IWorkflowContext, ActionExecutorResult, CancellationToken) |
Executes the core logic of the action. (Inherited from ActionExecutor) |
| ExecuteAsync(IWorkflowContext, CancellationToken) |
Executes the core logic of the action. (Inherited from ActionExecutor) |
| ExecuteAsync(IWorkflowContext, TMessage, CancellationToken) |
Executes the core logic of the action. (Inherited from ActionExecutor<TMessage>) |
| ExecuteCoreAsync(Object, TypeId, IWorkflowContext, CancellationToken) |
Process an incoming message using the registered handlers. (Inherited from Executor) |
| HandleAsync(TMessage, IWorkflowContext, CancellationToken) |
Handles the incoming message asynchronously. (Inherited from ActionExecutor<TMessage>) |
| InitializeAsync(IWorkflowContext, CancellationToken) |
Perform any asynchronous initialization required by the executor. This method is called once per executor instance, (Inherited from Executor) |
| InvokeAgentAsync(IWorkflowContext, String, String, Boolean, IEnumerable<ChatMessage>, CancellationToken) |
Invokes an agent using the provided ResponseAgentProvider. |
| OnCheckpointingAsync(IWorkflowContext, CancellationToken) |
Invoked before a checkpoint is saved, allowing custom pre-save logic in derived classes. (Inherited from Executor) |
| OnCheckpointRestoredAsync(IWorkflowContext, CancellationToken) |
Invoked after a checkpoint is loaded, allowing custom post-load logic in derived classes. (Inherited from Executor) |
| ResetAsync() |
Reset the executor (Inherited from ActionExecutor<TMessage>) |
Extension Methods
| Name | Description |
|---|---|
| BindExecutor(Executor) |
Configures an Executor instance for use in a workflow. |