Documentation - v1.2.0-alpha.3
    Preparing search index...

    Client for interacting with Microsoft Copilot Studio services. Provides functionality to start conversations and send messages to Copilot Studio bots.

    Index

    Constructors

    Properties

    scopeFromSettings: (settings: ConnectionSettings) => string = getTokenAudience

    Returns the scope URL needed to connect to Copilot Studio from the connection settings. This is used for authentication token audience configuration.

    Type Declaration

    Methods

    • 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.

      Use sendActivityStreaming instead.

    • 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.

      Use sendActivityStreaming instead.

    • 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.

    • Starts a new conversation with the Copilot Studio service.

      Parameters

      • emitStartConversationEvent: boolean = true

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

      Returns Promise<Activity[]>

      A promise yielding an array of activities.

      Use startConversationStreaming instead.

    • Starts a new conversation with the Copilot Studio service.

      Parameters

      • emitStartConversationEvent: boolean = true

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

      Returns AsyncGenerator<Activity>

      An async generator yielding the Agent's Activities.