InferenceScope class

Pacote:

@microsoft/agents-a365-observability

Fornece o escopo de rastreamento opentelemetry para operações de inferência de IA generativas.

Extends

OpenTelemetryScope

Métodos

recordFinishReasons(string[])	Registra os motivos de término para o acompanhamento de telemetria.
recordInputMessages(InputMessagesParam)	Registra as mensagens de entrada para o acompanhamento de telemetria. Aceita cadeias de caracteres simples (encapsuladas automaticamente como ChatMessage OTEL com função user) ou um wrapper InputMessages com versão.
recordInputTokens(number)	Registra o número de tokens de entrada para o acompanhamento de telemetria.
recordOutputMessages(OutputMessagesParam)	Registra as mensagens de saída para o acompanhamento de telemetria. Aceita cadeias de caracteres simples (encapsuladas automaticamente como OTEL OutputMessage com função assistant) ou um wrapper OutputMessages com versão.
recordOutputTokens(number)	Registra o número de tokens de saída para o acompanhamento de telemetria.
start(Request, InferenceDetails, AgentDetails, UserDetails, SpanDetails)	Cria e inicia um novo escopo para rastreamento de inferência.

Métodos herdados

dispose()	Método de descarte herdado para compatibilidade
getSpanContext()	Obtém o contexto de intervalo para esse escopo. Isso pode ser usado para criar um ParentSpanRef para vinculação pai-filho explícita entre limites assíncronos.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Registra vários pares de chave/valor de atributo para acompanhamento de telemetria.
recordCancellation(string)	Registra um evento de cancelamento no intervalo. Define o status de intervalo como ERROR com o motivo do cancelamento e marca o tipo de erro como 'TaskCanceledException'.
recordError(Error)	Registra um erro que ocorreu durante a operação
setEndTime(TimeInput)	Define uma hora de término personalizada para o escopo. Quando definido, o descarte passará esse valor para span.end() , em vez de usar o tempo atual do relógio de parede. Isso é útil quando a hora de término real da operação é conhecida antes de o escopo ser descartado.
withActiveSpanAsync<T>(() => Promise<T>)	Torna esse intervalo ativo durante a execução de retorno de chamada assíncrona

Detalhes do método

recordFinishReasons(string[])

Registra os motivos de término para o acompanhamento de telemetria.

function recordFinishReasons(finishReasons: string[])

Parâmetros

finishReasons

string[]

Matriz de motivos de término

recordInputMessages(InputMessagesParam)

Registra as mensagens de entrada para o acompanhamento de telemetria. Aceita cadeias de caracteres simples (encapsuladas automaticamente como ChatMessage OTEL com função user) ou um wrapper InputMessages com versão.

function recordInputMessages(messages: InputMessagesParam)

Parâmetros

messages

InputMessagesParam

Matriz de cadeias de caracteres de mensagem de entrada ou um wrapper InputMessages

recordInputTokens(number)

Registra o número de tokens de entrada para o acompanhamento de telemetria.

function recordInputTokens(inputTokens: number)

Parâmetros

inputTokens

number

Número de tokens de entrada

recordOutputMessages(OutputMessagesParam)

Registra as mensagens de saída para o acompanhamento de telemetria. Aceita cadeias de caracteres simples (encapsuladas automaticamente como OTEL OutputMessage com função assistant) ou um wrapper OutputMessages com versão.

function recordOutputMessages(messages: OutputMessagesParam)

Parâmetros

messages

OutputMessagesParam

Matriz de cadeias de caracteres de mensagem de saída ou um wrapper OutputMessages

recordOutputTokens(number)

Registra o número de tokens de saída para o acompanhamento de telemetria.

function recordOutputTokens(outputTokens: number)

Parâmetros

outputTokens

number

Número de tokens de saída

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

Cria e inicia um novo escopo para rastreamento de inferência.

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

Parâmetros

request

Request

Conteúdo da solicitação (canal, conversationId, conteúdo, sessionId).

details

InferenceDetails

Os detalhes da chamada de inferência (modelo, provedor, tokens etc.).

agentDetails

AgentDetails

O agente executando a inferência. A ID do locatário é derivada de agentDetails.tenantId.

userDetails

UserDetails

Identidade opcional do chamador humano.

spanDetails

SpanDetails

Configuração de intervalo opcional (parentContext, startTime, endTime, spanLinks). Observação: spanKind é ignorado; InferenceScope sempre usa SpanKind.CLIENT.

Retornos

InferenceScope

Uma nova instância de InferenceScope

Detalhes do método herdado

dispose()

Método de descarte herdado para compatibilidade

function dispose()

Herdado deOpenTelemetryScope.dispose

getSpanContext()

Obtém o contexto de intervalo para esse escopo. Isso pode ser usado para criar um ParentSpanRef para vinculação pai-filho explícita entre limites assíncronos.

function getSpanContext(): SpanContext

Retornos

SpanContext

O SpanContext que contém traceId e spanId

Herdado deOpenTelemetryScope.getSpanContext

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

Registra vários pares de chave/valor de atributo para acompanhamento de telemetria.

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

Parâmetros

attributes

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

Coleção de pares chave/valor de atributo (matriz ou iterável de [chave, valor] ou mapa de objeto).

Herdado deOpenTelemetryScope.recordAttributes

recordCancellation(string)

Registra um evento de cancelamento no intervalo. Define o status de intervalo como ERROR com o motivo do cancelamento e marca o tipo de erro como 'TaskCanceledException'.

function recordCancellation(reason?: string)

Parâmetros

reason

string

Motivo de cancelamento opcional. O padrão é 'Tarefa cancelada'.

Herdado deOpenTelemetryScope.recordCancellation

recordError(Error)

Registra um erro que ocorreu durante a operação

function recordError(error: Error)

Parâmetros

error

Error

O erro que ocorreu

Herdado deOpenTelemetryScope.recordError

setEndTime(TimeInput)

Define uma hora de término personalizada para o escopo. Quando definido, o descarte passará esse valor para span.end() , em vez de usar o tempo atual do relógio de parede. Isso é útil quando a hora de término real da operação é conhecida antes de o escopo ser descartado.

function setEndTime(endTime: TimeInput)

Parâmetros

endTime

TimeInput

A hora de término como milissegundos desde época, data ou tupla hrtime.

Herdado deOpenTelemetryScope.setEndTime

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

Torna esse intervalo ativo durante a execução de retorno de chamada assíncrona

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

Parâmetros

callback

() => Promise<T>

Retornos

Promise<T>

Herdado deOpenTelemetryScope.withActiveSpanAsync