InferenceScope class

الحزمة:

@microsoft/agents-a365-observability

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

يمتد

OpenTelemetryScope

الأساليب

recordFinishReasons(string[])	تسجيل أسباب الانتهاء لتتبع بيانات تتبع الاستخدام.
recordInputMessages(InputMessagesParam)	تسجيل رسائل الإدخال لتعقب بيانات تتبع الاستخدام. يقبل السلاسل العادية (ملفوفة تلقائيا ك OTEL ChatMessage مع دور user) أو برنامج تضمين InputMessages الذي تم إصداره.
recordInputTokens(number)	يسجل عدد رموز الإدخال المميزة لتتبع بيانات تتبع الاستخدام.
recordOutputMessages(OutputMessagesParam)	تسجيل رسائل الإخراج لتعقب بيانات تتبع الاستخدام. يقبل السلاسل العادية (ملفوفة تلقائيا ك OTEL OutputMessage مع دور assistant) أو برنامج تضمين OutputMessages الذي تم إصداره.
recordOutputTokens(number)	يسجل عدد الرموز المميزة للإخراج لتتبع بيانات تتبع الاستخدام.
start(Request, InferenceDetails, AgentDetails, UserDetails, 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>)	جعل هذا النطاق نشطا طوال مدة تنفيذ رد الاتصال غير المتزامن

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

recordFinishReasons(string[])

تسجيل أسباب الانتهاء لتتبع بيانات تتبع الاستخدام.

function recordFinishReasons(finishReasons: string[])

المعلمات

finishReasons

string[]

صفيف أسباب الانتهاء

recordInputMessages(InputMessagesParam)

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

function recordInputMessages(messages: InputMessagesParam)

المعلمات

messages

InputMessagesParam

صفيف سلاسل رسائل الإدخال أو برنامج تضمين InputMessages

recordInputTokens(number)

يسجل عدد رموز الإدخال المميزة لتتبع بيانات تتبع الاستخدام.

function recordInputTokens(inputTokens: number)

المعلمات

inputTokens

number

عدد رموز الإدخال المميزة

recordOutputMessages(OutputMessagesParam)

تسجيل رسائل الإخراج لتعقب بيانات تتبع الاستخدام. يقبل السلاسل العادية (ملفوفة تلقائيا ك OTEL OutputMessage مع دور assistant) أو برنامج تضمين OutputMessages الذي تم إصداره.

function recordOutputMessages(messages: OutputMessagesParam)

المعلمات

messages

OutputMessagesParam

صفيف سلاسل رسائل الإخراج أو برنامج تضمين OutputMessages

recordOutputTokens(number)

يسجل عدد الرموز المميزة للإخراج لتتبع بيانات تتبع الاستخدام.

function recordOutputTokens(outputTokens: number)

المعلمات

outputTokens

number

عدد الرموز المميزة للإخراج

start(Request, InferenceDetails, AgentDetails, UserDetails, SpanDetails)

إنشاء نطاق جديد لتعقب الاستدلال وبدء تشغيله.

static function start(request: Request, details: InferenceDetails, agentDetails: AgentDetails, userDetails?: UserDetails, spanDetails?: SpanDetails): InferenceScope

المعلمات

request

Request

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

details

InferenceDetails

تفاصيل استدعاء الاستدلال (النموذج والموفر والرموز المميزة وما إلى ذلك).

agentDetails

AgentDetails

العامل الذي يقوم بالاستدلال. معرف المستأجر مشتق من agentDetails.tenantId.

userDetails

UserDetails

هوية المتصل البشري الاختيارية.

spanDetails

SpanDetails

تكوين النطاق الاختياري (parentContext، startTime، endTime، spanLinks). ملاحظة: spanKind يتم تجاهلها؛ يستخدم SpanKind.CLIENTInferenceScope دائما .

المرتجعات

InferenceScope

مثيل InferenceScope جديد

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

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