Struct FnTool 

pub struct FnTool<A, F> { /* private fields */ }

A Tool built from a closure.

#[derive(Instructor, Serialize, Deserialize)]
struct WeatherArgs {
    #[llm(description = "City name")]
    city: String,
}

let tool = FnTool::new("get_weather", "Get the current weather for a city", |args: WeatherArgs| async move {
    Ok(json!({ "city": args.city, "temp_f": 72 }))
});
let toolbox = Toolbox::new().with(tool);

Implementations

impl<A, F> FnTool<A, F>

pub fn new( name: impl Into<String>, description: impl Into<String>, func: F, ) -> Self

Create a tool from a name, description, and an async closure over the (derived-schema) argument type.

Trait Implementations

impl<A, F, Fut> Tool for FnTool<A, F>

where A: Instructor + DeserializeOwned + Send + 'static, F: Fn(A) -> Fut + Send + Sync, Fut: Future<Output = Result<Value>> + Send,

type Args = A

The tool’s argument type. Its schema is derived via Instructor.

fn name(&self) -> String

The tool name the model uses to call it (must be unique within a toolbox).

fn description(&self) -> String

A description telling the model what the tool does and when to use it.

fn invoke<'life0, 'async_trait>( &'life0 self, args: A, ) -> Pin<Box<dyn Future<Output = Result<Value>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute the tool with deserialized arguments, returning a JSON result that is fed back to the model.