IOrchestratedClient Interface
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.
Defines the contract for a client that connects to the ExternalOrchestration API endpoint for Copilot Studio. Supports starting conversations, invoking tools, handling user responses, and sending conversation updates in an externally orchestrated flow.
public interface IOrchestratedClienttype IOrchestratedClient = interfacePublic Interface IOrchestratedClient- Derived
Methods
| Name | Description |
|---|---|
| ConversationUpdateAsync(String, RequestProperties, CancellationToken) |
Sends a conversation update event to the bot in an externally orchestrated conversation. |
| ExecuteTurnAsync(String, OrchestratedTurnRequest, RequestProperties, CancellationToken) |
Executes an orchestrated turn with a custom request. This is the low-level method that all other methods delegate to. |
| HandleUserResponseAsync(String, IActivity, RequestProperties, CancellationToken) |
Forwards a user response to an in-progress externally orchestrated conversation. |
| InvokeToolAsync(String, ToolInvocationInput, IActivity, RequestProperties, CancellationToken) |
Invokes a tool (topic) in an externally orchestrated conversation. |
| StartConversationAsync(String, RequestProperties, CancellationToken) |
Starts a new externally orchestrated conversation. |