Language

IOrchestratedClient.ConversationUpdateAsync Method

Definition

Sends a conversation update event to the bot in an externally orchestrated conversation.

public System.Collections.Generic.IAsyncEnumerable<Microsoft.Agents.CopilotStudio.Client.Models.OrchestratedResponse> ConversationUpdateAsync(string conversationId, Microsoft.Agents.CopilotStudio.Client.Models.RequestProperties? requestProperties = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ConversationUpdateAsync : string * Microsoft.Agents.CopilotStudio.Client.Models.RequestProperties * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Microsoft.Agents.CopilotStudio.Client.Models.OrchestratedResponse>
Public Function ConversationUpdateAsync (conversationId As String, Optional requestProperties As RequestProperties = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of OrchestratedResponse)

Parameters

conversationId
String

The conversation ID.

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.

Applies to