@microsoft/agents-a365-runtime package

מחלקות

AgenticAuthenticationService

שירות לטיפול באימות משתמש סוכן.
DefaultConfigurationProvider

ספק ברירת מחדל שמחזיר תצורה מבוססת סביבה.

שיקולים מרובי דיירים: ספק זה יוצר מופע תצורה יחיד בזמן בנייה, המשותף בכל הבקשות בתהליך. הספקים ברמת המודול המהווים ברירת מחדל (לדוגמה, defaultRuntimeConfigurationProvider) הם singletons.

עבור תרחישים מרובי דיירים, שתי גישות נתמכות:

  1. פונקציות עקיפה דינאמיות (מומלץ): העברת פונקציות עקיפה שנקראו מהקשר אסינכרוני (לדוגמה, כבודת OpenTelemetry) בזמן ריצה. אותו מופע תצורה מחזיר ערכים שונים לכל בקשה.

    const config = new ToolingConfiguration({
  mcpPlatformEndpoint: () => {
    const tenantConfig = context.active().getValue(TENANT_KEY);
    return tenantConfig?.endpoint ?? 'https://default.endpoint';
  }
});

  2. ספקי דיירים: צור מופעי ספק נפרדים עבור כל דייר כאשר דיירים שונים זקוקים לחלוטין לפונקציות עקיפה שונות.
OperationError

כיתוב שגיאה מפעולה.
OperationResult

מייצג את התוצאה של פעולה.
PowerPlatformApiDiscovery
RuntimeConfiguration

מחלקת קביעת תצורה בסיסית עבור SDK של Agent365. חבילות אחרות מרחיבות זאת כדי להוסיף הגדרות משלהן.

פונקציות עקיפה נקראות בכל גישה למאפיין, ומאפשרות רזולוציה דינאמית מהקשר אסינכרוני (לדוגמה, כבודת OpenTelemetry) לפי בקשה.
Utility

מחלקת כלי שירות המספקת שיטות עוזרות עבור פעולות זמן ריצה של סוכן.

ממשקים

IConfigurationProvider

ממשק כללי לאספקת תצורה. כל חבילה מגדירה סוג תצורה T משלה.

כינויי סוג

RuntimeConfigurationOptions

אפשרויות תצורה של זמן ריצה - כל הפונקציות האופציונליות. הפונקציות נקראות בכל גישה למאפיינים, מה שמאפשר רזולוציה דינאמית. ביטול ההגדרת ערכים חוזר למשתנה סביבה.

ערכי Enum

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

נכון אם הסביבה הנוכחית היא פיתוח, שקר אחרת.

פרטי המשתנה

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>