Struct FunctionObject 

pub struct FunctionObject {
    pub name: String,
    pub description: Option<String>,
    pub parameters: Option<Value>,
    pub strict: Option<bool>,
}

Available on crate feature chat-completion-types only.

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: Option<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.

Omitting parameters defines a function with an empty parameter list.

strict: Option<bool>

Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the function calling guide.

Trait Implementations

impl Clone for FunctionObject

Available on (crate features chat-completion-types or assistant-types) and (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) only.

fn clone(&self) -> FunctionObject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionObject

Available on (crate features chat-completion-types or assistant-types) and (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) only.

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

Formats the value using the given formatter.

impl Default for FunctionObject

Available on (crate features chat-completion-types or assistant-types) and (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) only.

fn default() -> FunctionObject

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FunctionObject

Available on (crate features chat-completion-types or assistant-types) and (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) only.

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<FunctionObject> for AssistantTools

Available on crate feature assistant-types only.

fn from(value: FunctionObject) -> Self

Converts to this type from the input type.

impl From<FunctionObject> for AssistantToolsFunction

Available on crate feature assistant-types only.

fn from(value: FunctionObject) -> Self

Converts to this type from the input type.

impl PartialEq for FunctionObject

Available on (crate features chat-completion-types or assistant-types) and (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) only.

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

Available on (crate features chat-completion-types or assistant-types) and (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) only.

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 FunctionObject

Available on (crate features chat-completion-types or assistant-types) and (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) only.