@microsoft/agents-a365-runtime package

Классы

AgenticAuthenticationService	Служба обработки проверки подлинности агента пользователя.
DefaultConfigurationProvider	Поставщик по умолчанию, возвращающий конфигурацию на основе среды. Рекомендации по работе с несколькими клиентами: Этот поставщик создает один экземпляр конфигурации во время строительства, общий доступ ко всем запросам в процессе. Поставщики уровня модуля по умолчанию (например, `defaultRuntimeConfigurationProvider`) являются одноэлементными. Для сценариев с несколькими клиентами поддерживаются два подхода: Динамические переопределения функций (рекомендуется): Передайте функции переопределения, которые считываются из асинхронного контекста (например, багаж OpenTelemetry) во время выполнения. Один и тот же экземпляр конфигурации возвращает разные значения для каждого запроса. `const config = new ToolingConfiguration({ mcpPlatformEndpoint: () => { const tenantConfig = context.active().getValue(TENANT_KEY); return tenantConfig?.endpoint ?? 'https://default.endpoint'; } });` Поставщики для каждого клиента: Создайте отдельные экземпляры поставщика для каждого клиента, если для разных клиентов требуются разные функции переопределения.
OperationError	Инкапсулирует ошибку из операции.
OperationResult	Представляет результат операции.
PowerPlatformApiDiscovery
RuntimeConfiguration	Базовый класс конфигурации для пакета SDK agent365. Другие пакеты расширяют это, чтобы добавить собственные параметры. Функции переопределения вызываются для каждого доступа к свойствам, что обеспечивает динамическое разрешение из асинхронного контекста (например, багаж OpenTelemetry) для каждого запроса.
Utility	Класс служебной программы, предоставляющий вспомогательные методы для операций среды выполнения агента.

Интерфейсы

IConfigurationProvider

Универсальный интерфейс для предоставления конфигурации. Каждый пакет определяет собственный тип конфигурации T.

Псевдонимы типа

RuntimeConfigurationOptions

Параметры конфигурации среды выполнения — все необязательные функции. Функции вызываются для каждого доступа к свойствам, обеспечивая динамическое разрешение. Неустановленные значения возвращаются к переменным среды.

Перечисления

ClusterCategory

Категории кластеров для обнаружения API Power Platform. Перечисление строк обеспечивает безопасность типов компиляции и проверку среды выполнения.

Функции

getClusterCategory(IConfigurationProvider<RuntimeConfiguration>)	Возвращает категорию кластера из переменных среды. Пример `// Before: import { getClusterCategory } from '@microsoft/agents-a365-runtime'; const cluster = getClusterCategory(); // After: import { defaultRuntimeConfigurationProvider } from '@microsoft/agents-a365-runtime'; const cluster = defaultRuntimeConfigurationProvider.getConfiguration().clusterCategory;`
getMcpPlatformAuthenticationScope()	Возвращает область проверки подлинности платформы MCP. Пример `// Before: import { getMcpPlatformAuthenticationScope } from '@microsoft/agents-a365-runtime'; const scope = getMcpPlatformAuthenticationScope(); // After: import { defaultToolingConfigurationProvider } from '@microsoft/agents-a365-tooling'; const scope = defaultToolingConfigurationProvider.getConfiguration().mcpPlatformAuthenticationScope;`
getObservabilityAuthenticationScope()	Возвращает область проверки подлинности в службе наблюдаемости. Пример `// Before: import { getObservabilityAuthenticationScope } from '@microsoft/agents-a365-runtime'; const scopes = getObservabilityAuthenticationScope(); // After: import { defaultObservabilityConfigurationProvider } from '@microsoft/agents-a365-observability'; const scopes = [...defaultObservabilityConfigurationProvider.getConfiguration().observabilityAuthenticationScopes];`
isDevelopmentEnvironment(IConfigurationProvider<RuntimeConfiguration>)	Возвращает значение true, если текущая среда является средой разработки. Пример `// Before: import { isDevelopmentEnvironment } from '@microsoft/agents-a365-runtime'; if (isDevelopmentEnvironment()) { ... } // After: import { defaultRuntimeConfigurationProvider } from '@microsoft/agents-a365-runtime'; if (defaultRuntimeConfigurationProvider.getConfiguration().isDevelopmentEnvironment) { ... }`

Переменные

DEVELOPMENT_ENVIRONMENT_NAME
PRODUCTION_ENVIRONMENT_NAME
PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE	Область проверки подлинности рабочей платформы MCP.
PROD_OBSERVABILITY_CLUSTER_CATEGORY	Категория кластера по умолчанию для рабочих сред.
PROD_OBSERVABILITY_SCOPE	Область проверки подлинности в рабочей среде.
defaultRuntimeConfigurationProvider	Общий поставщик по умолчанию для RuntimeConfiguration. Использует переменные среды без переопределения , подходящие для развертываний с одним клиентом или при использовании динамических переопределения функций для многотенантности.

Сведения о функции

getClusterCategory(IConfigurationProvider<RuntimeConfiguration>)

Предупреждение

Теперь этот API является нерекомендуемым.

Use RuntimeConfiguration.clusterCategory instead.

Возвращает категорию кластера из переменных среды.

Пример

// Before:
import { getClusterCategory } from '@microsoft/agents-a365-runtime';
const cluster = getClusterCategory();

// After:
import { defaultRuntimeConfigurationProvider } from '@microsoft/agents-a365-runtime';
const cluster = defaultRuntimeConfigurationProvider.getConfiguration().clusterCategory;

function getClusterCategory(configProvider?: IConfigurationProvider<RuntimeConfiguration>): string

Параметры

configProvider: IConfigurationProvider<RuntimeConfiguration>

Необязательный поставщик конфигурации. По умолчанию значение defaultRuntimeConfigurationProvider, если оно не указано.

Возвращаемое значение

string

Категория кластера из CLUSTER_CATEGORY env var по умолчанию — prod.

getMcpPlatformAuthenticationScope()

Предупреждение

Теперь этот API является нерекомендуемым.

Use ToolingConfiguration.mcpPlatformAuthenticationScope instead.

Возвращает область проверки подлинности платформы MCP.

Пример

// Before:
import { getMcpPlatformAuthenticationScope } from '@microsoft/agents-a365-runtime';
const scope = getMcpPlatformAuthenticationScope();

// After:
import { defaultToolingConfigurationProvider } from '@microsoft/agents-a365-tooling';
const scope = defaultToolingConfigurationProvider.getConfiguration().mcpPlatformAuthenticationScope;

function getMcpPlatformAuthenticationScope(): string

Возвращаемое значение

string

Область проверки подлинности платформы MCP.

getObservabilityAuthenticationScope()

Предупреждение

Теперь этот API является нерекомендуемым.

Use ObservabilityConfiguration.observabilityAuthenticationScopes instead.

Возвращает область проверки подлинности в службе наблюдаемости.

Пример

// Before:
import { getObservabilityAuthenticationScope } from '@microsoft/agents-a365-runtime';
const scopes = getObservabilityAuthenticationScope();

// After:
import { defaultObservabilityConfigurationProvider } from '@microsoft/agents-a365-observability';
const scopes = [...defaultObservabilityConfigurationProvider.getConfiguration().observabilityAuthenticationScopes];

function getObservabilityAuthenticationScope(): string[]

Возвращаемое значение

string[]

Области проверки подлинности для текущей среды.

isDevelopmentEnvironment(IConfigurationProvider<RuntimeConfiguration>)

Предупреждение

Теперь этот API является нерекомендуемым.

Use RuntimeConfiguration.isDevelopmentEnvironment instead.

Возвращает значение true, если текущая среда является средой разработки.

Пример

// Before:
import { isDevelopmentEnvironment } from '@microsoft/agents-a365-runtime';
if (isDevelopmentEnvironment()) { ... }

// After:
import { defaultRuntimeConfigurationProvider } from '@microsoft/agents-a365-runtime';
if (defaultRuntimeConfigurationProvider.getConfiguration().isDevelopmentEnvironment) { ... }

function isDevelopmentEnvironment(configProvider?: IConfigurationProvider<RuntimeConfiguration>): boolean

Параметры

configProvider: IConfigurationProvider<RuntimeConfiguration>

Необязательный поставщик конфигурации. По умолчанию значение defaultRuntimeConfigurationProvider, если оно не указано.

Возвращаемое значение

boolean

Значение True, если текущая среда является разработкой, значение false в противном случае.

Сведения об переменной

DEVELOPMENT_ENVIRONMENT_NAME

DEVELOPMENT_ENVIRONMENT_NAME: "Development"

Тип

"Development"

PRODUCTION_ENVIRONMENT_NAME

PRODUCTION_ENVIRONMENT_NAME: "production"

Тип

"production"

PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE

Предупреждение

Теперь этот API является нерекомендуемым.

This constant is exported for backward compatibility only. For new code, use ToolingConfiguration.mcpPlatformAuthenticationScope instead.

Область проверки подлинности рабочей платформы MCP.

PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE: "ea9ffc3e-8a23-4a7d-836d-234d7c7565c1/.default"

Тип

string

PROD_OBSERVABILITY_CLUSTER_CATEGORY

Предупреждение

Теперь этот API является нерекомендуемым.

This constant is exported for backward compatibility only. For new code, use RuntimeConfiguration.clusterCategory instead.

Категория кластера по умолчанию для рабочих сред.

PROD_OBSERVABILITY_CLUSTER_CATEGORY: "prod"

Тип

"prod"

PROD_OBSERVABILITY_SCOPE

Предупреждение

Теперь этот API является нерекомендуемым.

This constant is exported for backward compatibility only. For new code, use ObservabilityConfiguration.observabilityAuthenticationScopes instead.

Область проверки подлинности в рабочей среде.

PROD_OBSERVABILITY_SCOPE: "api://9b975845-388f-4429-889e-eab1ef63949c/.default"

Тип

string

defaultRuntimeConfigurationProvider

Общий поставщик по умолчанию для RuntimeConfiguration. Использует переменные среды без переопределения , подходящие для развертываний с одним клиентом или при использовании динамических переопределения функций для многотенантности.

defaultRuntimeConfigurationProvider: DefaultConfigurationProvider<RuntimeConfiguration>

Тип

DefaultConfigurationProvider<RuntimeConfiguration>