IOrchestratedClient.StartConversationAsync Method
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.
Starts a new externally orchestrated conversation.
public System.Collections.Generic.IAsyncEnumerable<Microsoft.Agents.CopilotStudio.Client.Models.OrchestratedResponse> StartConversationAsync(string conversationId, Microsoft.Agents.CopilotStudio.Client.Models.RequestProperties? requestProperties = default, System.Threading.CancellationToken cancellationToken = default);abstract member StartConversationAsync : string * Microsoft.Agents.CopilotStudio.Client.Models.RequestProperties * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Microsoft.Agents.CopilotStudio.Client.Models.OrchestratedResponse>Public Function StartConversationAsync (conversationId As String, Optional requestProperties As RequestProperties = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of OrchestratedResponse)Parameters
- conversationId
- String
The conversation ID for the new conversation.
- requestProperties
- RequestProperties
Optional properties mapped to HTTP request headers.
- cancellationToken
- CancellationToken
Cancellation token to cancel the operation.
Returns
An async enumerable stream of orchestrated responses from the copilot.
Exceptions
Thrown when conversationId is null or empty.
Thrown when the HTTP request fails.
Thrown when the response cannot be deserialized.