Microsoft.Agents.CopilotStudio.Client.Models Namespace

Classes

Name Description
AgentStatePayload

Payload containing agent state information returned from an externally orchestrated turn.

ExecuteTurnResponse
OrchestratedActivityResponse

An activity (message) from the copilot.

OrchestratedEndResponse

Signals that the orchestrated turn has completed and the SSE stream has ended.

OrchestratedErrorCodeExtensions

Extension methods for parsing OrchestratedErrorCode from error code strings.

OrchestratedErrorPayload

Error details returned from an externally orchestrated conversation turn.

OrchestratedErrorResponse

An error returned during an orchestrated turn.

OrchestratedResponse

Base type for responses from an externally orchestrated conversation turn. Use pattern matching to handle the specific response types: OrchestratedActivityResponse, OrchestratedStateResponse, OrchestratedErrorResponse, and OrchestratedEndResponse.

OrchestratedStateResponse

Agent state information returned after a turn completes.

OrchestratedTurnRequest

Request body for an externally orchestrated conversation turn. Extends ExecuteTurnRequest with orchestration metadata.

OrchestratedTurnResponse

Response from an externally orchestrated conversation turn (non-streaming JSON fallback).

OrchestrationRequest

Describes the orchestration metadata for an externally orchestrated turn.

RequestProperties

Optional properties that are mapped to HTTP headers on each request.

ResponseBase
StartRequest
StartResponse
SubscribeEvent

Represents a subscription event containing an activity and optional SSE event ID.

SubscribeRequest

Request model for subscribe operations.

SubscribeResponse

Response model for subscribe operations.

ToolInvocationInput

Input parameters for a tool invocation in an orchestrated conversation.

Structs

Name Description
AgentStatus

Represents the status of an externally orchestrated agent. Uses a string value for forward compatibility with new status types.

OrchestrationOperation

Represents the type of orchestration operation. Uses a string value for forward compatibility with new operation types.

Enums

Name Description
OrchestratedErrorCode

Known error codes returned from externally orchestrated conversation turns.