@microsoft/agents-copilotstudio-client/dist/src/copilotStudioConnectionSettings.d.ts

Microsoft Copilot Studio Client for JavaScript. Copilot Studio Client.

/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License.
 */
import { AgentType } from './agentType';
import { PowerPlatformCloud } from './powerPlatformCloud';
/**
 * Represents the settings required to establish a direct connection to the engine.
 */
export interface CopilotStudioConnectionSettings {
    /**
     * The identifier of the agent.
     * @deprecated This property will not be supported in future versions. Use schemaName instead.
     **/
    agentIdentifier?: string;
    /** The schema name of the agent. */
    schemaName?: string;
    /** The custom Power Platform cloud URL. */
    customPowerPlatformCloud?: string;
    /** The environment ID of the application. */
    environmentId?: string;
    /** The cloud environment of the application. */
    cloud?: PowerPlatformCloud;
    /** The type of the Copilot agent. */
    copilotAgentType?: AgentType;
    /** URL provided to connect directly to Copilot Studio endpoint. When provided all other settings are ignored. */
    directConnectUrl?: string;
    /** Directs Copilot Studio Client to use the experimental endpoint if available. Default value is false. */
    useExperimentalEndpoint?: boolean;
    /**
     * Enables diagnostic logging for debugging purposes.
     * When enabled, detailed logs about requests, responses, and connection status will be emitted.
     * Default value is false.
     */
    enableDiagnostics?: boolean;
    /**
     * The login authority to use for the connection.
     * @deprecated This property will not be supported in future versions. Handle the auth properties in the agent.
     **/
    authority?: string;
}