Struct Tool

pub struct Tool {
    pub name: Cow<'static, str>,
    pub description: Cow<'static, str>,
    pub input_schema: Arc<Map<String, Value>>,
}

A tool that can be used by a model.

Fields

name: Cow<'static, str>

The name of the tool

description: Cow<'static, str>

A description of what the tool does

input_schema: Arc<Map<String, Value>>

A JSON Schema object defining the expected parameters for the tool

Implementations

impl Tool

pub fn new<N, D, S>(name: N, description: D, input_schema: S) -> Tool

where N: Into<Cow<'static, str>>, D: Into<Cow<'static, str>>, S: Into<Arc<Map<String, Value>>>,

Create a new tool with the given name and description

pub fn schema_as_json_value(&self) -> Value

Get the schema as json value

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Tool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Tool

fn deserialize<__D>( __deserializer: __D, ) -> Result<Tool, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Tool

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

Tests for self and other values to be equal, and is used by ==.

const 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 Tool

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Tool