Skip to main content

Tool

supercode::tools

Trait Tool 

Source 
pub trait Tool: Send + Sync {
    // Required methods
    fn name(&self) -> &str;
    fn description(&self) -> &str;
    fn parameters(&self) -> Value;
    fn execute<'life0, 'life1, 'async_trait>(
        &'life0 self,
        args: Value,
        ctx: &'life1 ToolContext,
    ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             'life1: 'async_trait,
             Self: 'async_trait;
}
Expand description

A callable capability.

Required Methods§

Source

fn name(&self) -> &str

Stable, unique tool name (what the model calls).

Source

fn description(&self) -> &str

The built-in description. May be overridden via crate::Config.

Source

fn parameters(&self) -> Value

JSON Schema describing the tool’s input object.

Source

fn execute<'life0, 'life1, 'async_trait>( &'life0 self, args: Value, ctx: &'life1 ToolContext, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Run the tool. Returns text to feed back to the model.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§