Enum ToolChoiceOptions 

pub enum ToolChoiceOptions {
    None,
    Auto,
    Required,
}

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.

JSON schema

{
 "title": "Tool choice mode",
 "description": "Controls which (if any) tool is called by the model.\n\n`none` means the model will not call any tool and instead generates a message.\n\n`auto` means the model can pick between generating a message or calling one or\nmore tools.\n\n`required` means the model must call one or more tools.\n",
 "type": "string",
 "enum": [
   "none",
   "auto",
   "required"
 ]
}

Variants

None

Auto

Required

Trait Implementations

impl Clone for ToolChoiceOptions

fn clone(&self) -> ToolChoiceOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ToolChoiceOptions

impl Debug for ToolChoiceOptions

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolChoiceOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ToolChoiceOptions

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

Formats the value using the given formatter.

impl Eq for ToolChoiceOptions

impl From<ToolChoiceOptions> for RealtimeBetaResponseCreateParamsToolChoice

fn from(value: ToolChoiceOptions) -> Self

Converts to this type from the input type.

impl From<ToolChoiceOptions> for RealtimeResponseCreateParamsToolChoice

fn from(value: ToolChoiceOptions) -> Self

Converts to this type from the input type.

impl From<ToolChoiceOptions> for RealtimeSessionCreateRequestGaToolChoice

fn from(value: ToolChoiceOptions) -> Self

Converts to this type from the input type.

impl From<ToolChoiceOptions> for RealtimeSessionCreateResponseGaToolChoice

fn from(value: ToolChoiceOptions) -> Self

Converts to this type from the input type.

impl From<ToolChoiceOptions> for ToolChoiceParam

fn from(value: ToolChoiceOptions) -> Self

Converts to this type from the input type.

impl FromStr for ToolChoiceOptions

type Err = ConversionError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, ConversionError>

Parses a string s to return a value of this type.

impl Hash for ToolChoiceOptions

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 Ord for ToolChoiceOptions

fn cmp(&self, other: &ToolChoiceOptions) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ToolChoiceOptions

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ToolChoiceOptions

fn partial_cmp(&self, other: &ToolChoiceOptions) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ToolChoiceOptions

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 ToolChoiceOptions

impl TryFrom<&String> for ToolChoiceOptions

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &String) -> Result<Self, ConversionError>

Performs the conversion.

impl TryFrom<&str> for ToolChoiceOptions

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, ConversionError>

Performs the conversion.

impl TryFrom<String> for ToolChoiceOptions

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, ConversionError>

Performs the conversion.