BaggageBuilder class

Πακέτο:

@microsoft/agents-a365-observability

Ανά αίτηση εργαλείου δόμησης αποσκευών για τη μετάδοση περιβάλλοντος OpenTelemetry.

Αυτή η κλάση παρέχει ένα ευφράδειο API για τον ορισμό τιμών αποσκευών που θα μεταδοθούν στο περιβάλλον 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

Η διεύθυνση διακομιστή (όνομα κεντρικού υπολογιστή) της υπηρεσίας παράγοντα προορισμού.

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

Αυτόματη για σύνδεση σε αλυσίδα μεθόδων