Enum ToolChoice 

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

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

None

Required

Function

Force the model to call one specific function: {"type": "function", "function": {"name": "..."}}.

Fields

name: String

Implementations

impl ToolChoice

pub fn function(name: impl Into<String>) -> ToolChoice

Force a call to the named function.

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<(), Error>

Formats the value using the given formatter.

impl Default for ToolChoice

fn default() -> ToolChoice

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolChoice

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolChoice

impl TryFrom<ToolChoice> for ToolChoice

type Error = CompletionError

The type returned in the event of a conversion error.

fn try_from( value: ToolChoice, ) -> Result<ToolChoice, <ToolChoice as TryFrom<ToolChoice>>::Error>

Performs the conversion.