@microsoft/agents-copilotstudio-client package

Represents the settings required to establish a connection to Copilot Studio.

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

A utility class that provides WebChat integration capabilities for Copilot Studio services.

Example

Basic WebChat Integration

import { CopilotStudioClient } from '@microsoft/agents-copilotstudio-client';
import { CopilotStudioWebChat } from '@microsoft/agents-copilotstudio-client';

// Initialize the Copilot Studio client
const client = new CopilotStudioClient({
  botId: 'your-bot-id',
  tenantId: 'your-tenant-id'
});

// Create a WebChat-compatible connection
const directLine = CopilotStudioWebChat.createConnection(client, {
  showTyping: true
});

// Integrate with WebChat
window.WebChat.renderWebChat({
  directLine: directLine,
  // ... other WebChat options
}, document.getElementById('webchat'));

Example

Advanced Usage with Connection Monitoring

const connection = CopilotStudioWebChat.createConnection(client);

// Monitor connection status
connection.connectionStatus$.subscribe(status => {
  switch (status) {
    case 0: console.log('Disconnected'); break;
    case 1: console.log('Connecting...'); break;
    case 2: console.log('Connected and ready'); break;
  }
});

// Listen for incoming activities
connection.activity$.subscribe(activity => {
  console.log('Received activity:', activity);
});

Represents a request to execute a turn in a conversation. This class encapsulates the activity and optional conversation context.

Utility class for generating authentication scope URLs for Copilot Studio.

Utility class for generating user agent strings for Copilot Studio client requests.

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

Represents a connection interface for integrating Copilot Studio with WebChat.

Configuration settings for the Copilot Studio WebChat connection. These settings control the behavior and appearance of the WebChat interface when connected to the Copilot Studio service.

Response returned when executing a turn in an existing conversation.

Base interface for all Copilot Studio API responses.

Represents a request to start a new conversation with a Copilot Studio agent. This request encapsulates all parameters needed to initiate a conversation.

Response returned when starting a new conversation.

Represents an event received from a subscription to a Copilot Studio conversation.

Represents a request to subscribe to a conversation.

Enum representing the type of agent.

Enum representing different Power Platform cloud environments.

Creates an ExecuteTurnResponse from an array of activities.

Creates a StartRequest with default values.

Creates a StartResponse from an array of activities.

Generates the connection URL for Copilot Studio.

Generates the subscribe URL for Copilot Studio Server-Sent Events (SSE).

Returns the Power Platform API Audience.

Loads the connection settings for Copilot Studio from environment variables.