Struct OpenAiFunction

pub struct OpenAiFunction {
    pub strict: Option<bool>,
    pub name: String,
    pub description: Option<String>,
    pub parameters: Option<OpenAiFunctionParameters>,
}

Fields

strict: Option<bool>

This is a boolean that controls 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 OpenAI guide. @default false

name: String

This is the 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>

This is the description of what the function does, used by the AI to choose when and how to call the function.

parameters: Option<OpenAiFunctionParameters>

These are the parameters the functions accepts, described as a JSON Schema object. See the OpenAI guide for examples, and the JSON Schema reference for documentation about the format. Omitting parameters defines a function with an empty parameter list.

Implementations

impl OpenAiFunction

pub fn new(name: String) -> OpenAiFunction

Trait Implementations

impl Clone for OpenAiFunction

fn clone(&self) -> OpenAiFunction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAiFunction

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

Formats the value using the given formatter.

impl Default for OpenAiFunction

fn default() -> OpenAiFunction

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OpenAiFunction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl OpenApi for OpenAiFunction

fn openapi() -> OpenApi

Return the openapi::OpenApi instance which can be parsed with serde or served via OpenAPI visualization tool such as Swagger UI.

impl PartialEq for OpenAiFunction

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

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 OpenAiFunction