OutputScope class

Pacchetto:

@microsoft/agents-a365-observability

Fornisce l'ambito di traccia OpenTelemetry per la traccia dei messaggi di output con il collegamento dell'intervallo padre.

Extends

OpenTelemetryScope

Metodi

recordOutputMessages(ResponseMessagesParam)

Registra i messaggi di output per il rilevamento dei dati di telemetria. Sovrascrive tutti i messaggi di output registrati in precedenza nell'intervallo. Accetta una singola stringa, una matrice di stringhe (con wrapping automatico come OutputMessage INTUNE), un wrapper OutputMessages con controllo delle versioni o un dict non elaborato (considerato come risultato di una chiamata allo strumento per ogni specifica INTUNE, serializzato direttamente).

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

Crea e avvia un nuovo ambito per la traccia dei messaggi di output.

Metodi ereditati

dispose()	Metodo dispose legacy per la compatibilità
getSpanContext()	Ottiene il contesto dell'intervallo per questo ambito. Può essere usato per creare un elemento ParentSpanRef per il collegamento esplicito padre-figlio attraverso i limiti asincroni.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Registra più coppie chiave/valore di attributo per il rilevamento dei dati di telemetria.
recordCancellation(string)	Registra un evento di annullamento nell'intervallo. Imposta lo stato dell'intervallo su ERROR con il motivo dell'annullamento e contrassegna il tipo di errore come 'TaskCanceledException'.
recordError(Error)	Registra un errore che si è verificato durante l'operazione
setEndTime(TimeInput)	Imposta un'ora di fine personalizzata per l'ambito. Se impostato, dispose passerà questo valore a span.end() invece di usare l'ora corrente. Ciò è utile quando l'ora di fine effettiva dell'operazione è nota prima dell'eliminazione dell'ambito.
withActiveSpanAsync<T>(() => Promise<T>)	Rende attivo questo intervallo per la durata dell'esecuzione del callback asincrono

Dettagli metodo

recordOutputMessages(ResponseMessagesParam)

Registra i messaggi di output per il rilevamento dei dati di telemetria. Sovrascrive tutti i messaggi di output registrati in precedenza nell'intervallo. Accetta una singola stringa, una matrice di stringhe (con wrapping automatico come OutputMessage INTUNE), un wrapper OutputMessages con controllo delle versioni o un dict non elaborato (considerato come risultato di una chiamata allo strumento per ogni specifica INTUNE, serializzato direttamente).

function recordOutputMessages(messages: ResponseMessagesParam)

Parametri

messages

ResponseMessagesParam

Stringa, matrice di stringhe, wrapper OutputMessages o dict.

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

Crea e avvia un nuovo ambito per la traccia dei messaggi di output.

static function start(request: Request, response: OutputResponse, agentDetails: AgentDetails, userDetails?: UserDetails, spanDetails?: SpanDetails): OutputScope

Parametri

request

Request

Payload della richiesta (channel, conversationId, content, sessionId).

response

OutputResponse

Risposta contenente i messaggi di output iniziali.

agentDetails

AgentDetails

L'agente che produce l'output. L'ID tenant è derivato da agentDetails.tenantId.

userDetails

UserDetails

Dettagli dell'identità del chiamante umano facoltativi.

spanDetails

SpanDetails

Configurazione dell'intervallo facoltativo (parentContext, startTime, endTime, spanLinks).

Valori restituiti

OutputScope

Nuova istanza di OutputScope.

Dettagli dei metodi ereditati

dispose()

Metodo dispose legacy per la compatibilità

function dispose()

Ereditato daOpenTelemetryScope.dispose

getSpanContext()

Ottiene il contesto dell'intervallo per questo ambito. Può essere usato per creare un elemento ParentSpanRef per il collegamento esplicito padre-figlio attraverso i limiti asincroni.

function getSpanContext(): SpanContext

Valori restituiti

SpanContext

SpanContext contenente traceId e spanId

Ereditato daOpenTelemetryScope.getSpanContext

recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Registra più coppie chiave/valore di attributo per il rilevamento dei dati di telemetria.

function recordAttributes(attributes: undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Parametri

attributes

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

Raccolta di coppie chiave/valore dell'attributo (matrice o iterabile di [chiave, valore] o mappa oggetti).

Ereditato daOpenTelemetryScope.recordAttributes

recordCancellation(string)

Registra un evento di annullamento nell'intervallo. Imposta lo stato dell'intervallo su ERROR con il motivo dell'annullamento e contrassegna il tipo di errore come 'TaskCanceledException'.

function recordCancellation(reason?: string)

Parametri

reason

string

Motivo di annullamento facoltativo. L'impostazione predefinita è 'Task was cancelled'.

Ereditato daOpenTelemetryScope.recordCancellation

recordError(Error)

Registra un errore che si è verificato durante l'operazione

function recordError(error: Error)

Parametri

error

Error

L'errore che si è verificato

Ereditato daOpenTelemetryScope.recordError

setEndTime(TimeInput)

Imposta un'ora di fine personalizzata per l'ambito. Se impostato, dispose passerà questo valore a span.end() invece di usare l'ora corrente. Ciò è utile quando l'ora di fine effettiva dell'operazione è nota prima dell'eliminazione dell'ambito.

function setEndTime(endTime: TimeInput)

Parametri

endTime

TimeInput

Ora di fine come millisecondi dall'epoca, da una tupla Date o HrTime.

Ereditato daOpenTelemetryScope.setEndTime

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

Rende attivo questo intervallo per la durata dell'esecuzione del callback asincrono

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

Parametri

callback

() => Promise<T>

Valori restituiti

Promise<T>

Ereditato daOpenTelemetryScope.withActiveSpanAsync