@microsoft/agents-a365-runtime package

Clases

AgenticAuthenticationService

Servicio para controlar la autenticación de usuario agente.

DefaultConfigurationProvider

Proveedor predeterminado que devuelve la configuración basada en el entorno.

Consideraciones multiinquilino: Este proveedor crea una única instancia de configuración en tiempo de construcción, compartida en todas las solicitudes de un proceso. Los proveedores de nivel de módulo predeterminados (por ejemplo, defaultRuntimeConfigurationProvider) son singletons.

En escenarios multiinquilino, se admiten dos enfoques:

  1. Funciones de invalidación dinámica (recomendadas): Pase las funciones de invalidación que leen del contexto asincrónico (por ejemplo, equipaje de OpenTelemetry) en tiempo de ejecución. La misma instancia de Configuración devuelve valores diferentes por solicitud.

    const config = new ToolingConfiguration({
      mcpPlatformEndpoint: () => {
        const tenantConfig = context.active().getValue(TENANT_KEY);
        return tenantConfig?.endpoint ?? 'https://default.endpoint';
      }
    });
    
  2. Proveedores por inquilino: Cree instancias de proveedor independientes para cada inquilino cuando los distintos inquilinos necesiten diferentes funciones de invalidación por completo.

OperationError

Encapsula un error de una operación.

OperationResult

Representa el resultado de una operación.

PowerPlatformApiDiscovery
RuntimeConfiguration

Clase de configuración base para el SDK de Agent365. Otros paquetes amplían esta opción para agregar su propia configuración.

Se llama a las funciones de invalidación en cada acceso a propiedades, lo que permite la resolución dinámica desde un contexto asincrónico (por ejemplo, equipaje de OpenTelemetry) por solicitud.

Utility

Clase de utilidad que proporciona métodos auxiliares para las operaciones en tiempo de ejecución del agente.

Interfaces

IConfigurationProvider

Interfaz genérica para proporcionar configuración. Cada paquete define su propio tipo de configuración T.

Alias de tipos

RuntimeConfigurationOptions

Opciones de configuración en tiempo de ejecución: todas las funciones opcionales. Se llama a funciones en cada acceso a propiedades, lo que permite la resolución dinámica. Los valores sin establecer se revierten a las variables de entorno.

Enumeraciones

ClusterCategory

Categorías de clúster para la detección de Power Platform API. La enumeración de cadena proporciona seguridad de tipos en tiempo de compilación y validación en tiempo de ejecución.

Funciones

getClusterCategory(IConfigurationProvider<RuntimeConfiguration>)

Obtiene la categoría de clúster de las variables de entorno.

Ejemplo

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

Obtiene el ámbito de autenticación de la plataforma MCP.

Ejemplo

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

Devuelve el ámbito para autenticarse en el servicio de observabilidad.

Ejemplo

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

Devuelve true si el entorno actual es un entorno de desarrollo.

Ejemplo

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

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

Variables

DEVELOPMENT_ENVIRONMENT_NAME
PRODUCTION_ENVIRONMENT_NAME
PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE

Ámbito de autenticación de la plataforma MCP de producción.

PROD_OBSERVABILITY_CLUSTER_CATEGORY

Categoría de clúster predeterminada para entornos de producción.

PROD_OBSERVABILITY_SCOPE

Ámbito de autenticación de observabilidad de producción.

defaultRuntimeConfigurationProvider

Proveedor predeterminado compartido para RuntimeConfiguration. Usa variables de entorno sin invalidaciones: adecuadas para implementaciones de un solo inquilino o cuando se usan funciones de invalidación dinámica para multiinquilino.

Detalles de la función

getClusterCategory(IConfigurationProvider<RuntimeConfiguration>)

Advertencia

Esta API ya está en desuso.

Use RuntimeConfiguration.clusterCategory instead.

Obtiene la categoría de clúster de las variables de entorno.

Ejemplo

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

Parámetros

configProvider

IConfigurationProvider<RuntimeConfiguration>

Proveedor de configuración opcional. El valor predeterminado es defaultRuntimeConfigurationProvider si no se especifica.

Devoluciones

string

La categoría de clúster de CLUSTER_CATEGORY env var, el valor predeterminado es "prod".

getMcpPlatformAuthenticationScope()

Advertencia

Esta API ya está en desuso.

Use ToolingConfiguration.mcpPlatformAuthenticationScope instead.

Obtiene el ámbito de autenticación de la plataforma MCP.

Ejemplo

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

Devoluciones

string

Ámbito de autenticación de la plataforma MCP.

getObservabilityAuthenticationScope()

Advertencia

Esta API ya está en desuso.

Use ObservabilityConfiguration.observabilityAuthenticationScopes instead.

Devuelve el ámbito para autenticarse en el servicio de observabilidad.

Ejemplo

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

Devoluciones

string[]

Ámbitos de autenticación para el entorno actual.

isDevelopmentEnvironment(IConfigurationProvider<RuntimeConfiguration>)

Advertencia

Esta API ya está en desuso.

Use RuntimeConfiguration.isDevelopmentEnvironment instead.

Devuelve true si el entorno actual es un entorno de desarrollo.

Ejemplo

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

Parámetros

configProvider

IConfigurationProvider<RuntimeConfiguration>

Proveedor de configuración opcional. El valor predeterminado es defaultRuntimeConfigurationProvider si no se especifica.

Devoluciones

boolean

True si el entorno actual es desarrollo; de lo contrario, false.

Detalles de variables

DEVELOPMENT_ENVIRONMENT_NAME

DEVELOPMENT_ENVIRONMENT_NAME: "Development"

Tipo

"Development"

PRODUCTION_ENVIRONMENT_NAME

PRODUCTION_ENVIRONMENT_NAME: "production"

Tipo

"production"

PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE

Advertencia

Esta API ya está en desuso.

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

Ámbito de autenticación de la plataforma MCP de producción.

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

Tipo

string

PROD_OBSERVABILITY_CLUSTER_CATEGORY

Advertencia

Esta API ya está en desuso.

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

Categoría de clúster predeterminada para entornos de producción.

PROD_OBSERVABILITY_CLUSTER_CATEGORY: "prod"

Tipo

"prod"

PROD_OBSERVABILITY_SCOPE

Advertencia

Esta API ya está en desuso.

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

Ámbito de autenticación de observabilidad de producción.

PROD_OBSERVABILITY_SCOPE: "https://api.powerplatform.com/.default"

Tipo

string

defaultRuntimeConfigurationProvider

Proveedor predeterminado compartido para RuntimeConfiguration. Usa variables de entorno sin invalidaciones: adecuadas para implementaciones de un solo inquilino o cuando se usan funciones de invalidación dinámica para multiinquilino.

defaultRuntimeConfigurationProvider: DefaultConfigurationProvider<RuntimeConfiguration>

Tipo