Enum Trace

#[non_exhaustive]
pub enum Trace {
    CustomOrchestrationTrace(CustomOrchestrationTrace),
    FailureTrace(FailureTrace),
    GuardrailTrace(GuardrailTrace),
    OrchestrationTrace(OrchestrationTrace),
    PostProcessingTrace(PostProcessingTrace),
    PreProcessingTrace(PreProcessingTrace),
    RoutingClassifierTrace(RoutingClassifierTrace),
    #[non_exhaustive]
    Unknown,
}

Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

CustomOrchestrationTrace(CustomOrchestrationTrace)

Details about the custom orchestration step in which the agent determines the order in which actions are executed.

FailureTrace(FailureTrace)

Contains information about the failure of the interaction.

GuardrailTrace(GuardrailTrace)

The trace details for a trace defined in the Guardrail filter.

OrchestrationTrace(OrchestrationTrace)

Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

PostProcessingTrace(PostProcessingTrace)

Details about the post-processing step, in which the agent shapes the response..

PreProcessingTrace(PreProcessingTrace)

Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

RoutingClassifierTrace(RoutingClassifierTrace)

A routing classifier's trace.

Unknown

The Unknown variant represents cases where new union variant was received. Consider upgrading the SDK to the latest available version. An unknown enum variant

Note: If you encounter this error, consider upgrading your SDK to the latest version. The Unknown variant represents cases where the server sent a value that wasn’t recognized by the client. This can happen when the server adds new functionality, but the client has not been updated. To investigate this, consider turning on debug logging to print the raw HTTP response.

Implementations

impl Trace

pub fn as_custom_orchestration_trace( &self, ) -> Result<&CustomOrchestrationTrace, &Self>

Tries to convert the enum instance into CustomOrchestrationTrace, extracting the inner CustomOrchestrationTrace. Returns Err(&Self) if it can’t be converted.

pub fn is_custom_orchestration_trace(&self) -> bool

Returns true if this is a CustomOrchestrationTrace.

pub fn as_failure_trace(&self) -> Result<&FailureTrace, &Self>

Tries to convert the enum instance into FailureTrace, extracting the inner FailureTrace. Returns Err(&Self) if it can’t be converted.

pub fn is_failure_trace(&self) -> bool

Returns true if this is a FailureTrace.

pub fn as_guardrail_trace(&self) -> Result<&GuardrailTrace, &Self>

Tries to convert the enum instance into GuardrailTrace, extracting the inner GuardrailTrace. Returns Err(&Self) if it can’t be converted.

pub fn is_guardrail_trace(&self) -> bool

Returns true if this is a GuardrailTrace.

pub fn as_orchestration_trace(&self) -> Result<&OrchestrationTrace, &Self>

Tries to convert the enum instance into OrchestrationTrace, extracting the inner OrchestrationTrace. Returns Err(&Self) if it can’t be converted.

pub fn is_orchestration_trace(&self) -> bool

Returns true if this is a OrchestrationTrace.

pub fn as_post_processing_trace(&self) -> Result<&PostProcessingTrace, &Self>

Tries to convert the enum instance into PostProcessingTrace, extracting the inner PostProcessingTrace. Returns Err(&Self) if it can’t be converted.

pub fn is_post_processing_trace(&self) -> bool

Returns true if this is a PostProcessingTrace.

pub fn as_pre_processing_trace(&self) -> Result<&PreProcessingTrace, &Self>

Tries to convert the enum instance into PreProcessingTrace, extracting the inner PreProcessingTrace. Returns Err(&Self) if it can’t be converted.

pub fn is_pre_processing_trace(&self) -> bool

Returns true if this is a PreProcessingTrace.

pub fn as_routing_classifier_trace( &self, ) -> Result<&RoutingClassifierTrace, &Self>

Tries to convert the enum instance into RoutingClassifierTrace, extracting the inner RoutingClassifierTrace. Returns Err(&Self) if it can’t be converted.

pub fn is_routing_classifier_trace(&self) -> bool

Returns true if this is a RoutingClassifierTrace.

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations

impl Clone for Trace

fn clone(&self) -> Trace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Trace

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

Formats the value using the given formatter.

impl PartialEq for Trace

fn eq(&self, other: &Trace) -> 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 Trace