Enum ToolChoice 

pub enum ToolChoice {
    Simple(ToolChoiceMode),
    Function(NamedFunctionChoice),
}

Controls how the model selects tools

This enum allows you to specify whether the model should automatically choose tools, be forced to use specific tools, or be prevented from using tools altogether.

API Reference

Corresponds to the tool_choice parameter in the OpenAI Responses API: https://platform.openai.com/docs/api-reference/responses/create

Examples

use openai_tools::responses::request::{ToolChoice, ToolChoiceMode, NamedFunctionChoice};

// Let the model decide
let auto_choice = ToolChoice::Simple(ToolChoiceMode::Auto);

// Force a specific function
let function_choice = ToolChoice::Function(NamedFunctionChoice::new("get_weather"));

Variants

Simple(ToolChoiceMode)

Simple mode selection (auto, none, required)

Function(NamedFunctionChoice)

Force a specific function to be called

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 Serialize for ToolChoice

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

where __S: Serializer,

Serialize this value into the given Serde serializer.