ExecuteToolScope class

חבילה:

@microsoft/agents-a365-observability

מספק טווח מעקב של OpenTelemetry עבור פעולות של ביצוע כלי בינה מלאכותית.

מרחיב

OpenTelemetryScope

שיטות

recordResponse(string | Record<string, unknown>)	מתעד מידע תגובה למעקב אחר מדידת שימוש.
start(Request, ToolCallDetails, 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>)	הפיכת טווח זה לפעיל למשך הזמן של ביצוע ההתקשרות חזרה האסינכרונית

פרטי פעולת השירות

recordResponse(string | Record<string, unknown>)

מתעד מידע תגובה למעקב אחר מדידת שימוש.

function recordResponse(response: string | Record<string, unknown>)

פרמטרים

response

string | Record<string, unknown>

תגובת ביצוע הכלי. אובייקטים טוריים ב- JSON באופן אוטומטי.

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

יצירה והפעלה של טווח חדש עבור מעקב אחר ביצוע כלי.

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

פרמטרים

request

Request

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

details

ToolCallDetails

פרטי שיחת הכלי (שם, סוג, args, מזהה שיחה וכולי).

agentDetails

AgentDetails

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

userDetails

UserDetails

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

spanDetails

SpanDetails

תצורת span אופציונלית (parentContext, startTime, endTime, spanLinks, spanKind). ברירות מחדל ל- SpanKind.INTERNAL.

החזרות

ExecuteToolScope

מופע ExecuteToolScope חדש.

פרטי שיטות שעברו בירושה

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