ApplyGuardrailScope class

Paquete:

@microsoft/agents-a365-observability

Proporciona el ámbito de seguimiento de OpenTelemetry para las operaciones de evaluación de barreras de seguridad.

Describe una evaluación de protección de seguridad. Pueden existir varios intervalos de guardianes en un único intervalo de operaciones si se encadenan varios guardianes.

Los intervalos de protección DEBEN ser elementos secundarios del intervalo de operaciones que protegen (por ejemplo, inferencia o intervalos de execute_tool).

Extends

OpenTelemetryScope

Métodos

recordContentOutput(string)	Registra el valor de contenido de salida para la evaluación de límites de protección (participación).
recordDecision(GuardrailDecisionType, string)	Registra una decisión actualizada sobre el intervalo de límites de protección. Úselo cuando se determine la decisión de límite de protección después de la creación del intervalo.
recordFinding(GuardrailFinding)	Registra un evento de búsqueda de seguridad en el intervalo actual. Se pueden registrar varios hallazgos por evaluación de barrera de protección.
start(GuardrailDetails, AgentDetails, Request, UserDetails, SpanDetails)	Crea e inicia un nuevo ámbito para el seguimiento de evaluación de límites de protección.

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(Iterable<[string, AttributeValue], any, any> | Record<string, AttributeValue> | null | undefined)	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.
[dispose]()	Elimina el ámbito y finaliza la recopilación de datos de telemetría.

Detalles del método

recordContentOutput(string)

Registra el valor de contenido de salida para la evaluación de límites de protección (participación).

function recordContentOutput(outputValue: string)

Parámetros

outputValue

string

Contenido de salida después del procesamiento de límites de protección.

recordDecision(GuardrailDecisionType, string)

Registra una decisión actualizada sobre el intervalo de límites de protección. Úselo cuando se determine la decisión de límite de protección después de la creación del intervalo.

function recordDecision(decisionType: GuardrailDecisionType, reason?: string)

Parámetros

decisionType

GuardrailDecisionType

Tipo de decisión tomado por el tutor.

reason

string

Explicación opcional legible de la decisión.

recordFinding(GuardrailFinding)

Registra un evento de búsqueda de seguridad en el intervalo actual. Se pueden registrar varios hallazgos por evaluación de barrera de protección.

function recordFinding(finding: GuardrailFinding)

Parámetros

finding

GuardrailFinding

Búsqueda de seguridad que se va a registrar.

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

Crea e inicia un nuevo ámbito para el seguimiento de evaluación de límites de protección.

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

Parámetros

details

GuardrailDetails

Detalles de la evaluación de límites de protección (destino, decisión, información de tutor, directiva).

agentDetails

AgentDetails

Información sobre el agente que se protege.

request

Request

Detalles de solicitud opcionales para el contexto de conversación.

userDetails

UserDetails

Detalles opcionales del usuario humano.

spanDetails

SpanDetails

Configuración de intervalo opcional (contexto primario, tiempo, tipo, vínculos de intervalo).

Devoluciones

ApplyGuardrailScope

Nueva instancia de ApplyGuardrailScope.

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(Iterable<[string, AttributeValue], any, any> | Record<string, AttributeValue> | null | undefined)

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

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

Parámetros

attributes

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

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

[dispose]()

Elimina el ámbito y finaliza la recopilación de datos de telemetría.

function [dispose]()

Se hereda deOpenTelemetryScope.[ dispose]