CopilotClientProtocol Class

Protocol defining the contract for a client that connects to the Direct-to-Engine API endpoint for Copilot Studio.

Constructor

CopilotClientProtocol()

Methods

__init__
__new__
ask_question

Ask a question in a conversation.

ask_question_with_activity

Ask a question using an Activity object.

execute

Execute an activity with a specified conversation ID.

send_activity

Send an activity to the bot.

start_conversation

Start a new conversation.

start_conversation_with_request

Start a new conversation with a StartRequest.

subscribe

Subscribe to conversation events.

__init__

__init__(*args, **kwargs)

__new__

__new__(**kwargs)

ask_question

Ask a question in a conversation.

async ask_question(question: str, conversation_id: str | None = None) -> AsyncIterable[Activity]

Parameters

Name Description
question
Required
str

The question text.

conversation_id
str | None

Optional conversation ID.

Default value: None

Returns

Type Description

An asynchronous iterable of Activity objects.

ask_question_with_activity

Ask a question using an Activity object.

async ask_question_with_activity(activity: Activity) -> AsyncIterable[Activity]

Parameters

Name Description
activity
Required

The activity to send.

Returns

Type Description

An asynchronous iterable of Activity objects.

execute

Execute an activity with a specified conversation ID.

async execute(conversation_id: str, activity: Activity) -> AsyncIterable[Activity]

Parameters

Name Description
conversation_id
Required
str

The conversation ID.

activity
Required

The activity to execute.

Returns

Type Description

An asynchronous iterable of Activity objects.

send_activity

Send an activity to the bot.

async send_activity(activity: Activity) -> AsyncIterable[Activity]

Parameters

Name Description
activity
Required

The activity to send.

Returns

Type Description

An asynchronous iterable of Activity objects.

start_conversation

Start a new conversation.

async start_conversation(emit_start_conversation_event: bool = True) -> AsyncIterable[Activity]

Parameters

Name Description
emit_start_conversation_event

Whether to emit a start conversation event.

Default value: True

Returns

Type Description

An asynchronous iterable of Activity objects.

start_conversation_with_request

Start a new conversation with a StartRequest.

async start_conversation_with_request(start_request: StartRequest) -> AsyncIterable[Activity]

Parameters

Name Description
start_request
Required

The StartRequest containing conversation parameters.

Returns

Type Description

An asynchronous iterable of Activity objects.

subscribe

Subscribe to conversation events.

async subscribe(conversation_id: str, last_received_event_id: str | None = None) -> AsyncIterable[SubscribeEvent]

Parameters

Name Description
conversation_id
Required
str

The conversation ID to subscribe to.

last_received_event_id
str | None

Optional last received event ID for resumption.

Default value: None

Returns

Type Description

An asynchronous iterable of SubscribeEvent objects.