InferenceScope class

Pacote:

@microsoft/agents-a365-observability

Fornece o âmbito de rastreamento OpenTelemetry para operações de inferência de IA generativa.

Extends

OpenTelemetryScope

Métodos

recordFinishReasons(string[])	Regista as razões de acabamento para o rastreio de telemetria.
recordInputMessages(InputMessagesParam)	Grava as mensagens de entrada para rastreio de telemetria. Aceita strings simples (auto-encapsuladas como OTEL ChatMessage com função user) ou um wrapper InputMessages versionado.
recordInputTokens(number)	Regista o número de tokens de entrada para rastreamento de telemetria.
recordOutputMessages(OutputMessagesParam)	Grava as mensagens de saída para rastreamento de telemetria. Aceita strings simples (auto-encapsuladas como OTEL OutputMessage com papel assistant) ou um wrapper OutputMessages versionado.
recordOutputTokens(number)	Regista o número de tokens de saída para rastreamento de telemetria.
start(Request, InferenceDetails, AgentDetails, UserDetails, SpanDetails)	Cria e inicia um novo âmbito para o rastreio de inferência.

Métodos Herdados

dispose()	Método de descarte legado para compatibilidade
getSpanContext()	Obtém o contexto de extensão para este telescópio. Isto pode ser usado para criar um ParentSpanRef para ligações explícitas pai-filho através de fronteiras assíncronas.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Grava múltiplos pares chave/valor de atributos para rastreamento de telemetria.
recordCancellation(string)	Regista um evento de cancelamento durante a travessia. Define o estado do span para ERRO com a razão do cancelamento e marca o tipo de erro como 'TaskCanceledException'.
recordError(Error)	Regista um erro ocorrido durante a operação
setEndTime(TimeInput)	Define uma hora de fim personalizada para o telescópio. Quando definido, descarte transmite este valor para span.end() em vez de usar o tempo atual do relógio de parede. Isto é útil quando a hora real de fim da operação é conhecida antes do escopo.
withActiveSpanAsync<T>(() => Promise<T>)	Torna este intervalo ativo durante toda a execução do callback assíncrono

Detalhes de Método

recordFinishReasons(string[])

Regista as razões de acabamento para o rastreio de telemetria.

function recordFinishReasons(finishReasons: string[])

Parâmetros

finishReasons

string[]

Variedade de razões de acabamento

recordInputMessages(InputMessagesParam)

Grava as mensagens de entrada para rastreio de telemetria. Aceita strings simples (auto-encapsuladas como OTEL ChatMessage com função user) ou um wrapper InputMessages versionado.

function recordInputMessages(messages: InputMessagesParam)

Parâmetros

messages

InputMessagesParam

Array de cadeias de mensagens de entrada ou um wrapper InputMessages

recordInputTokens(number)

Regista o número de tokens de entrada para rastreamento de telemetria.

function recordInputTokens(inputTokens: number)

Parâmetros

inputTokens

number

Número de tokens de entrada

recordOutputMessages(OutputMessagesParam)

Grava as mensagens de saída para rastreamento de telemetria. Aceita strings simples (auto-encapsuladas como OTEL OutputMessage com papel assistant) ou um wrapper OutputMessages versionado.

function recordOutputMessages(messages: OutputMessagesParam)

Parâmetros

messages

OutputMessagesParam

Array de cadeias de mensagens de saída ou um wrapper OutputMessages

recordOutputTokens(number)

Regista o número de tokens de saída para rastreamento 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 âmbito para o rastreio de inferência.

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

Parâmetros

request

Request

Solicita carga útil (channel, conversationId, content, sessionId).

details

InferenceDetails

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

agentDetails

AgentDetails

O agente que faz a inferência. O ID do inquilino é derivado de agentDetails.tenantId.

userDetails

UserDetails

Identificação opcional de chamador humano.

spanDetails

SpanDetails

Configuração opcional do span (parentContext, startTime, endTime, spanLinks). Nota: spanKind é ignorado; InferenceScope utiliza SpanKind.CLIENTsempre .

Devoluções

InferenceScope

Uma nova instância InferenceScope

Detalhes do Método Herdado

dispose()

Método de descarte legado para compatibilidade

function dispose()

Herdado doOpenTelemetryScope.dispose

getSpanContext()

Obtém o contexto de extensão para este telescópio. Isto pode ser usado para criar um ParentSpanRef para ligações explícitas pai-filho através de fronteiras assíncronas.

function getSpanContext(): SpanContext

Devoluções

SpanContext

O SpanContext contendo traceId e spanId

Herdado deOpenTelemetryScope.getSpanContext

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

Grava múltiplos pares chave/valor de atributos para rastreamento 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 atributos (array ou iterável de [chave, valor] ou mapa de objetos).

Herdado deOpenTelemetryScope.recordAttributes

recordCancellation(string)

Regista um evento de cancelamento durante a travessia. Define o estado do span para ERRO com a razão do cancelamento e marca o tipo de erro como 'TaskCanceledException'.

function recordCancellation(reason?: string)

Parâmetros

reason

string

Motivo opcional de cancelamento. Por defeito, 'Tarefa foi cancelada'.

Herdado doOpenTelemetryScope.recordCancelamento

recordError(Error)

Regista um erro ocorrido durante a operação

function recordError(error: Error)

Parâmetros

error

Error

O erro que ocorreu

Herdado doOpenTelemetryScope.recordError

setEndTime(TimeInput)

Define uma hora de fim personalizada para o telescópio. Quando definido, descarte transmite este valor para span.end() em vez de usar o tempo atual do relógio de parede. Isto é útil quando a hora real de fim da operação é conhecida antes do escopo.

function setEndTime(endTime: TimeInput)

Parâmetros

endTime

TimeInput

O tempo de fim em milissegundos desde a época, uma Data ou uma tupla HrTime.

Herdado deOpenTelemetryScope.setEndTime

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

Torna este intervalo ativo durante toda a execução do callback assíncrono

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

Parâmetros

callback

() => Promise<T>

Devoluções

Promise<T>

Herdado doOpenTelemetryScope.withActiveSpanAsync