OrchestratedClient 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.
Client for externally orchestrated Copilot Studio conversations. This is intended for internal use only. Uses the ExternalOrchestration API to start conversations, invoke tools, handle user responses, and send conversation updates.
public class OrchestratedClient : Microsoft.Agents.CopilotStudio.Client.IOrchestratedClienttype OrchestratedClient = class
interface IOrchestratedClientPublic Class OrchestratedClient
Implements IOrchestratedClient- Inheritance
-
OrchestratedClient
- Implements
Constructors
| Name | Description |
|---|---|
| OrchestratedClient(ConnectionSettings, IHttpClientFactory, Func<String,Task<String>>, ILogger, String) |
Creates an ExternalOrchestration client with an external token provider. This is intended for internal use. |
| OrchestratedClient(ConnectionSettings, IHttpClientFactory, ILogger, String) |
Creates an ExternalOrchestration client for Microsoft Copilot Studio hosted agents. |
Properties
| Name | Description |
|---|---|
| Settings |
The connection settings for Copilot Studio. |
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. |
| ScopeFromSettings(ConnectionSettings) |
Returns the scope URL needed to connect to Copilot Studio from the connection settings. |
| StartConversationAsync(String, RequestProperties, CancellationToken) |
Starts a new externally orchestrated conversation. |