InvokeAgentScope class

Pacote:

@microsoft/agents-a365-observability

Fornece o escopo de rastreamento opentelemetry para operações de invocação de agente de IA.

Extends

OpenTelemetryScope

Métodos

recordInputMessages(InputMessagesParam)	Registra as mensagens de entrada para o acompanhamento de telemetria. Aceita uma única cadeia de caracteres, uma matriz de cadeias de caracteres (encapsuladas automaticamente como ChatMessage OTEL com função user) ou um wrapper InputMessages com versão.
recordOutputMessages(OutputMessagesParam)	Registra as mensagens de saída para o acompanhamento de telemetria. Aceita uma única cadeia de caracteres, uma matriz de cadeias de caracteres (encapsuladas automaticamente como OTEL OutputMessage com função assistant) ou um wrapper OutputMessages com versão.
recordResponse(string)	Registra informações de resposta para o acompanhamento de telemetria.
start(Request, InvokeAgentScopeDetails, AgentDetails, CallerDetails, SpanDetails)	Cria e inicia um novo escopo para o rastreamento de invocação de agente.

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

recordInputMessages(InputMessagesParam)

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

function recordInputMessages(messages: InputMessagesParam)

Parâmetros

messages

InputMessagesParam

Uma cadeia de caracteres, uma matriz de cadeias de caracteres ou um wrapper InputMessages

recordOutputMessages(OutputMessagesParam)

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

function recordOutputMessages(messages: OutputMessagesParam)

Parâmetros

messages

OutputMessagesParam

Uma cadeia de caracteres, uma matriz de cadeias de caracteres ou um wrapper OutputMessages

recordResponse(string)

Registra informações de resposta para o acompanhamento de telemetria.

function recordResponse(response: string)

Parâmetros

response

string

A resposta de invocação

start(Request, InvokeAgentScopeDetails, AgentDetails, CallerDetails, SpanDetails)

Cria e inicia um novo escopo para o rastreamento de invocação de agente.

static function start(request: Request, invokeScopeDetails: InvokeAgentScopeDetails, agentDetails: AgentDetails, callerDetails?: CallerDetails, spanDetails?: SpanDetails): InvokeAgentScope

Parâmetros

request

Request

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

invokeScopeDetails

InvokeAgentScopeDetails

Detalhes no nível do escopo

agentDetails

AgentDetails

A identidade do agente. A ID do locatário é derivada de agentDetails.tenantId (obrigatório).

callerDetails

CallerDetails

Informações opcionais do chamador. Dá suporte a três cenários:

• Somente chamador humano: { userDetails: { userId, userName, ... } }
• Somente o chamador do agente: { callerAgentDetails: { agentId, agentName, ... } }
• Ambos (A2A com humanos em cadeia): { userDetails: { ... }, callerAgentDetails: { ... } }

spanDetails

SpanDetails

Configuração de intervalo opcional (parentContext, startTime, endTime, spanKind, spanLinks).

Retornos

InvokeAgentScope

Uma nova instância invokeAgentScope.

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