ExecuteToolScope class

Pacote:

@microsoft/agents-a365-observability

Fornece o âmbito de rastreamento OpenTelemetry para operações de execução de ferramentas de IA.

Extends

OpenTelemetryScope

Métodos

recordResponse(string | Record<string, unknown>)	Regista informações de resposta para rastreamento de telemetria.
start(Request, ToolCallDetails, AgentDetails, UserDetails, SpanDetails)	Cria e inicia um novo âmbito para rastreamento de execução de ferramentas.

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

recordResponse(string | Record<string, unknown>)

Regista informações de resposta para rastreamento de telemetria.

function recordResponse(response: string | Record<string, unknown>)

Parâmetros

response

string | Record<string, unknown>

A resposta de execução da ferramenta. Os objetos são serializados automaticamente para JSON.

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

Cria e inicia um novo âmbito para rastreamento de execução de ferramentas.

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

Parâmetros

request

Request

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

details

ToolCallDetails

Os detalhes da chamada da ferramenta (nome, tipo, args, call id, etc.).

agentDetails

AgentDetails

O agente que executa a ferramenta. O ID do inquilino é derivado de agentDetails.tenantId.

userDetails

UserDetails

Identificação opcional de chamador humano.

spanDetails

SpanDetails

Configuração opcional de span (parentContext, startTime, endTime, spanLinks, spanKind). Por defeito, SpanKind.INTERNAL.

Devoluções

ExecuteToolScope

Uma nova instância do ExecuteToolScope.

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