Enum ToolChoice 

pub enum ToolChoice {
    Auto,
    None,
    Required,
    Tool {
        tool_name: ToolName,
    },
}

Constraint on which tool the model may call.

Variants

Auto

The model decides whether to call a tool.

None

The model must not call a tool.

Required

The model must call one of the available tools.

Tool

The model must call the named tool.

Fields

tool_name: ToolName

Name of the required tool.

Implementations

impl ToolChoice

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

Requires the model to call the tool named name.

Trait Implementations

impl Clone for ToolChoice

fn clone(&self) -> ToolChoice

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: &ToolChoice) -> 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