Struct FunctionObject

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

Fields

description: Option<String>

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

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.

parameters: Option<FunctionParameters>

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.

Implementations

impl FunctionObject

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

Create a builder for building FunctionObject. On the builder, call .description(...)(optional), .name(...), .parameters(...)(optional), .strict(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of FunctionObject.

Trait Implementations

impl Clone for FunctionObject

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

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

Formats the value using the given formatter.

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FunctionObject

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

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