Enum ToolChoiceMode 

pub enum ToolChoiceMode {
    None,
    Auto,
    Required,
}

Defines how the model should choose and use tools

This enum controls the model’s behavior regarding tool usage during response generation.

API Reference

Corresponds to the tool_choice parameter in the OpenAI Responses API.

Variants

None

Disable tool usage completely

The model will not use any tools and will generate responses based solely on its training data.

Auto

Automatically decide when to use tools

The model will automatically determine when tools are needed and which tools to use based on the query context.

Required

Require the use of tools

The model must use at least one of the provided tools in its response.

Trait Implementations

impl Clone for ToolChoiceMode

fn clone(&self) -> ToolChoiceMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolChoiceMode

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

Formats the value using the given formatter.

impl Display for ToolChoiceMode

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

Formats the value using the given formatter.

impl FromStr for ToolChoiceMode

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<ToolChoiceMode, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for ToolChoiceMode

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for ToolChoiceMode

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<ToolChoiceMode, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl StructuralPartialEq for ToolChoiceMode