Struct Tool 

pub struct Tool {
    pub name: String,
    pub description: String,
    pub parameters: Schema,
}

A function the model may ask for.

Fields

name: String

description: String

What it does, in prose. This is the only thing the model has to go on when deciding whether to reach for it, so it earns its length.

parameters: Schema

Implementations

impl Tool

pub fn new(name: impl Into<String>, description: impl Into<String>) -> Tool

pub fn parameters(self, schema: Schema) -> Tool

pub fn string(self, name: &str, description: &str) -> Tool

pub fn integer(self, name: &str, description: &str) -> Tool

pub fn number(self, name: &str, description: &str) -> Tool

pub fn boolean(self, name: &str, description: &str) -> Tool

pub fn one_of(self, name: &str, description: &str, values: &[&str]) -> Tool

pub fn array_of(self, name: &str, description: &str, item_type: &str) -> Tool

pub fn optional(self) -> Tool

Make the parameter just added optional.

pub fn schema_json(&self) -> Json

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tool

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

Formats the value using the given formatter.

impl PartialEq for Tool

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Tool