BaggageBuilder class

חבילה:

@microsoft/agents-a365-observability

בונה כבודה לבקשה להפצת הקשר OpenTelemetry.

מחלקה זו מספקת API Fluent להגדרת ערכי כבודה אשר יופצו בהקשר OpenTelemetry.

דוגמה

const scope = new BaggageBuilder()
  .tenantId("tenant-123")
  .agentId("agent-456")
  .build();

scope.enter();
// Baggage is set in this context
// ... do work ...
scope.exit();
// Baggage is restored after exiting the context

שיטות

agentAuid(undefined | null | string)	הגדר את ערך כבודת AUID של הסוכן.
agentBlueprintId(undefined | null | string)	הגדר את ערך כבודת שרטוט הסוכן.
agentDescription(undefined | null | string)	הגדר את ערך כבודת הסוכן.
agentEmail(undefined | null | string)	הגדר את ערך כבודת הדואר האלקטרוני של הסוכן.
agentId(undefined | null | string)	הגדר את ערך כבודת המזהה של הסוכן.
agentName(undefined | null | string)	הגדר את ערך כבודת שם הסוכן.
agentPlatformId(undefined | null | string)	הגדר את ערך כבודת מזהה פלטפורמת הסוכן.
agentVersion(undefined | null | string)	הגדר את ערך כבודת גירסת הסוכן.
build()	החל את כבודת האיסוף על ההקשר הנוכחי.
callerAgentPlatformId(undefined | null | string)	הגדר את ערך כבודת המזהה של הפלטפורמה של סוכן מתקשר.
callerClientIp(undefined | null | string)	הגדר את ערך כבודת ה- IP של לקוח מתקשר. משמש ללכידת כתובת ה- IP המקורית של הלקוח עבור הבקשה כדי שניתן יהיה להוסיף אותה באמצעות כבודה של OpenTelemetry.
channelLink(undefined | null | string)	הגדר את הקישור/כתובת ה- URL של הערוץ.
channelName(undefined | null | string)	הגדר את שם הערוץ (לדוגמה, Teams, Slack).
conversationId(undefined | null | string)	הגדר את ערך כבודת מזהה השיחה.
conversationItemLink(undefined | null | string)	הגדר את ערך כבודת הקישור של פריט השיחה.
invokeAgentServer(undefined | null | string, number)	הגדרת כתובת השרת של הסוכן ההפעלה ופרטי כבודת היציאה.
operationSource(undefined | null | string)	הגדר את ערך כבודת מקור הפעולה. משמשת לשרת מתפרס כדי לזהות את השירות (לדוגמה, ATG, ACF).
sessionDescription(undefined | null | string)	הגדר את ערך כבודת תיאור ההפעלה.
sessionId(string)	הגדר את ערך כבודת מזהה ההפעלה.
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)	הגדר זוגות כבודה מרובים ממילון או ניתנים להפעלה.
setRequestContext(null | string, null | string)	שיטת נוחות להתחיל היקף כבודת בקשה עם שדות משותפים.
tenantId(undefined | null | string)	הגדר את ערך כבודת מזהה הדייר.
userEmail(undefined | null | string)	הגדר את ערך כבודת הדואר האלקטרוני של המשתמש.
userId(undefined | null | string)	הגדר את ערך כבודת מזהה המשתמש.
userName(undefined | null | string)	הגדר את ערך כבודת שם המשתמש.

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

agentAuid(undefined | null | string)

הגדר את ערך כבודת AUID של הסוכן.

function agentAuid(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

AUID של הסוכן

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

agentBlueprintId(undefined | null | string)

הגדר את ערך כבודת שרטוט הסוכן.

function agentBlueprintId(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

מזהה השרטוט של הסוכן

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

agentDescription(undefined | null | string)

הגדר את ערך כבודת הסוכן.

function agentDescription(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

תיאור הסוכן

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

agentEmail(undefined | null | string)

הגדר את ערך כבודת הדואר האלקטרוני של הסוכן.

function agentEmail(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

הודעת הדואר האלקטרוני של הסוכן

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

agentId(undefined | null | string)

הגדר את ערך כבודת המזהה של הסוכן.

function agentId(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

מזהה הסוכן

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

agentName(undefined | null | string)

הגדר את ערך כבודת שם הסוכן.

function agentName(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

שם הסוכן

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

agentPlatformId(undefined | null | string)

הגדר את ערך כבודת מזהה פלטפורמת הסוכן.

function agentPlatformId(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

מזהה פלטפורמת הסוכן

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

agentVersion(undefined | null | string)

הגדר את ערך כבודת גירסת הסוכן.

function agentVersion(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

גירסת הסוכן (לדוגמה, '1.0.0', '2025-05-01')

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

build()

החל את כבודת האיסוף על ההקשר הנוכחי.

function build(): BaggageScope

החזרות

BaggageScope

מנהל הקשר המשחזר את הכבודה הקודמת ביציאה

callerAgentPlatformId(undefined | null | string)

הגדר את ערך כבודת המזהה של הפלטפורמה של סוכן מתקשר.

function callerAgentPlatformId(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

מזהה הפלטפורמה של סוכן מתקשר

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

callerClientIp(undefined | null | string)

הגדר את ערך כבודת ה- IP של לקוח מתקשר. משמש ללכידת כתובת ה- IP המקורית של הלקוח עבור הבקשה כדי שניתן יהיה להוסיף אותה באמצעות כבודה של OpenTelemetry.

function callerClientIp(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

כתובת ה- IP של לקוח מתקשר

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

channelLink(undefined | null | string)

הגדר את הקישור/כתובת ה- URL של הערוץ.

function channelLink(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

קישור הערוץ

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

channelName(undefined | null | string)

הגדר את שם הערוץ (לדוגמה, Teams, Slack).

function channelName(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

שם הערוץ

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

conversationId(undefined | null | string)

הגדר את ערך כבודת מזהה השיחה.

function conversationId(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

מזהה השיחה

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

conversationItemLink(undefined | null | string)

הגדר את ערך כבודת הקישור של פריט השיחה.

function conversationItemLink(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

הקישור 'פריט שיחה'

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

invokeAgentServer(undefined | null | string, number)

הגדרת כתובת השרת של הסוכן ההפעלה ופרטי כבודת היציאה.

function invokeAgentServer(address: undefined | null | string, port?: number): BaggageBuilder

פרמטרים

address

undefined | null | string

כתובת השרת (hostname) של שירות סוכן היעד.

port

number

יציאת שרת אופציונלית. הוקלט רק כאשר הוא שונה מ- 443.

החזרות

BaggageBuilder

מופע הבונה הנוכחי עבור שרשרת פעולת שירות.

operationSource(undefined | null | string)

הגדר את ערך כבודת מקור הפעולה. משמשת לשרת מתפרס כדי לזהות את השירות (לדוגמה, ATG, ACF).

function operationSource(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

מקור הפעולה

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

sessionDescription(undefined | null | string)

הגדר את ערך כבודת תיאור ההפעלה.

function sessionDescription(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

תיאור ההפעלה

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

sessionId(string)

הגדר את ערך כבודת מזהה ההפעלה.

function sessionId(value: string): BaggageBuilder

פרמטרים

value

string

מזהה ההפעלה

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)

הגדר זוגות כבודה מרובים ממילון או ניתנים להפעלה.

function setPairs(pairs: undefined | null | Record<string, any> | Iterable<[string, any]>): BaggageBuilder

פרמטרים

pairs

undefined | null | Record<string, any> | Iterable<[string, any]>

מילון או איטרה של זוגות ערכי מפתח

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

setRequestContext(null | string, null | string)

שיטת נוחות להתחיל היקף כבודת בקשה עם שדות משותפים.

static function setRequestContext(tenantId?: null | string, agentId?: null | string): BaggageScope

פרמטרים

tenantId

null | string

מזהה הדייר

agentId

null | string

מזהה הסוכן

החזרות

BaggageScope

מנהל הקשר המשחזר את הכבודה הקודמת ביציאה

tenantId(undefined | null | string)

הגדר את ערך כבודת מזהה הדייר.

function tenantId(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

מזהה הדייר

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

userEmail(undefined | null | string)

הגדר את ערך כבודת הדואר האלקטרוני של המשתמש.

function userEmail(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

כתובת הדואר האלקטרוני של המשתמש

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

userId(undefined | null | string)

הגדר את ערך כבודת מזהה המשתמש.

function userId(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

מזהה המשתמש

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה

userName(undefined | null | string)

הגדר את ערך כבודת שם המשתמש.

function userName(value: undefined | null | string): BaggageBuilder

פרמטרים

value

undefined | null | string

שם המשתמש

החזרות

BaggageBuilder

עצמי עבור יצירת שרשרת של שיטה