Enum OrchestrationTrace

#[non_exhaustive]
pub enum OrchestrationTrace {
    InvocationInput(InvocationInput),
    ModelInvocationInput(ModelInvocationInput),
    ModelInvocationOutput(OrchestrationModelInvocationOutput),
    Observation(Observation),
    Rationale(Rationale),
    #[non_exhaustive]
    Unknown,
}

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

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.

InvocationInput(InvocationInput)

Contains information pertaining to the action group or knowledge base that is being invoked.

ModelInvocationInput(ModelInvocationInput)

The input for the orchestration step.

• The type is ORCHESTRATION.

• The text contains the prompt.

• The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

ModelInvocationOutput(OrchestrationModelInvocationOutput)

Contains information pertaining to the output from the foundation model that is being invoked.

Observation(Observation)

Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

Rationale(Rationale)

Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

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 OrchestrationTrace

pub fn as_invocation_input(&self) -> Result<&InvocationInput, &Self>

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

pub fn is_invocation_input(&self) -> bool

Returns true if this is a InvocationInput.

pub fn as_model_invocation_input(&self) -> Result<&ModelInvocationInput, &Self>

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

pub fn is_model_invocation_input(&self) -> bool

Returns true if this is a ModelInvocationInput.

pub fn as_model_invocation_output( &self, ) -> Result<&OrchestrationModelInvocationOutput, &Self>

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

pub fn is_model_invocation_output(&self) -> bool

Returns true if this is a ModelInvocationOutput.

pub fn as_observation(&self) -> Result<&Observation, &Self>

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

pub fn is_observation(&self) -> bool

Returns true if this is a Observation.

pub fn as_rationale(&self) -> Result<&Rationale, &Self>

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

pub fn is_rationale(&self) -> bool

Returns true if this is a Rationale.

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations

impl Clone for OrchestrationTrace

fn clone(&self) -> OrchestrationTrace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrchestrationTrace

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

Formats the value using the given formatter.

impl PartialEq for OrchestrationTrace

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