Enum ChatCompletionToolChoiceOption

pub enum ChatCompletionToolChoiceOption {
    None,
    Auto,
    Required,
    Named(ChatCompletionNamedToolChoice),
}

Controls which (if any) tool is called by the model. none means the model will not call any tool and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools. Specifying a particular tool via {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.

none is the default when no tools are present. auto is the default if tools are present.present.

Variants

None

Auto

Required

Named(ChatCompletionNamedToolChoice)

Trait Implementations

impl Clone for ChatCompletionToolChoiceOption

fn clone(&self) -> ChatCompletionToolChoiceOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatCompletionToolChoiceOption

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

Formats the value using the given formatter.

impl Default for ChatCompletionToolChoiceOption

fn default() -> ChatCompletionToolChoiceOption

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChatCompletionToolChoiceOption

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for ChatCompletionToolChoiceOption

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for ChatCompletionToolChoiceOption

fn from(value: String) -> Self

Converts to this type from the input type.

impl PartialEq for ChatCompletionToolChoiceOption

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ChatCompletionToolChoiceOption

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 ChatCompletionToolChoiceOption