InferenceScope class

Pacchetto:

@microsoft/agents-a365-observability

Fornisce l'ambito di traccia OpenTelemetry per le operazioni di inferenza di intelligenza artificiale generative.

Extends

OpenTelemetryScope

Metodi

recordFinishReasons(string[])	Registra i motivi di fine per il rilevamento dei dati di telemetria.
recordInputMessages(InputMessagesParam)	Registra i messaggi di input per il rilevamento dei dati di telemetria. Accetta stringhe semplici (con wrapping automatico come ChatMessage MULTIDIMENSIONAL con ruolo user) o un wrapper InputMessages con controllo delle versioni.
recordInputTokens(number)	Registra il numero di token di input per il rilevamento dei dati di telemetria.
recordOutputMessages(OutputMessagesParam)	Registra i messaggi di output per il rilevamento dei dati di telemetria. Accetta stringhe semplici (con wrapping automatico come OutputMessage MULTIDIMENSIONAL con ruolo assistant) o un wrapper OutputMessages con versione.
recordOutputTokens(number)	Registra il numero di token di output per il rilevamento dei dati di telemetria.
start(Request, InferenceDetails, AgentDetails, UserDetails, SpanDetails)	Crea e avvia un nuovo ambito per la traccia dell'inferenza.

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

recordFinishReasons(string[])

Registra i motivi di fine per il rilevamento dei dati di telemetria.

function recordFinishReasons(finishReasons: string[])

Parametri

finishReasons

string[]

Matrice di motivi di fine

recordInputMessages(InputMessagesParam)

Registra i messaggi di input per il rilevamento dei dati di telemetria. Accetta stringhe semplici (con wrapping automatico come ChatMessage MULTIDIMENSIONAL con ruolo user) o un wrapper InputMessages con controllo delle versioni.

function recordInputMessages(messages: InputMessagesParam)

Parametri

messages

InputMessagesParam

Matrice di stringhe di messaggi di input o wrapper InputMessages

recordInputTokens(number)

Registra il numero di token di input per il rilevamento dei dati di telemetria.

function recordInputTokens(inputTokens: number)

Parametri

inputTokens

number

Numero di token di input

recordOutputMessages(OutputMessagesParam)

Registra i messaggi di output per il rilevamento dei dati di telemetria. Accetta stringhe semplici (con wrapping automatico come OutputMessage MULTIDIMENSIONAL con ruolo assistant) o un wrapper OutputMessages con versione.

function recordOutputMessages(messages: OutputMessagesParam)

Parametri

messages

OutputMessagesParam

Matrice di stringhe di messaggio di output o wrapper OutputMessages

recordOutputTokens(number)

Registra il numero di token di output per il rilevamento dei dati di telemetria.

function recordOutputTokens(outputTokens: number)

Parametri

outputTokens

number

Numero di token di output

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

Crea e avvia un nuovo ambito per la traccia dell'inferenza.

static function start(request: Request, details: InferenceDetails, agentDetails: AgentDetails, userDetails?: UserDetails, spanDetails?: SpanDetails): InferenceScope

Parametri

request

Request

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

details

InferenceDetails

Dettagli della chiamata di inferenza (modello, provider, token e così via).

agentDetails

AgentDetails

Agente che esegue l'inferenza. L'ID tenant è derivato da agentDetails.tenantId.

userDetails

UserDetails

Identità del chiamante umano facoltativa.

spanDetails

SpanDetails

Configurazione dell'intervallo facoltativo (parentContext, startTime, endTime, spanLinks). Nota: spanKind viene ignorato; InferenceScope usa SpanKind.CLIENTsempre .

Valori restituiti

InferenceScope

Nuova istanza di InferenceScope

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