pub struct FunctionTool<F, Deps = ()> { /* private fields */ }Expand description
Wrapper for function-based tools.
This allows creating tools from async closures without implementing
the Tool trait manually.
§Example
ⓘ
use serdes_ai_tools::{FunctionTool, SchemaBuilder, ToolReturn};
let tool = FunctionTool::new(
"add",
"Add two numbers",
SchemaBuilder::new()
.number("a", "First number", true)
.number("b", "Second number", true)
.build()
.unwrap(),
|_ctx, args| async move {
let a = args["a"].as_f64().unwrap_or(0.0);
let b = args["b"].as_f64().unwrap_or(0.0);
Ok(ToolReturn::text(format!("{}", a + b)))
},
);Implementations§
Source§impl<F, Deps> FunctionTool<F, Deps>
impl<F, Deps> FunctionTool<F, Deps>
Sourcepub fn new(
name: impl Into<String>,
description: impl Into<String>,
parameters: impl Into<JsonValue>,
function: F,
) -> Self
pub fn new( name: impl Into<String>, description: impl Into<String>, parameters: impl Into<JsonValue>, function: F, ) -> Self
Create a new function tool.
Sourcepub fn with_max_retries(self, retries: u32) -> Self
pub fn with_max_retries(self, retries: u32) -> Self
Set maximum retries.
Sourcepub fn with_strict(self, strict: bool) -> Self
pub fn with_strict(self, strict: bool) -> Self
Set strict mode.
Trait Implementations§
Source§impl<F, Deps> Debug for FunctionTool<F, Deps>
impl<F, Deps> Debug for FunctionTool<F, Deps>
Source§impl<F, Deps> Tool<Deps> for FunctionTool<F, Deps>
impl<F, Deps> Tool<Deps> for FunctionTool<F, Deps>
Source§fn definition(&self) -> ToolDefinition
fn definition(&self) -> ToolDefinition
Get the tool’s definition. Read more
Source§fn call<'life0, 'life1, 'async_trait>(
&'life0 self,
ctx: &'life1 RunContext<Deps>,
args: JsonValue,
) -> Pin<Box<dyn Future<Output = ToolResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn call<'life0, 'life1, 'async_trait>(
&'life0 self,
ctx: &'life1 RunContext<Deps>,
args: JsonValue,
) -> Pin<Box<dyn Future<Output = ToolResult> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Execute the tool with given arguments. Read more
Source§fn prepare<'life0, 'life1, 'async_trait>(
&'life0 self,
_ctx: &'life1 RunContext<Deps>,
def: ToolDefinition,
) -> Pin<Box<dyn Future<Output = Option<ToolDefinition>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn prepare<'life0, 'life1, 'async_trait>(
&'life0 self,
_ctx: &'life1 RunContext<Deps>,
def: ToolDefinition,
) -> Pin<Box<dyn Future<Output = Option<ToolDefinition>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Prepare the tool definition at runtime. Read more
Source§fn description(&self) -> String
fn description(&self) -> String
Get the tool description.
Auto Trait Implementations§
impl<F, Deps> Freeze for FunctionTool<F, Deps>where
F: Freeze,
impl<F, Deps> RefUnwindSafe for FunctionTool<F, Deps>where
F: RefUnwindSafe,
impl<F, Deps> Send for FunctionTool<F, Deps>where
F: Send,
impl<F, Deps> Sync for FunctionTool<F, Deps>where
F: Sync,
impl<F, Deps> Unpin for FunctionTool<F, Deps>where
F: Unpin,
impl<F, Deps> UnwindSafe for FunctionTool<F, Deps>where
F: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more