Struct GuardrailTrace

#[non_exhaustive]
pub struct GuardrailTrace {
    pub action: Option<GuardrailAction>,
    pub trace_id: Option<String>,
    pub input_assessments: Option<Vec<GuardrailAssessment>>,
    pub output_assessments: Option<Vec<GuardrailAssessment>>,
    pub metadata: Option<Metadata>,
}

The trace details used in the Guardrail.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

action: Option<GuardrailAction>

The trace action details used with the Guardrail.

trace_id: Option<String>

The details of the trace Id used in the Guardrail Trace.

input_assessments: Option<Vec<GuardrailAssessment>>

The details of the input assessments used in the Guardrail Trace.

output_assessments: Option<Vec<GuardrailAssessment>>

The details of the output assessments used in the Guardrail Trace.

metadata: Option<Metadata>

Contains information about the Guardrail output.

Implementations

impl GuardrailTrace

pub fn action(&self) -> Option<&GuardrailAction>

The trace action details used with the Guardrail.

pub fn trace_id(&self) -> Option<&str>

The details of the trace Id used in the Guardrail Trace.

pub fn input_assessments(&self) -> &[GuardrailAssessment]

The details of the input assessments used in the Guardrail Trace.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .input_assessments.is_none().

pub fn output_assessments(&self) -> &[GuardrailAssessment]

The details of the output assessments used in the Guardrail Trace.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .output_assessments.is_none().

pub fn metadata(&self) -> Option<&Metadata>

Contains information about the Guardrail output.

impl GuardrailTrace

pub fn builder() -> GuardrailTraceBuilder

Creates a new builder-style object to manufacture GuardrailTrace.

Trait Implementations

impl Clone for GuardrailTrace

fn clone(&self) -> GuardrailTrace

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GuardrailTrace

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GuardrailTrace

fn eq(&self, other: &GuardrailTrace) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GuardrailTrace