InvokeAgentScope class

Πακέτο:: @microsoft/agents-a365-observability

Παρέχει εμβέλεια ανίχνευσης OpenTelemetry για λειτουργίες κλήσης παράγοντα AI.

Επεκτείνει: 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)	Καταγράφει ένα συμβάν ακύρωσης στο εύρος. Ορίζει την κατάσταση της περιοχής σε ERROR με την αιτία ακύρωσης και επισημαίνει τον τύπο σφάλματος ως "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

Ωφέλιμο φορτίο αίτησης (κανάλι, αναγνωριστικό συνομιλίας, περιεχόμενο, αναγνωριστικό περιόδου λειτουργίας).

invokeScopeDetails: InvokeAgentScopeDetails

Λεπτομέρειες επιπέδου εμβέλειας

agentDetails: AgentDetails

Η ταυτότητα του πράκτορα. Το αναγνωριστικό μισθωτή προκύπτει από agentDetails.tenantId το (απαιτείται).

callerDetails: CallerDetails

Προαιρετικές πληροφορίες καλούντες. Υποστηρίζει τρία σενάρια:

Μόνο για ανθρώπους που καλούν: { userDetails: { userId, userName, ... } }
Μόνο καλούντες αντιπροσώπων: { callerAgentDetails: { agentId, agentName, ... } }
Και τα δύο (A2A με άνθρωπο στην αλυσίδα): { userDetails: { ... }, callerAgentDetails: { ... } }

spanDetails: SpanDetails

Προαιρετική ρύθμιση παραμέτρων εύρους (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)

Καταγράφει ένα συμβάν ακύρωσης στο εύρος. Ορίζει την κατάσταση της περιοχής σε ERROR με την αιτία ακύρωσης και επισημαίνει τον τύπο σφάλματος ως "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

Η ώρα λήξης ως χιλιοστά του δευτερολέπτου από την χρονική σήμανση, μια ημερομηνία ή μια πλειάδα HrTime.

Μεταβίβαση από τοOpenTelemetryScope.setEndTime

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

Αυτό το εύρος είναι ενεργό κατά τη διάρκεια της ασύγχρονης εκτέλεσης επιστροφής κλήσης

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

Παράμετροι

callback: () => Promise<T>

Επιστροφές

Promise<T>

Μεταβίβαση από τοOpenTelemetryScope.withActiveSpanAsync