Enum ToolChoice 

#[non_exhaustive]
pub enum ToolChoice {
    Auto,
    None,
    Required,
    Named {
        name: String,
    },
}

How free the model is to call tools.

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.

None

The model must not call a tool.

Required

The model must call some tool.

Named

The model must call this tool. Used to force a structured payload through a function schema.

Fields

name: String

Tool name.

Implementations

impl ToolChoice

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

Forces one named tool.

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

Stable snake-case label.

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