Enum AssistantsApiToolChoiceOption

pub enum AssistantsApiToolChoiceOption {
    None,
    Auto,
    Required,
    AssistantsNamedToolChoice(AssistantsNamedToolChoice),
}

Controls which (if any) tool is called by the model. none means the model will not call any tools and instead generates a message. auto is the default value and 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 before responding to the user. Specifying a particular tool like {"type": "file_search"} or {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.

Variants

None

none

Auto

auto

Required

required

AssistantsNamedToolChoice(AssistantsNamedToolChoice)

Trait Implementations

impl Clone for AssistantsApiToolChoiceOption

fn clone(&self) -> AssistantsApiToolChoiceOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AssistantsApiToolChoiceOption

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AssistantsApiToolChoiceOption

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AssistantsApiToolChoiceOption

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

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

const 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 AssistantsApiToolChoiceOption

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 AssistantsApiToolChoiceOption