Struct FunctionTool

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

Defines a function in your own code the model can choose to call. Learn more about function calling.

Fields

name: String

The name of the function to call.

description: Option<String>

A description of the function. Used by the model to determine whether or not to call the function.

parameters: Option<HashMap<String, Value>>

A JSON schema object describing the parameters of the function.

strict: Option<bool>

Whether to enforce strict parameter validation. Default true.

Implementations

impl FunctionTool

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

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

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<'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