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)	מתעד אירוע ביטול על לאורך. הגדרת מצב טווח לשגיאה עם סיבת הביטול וסמנת את סוג השגיאה כ- '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

בקש תוכן מנה (ערוץ, conversationId, תוכן, sessionId).

details

InferenceDetails

פרטי שיחת ההסקאות (מודל, ספק, אסימונים וכדומה).

agentDetails

AgentDetails

הסוכן שמבצע את ההסקה. מזהה הדייר נגזר מ- agentDetails.tenantId.

userDetails

UserDetails

זהות מתקשר אנושית אופציונלית.

spanDetails

SpanDetails

תצורת span אופציונלית (parentContext, startTime, endTime, spanLinks). הערה: spanKind התעלמות ממנו; InferenceScope משתמש תמיד ב- SpanKind.CLIENT.

החזרות

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)

מתעד אירוע ביטול על לאורך. הגדרת מצב טווח לשגיאה עם סיבת הביטול וסמנת את סוג השגיאה כ- '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

שעת הסיום כמילפיות שניה מאז epoch, Date או קבוצת משתנים של HrTime.

עובר בירושה מ- OpenTelemetryScope.setEndTime

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

הפיכת טווח זה לפעיל למשך הזמן של ביצוע ההתקשרות חזרה האסינכרונית

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

פרמטרים

callback

() => Promise<T>

החזרות

Promise<T>

עובר בירושה מ- OpenTelemetryScope.withActiveSpanAsync