Enum ToolChoice 

pub enum ToolChoice {
    Auto,
    None,
    Required,
    Any,
    Tool {
        name: String,
    },
    Allowed {
        mode: AllowedToolMode,
        names: Vec<String>,
    },
}

Portable tool-selection policy for a request.

Provider renderers map this policy into their native tool-choice shape after the selected model has validated whether tools, strict schemas, and forced choices are supported together.

Examples

let choice = providers_kit::generation::ToolChoice::Tool {
    name: "lookup_weather".into(),
};
assert!(matches!(choice, providers_kit::generation::ToolChoice::Tool { .. }));

Variants

Auto

Lets the provider choose whether tools should be used.

None

Disables tool calling for the request.

Required

Requires at least one tool call before completion.

Any

Allows any declared tool to be called.

Tool

Forces the provider to call one specific tool.

Fields

name: String

Declared tool name that must be used.

Allowed

Restricts tool calls to an explicit subset of tool names.

Fields

mode: AllowedToolMode

Enforcement mode for the allowed-tool subset.

names: Vec<String>

Tool names that remain eligible for selection.

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<'de> Deserialize<'de> for ToolChoice

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 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.

impl StructuralPartialEq for ToolChoice