Enum ToolChoice 

#[non_exhaustive]
pub enum ToolChoice {
    Auto,
    None,
    Required,
    Tool(String),
}

How the model should choose among a prompt’s Prompt::tools: freely, not at all, mandatorily, or pinned to one named tool (issue #665).

#[non_exhaustive]: the wire protocols have more ways to steer this (“any tool but this one”, a per-tool probability), and adding one must not break every caller.

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.

Auto

The model decides whether to call a tool or answer directly.

None

The model must answer without calling a tool.

Required

The model must call some tool, whichever it picks.

Tool(String)

The model must call the tool with this name.

Trait Implementations

impl Clone for ToolChoice

fn clone(&self) -> Self

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

impl PartialEq for ToolChoice

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ToolChoice