InvokeAgentScope class

Proporciona el ámbito de seguimiento de OpenTelemetry para las operaciones de invocación del agente de IA.

Métodos

recordInputMessages(InputMessagesParam)	Registra los mensajes de entrada para el seguimiento de telemetría. Acepta una sola cadena, una matriz de cadenas (ajustada automáticamente como OTEL ChatMessage con el rol `user`) o un contenedor InputMessages con versiones.
recordOutputMessages(OutputMessagesParam)	Registra los mensajes de salida para el seguimiento de telemetría. Acepta una sola cadena, una matriz de cadenas (ajustada automáticamente como OutputMessage de OTEL con el rol `assistant`) o un contenedor OutputMessages con versiones.
recordResponse(string)	Registra información de respuesta para el seguimiento de telemetría.
start(Request, InvokeAgentScopeDetails, AgentDetails, CallerDetails, SpanDetails)	Crea e inicia un nuevo ámbito para el seguimiento de invocaciones del agente.

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.

recordInputMessages(InputMessagesParam)

Registra los mensajes de entrada para el seguimiento de telemetría. Acepta una sola cadena, una matriz de cadenas (ajustada automáticamente como OTEL ChatMessage con el rol user) o un contenedor InputMessages con versiones.

function recordInputMessages(messages: InputMessagesParam)

Parámetros

messages: InputMessagesParam

Cadena, matriz de cadenas o contenedor InputMessages

recordOutputMessages(OutputMessagesParam)

Registra los mensajes de salida para el seguimiento de telemetría. Acepta una sola cadena, una matriz de cadenas (ajustada automáticamente como OutputMessage de OTEL con el rol assistant) o un contenedor OutputMessages con versiones.

function recordOutputMessages(messages: OutputMessagesParam)

Parámetros

messages: OutputMessagesParam

Cadena, matriz de cadenas o contenedor OutputMessages

recordResponse(string)

Registra información de respuesta para el seguimiento de telemetría.

function recordResponse(response: string)

Parámetros

response: string

Respuesta de invocación

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

Crea e inicia un nuevo ámbito para el seguimiento de invocaciones del agente.

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

Parámetros

request: Request

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

invokeScopeDetails: InvokeAgentScopeDetails

Detalles de nivel de ámbito

agentDetails: AgentDetails

Identidad del agente. El identificador de inquilino se deriva de agentDetails.tenantId (obligatorio).

callerDetails: CallerDetails

Información opcional del autor de la llamada. Admite tres escenarios:

Solo llamador humano: { userDetails: { userId, userName, ... } }
Solo llamador del agente: { callerAgentDetails: { agentId, agentName, ... } }
Ambos (A2A con humanos en cadena): { userDetails: { ... }, callerAgentDetails: { ... } }

spanDetails: SpanDetails

Configuración de intervalo opcional (parentContext, startTime, endTime, spanKind, spanLinks).

Devoluciones

InvokeAgentScope

Nueva instancia invokeAgentScope.

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

InvokeAgentScope class

Métodos

Métodos heredados

Detalles del método

recordInputMessages(InputMessagesParam)

Parámetros

recordOutputMessages(OutputMessagesParam)

Parámetros

recordResponse(string)

Parámetros

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

Parámetros

Devoluciones

Detalles de los métodos heredados

dispose()

getSpanContext()

Devoluciones

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

Parámetros

recordCancellation(string)

Parámetros

recordError(Error)

Parámetros

setEndTime(TimeInput)

Parámetros

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

Parámetros

Devoluciones