Enum ToolMode 

pub enum ToolMode {
    Auto,
    Required(Option<String>),
    None,
}

If and how tools may be used for a request. Mirrors the Python ToolMode.

The four modes are Auto, “required any” (ToolMode::required_any, i.e. Required(None)), a specific required function (ToolMode::required_function, i.e. Required(Some(name))), and None (tools disabled). Like Python’s serialize_model, serialization emits only the mode string; the specific function name is applied by the provider mapping, not persisted on the mode itself.

Variants

Auto

The model decides whether to call tools.

Required(Option<String>)

The model must call a tool; optionally a specific named function.

None

Tools are disabled.

Implementations

impl ToolMode

pub fn required(function_name: Option<String>) -> ToolMode

Construct a Required mode, optionally pinning a specific function.

pub fn auto() -> ToolMode

The model decides whether to call tools.

pub fn none() -> ToolMode

Tools are disabled.

pub fn required_any() -> ToolMode

The model must call some tool, but any tool is acceptable.

pub fn required_function(function_name: impl Into<String>) -> ToolMode

The model must call the named function.

pub fn required_function_name(&self) -> Option<&str>

The specific function name pinned by a Required mode, if any.

pub fn as_str(&self) -> &'static str

Trait Implementations

impl Clone for ToolMode

fn clone(&self) -> ToolMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolMode

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

Formats the value using the given formatter.

impl Default for ToolMode

fn default() -> ToolMode

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolMode

fn deserialize<D>(d: D) -> Result<ToolMode, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ToolMode

impl PartialEq for ToolMode

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolMode

fn serialize<S>( &self, s: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolMode