OutputScope class

Pacote:
@microsoft/agents-a365-observability

Fornece o escopo de rastreamento opentelemetry para rastreamento de mensagens de saída com vinculação de intervalo pai.

Extends
OpenTelemetryScope

Métodos

recordOutputMessages(ResponseMessagesParam)

Registra as mensagens de saída para o acompanhamento de telemetria. Substitui todas as mensagens de saída registradas anteriormente no intervalo. Aceita uma única cadeia de caracteres, uma matriz de cadeias de caracteres (encapsuladas automaticamente como OTEL OutputMessage), um wrapper OutputMessages com versão ou um ditado bruto (tratado como um resultado de chamada de ferramenta por especificação OTEL, serializado diretamente).
start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)

Cria e inicia um novo escopo para rastreamento de mensagem de saída.

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

recordOutputMessages(ResponseMessagesParam)

Registra as mensagens de saída para o acompanhamento de telemetria. Substitui todas as mensagens de saída registradas anteriormente no intervalo. Aceita uma única cadeia de caracteres, uma matriz de cadeias de caracteres (encapsuladas automaticamente como OTEL OutputMessage), um wrapper OutputMessages com versão ou um ditado bruto (tratado como um resultado de chamada de ferramenta por especificação OTEL, serializado diretamente).

function recordOutputMessages(messages: ResponseMessagesParam)

Parâmetros

messages
ResponseMessagesParam

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

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

Cria e inicia um novo escopo para rastreamento de mensagem de saída.

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

Parâmetros

request
Request

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

response
OutputResponse

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

agentDetails
AgentDetails

O agente que produz a saída. A ID do locatário é derivada de agentDetails.tenantId.

userDetails
UserDetails

Detalhes opcionais de identidade do chamador humano.

spanDetails
SpanDetails

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

Retornos

OutputScope

Uma nova instância de OutputScope.

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