Struct async_openai::types::ChatCompletionFunctions

pub struct ChatCompletionFunctions {
    pub name: String,
    pub description: Option<String>,
    pub parameters: Value,
}

Fields

name: String

The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

description: Option<String>

A description of what the function does, used by the model to choose when and how to call the function.

parameters: Value

The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.

To describe a function that accepts no parameters, provide the value {\"type\": \"object\", \"properties\": {}}.

Trait Implementations

impl Clone for ChatCompletionFunctions

fn clone(&self) -> ChatCompletionFunctions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChatCompletionFunctions

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

Formats the value using the given formatter.

impl Default for ChatCompletionFunctions

fn default() -> ChatCompletionFunctions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChatCompletionFunctions

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

Deserialize this value from the given Serde deserializer.

impl From<(String, Value)> for ChatCompletionFunctions

fn from(value: (String, Value)) -> Self

Converts to this type from the input type.

impl From<ChatCompletionFunctions> for AssistantTools

fn from(value: ChatCompletionFunctions) -> Self

Converts to this type from the input type.

impl From<ChatCompletionFunctions> for AssistantToolsFunction

fn from(value: ChatCompletionFunctions) -> Self

Converts to this type from the input type.

impl PartialEq for ChatCompletionFunctions

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ChatCompletionFunctions

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 ChatCompletionFunctions