OutputScope class

Pacote:

@microsoft/agents-a365-observability

Fornece o âmbito de rastreamento OpenTelemetry para rastreamento de mensagens de saída com ligação de span pai.

Extends

OpenTelemetryScope

Métodos

recordOutputMessages(ResponseMessagesParam)	Grava as mensagens de saída para rastreamento de telemetria. Sobrescrive quaisquer mensagens de saída previamente gravadas no span. Aceita uma única cadeia, um array de cadeias (auto-encapsulado como OTEL OutputMessage), um wrapper OutputMessages versionado, ou um dictado bruto (tratado como resultado de chamada de ferramenta segundo a especificação OTEL, serializado diretamente).
start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)	Cria e inicia um novo âmbito para rastreio de mensagens de saída.

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

recordOutputMessages(ResponseMessagesParam)

Grava as mensagens de saída para rastreamento de telemetria. Sobrescrive quaisquer mensagens de saída previamente gravadas no span. Aceita uma única cadeia, um array de cadeias (auto-encapsulado como OTEL OutputMessage), um wrapper OutputMessages versionado, ou um dictado bruto (tratado como resultado de chamada de ferramenta segundo a especificação OTEL, serializado diretamente).

function recordOutputMessages(messages: ResponseMessagesParam)

Parâmetros

messages

ResponseMessagesParam

Uma string, array de strings, um wrapper OutputMessages ou um dict.

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

Cria e inicia um novo âmbito para rastreio de mensagens de saída.

static function start(request: Request, response: OutputResponse, agentDetails: AgentDetails, userDetails?: UserDetails, spanDetails?: SpanDetails): OutputScope

Parâmetros

request

Request

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

response

OutputResponse

A resposta contém mensagens de saída iniciais.

agentDetails

AgentDetails

O agente que produz a saída. O ID do inquilino é derivado de agentDetails.tenantId.

userDetails

UserDetails

Detalhes opcionais da identidade humana do chamador.

spanDetails

SpanDetails

Configuração opcional do span (parentContext, startTime, endTime, spanLinks).

Devoluções

OutputScope

Uma nova instância OutputScope.

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