Struct FunctionTool

pub struct FunctionTool {
    pub name: Cow<'static, str>,
    pub description: Option<Cow<'static, str>>,
    pub parameters: Option<Value>,
}

Fields

name: Cow<'static, str>

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<Cow<'static, str>>

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.

Trait Implementations

impl Clone for FunctionTool

fn clone(&self) -> FunctionTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionTool

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

Formats the value using the given formatter.

impl Default for FunctionTool

fn default() -> FunctionTool

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FunctionTool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FunctionTool

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

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 FunctionTool