Enum ToolChoice 

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

Whether the model may call a tool, must call one, or must call a given one.

Each wire API maps it explicitly: Chat Completions sends tool_choice. Auto is every server’s default and is not sent; neither is None in a request that offers no tools, since there is nothing to forbid.

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

None

The model may not call a tool.

Required

The model must call at least one of the tools the request offers.

Tool(String)

The model must call the tool of this name, which the request offers.

Implementations

impl ToolChoice

pub fn tool(name: impl Into<String>) -> Self

The model must call the tool named 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 Default for ToolChoice

fn default() -> Self

Returns the “default value” for a type.

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

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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