IOrchestratedClient.HandleUserResponseAsync 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.
Forwards a user response to an in-progress externally orchestrated conversation.
public System.Collections.Generic.IAsyncEnumerable<Microsoft.Agents.CopilotStudio.Client.Models.OrchestratedResponse> HandleUserResponseAsync(string conversationId, Microsoft.Agents.Core.Models.IActivity activity, Microsoft.Agents.CopilotStudio.Client.Models.RequestProperties? requestProperties = default, System.Threading.CancellationToken cancellationToken = default);abstract member HandleUserResponseAsync : string * Microsoft.Agents.Core.Models.IActivity * Microsoft.Agents.CopilotStudio.Client.Models.RequestProperties * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Microsoft.Agents.CopilotStudio.Client.Models.OrchestratedResponse>Public Function HandleUserResponseAsync (conversationId As String, activity As IActivity, Optional requestProperties As RequestProperties = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of OrchestratedResponse)Parameters
- conversationId
- String
The conversation ID.
- activity
- IActivity
The user activity to forward.
- 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 or activity is null.
Thrown when the HTTP request fails.
Thrown when the response cannot be deserialized.