StartRequest interface

Package:: @microsoft/agents-copilotstudio-client

Represents a request to start a new conversation with a Copilot Studio agent. This request encapsulates all parameters needed to initiate a conversation.

Properties

conversationId	Optional conversation ID to use for this conversation. If not specified, a new conversation ID will be generated by the service.
emitStartConversationEvent	Whether to emit a start conversation event. When true, the agent will be notified that this is the beginning of a new conversation. Default is true.
locale	Optional locale code (e.g., 'en-US', 'fr-FR') for the conversation. If not specified, the agent's default locale will be used.

Property Details

conversationId

Optional conversation ID to use for this conversation. If not specified, a new conversation ID will be generated by the service.

conversationId?: string

Property Value

string

emitStartConversationEvent

Whether to emit a start conversation event. When true, the agent will be notified that this is the beginning of a new conversation. Default is true.

emitStartConversationEvent?: boolean

Property Value

boolean

locale

Optional locale code (e.g., 'en-US', 'fr-FR') for the conversation. If not specified, the agent's default locale will be used.

locale?: string

Property Value

string