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

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

invokeScopeDetails: InvokeAgentScopeDetails

פרטים ברמת הטווח

agentDetails: AgentDetails

זהות הסוכן. מזהה הדייר נגזר מ- agentDetails.tenantId (נדרש).

callerDetails: CallerDetails

פרטי מתקשר אופציונליים. תומך בשלושה תרחישים:

מתקשר אנושי בלבד: { userDetails: { userId, userName, ... } }
מתקשר סוכן בלבד: { callerAgentDetails: { agentId, agentName, ... } }
שניהם (A2A עם בני אדם בשרשרת): { userDetails: { ... }, callerAgentDetails: { ... } }

spanDetails: SpanDetails

תצורת span אופציונלית (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)

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