@microsoft/agents-copilotstudio-client/src/directToEngineConnectionSettings.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 DirectToEngineConnectionSettings {
  /** The identifier of the agent. */
  agentIdentifier: 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
}