Struct Function

pub struct Function {
    pub name: String,
    pub description: Option<String>,
    pub parameters: Option<Parameters>,
    pub arguments: Option<HashMap<String, Value>>,
    pub strict: bool,
}

Represents a function that can be called by OpenAI tools.

This structure contains metadata about a function including its name, description, parameters, and whether it should be executed in strict mode.

Fields

name: String

The name of the function

description: Option<String>

Optional description of what the function does

parameters: Option<Parameters>

Optional parameters that the function accepts

arguments: Option<HashMap<String, Value>>

Optional arguments passed to the function as key-value pairs

strict: bool

Whether the function should be executed in strict mode

Implementations

impl Function

pub fn new<T: AsRef<str>, U: AsRef<str>>( name: T, description: U, parameters: Parameters, strict: bool, ) -> Self

Creates a new Function instance with the specified parameters.

Arguments

• name - The name of the function
• description - A description of what the function does
• parameters - The parameters that the function accepts
• strict - Whether the function should be executed in strict mode

Returns

A new Function instance

pub fn arguments_as_map(&self) -> OpenAIToolResult<HashMap<String, Value>>

Returns the function arguments as a HashMap.

Returns

• Ok(HashMap<String, Value>) - The arguments as a map if they exist
• Err(OpenAIToolError) - If the arguments are not set

Errors

This function will return an error if the arguments are not set.

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl Default for Function

fn default() -> Function

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Function

Custom deserialization implementation for Function.

This implementation handles the deserialization of Function from JSON, parsing arguments as JSON strings and converting parameters from JSON objects. The name field is required, while other fields are optional.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Function

Custom serialization implementation for Function.

This implementation ensures that only non-None optional fields are serialized, keeping the JSON output clean and avoiding null values for optional fields.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.