Enum ChatCompletionToolChoiceOption

Source
pub enum ChatCompletionToolChoiceOption {
    String(ChatCompletionToolChoiceStrEnum),
    VariantNamedToolChoice(ChatCompletionNamedToolChoice),
}
Expand description

§on openapi.yaml

ChatCompletionToolChoiceOption:
  description: >
    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.
  oneOf:
    - type: string
      description: >
        `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.
      enum:
        - none
        - auto
        - required
    - $ref: "#/components/schemas/ChatCompletionNamedToolChoice"

Variants§

§

String(ChatCompletionToolChoiceStrEnum)

Str

§

VariantNamedToolChoice(ChatCompletionNamedToolChoice)

Named tool choice variant for specific tool selection

Trait Implementations§

Source§

impl Debug for ChatCompletionToolChoiceOption

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ChatCompletionToolChoiceOption

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,