InvokeAgentScope class

الحزمة:: @microsoft/agents-a365-observability

يوفر نطاق تتبع OpenTelemetry لعمليات استدعاء عامل الذكاء الاصطناعي.

يمتد: OpenTelemetryScope

الأساليب

recordInputMessages(InputMessagesParam)	تسجيل رسائل الإدخال لتعقب بيانات تتبع الاستخدام. يقبل سلسلة واحدة أو صفيف من السلاسل (ملفوف تلقائيا ك OTEL ChatMessage مع دور `user`)، أو برنامج تضمين InputMessages الذي تم إصداره.
recordOutputMessages(OutputMessagesParam)	تسجيل رسائل الإخراج لتعقب بيانات تتبع الاستخدام. يقبل سلسلة واحدة أو صفيف من السلاسل (ملفوف تلقائيا ك OTEL OutputMessage مع دور `assistant`)، أو برنامج تضمين OutputMessages الذي تم إصداره.
recordResponse(string)	تسجيل معلومات الاستجابة لتعقب بيانات تتبع الاستخدام.
start(Request, InvokeAgentScopeDetails, AgentDetails, CallerDetails, SpanDetails)	إنشاء نطاق جديد لتعقب استدعاء العامل وبدء تشغيله.

الأساليب المتوارثة

dispose()	أسلوب التخلص القديم للتوافق
getSpanContext()	الحصول على سياق النطاق لهذا النطاق. يمكن استخدام هذا لإنشاء ParentSpanRef لربط أصل-تابع صريح عبر الحدود غير المتزامنة.
recordAttributes(undefined \| null \| Iterable<[string, AttributeValue]> \| Record<string, AttributeValue>)	تسجيل أزواج متعددة من مفاتيح/قيم السمات لتعقب بيانات تتبع الاستخدام.
recordCancellation(string)	تسجيل حدث إلغاء على النطاق. تعيين حالة النطاق إلى ERROR مع سبب الإلغاء ووضع علامة على نوع الخطأ على أنه "TaskCanceledException".
recordError(Error)	تسجيل خطأ حدث أثناء العملية
setEndTime(TimeInput)	تعيين وقت انتهاء مخصص للنطاق. عند التعيين، سيمرر التخلص هذه القيمة إلى `span.end()` بدلا من استخدام وقت ساعة الحائط الحالي. وهذا مفيد عندما يكون وقت الانتهاء الفعلي للعملية معروفا قبل التخلص من النطاق.
withActiveSpanAsync<T>(() => Promise<T>)	جعل هذا النطاق نشطا طوال مدة تنفيذ رد الاتصال غير المتزامن

تفاصيل الأسلوب

recordInputMessages(InputMessagesParam)

تسجيل رسائل الإدخال لتعقب بيانات تتبع الاستخدام. يقبل سلسلة واحدة أو صفيف من السلاسل (ملفوف تلقائيا ك OTEL ChatMessage مع دور user)، أو برنامج تضمين InputMessages الذي تم إصداره.

function recordInputMessages(messages: InputMessagesParam)

المعلمات

messages: InputMessagesParam

سلسلة أو صفيف من السلاسل أو برنامج تضمين InputMessages

recordOutputMessages(OutputMessagesParam)

تسجيل رسائل الإخراج لتعقب بيانات تتبع الاستخدام. يقبل سلسلة واحدة أو صفيف من السلاسل (ملفوف تلقائيا ك 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

حمولة الطلب (القناة ومعرف المحادثة والمحتوى ومعرف الجلسة).

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 لربط أصل-تابع صريح عبر الحدود غير المتزامنة.

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

جعل هذا النطاق نشطا طوال مدة تنفيذ رد الاتصال غير المتزامن

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

المعلمات

callback: () => Promise<T>

المرتجعات

Promise<T>

موروث منOpenTelemetryScope.withActiveSpanAsync