Struct OpenAiFunctionParameters

pub struct OpenAiFunctionParameters {
    pub type: TypeTrue,
    pub properties: HashMap<String, JsonSchema>,
    pub required: Option<Vec<String>>,
}

Fields

type: TypeTrue

This must be set to ‘object’. It instructs the model to return a JSON object containing the function call properties.

properties: HashMap<String, JsonSchema>

This provides a description of the properties required by the function. JSON Schema can be used to specify expectations for each property. Refer to this doc for a comprehensive guide on JSON Schema.

required: Option<Vec<String>>

This specifies the properties that are required by the function.

Implementations

impl OpenAiFunctionParameters

pub fn new( type: TypeTrue, properties: HashMap<String, JsonSchema>, ) -> OpenAiFunctionParameters

Trait Implementations

impl Clone for OpenAiFunctionParameters

fn clone(&self) -> OpenAiFunctionParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAiFunctionParameters

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

Formats the value using the given formatter.

impl Default for OpenAiFunctionParameters

fn default() -> OpenAiFunctionParameters

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OpenAiFunctionParameters

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OpenAiFunctionParameters

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

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 OpenAiFunctionParameters