Struct TypedTool 

pub struct TypedTool<A, F, Fut>
where
    A: JsonSchema + DeserializeOwned + Send + Sync + 'static,
    F: Fn(A) -> Fut + Send + Sync + 'static,
    Fut: Future<Output = Result<Value, ToolError>> + Send + 'static,
{ /* private fields */ }

Available on crate features async and schemars-tools only.

Typed-input adapter that implements Tool for a handler taking a JsonSchema-deriving struct.

Constructed implicitly by ToolRegistry::register_typed / ToolRegistry::register_typed_described; rarely instantiated directly.

Implementations

impl<A, F, Fut> TypedTool<A, F, Fut>

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

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

Build a typed tool. The schema is derived from A automatically.

pub fn with_description(self, description: impl Into<String>) -> Self

Attach a description.

Trait Implementations

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

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

fn name(&self) -> &str

Stable identifier the model uses to refer to this tool.

fn description(&self) -> Option<&str>

Optional human-readable description; helps the model decide when to invoke. Default returns None.

fn schema(&self) -> Value

JSON Schema describing the tool’s expected input.

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

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

Run the tool with the model-supplied input and return its result.