Enum ToolChoice

#[non_exhaustive]
pub enum ToolChoice {
    Any(AnyToolChoice),
    Auto(AutoToolChoice),
    Tool(SpecificToolChoice),
    #[non_exhaustive]
    Unknown,
}

Determines which tools the model should request in a call to Converse or ConverseStream. ToolChoice is only supported by Anthropic Claude 3 models and by Mistral AI Mistral Large.

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.

Any(AnyToolChoice)

The model must request at least one tool (no text is generated).

Auto(AutoToolChoice)

(Default). The Model automatically decides if a tool should be called or whether to generate text instead.

Tool(SpecificToolChoice)

The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

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 ToolChoice

pub fn as_any(&self) -> Result<&AnyToolChoice, &Self>

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

pub fn is_any(&self) -> bool

Returns true if this is a Any.

pub fn as_auto(&self) -> Result<&AutoToolChoice, &Self>

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

pub fn is_auto(&self) -> bool

Returns true if this is a Auto.

pub fn as_tool(&self) -> Result<&SpecificToolChoice, &Self>

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

pub fn is_tool(&self) -> bool

Returns true if this is a Tool.

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations

impl Clone for ToolChoice

fn clone(&self) -> ToolChoice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolChoice

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

Formats the value using the given formatter.

impl PartialEq for ToolChoice

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

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

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 ToolChoice