Class CopilotStudioClient

constructor

• new CopilotStudioClient(
      settings: ConnectionSettings,
      token: string,
  ): CopilotStudioClient

  Creates an instance of CopilotStudioClient.

  Parameters

  • settings: ConnectionSettings

    The connection settings.

  • token: string

    The authentication token.

  Returns CopilotStudioClient

StaticscopeFromSettings

askQuestionAsync

• askQuestionAsync(question: string, conversationId?: string): Promise<Activity[]>

  Sends a question to the Copilot Studio service and retrieves the response activities.

  Parameters

  • question: string

    The question to ask.

  • OptionalconversationId: string

    The ID of the conversation. Defaults to the current conversation ID.

  Returns Promise<Activity[]>

  A promise yielding an array of activities.

  Deprecated

  Use sendActivityStreaming instead.

execute

• execute(activity: Activity, conversationId: string): Promise<Activity[]>

  Executes a turn in an existing conversation by sending an activity.

  Parameters

  • activity: Activity

    The activity to send.

  • conversationId: string

    The ID of the conversation. Required.

  Returns Promise<Activity[]>

  A promise yielding an array of activities.

  Throws

  Error if conversationId is not provided.

  Deprecated

  Use executeStreaming instead.

executeStreaming

• executeStreaming(
      activity: Activity,
      conversationId: string,
  ): AsyncGenerator<Activity>

  Executes a turn in an existing conversation by sending an activity. This method provides explicit control over the conversation ID.

  Parameters

  • activity: Activity

    The activity to send.

  • conversationId: string

    The ID of the conversation. Required.

  Returns AsyncGenerator<Activity>

  An async generator yielding the Agent's Activities.

  Throws

  Error if conversationId is not provided.

executeWithResponse

• executeWithResponse(
      activity: Activity,
      conversationId: string,
  ): Promise<ExecuteTurnResponse>

  Executes a turn and returns a typed response.

  Parameters

  • activity: Activity

    The activity to send.

  • conversationId: string

    The conversation ID.

  Returns Promise<ExecuteTurnResponse>

  A promise yielding an ExecuteTurnResponse with activities and metadata.

sendActivity

• sendActivity(activity: Activity, conversationId?: string): Promise<Activity[]>

  Sends an activity to the Copilot Studio service and retrieves the response activities.

  Parameters

  • activity: Activity

    The activity to send.

  • conversationId: string = ...

    The ID of the conversation. Defaults to the current conversation ID.

  Returns Promise<Activity[]>

  A promise yielding an array of activities.

  Deprecated

  Use sendActivityStreaming instead.

sendActivityStreaming

• sendActivityStreaming(
      activity: Activity,
      conversationId?: string,
  ): AsyncGenerator<Activity>

  Sends an activity to the Copilot Studio service and retrieves the response activities.

  Parameters

  • activity: Activity

    The activity to send.

  • conversationId: string = ...

    The ID of the conversation. Defaults to the current conversation ID.

  Returns AsyncGenerator<Activity>

  An async generator yielding the Agent's Activities.

startConversationAsync

• startConversationAsync(request: StartRequest): Promise<Activity[]>

  Starts a new conversation with the Copilot Studio service using a StartRequest.

  Parameters

  • request: StartRequest

    The request parameters for starting the conversation.

  Returns Promise<Activity[]>

  A promise yielding an array of activities.

  Deprecated

  Use startConversationStreaming instead.

• startConversationAsync(
      emitStartConversationEvent?: boolean,
  ): Promise<Activity[]>

  Starts a new conversation with the Copilot Studio service.

  Parameters

  • OptionalemitStartConversationEvent: boolean

    Whether to emit a start conversation event. Defaults to true.

  Returns Promise<Activity[]>

  A promise yielding an array of activities.

  Deprecated

  Use startConversationStreaming instead.

startConversationStreaming

• startConversationStreaming(request: StartRequest): AsyncGenerator<Activity>

  Starts a new conversation with the Copilot Studio service using a StartRequest.

  Parameters

  • request: StartRequest

    The request parameters for starting the conversation.

  Returns AsyncGenerator<Activity>

  An async generator yielding the Agent's Activities.

• startConversationStreaming(
      emitStartConversationEvent?: boolean,
  ): AsyncGenerator<Activity>

  Starts a new conversation with the Copilot Studio service.

  Parameters

  • OptionalemitStartConversationEvent: boolean

    Whether to emit a start conversation event. Defaults to true.

  Returns AsyncGenerator<Activity>

  An async generator yielding the Agent's Activities.

startConversationWithResponse

• startConversationWithResponse(
      request?: boolean | StartRequest,
  ): Promise<StartResponse>

  Starts a new conversation and returns a typed response.

  Parameters

  • Optionalrequest: boolean | StartRequest

    The request parameters for starting the conversation.

  Returns Promise<StartResponse>

  A promise yielding a StartResponse with activities and conversation metadata.

subscribeAsync

• subscribeAsync(
      conversationId: string,
      lastReceivedEventId?: string,
  ): AsyncGenerator<SubscribeEvent>

  Subscribes to a conversation to receive events via Server-Sent Events (SSE). This method allows resumption from a specific event ID.

  Parameters

  • conversationId: string

    The ID of the conversation to subscribe to.

  • OptionallastReceivedEventId: string

    Optional. The last received event ID for resumption.

  Returns AsyncGenerator<SubscribeEvent>

  An async generator yielding SubscribeEvent objects containing activities and event IDs.