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

    Interface CopilotStudioConnectionSettings

    Represents the settings required to establish a direct connection to the engine.

    interface CopilotStudioConnectionSettings {
        agentIdentifier?: string;
        authority?: string;
        cloud?: PowerPlatformCloud;
        copilotAgentType?: AgentType;
        customPowerPlatformCloud?: string;
        directConnectUrl?: string;
        environmentId?: string;
        schemaName?: string;
        useExperimentalEndpoint?: boolean;
    }
    Index

    Properties

    agentIdentifier? authority? cloud? copilotAgentType? customPowerPlatformCloud? directConnectUrl? environmentId? schemaName? useExperimentalEndpoint?

    Properties

    agentIdentifier?: string

    The identifier of the agent.

    This property will not be supported in future versions. Use schemaName instead.

    authority?: string

    The login authority to use for the connection.

    This property will not be supported in future versions. Handle the auth properties in the agent.

    cloud?: PowerPlatformCloud

    The cloud environment of the application.

    copilotAgentType?: AgentType

    The type of the Copilot agent.

    customPowerPlatformCloud?: string

    The custom Power Platform cloud URL.

    directConnectUrl?: string

    URL provided to connect directly to Copilot Studio endpoint. When provided all other settings are ignored.

    environmentId?: string

    The environment ID of the application.

    schemaName?: string

    The schema name of the agent.

    useExperimentalEndpoint?: boolean

    Directs Copilot Studio Client to use the experimental endpoint if available. Default value is false.

    Settings

    Member Visibility

    On This Page

    Properties