ApplyGuardrailScope class

Fornisce l'ambito di traccia OpenTelemetry per le operazioni di valutazione della protezione della protezione.

Descrive una valutazione del tutore della sicurezza. Più intervalli di sorveglianza POSSONO esistere in un'unica operazione se più guardiani sono concatenati.

Gli intervalli di sorveglianza DOVREBBERO essere figli dell'intervallo di operazioni che proteggono (ad esempio, inferenza o execute_tool intervalli).

Metodi

recordContentOutput(string)	Registra il valore del contenuto di output per la valutazione guardrail (consenso esplicito).
recordDecision(GuardrailDecisionType, string)	Registra una decisione aggiornata sull'intervallo di protezione. Utilizzare questa opzione quando la decisione di protezione viene determinata dopo la creazione dell'intervallo.
recordFinding(GuardrailFinding)	Registra un evento di ricerca della sicurezza nell'intervallo corrente. È possibile registrare più risultati per ogni valutazione del guardrail.
start(GuardrailDetails, AgentDetails, Request, UserDetails, SpanDetails)	Crea e avvia un nuovo ambito per la traccia di valutazione della protezione.

Metodi ereditati

dispose()	Metodo dispose legacy per la compatibilità
getSpanContext()	Ottiene il contesto dell'intervallo per questo ambito. Può essere usato per creare un elemento ParentSpanRef per il collegamento esplicito padre-figlio attraverso i limiti asincroni.
recordAttributes(Iterable<[string, AttributeValue], any, any> \| Record<string, AttributeValue> \| null \| undefined)	Registra più coppie chiave/valore di attributo per il rilevamento dei dati di telemetria.
recordCancellation(string)	Registra un evento di annullamento nell'intervallo. Imposta lo stato dell'intervallo su ERROR con il motivo dell'annullamento e contrassegna il tipo di errore come 'TaskCanceledException'.
recordError(Error)	Registra un errore che si è verificato durante l'operazione
setEndTime(TimeInput)	Imposta un'ora di fine personalizzata per l'ambito. Se impostato, dispose passerà questo valore a `span.end()` invece di usare l'ora corrente. Ciò è utile quando l'ora di fine effettiva dell'operazione è nota prima dell'eliminazione dell'ambito.
withActiveSpanAsync<T>(() => Promise<T>)	Rende attivo questo intervallo per la durata dell'esecuzione del callback asincrono
[dispose]()	Elimina l'ambito e finalizza la raccolta dei dati di telemetria

recordContentOutput(string)

Registra il valore del contenuto di output per la valutazione guardrail (consenso esplicito).

function recordContentOutput(outputValue: string)

Parametri

outputValue: string

Contenuto di output dopo l'elaborazione della protezione.

recordDecision(GuardrailDecisionType, string)

Registra una decisione aggiornata sull'intervallo di protezione. Utilizzare questa opzione quando la decisione di protezione viene determinata dopo la creazione dell'intervallo.

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

Parametri

decisionType: GuardrailDecisionType

Tipo di decisione presa dal guardiano.

reason: string

Spiegazione leggibile facoltativa per la decisione.

recordFinding(GuardrailFinding)

Registra un evento di ricerca della sicurezza nell'intervallo corrente. È possibile registrare più risultati per ogni valutazione del guardrail.

function recordFinding(finding: GuardrailFinding)

Parametri

finding: GuardrailFinding

Ricerca di sicurezza da registrare.

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

Crea e avvia un nuovo ambito per la traccia di valutazione della protezione.

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

Parametri

details: GuardrailDetails

Dettagli della valutazione del guardrail (target, decision, guardian info, policy).

agentDetails: AgentDetails

Informazioni sull'agente sorvegliato.

request: Request

Dettagli della richiesta facoltativi per il contesto della conversazione.

userDetails: UserDetails

Dettagli facoltativi dell'utente umano.

spanDetails: SpanDetails

Configurazione dell'intervallo facoltativo (contesto padre, intervallo, tipo, collegamenti span).

Valori restituiti

ApplyGuardrailScope

Nuova istanza applyGuardrailScope.

dispose()

Metodo dispose legacy per la compatibilità

function dispose()

Ereditato daOpenTelemetryScope.dispose

getSpanContext()

Ottiene il contesto dell'intervallo per questo ambito. Può essere usato per creare un elemento ParentSpanRef per il collegamento esplicito padre-figlio attraverso i limiti asincroni.

function getSpanContext(): SpanContext

Valori restituiti

SpanContext

SpanContext contenente traceId e spanId

Ereditato daOpenTelemetryScope.getSpanContext

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

Registra più coppie chiave/valore di attributo per il rilevamento dei dati di telemetria.

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

Parametri

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

Raccolta di coppie chiave/valore dell'attributo (matrice o iterabile di [chiave, valore] o mappa oggetti).

Ereditato daOpenTelemetryScope.recordAttributes

recordCancellation(string)

Registra un evento di annullamento nell'intervallo. Imposta lo stato dell'intervallo su ERROR con il motivo dell'annullamento e contrassegna il tipo di errore come 'TaskCanceledException'.

function recordCancellation(reason?: string)

Parametri

reason: string

Motivo di annullamento facoltativo. L'impostazione predefinita è 'Task was cancelled'.

Ereditato daOpenTelemetryScope.recordCancellation

recordError(Error)

Registra un errore che si è verificato durante l'operazione

function recordError(error: Error)

Parametri

error: Error

L'errore che si è verificato

Ereditato daOpenTelemetryScope.recordError

setEndTime(TimeInput)

Imposta un'ora di fine personalizzata per l'ambito. Se impostato, dispose passerà questo valore a span.end() invece di usare l'ora corrente. Ciò è utile quando l'ora di fine effettiva dell'operazione è nota prima dell'eliminazione dell'ambito.

function setEndTime(endTime: TimeInput)

Parametri

endTime: TimeInput

Ora di fine come millisecondi dall'epoca, da una tupla Date o HrTime.

Ereditato daOpenTelemetryScope.setEndTime

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

Rende attivo questo intervallo per la durata dell'esecuzione del callback asincrono

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

Parametri

callback: () => Promise<T>

Valori restituiti

Promise<T>

Ereditato daOpenTelemetryScope.withActiveSpanAsync

[dispose]()

Elimina l'ambito e finalizza la raccolta dei dati di telemetria

function [dispose]()

Ereditato daOpenTelemetryScope.[ dispose]

ApplyGuardrailScope class

Metodi

Metodi ereditati

Dettagli metodo

recordContentOutput(string)

Parametri

recordDecision(GuardrailDecisionType, string)

Parametri

recordFinding(GuardrailFinding)

Parametri

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

Parametri

Valori restituiti

Dettagli dei metodi ereditati

dispose()

getSpanContext()

Valori restituiti

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

Parametri

recordCancellation(string)

Parametri

recordError(Error)

Parametri

setEndTime(TimeInput)

Parametri

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

Parametri

Valori restituiti

[dispose]()