InvokeAgentScope class

แพคเกจ:

@microsoft/agents-a365-observability

ให้ขอบเขตการติดตาม OpenTelemetry สําหรับการดําเนินการเรียกใช้ตัวแทน AI

ขยาย

OpenTelemetryScope

วิธีการ

recordInputMessages(InputMessagesParam)	บันทึกข้อความป้อนเข้าสําหรับการติดตามการวัดและส่งข้อมูลทางไกล ยอมรับสตริงเดียว อาร์เรย์ของสตริง (auto-wrapped เป็น OTEL ChatMessage ด้วยบทบาท user) หรือตัวครอบคลุม InputMessages เวอร์ชัน
recordOutputMessages(OutputMessagesParam)	บันทึกข้อความเอาต์พุตสําหรับการติดตามการวัดและส่งข้อมูลทางไกล ยอมรับสตริงเดียว อาร์เรย์ของสตริง (auto-wrapped เป็น OTEL OutputMessage ที่มีบทบาท assistant) หรือตัวครอบ OutputMessages เวอร์ชัน
recordResponse(string)	บันทึกข้อมูลการตอบสนองสําหรับการติดตามการวัดและส่งข้อมูลทางไกล
start(Request, InvokeAgentScopeDetails, AgentDetails, CallerDetails, SpanDetails)	สร้างและเริ่มต้นขอบเขตใหม่สําหรับการติดตามการเรียกตัวแทน

วิธีการสืบทอด

dispose()	วิธีการกําจัดแบบดั้งเดิมสําหรับความเข้ากันได้
getSpanContext()	รับบริบทขยายสําหรับขอบเขตนี้ ซึ่งสามารถใช้เพื่อสร้าง ParentSpanRef สําหรับการเชื่อมโยงแบบ parent-child ที่ชัดเจนข้ามขอบเขตต่าง ๆ ที่ไม่ตรงกัน
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	บันทึกคู่คีย์/ค่าแอตทริบิวต์หลายคู่สําหรับการติดตามการวัดและส่งข้อมูลทางไกล
recordCancellation(string)	บันทึกเหตุการณ์การยกเลิกในช่วงดังกล่าว ตั้งค่าสถานะการขยายเป็น ERROR ด้วยเหตุผลการยกเลิกและทําเครื่องหมายประเภทข้อผิดพลาดเป็น 'TaskCanceledException'
recordError(Error)	บันทึกข้อผิดพลาดที่เกิดขึ้นระหว่างการดําเนินการ
setEndTime(TimeInput)	ตั้งค่าเวลาสิ้นสุดแบบกําหนดเองสําหรับขอบเขต เมื่อตั้งค่า กําจัด ค่านี้จะส่งผ่านค่า span.end() นี้แทนที่จะใช้เวลานาฬิกาแขวนในปัจจุบัน ซึ่งจะเป็นประโยชน์เมื่อเวลาสิ้นสุดที่แท้จริงของการดําเนินการถูกทราบก่อนที่จะกําจัดขอบเขต
withActiveSpanAsync<T>(() => Promise<T>)	ทําให้การขยายนี้ใช้งานได้สําหรับระยะเวลาของการเรียกกลับแบบ async

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

recordInputMessages(InputMessagesParam)

บันทึกข้อความป้อนเข้าสําหรับการติดตามการวัดและส่งข้อมูลทางไกล ยอมรับสตริงเดียว อาร์เรย์ของสตริง (auto-wrapped เป็น OTEL ChatMessage ด้วยบทบาท user) หรือตัวครอบคลุม InputMessages เวอร์ชัน

function recordInputMessages(messages: InputMessagesParam)

พารามิเตอร์

messages

InputMessagesParam

สตริง อาร์เรย์ ของสตริง หรือตัวรวบ InputMessages

recordOutputMessages(OutputMessagesParam)

บันทึกข้อความเอาต์พุตสําหรับการติดตามการวัดและส่งข้อมูลทางไกล ยอมรับสตริงเดียว อาร์เรย์ของสตริง (auto-wrapped เป็น OTEL OutputMessage ที่มีบทบาท assistant) หรือตัวครอบ OutputMessages เวอร์ชัน

function recordOutputMessages(messages: OutputMessagesParam)

พารามิเตอร์

messages

OutputMessagesParam

สตริง อาร์เรย์ ของสตริง หรือตัวรวบ OutputMessages

recordResponse(string)

บันทึกข้อมูลการตอบสนองสําหรับการติดตามการวัดและส่งข้อมูลทางไกล

function recordResponse(response: string)

พารามิเตอร์

response

string

การตอบสนองการเรียกใช้

start(Request, InvokeAgentScopeDetails, AgentDetails, CallerDetails, SpanDetails)

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

static function start(request: Request, invokeScopeDetails: InvokeAgentScopeDetails, agentDetails: AgentDetails, callerDetails?: CallerDetails, spanDetails?: SpanDetails): InvokeAgentScope

พารามิเตอร์

request

Request

คําขอส่วนข้อมูล (ช่อง, การสนทนา Id, เนื้อหา, sessionId)

invokeScopeDetails

InvokeAgentScopeDetails

รายละเอียดระดับขอบเขต

agentDetails

AgentDetails

ข้อมูลประจําตัวของเอเจนต์ รหัสผู้เช่าได้รับมาจาก agentDetails.tenantId (จําเป็น)

callerDetails

CallerDetails

ข้อมูลผู้เรียกที่เลือกได้ รองรับสามสถานการณ์:

• ผู้เรียกของมนุษย์เท่านั้น: { userDetails: { userId, userName, ... } }
• ผู้โทรของตัวแทนเท่านั้น: { callerAgentDetails: { agentId, agentName, ... } }
• ทั้ง (A2A ที่มีมนุษยธรรมในสาย): { userDetails: { ... }, callerAgentDetails: { ... } }

spanDetails

SpanDetails

การกําหนดค่าการขยายตัวเลือก (parentContext, startTime, endTime, spanKind, spanLinks)

การส่งคืน

InvokeAgentScope

อินสแตนซ์ InvokeAgentScope ใหม่

รายละเอียดวิธีการสืบทอด

dispose()

วิธีการกําจัดแบบดั้งเดิมสําหรับความเข้ากันได้

function dispose()

สืบทอดมาจากOpenTelemetryScope.dispose

getSpanContext()

รับบริบทขยายสําหรับขอบเขตนี้ ซึ่งสามารถใช้เพื่อสร้าง ParentSpanRef สําหรับการเชื่อมโยงแบบ parent-child ที่ชัดเจนข้ามขอบเขตต่าง ๆ ที่ไม่ตรงกัน

function getSpanContext(): SpanContext

การส่งคืน

SpanContext

SpanContext ที่มี traceId และ spanId

สืบทอดมาจากOpenTelemetryScope.getSpanContext

recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

บันทึกคู่คีย์/ค่าแอตทริบิวต์หลายคู่สําหรับการติดตามการวัดและส่งข้อมูลทางไกล

function recordAttributes(attributes: undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

พารามิเตอร์

attributes

undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>

คอลเลกชันของคู่คีย์/ค่าแอตทริบิวต์ (อาร์เรย์หรือสามารถคํานวณซ้ําได้ของ [คีย์, ค่า] หรือแผนที่วัตถุ)

สืบทอดมาจากOpenTelemetryScope.recordAttributes

recordCancellation(string)

บันทึกเหตุการณ์การยกเลิกในช่วงดังกล่าว ตั้งค่าสถานะการขยายเป็น ERROR ด้วยเหตุผลการยกเลิกและทําเครื่องหมายประเภทข้อผิดพลาดเป็น 'TaskCanceledException'

function recordCancellation(reason?: string)

พารามิเตอร์

reason

string

เหตุผลการยกเลิกทางเลือก ค่าเริ่มต้นเป็น 'งานถูกยกเลิก'

สืบทอดมาจากOpenTelemetryScope.recordCancellation

recordError(Error)

บันทึกข้อผิดพลาดที่เกิดขึ้นระหว่างการดําเนินการ

function recordError(error: Error)

พารามิเตอร์

error

Error

ข้อผิดพลาดที่เกิดขึ้น

สืบทอดมาจากOpenTelemetryScope.recordError

setEndTime(TimeInput)

ตั้งค่าเวลาสิ้นสุดแบบกําหนดเองสําหรับขอบเขต เมื่อตั้งค่า กําจัด ค่านี้จะส่งผ่านค่า span.end() นี้แทนที่จะใช้เวลานาฬิกาแขวนในปัจจุบัน ซึ่งจะเป็นประโยชน์เมื่อเวลาสิ้นสุดที่แท้จริงของการดําเนินการถูกทราบก่อนที่จะกําจัดขอบเขต

function setEndTime(endTime: TimeInput)

พารามิเตอร์

endTime

TimeInput

เวลาสิ้นสุดเป็นมิลลิวินาทีตั้งแต่ยุค วันที่ หรือทูเพิล HrTime

สืบทอดมาจากOpenTelemetryScope.setEndTime

withActiveSpanAsync<T>(() => Promise<T>)

ทําให้การขยายนี้ใช้งานได้สําหรับระยะเวลาของการเรียกกลับแบบ async

function withActiveSpanAsync<T>(callback: () => Promise<T>): Promise<T>

พารามิเตอร์

callback

() => Promise<T>

การส่งคืน

Promise<T>

สืบทอดมาจากOpenTelemetryScope.withActiveSpanAsync