Utility class

แพคเกจ:: @microsoft/agents-a365-tooling

คุณสมบัติ

HEADER_AGENT_ID	ชื่อส่วนหัวสําหรับส่งตัวระบุตัวแทนไปยังแพลตฟอร์ม MCP สําหรับการบันทึก/การวิเคราะห์
HEADER_CHANNEL_ID
HEADER_SUBCHANNEL_ID
HEADER_USER_AGENT

วิธีการ

BuildMcpServerUrl(string, IConfigurationProvider<ToolingConfiguration>)	สร้าง URL แบบเต็มสําหรับการเข้าถึงเซิร์ฟเวอร์ MCP ที่เฉพาะเจาะจง ตัวอย่าง: Utility.BuildMcpServerUrl('MyServer') // => "https://agent365.svc.cloud.microsoft/agents/servers/MyServer/"
GetChatHistoryEndpoint(IConfigurationProvider<ToolingConfiguration>)	สร้าง URL ปลายทางสําหรับการส่งประวัติการแชทไปยังแพลตฟอร์ม MCP สําหรับการป้องกันภัยคุกคามแบบเรียลไทม์
GetMcpBaseUrl(IConfigurationProvider<ToolingConfiguration>)	รับ URL พื้นฐานที่ใช้ในการคิวรีสภาพแวดล้อม MCP
GetToolingGatewayForDigitalWorker(string, IConfigurationProvider<ToolingConfiguration>)	สร้าง URL ของเกตเวย์เครื่องมือสําหรับข้อมูลประจําตัวของตัวแทนที่กําหนด จุดสิ้นสุดนี้ใช้เพื่อค้นหาเซิร์ฟเวอร์ MCP ที่เชื่อมโยงกับข้อมูลประจําตัวของตัวแทนที่ระบุ ตัวอย่าง: Utility.GetToolingGatewayForDigitalWorker(agenticAppId) // => "https://agent365.svc.cloud.microsoft/agents/v2/{agenticAppId}/mcpServers"
GetToolRequestHeaders(string, TurnContext, ToolOptions)	เขียนส่วนหัวมาตรฐานสําหรับคําขอการใช้เครื่องมือ MCP รวมถึงโทเค็นผู้ถือสิทธิ์เมื่อระบุและอาจมีตัวระบุช่องและแชนเนลย่อยสําหรับการกําหนดเส้นทางด้วย
ValidateAuthToken(undefined \| string)	ตรวจสอบโทเค็นการรับรองความถูกต้อง JWT ตรวจสอบว่าโทเค็นเป็น JWT ที่ถูกต้องและไม่หมดอายุ

รายละเอียดคุณสมบัติ

HEADER_AGENT_ID

ชื่อส่วนหัวสําหรับส่งตัวระบุตัวแทนไปยังแพลตฟอร์ม MCP สําหรับการบันทึก/การวิเคราะห์

static HEADER_AGENT_ID: "x-ms-agentid" = "x-ms-agentid"

ค่าคุณสมบัติ

"x-ms-agentid"

HEADER_CHANNEL_ID

static HEADER_CHANNEL_ID: "x-ms-channel-id" = "x-ms-channel-id"

ค่าคุณสมบัติ

"x-ms-channel-id"

HEADER_SUBCHANNEL_ID

static HEADER_SUBCHANNEL_ID: "x-ms-subchannel-id" = "x-ms-subchannel-id"

ค่าคุณสมบัติ

"x-ms-subchannel-id"

HEADER_USER_AGENT

static HEADER_USER_AGENT: "User-Agent" = "User-Agent"

ค่าคุณสมบัติ

"User-Agent"

รายละเอียดวิธีการ

BuildMcpServerUrl(string, IConfigurationProvider<ToolingConfiguration>)

คำเตือน

API นี้ถูกเลิกใช้แล้วในตอนนี้

This method is for internal use only. Use McpToolServerConfigurationService instead.

สร้าง URL แบบเต็มสําหรับการเข้าถึงเซิร์ฟเวอร์ MCP ที่เฉพาะเจาะจง

ตัวอย่าง: Utility.BuildMcpServerUrl('MyServer') // => "https://agent365.svc.cloud.microsoft/agents/servers/MyServer/"

static function BuildMcpServerUrl(serverName: string, configProvider?: IConfigurationProvider<ToolingConfiguration>): string

พารามิเตอร์

serverName: string

ชื่อทรัพยากรเซิร์ฟเวอร์ MCP

configProvider: IConfigurationProvider<ToolingConfiguration>

ตัวให้บริการการกําหนดค่าทางเลือก ค่าเริ่มต้นเป็น defaultToolingConfigurationProvider

การส่งคืน

string

URL ของเซิร์ฟเวอร์ MCP แบบเต็ม รวมถึงเครื่องหมายทับต่อท้าย

GetChatHistoryEndpoint(IConfigurationProvider<ToolingConfiguration>)

คำเตือน

API นี้ถูกเลิกใช้แล้วในตอนนี้

This method is for internal use only. Use McpToolServerConfigurationService.sendChatHistory() instead.

สร้าง URL ปลายทางสําหรับการส่งประวัติการแชทไปยังแพลตฟอร์ม MCP สําหรับการป้องกันภัยคุกคามแบบเรียลไทม์

static function GetChatHistoryEndpoint(configProvider?: IConfigurationProvider<ToolingConfiguration>): string

พารามิเตอร์

configProvider: IConfigurationProvider<ToolingConfiguration>

ตัวให้บริการการกําหนดค่าทางเลือก ค่าเริ่มต้นเป็น defaultToolingConfigurationProvider

การส่งคืน

string

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

หมายเหตุ

เรียกใช้วิธีนี้เมื่อสร้างคําขอ HTTP ที่จําเป็นต้องเข้าถึงประวัติข้อความแชทสําหรับการป้องกันภัยคุกคามแบบเรียลไทม์ URL ที่ส่งกลับมามีที่อยู่ฐานของแพลตฟอร์ม MCP และเซกเมนต์ /agents/real-time-threat-protection/chat-messageเส้นทางคงที่อยู่แล้ว

GetMcpBaseUrl(IConfigurationProvider<ToolingConfiguration>)

คำเตือน

API นี้ถูกเลิกใช้แล้วในตอนนี้

This method is for internal use only. Use McpToolServerConfigurationService instead.

รับ URL พื้นฐานที่ใช้ในการคิวรีสภาพแวดล้อม MCP

static function GetMcpBaseUrl(configProvider?: IConfigurationProvider<ToolingConfiguration>): string

พารามิเตอร์

configProvider: IConfigurationProvider<ToolingConfiguration>

ตัวให้บริการการกําหนดค่าทางเลือก ค่าเริ่มต้นเป็น defaultToolingConfigurationProvider

การส่งคืน

string

URL ของสภาพแวดล้อม MCP พื้นฐาน

GetToolingGatewayForDigitalWorker(string, IConfigurationProvider<ToolingConfiguration>)

คำเตือน

API นี้ถูกเลิกใช้แล้วในตอนนี้

This method is for internal use only. Use McpToolServerConfigurationService.listToolServers() instead.

สร้าง URL ของเกตเวย์เครื่องมือสําหรับข้อมูลประจําตัวของตัวแทนที่กําหนด จุดสิ้นสุดนี้ใช้เพื่อค้นหาเซิร์ฟเวอร์ MCP ที่เชื่อมโยงกับข้อมูลประจําตัวของตัวแทนที่ระบุ

ตัวอย่าง: Utility.GetToolingGatewayForDigitalWorker(agenticAppId) // => "https://agent365.svc.cloud.microsoft/agents/v2/{agenticAppId}/mcpServers"

static function GetToolingGatewayForDigitalWorker(agenticAppId: string, configProvider?: IConfigurationProvider<ToolingConfiguration>): string

พารามิเตอร์

agenticAppId: string

รหัสเฉพาะสําหรับข้อมูลประจําตัวของตัวแทน

configProvider: IConfigurationProvider<ToolingConfiguration>

ตัวให้บริการการกําหนดค่าทางเลือก ค่าเริ่มต้นเป็น defaultToolingConfigurationProvider

การส่งคืน

string

การชี้ URL แบบเต็มที่เกตเวย์เครื่องมือสําหรับตัวแทน

GetToolRequestHeaders(string, TurnContext, ToolOptions)

เขียนส่วนหัวมาตรฐานสําหรับคําขอการใช้เครื่องมือ MCP รวมถึงโทเค็นผู้ถือสิทธิ์เมื่อระบุและอาจมีตัวระบุช่องและแชนเนลย่อยสําหรับการกําหนดเส้นทางด้วย

static function GetToolRequestHeaders(authToken?: string, turnContext?: TurnContext, options?: ToolOptions): Record<string, string>

พารามิเตอร์

authToken: string

โทเค็นแบเรอร์สําหรับส่วนหัวการตรวจสอบ

turnContext: TurnContext

ออบเจ็กต์ TurnContext ที่เลือกได้ที่มีการแยก ID ช่องและแชนเนลย่อย

options: ToolOptions

ออบเจ็กต์ ToolOptions ที่เป็นตัวเลือกสําหรับการกําหนดค่าคําขอเพิ่มเติม

การส่งคืน

Record<string, string>

ส่วนหัวของเรกคอร์ดเหมาะสําหรับคําขอ HTTP

ValidateAuthToken(undefined | string)

ตรวจสอบโทเค็นการรับรองความถูกต้อง JWT ตรวจสอบว่าโทเค็นเป็น JWT ที่ถูกต้องและไม่หมดอายุ

static function ValidateAuthToken(authToken: undefined | string)

พารามิเตอร์

authToken: undefined | string

โทเค็น JWT ที่จะตรวจสอบ