@microsoft/agents-a365-runtime package

Třídy

AgenticAuthenticationService

Služba pro zpracování ověřování agentů uživatelů.

DefaultConfigurationProvider

Výchozí zprostředkovatel, který vrací konfiguraci založenou na prostředí.

Důležité informace o více tenantech: Tento zprostředkovatel vytvoří v době výstavby jednu instanci konfigurace, která se sdílí napříč všemi požadavky v procesu. Výchozí zprostředkovatelé na úrovni modulu (např defaultRuntimeConfigurationProvider. ) jsou singletony.

V případě scénářů s více tenanty se podporují dva přístupy:

  1. Funkce dynamického přepsání (doporučeno): Předejte funkce přepsání, které se čtou z asynchronního kontextu (např. OpenTelemetry zavazadlo) za běhu. Stejná instance konfigurace vrátí různé hodnoty na požadavek.

    const config = new ToolingConfiguration({
      mcpPlatformEndpoint: () => {
        const tenantConfig = context.active().getValue(TENANT_KEY);
        return tenantConfig?.endpoint ?? 'https://default.endpoint';
      }
    });
    
  2. Poskytovatelé pro jednotlivé tenanty: Vytvořte pro každého tenanta samostatné instance zprostředkovatele, pokud různé tenanty potřebují zcela jiné funkce přepsání.

OperationError

Zapouzdřuje chybu z operace.

OperationResult

Představuje výsledek operace.

PowerPlatformApiDiscovery
RuntimeConfiguration

Základní třída konfigurace pro sadu Agent365 SDK. Ostatní balíčky to rozšiřují a přidávají vlastní nastavení.

Funkce přepsání se volají pro každý přístup k vlastnostem a umožňují dynamické rozlišení z asynchronního kontextu (např. zavazadlo OpenTelemetry) podle požadavku.

Utility

Utility třída poskytující pomocné metody pro operace modulu runtime agenta.

Rozhraní

IConfigurationProvider

Obecné rozhraní pro poskytování konfigurace Každý balíček definuje vlastní typ konfigurace T.

Aliasy typu

RuntimeConfigurationOptions

Možnosti konfigurace modulu runtime – všechny volitelné funkce Funkce se volají pro každý přístup k vlastnostem a umožňují dynamické rozlišení. Nenasadené hodnoty se vrátí do proměnných prostředí.

Výčty

ClusterCategory

Kategorie clusterů pro zjišťování rozhraní API Power Platform Výčet řetězců poskytuje zabezpečení typu kompilace i ověřování za běhu.

Funkce

getClusterCategory(IConfigurationProvider<RuntimeConfiguration>)

Získá kategorii clusteru z proměnných prostředí.

Příklad

// 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()

Získá obor ověřování platformy MCP.

Příklad

// 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()

Vrátí obor pro ověřování ve službě pozorovatelnosti.

Příklad

// 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>)

Vrátí hodnotu true, pokud je aktuálním prostředím vývojové prostředí.

Příklad

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

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

Proměnné

DEVELOPMENT_ENVIRONMENT_NAME
PRODUCTION_ENVIRONMENT_NAME
PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE

Obor ověřování produkční platformy MCP

PROD_OBSERVABILITY_CLUSTER_CATEGORY

Výchozí kategorie clusteru pro produkční prostředí

PROD_OBSERVABILITY_SCOPE

Rozsah ověřování pozorovatelnosti v produkčním prostředí

defaultRuntimeConfigurationProvider

Sdílený výchozí zprostředkovatel pro RuntimeConfiguration. Používá proměnné prostředí bez přepsání – vhodné pro nasazení s jedním tenantem nebo při použití dynamických přepsání funkcí pro více tenantů.

Podrobnosti funkce

getClusterCategory(IConfigurationProvider<RuntimeConfiguration>)

Upozornění

Toto rozhraní API je teď zastaralé.

Use RuntimeConfiguration.clusterCategory instead.

Získá kategorii clusteru z proměnných prostředí.

Příklad

// 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

Parametry

configProvider

IConfigurationProvider<RuntimeConfiguration>

Volitelný zprostředkovatel konfigurace Výchozí hodnota je defaultRuntimeConfigurationProvider, pokud není zadána.

Návraty

string

Kategorie clusteru z CLUSTER_CATEGORY env var, výchozí hodnota je "prod".

getMcpPlatformAuthenticationScope()

Upozornění

Toto rozhraní API je teď zastaralé.

Use ToolingConfiguration.mcpPlatformAuthenticationScope instead.

Získá obor ověřování platformy MCP.

Příklad

// 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

Návraty

string

Obor ověřování platformy MCP.

getObservabilityAuthenticationScope()

Upozornění

Toto rozhraní API je teď zastaralé.

Use ObservabilityConfiguration.observabilityAuthenticationScopes instead.

Vrátí obor pro ověřování ve službě pozorovatelnosti.

Příklad

// 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[]

Návraty

string[]

Obory ověřování pro aktuální prostředí.

isDevelopmentEnvironment(IConfigurationProvider<RuntimeConfiguration>)

Upozornění

Toto rozhraní API je teď zastaralé.

Use RuntimeConfiguration.isDevelopmentEnvironment instead.

Vrátí hodnotu true, pokud je aktuálním prostředím vývojové prostředí.

Příklad

// 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

Parametry

configProvider

IConfigurationProvider<RuntimeConfiguration>

Volitelný zprostředkovatel konfigurace Výchozí hodnota je defaultRuntimeConfigurationProvider, pokud není zadána.

Návraty

boolean

Hodnota True, pokud je aktuální prostředí vývojové, v opačném případě false.

Podrobnosti proměnné

DEVELOPMENT_ENVIRONMENT_NAME

DEVELOPMENT_ENVIRONMENT_NAME: "Development"

Typ

"Development"

PRODUCTION_ENVIRONMENT_NAME

PRODUCTION_ENVIRONMENT_NAME: "production"

Typ

"production"

PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE

Upozornění

Toto rozhraní API je teď zastaralé.

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

Obor ověřování produkční platformy MCP

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

Typ

string

PROD_OBSERVABILITY_CLUSTER_CATEGORY

Upozornění

Toto rozhraní API je teď zastaralé.

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

Výchozí kategorie clusteru pro produkční prostředí

PROD_OBSERVABILITY_CLUSTER_CATEGORY: "prod"

Typ

"prod"

PROD_OBSERVABILITY_SCOPE

Upozornění

Toto rozhraní API je teď zastaralé.

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

Rozsah ověřování pozorovatelnosti v produkčním prostředí

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

Typ

string

defaultRuntimeConfigurationProvider

Sdílený výchozí zprostředkovatel pro RuntimeConfiguration. Používá proměnné prostředí bez přepsání – vhodné pro nasazení s jedním tenantem nebo při použití dynamických přepsání funkcí pro více tenantů.

defaultRuntimeConfigurationProvider: DefaultConfigurationProvider<RuntimeConfiguration>

Typ