UNPKG

@microsoft/agents-copilotstudio-client

Version:

Microsoft Copilot Studio Client for JavaScript. Copilot Studio Client.

github.com/microsoft/Agents-for-js

microsoft/Agents-for-js

33 lines (32 loc) • 1.72 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
/** * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. */ import { ConnectionSettings } from './connectionSettings'; import { PowerPlatformCloud } from './powerPlatformCloud'; /** * Generates the connection URL for Copilot Studio. * @param settings - The connection settings. * @param conversationId - Optional conversation ID. * @returns The connection URL. * @throws Will throw an error if required settings are missing or invalid. */ export declare function getCopilotStudioConnectionUrl(settings: ConnectionSettings, conversationId?: string): string; /** * Generates the subscribe URL for Copilot Studio Server-Sent Events (SSE). * @param settings - The connection settings. * @param conversationId - The conversation ID to subscribe to. * @returns The subscribe URL. * @throws Will throw an error if required settings are missing or invalid. */ export declare function getCopilotStudioSubscribeUrl(settings: ConnectionSettings, conversationId: string): string; /** * Returns the Power Platform API Audience. * @param settings - Configuration Settings to use. * @param cloud - Optional Power Platform Cloud Hosting Agent. * @param cloudBaseAddress - Optional Power Platform API endpoint to use if Cloud is configured as "other". * @param directConnectUrl - Optional DirectConnection URL to a given Copilot Studio agent, if provided all other settings are ignored. * @returns The Power Platform Audience. * @throws Will throw an error if required settings are missing or invalid. */ export declare function getTokenAudience(settings?: ConnectionSettings, cloud?: PowerPlatformCloud, cloudBaseAddress?: string, directConnectUrl?: string): string;