Struct ChatCompletionAllowedTools 

pub struct ChatCompletionAllowedTools {
    pub mode: Mode,
    pub tools: Vec<IndexMap<String, Value>>,
}

Constrains the tools available to the model to a pre-defined set.

Fields

mode: Mode

Constrains the tools available to the model to a pre-defined set.

auto allows the model to pick from among the allowed tools and generate a message.

required requires the model to call one or more of the allowed tools.

tools: Vec<IndexMap<String, Value>>

A list of tool definitions that the model should be allowed to call.

For the Chat Completions API, the list of tool definitions might look like:

[
  { "type": "function", "function": { "name": "get_weather" } },
  { "type": "function", "function": { "name": "get_time" } }
]
```text

Implementations

impl ChatCompletionAllowedTools

pub fn builder() -> ChatCompletionAllowedToolsBuilder<((), ())>

Create a builder for building ChatCompletionAllowedTools. On the builder, call .mode(...), .tools(...) to set the values of the fields. Finally, call .build() to create the instance of ChatCompletionAllowedTools.

Trait Implementations

impl Clone for ChatCompletionAllowedTools

fn clone(&self) -> ChatCompletionAllowedTools

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatCompletionAllowedTools

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChatCompletionAllowedTools

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChatCompletionAllowedTools

fn eq(&self, other: &ChatCompletionAllowedTools) -> 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 ChatCompletionAllowedTools

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 ChatCompletionAllowedTools