Struct Tool 

#[non_exhaustive]
pub struct Tool {
    pub name: Cow<'static, str>,
    pub title: Option<String>,
    pub description: Option<Cow<'static, str>>,
    pub input_schema: Arc<Map<String, Value>>,
    pub output_schema: Option<Arc<Map<String, Value>>>,
    pub annotations: Option<ToolAnnotations>,
    pub icons: Option<Vec<Icon>>,
    pub meta: Option<MetaObject>,
}

A tool that can be used by a model.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Cow<'static, str>

The name of the tool

title: Option<String>

A human-readable title for the tool

description: Option<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

output_schema: Option<Arc<Map<String, Value>>>

An optional JSON Schema object defining the structure of the tool’s output

annotations: Option<ToolAnnotations>

Optional additional tool information.

icons: Option<Vec<Icon>>

Optional list of icons for the tool

meta: Option<MetaObject>

Optional additional metadata for this 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 new_with_raw<N, S>( name: N, description: Option<Cow<'static, str>>, input_schema: S, ) -> Tool

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

Create a new tool with just a name and input schema (no description)

pub fn with_title(self, title: impl Into<String>) -> Tool

Set the human-readable title

pub fn with_raw_output_schema( self, output_schema: Arc<Map<String, Value>>, ) -> Tool

Set the output schema from a raw value

pub fn with_annotations(self, annotations: ToolAnnotations) -> Tool

Set the annotations

pub fn with_icons(self, icons: Vec<Icon>) -> Tool

Set the icons

pub fn with_meta(self, meta: MetaObject) -> Tool

Set the metadata

pub fn annotate(self, annotations: ToolAnnotations) -> Tool

pub fn with_output_schema<T>(self) -> Tool

where T: JsonSchema + 'static,

Set the output schema using a type that implements JsonSchema

pub fn with_input_schema<T>(self) -> Tool

where T: JsonSchema + 'static,

Set the input schema using a type that implements JsonSchema

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.

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 Default for Tool

fn default() -> Tool

Returns the “default value” for a type.

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 JsonSchema for Tool

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Tool

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

Equality operator ==.

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

Inequality operator !=.

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