@microsoft/agents-a365-runtime package

ชั้นเรียน

AgenticAuthenticationService

บริการสําหรับการจัดการการรับรองความถูกต้องผู้ใช้ที่เป็นตัวแทน

DefaultConfigurationProvider

ตัวให้บริการเริ่มต้นที่ส่งกลับการกําหนดค่าตามสภาพแวดล้อม

ข้อควรพิจารณาแบบหลายผู้เช่า: ตัวให้บริการนี้สร้างอินสแตนซ์การกําหนดค่าเดียวในขณะก่อสร้าง ซึ่งใช้ร่วมกันทั่วทั้งคําขอทั้งหมดในกระบวนการ ตัวให้บริการระดับโมดูลเริ่มต้น (เช่น defaultRuntimeConfigurationProvider) คือ singletons

สําหรับสถานการณ์แบบหลายผู้เช่า ได้รับการสนับสนุนสองวิธี:

  1. ฟังก์ชันการแทนที่แบบไดนามิก (แนะนํา): ส่งผ่านฟังก์ชันแทนที่ที่อ่านจากบริบท async (เช่น OpenTelemetry baggage) ที่รันไทม์ อินสแตนซ์การกําหนดค่าเดียวกันจะส่งกลับค่าที่แตกต่างกันต่อคําขอ

    const config = new ToolingConfiguration({
      mcpPlatformEndpoint: () => {
        const tenantConfig = context.active().getValue(TENANT_KEY);
        return tenantConfig?.endpoint ?? 'https://default.endpoint';
      }
    });
    
  2. ผู้ให้บริการต่อผู้เช่า: สร้างอินสแตนซ์ของผู้ให้บริการแยกต่างหากสําหรับผู้เช่าแต่ละรายเมื่อผู้เช่าที่แตกต่างกันต้องการฟังก์ชันการแทนที่ที่แตกต่างกันทั้งหมด

OperationError

ย่อส่วนข้อผิดพลาดจากการดําเนินการ

OperationResult

แสดงผลลัพธ์ของการดําเนินการ

PowerPlatformApiDiscovery
RuntimeConfiguration

ระดับการกําหนดค่าพื้นฐานสําหรับ Agent365 SDK แพคเกจอื่นๆ จะขยายการตั้งค่านี้เพื่อเพิ่มการตั้งค่าของพวกเขาเอง

ฟังก์ชันการแทนที่จะถูกเรียกใช้ในแต่ละการเข้าถึงคุณสมบัติ การเปิดใช้งานการแก้ปัญหาแบบไดนามิกจากบริบทต่างเวลา (เช่น สัมภาระ OpenTelemetry) ต่อคําขอ

Utility

คลาสยูทิลิตี้ที่มีวิธีการช่วยเหลือสําหรับการดําเนินการรันไทม์ตัวแทน

อินเทอร์เฟซ

IConfigurationProvider

อินเทอร์เฟซทั่วไปสําหรับการจัดโครงแบบ แต่ละแพคเกจจะกําหนดประเภทการกําหนดค่า T ของตัวเอง

ประเภทนามแฝง

RuntimeConfigurationOptions

ตัวเลือกการกําหนดค่ารันไทม์ - ฟังก์ชันตัวเลือกทั้งหมด ฟังก์ชันถูกเรียกใช้ในแต่ละการเข้าถึงคุณสมบัติ เปิดใช้งานความละเอียดแบบไดนามิก ค่าที่ไม่ตั้งค่าจะกลับสู่ตัวแปรสภาพแวดล้อม

Enums

ClusterCategory

ประเภทคลัสเตอร์สําหรับการค้นพบ Power Platform API Enum สตริงมีทั้งความปลอดภัยประเภทเวลาการคอมไพล์และการตรวจสอบรันไทม์

ฟังก์ชัน

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>

พิมพ์