InferenceScope class

Paquete:
@microsoft/agents-a365-observability

Proporciona el ámbito de seguimiento de OpenTelemetry para las operaciones de inferencia de IA generativas.

Extends
OpenTelemetryScope

Métodos

recordFinishReasons(string[])

Registra los motivos de finalización del seguimiento de telemetría.
recordInputMessages(InputMessagesParam)

Registra los mensajes de entrada para el seguimiento de telemetría. Acepta cadenas sin formato (ajustadas automáticamente como OTEL ChatMessage con rol user) o un contenedor InputMessages con versiones.
recordInputTokens(number)

Registra el número de tokens de entrada para el seguimiento de telemetría.
recordOutputMessages(OutputMessagesParam)

Registra los mensajes de salida para el seguimiento de telemetría. Acepta cadenas sin formato (ajustadas automáticamente como OutputMessage de OTEL con el rol assistant) o un contenedor OutputMessages con versiones.
recordOutputTokens(number)

Registra el número de tokens de salida para el seguimiento de telemetría.
start(Request, InferenceDetails, AgentDetails, UserDetails, SpanDetails)

Crea e inicia un nuevo ámbito para el seguimiento de inferencia.

Métodos heredados

dispose()

Método Dispose heredado para la compatibilidad
getSpanContext()

Obtiene el contexto de intervalo para este ámbito. Esto se puede usar para crear un elemento ParentSpanRef para la vinculación explícita de elementos primarios y secundarios a través de límites asincrónicos.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Registra varios pares clave-valor de atributo para el seguimiento de telemetría.
recordCancellation(string)

Registra un evento de cancelación en el intervalo. Establece el estado del intervalo en ERROR con el motivo de cancelación y marca el tipo de error como "TaskCanceledException".
recordError(Error)

Registra un error que se produjo durante la operación
setEndTime(TimeInput)

Establece una hora de finalización personalizada para el ámbito. Cuando se establece, dispose pasará este valor a span.end() en lugar de usar la hora actual del reloj. Esto resulta útil cuando se conoce la hora de finalización real de la operación antes de eliminar el ámbito.
withActiveSpanAsync<T>(() => Promise<T>)

Hace que este intervalo se active durante la ejecución de la devolución de llamada asincrónica.

Detalles del método

recordFinishReasons(string[])

Registra los motivos de finalización del seguimiento de telemetría.

function recordFinishReasons(finishReasons: string[])

Parámetros

finishReasons

string[]

Matriz de motivos de finalización

recordInputMessages(InputMessagesParam)

Registra los mensajes de entrada para el seguimiento de telemetría. Acepta cadenas sin formato (ajustadas automáticamente como OTEL ChatMessage con rol user) o un contenedor InputMessages con versiones.

function recordInputMessages(messages: InputMessagesParam)

Parámetros

messages
InputMessagesParam

Matriz de cadenas de mensaje de entrada o un contenedor InputMessages

recordInputTokens(number)

Registra el número de tokens de entrada para el seguimiento de telemetría.

function recordInputTokens(inputTokens: number)

Parámetros

inputTokens

number

Número de tokens de entrada

recordOutputMessages(OutputMessagesParam)

Registra los mensajes de salida para el seguimiento de telemetría. Acepta cadenas sin formato (ajustadas automáticamente como OutputMessage de OTEL con el rol assistant) o un contenedor OutputMessages con versiones.

function recordOutputMessages(messages: OutputMessagesParam)

Parámetros

messages
OutputMessagesParam

Matriz de cadenas de mensaje de salida o un contenedor OutputMessages

recordOutputTokens(number)

Registra el número de tokens de salida para el seguimiento de telemetría.

function recordOutputTokens(outputTokens: number)

Parámetros

outputTokens

number

Número de tokens de salida

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

Crea e inicia un nuevo ámbito para el seguimiento de inferencia.

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

Parámetros

request
Request

Carga de solicitud (canal, conversationId, contenido, sessionId).

details
InferenceDetails

Los detalles de la llamada de inferencia (modelo, proveedor, tokens, etc.).

agentDetails
AgentDetails

Agente que realiza la inferencia. El identificador de inquilino se deriva de agentDetails.tenantId.

userDetails
UserDetails

Identidad opcional del autor de la llamada humana.

spanDetails
SpanDetails

Configuración de intervalo opcional (parentContext, startTime, endTime, spanLinks). Nota: spanKind se omite; InferenceScope siempre usa SpanKind.CLIENT.

Devoluciones

InferenceScope

Nueva instancia de InferenceScope

Detalles de los métodos heredados

dispose()

Método Dispose heredado para la compatibilidad

function dispose()

Heredado deOpenTelemetryScope.dispose

getSpanContext()

Obtiene el contexto de intervalo para este ámbito. Esto se puede usar para crear un elemento ParentSpanRef para la vinculación explícita de elementos primarios y secundarios a través de límites asincrónicos.

function getSpanContext(): SpanContext

Devoluciones

SpanContext

SpanContext que contiene traceId y spanId

Heredado deOpenTelemetryScope.getSpanContext

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

Registra varios pares clave-valor de atributo para el seguimiento de telemetría.

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

Parámetros

attributes

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

Colección de pares clave-valor de atributo (matriz o iterable de [clave, valor] o mapa de objetos).

Heredado deOpenTelemetryScope.recordAttributes

recordCancellation(string)

Registra un evento de cancelación en el intervalo. Establece el estado del intervalo en ERROR con el motivo de cancelación y marca el tipo de error como "TaskCanceledException".

function recordCancellation(reason?: string)

Parámetros

reason

string

Motivo de cancelación opcional. El valor predeterminado es "Se canceló la tarea".

Heredado deOpenTelemetryScope.recordCancellation

recordError(Error)

Registra un error que se produjo durante la operación

function recordError(error: Error)

Parámetros

error

Error

El error que ocurrió

Heredado deOpenTelemetryScope.recordError

setEndTime(TimeInput)

Establece una hora de finalización personalizada para el ámbito. Cuando se establece, dispose pasará este valor a span.end() en lugar de usar la hora actual del reloj. Esto resulta útil cuando se conoce la hora de finalización real de la operación antes de eliminar el ámbito.

function setEndTime(endTime: TimeInput)

Parámetros

endTime

TimeInput

Hora de finalización como milisegundos desde la época, una fecha o una tupla HrTime.

Heredado deOpenTelemetryScope.setEndTime

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

Hace que este intervalo se active durante la ejecución de la devolución de llamada asincrónica.

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

Parámetros

callback

() => Promise<T>

Devoluciones

Promise<T>

Heredado deOpenTelemetryScope.withActiveSpanAsync