Struct StructuredTool 

pub struct StructuredTool { /* private fields */ }

Tool that can operate on any number of inputs.

Unlike Tool, which accepts a single string input, StructuredTool accepts a dictionary of typed arguments.

Implementations

impl StructuredTool

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

Create a new StructuredTool.

pub fn with_func(self, func: StructuredToolFunc) -> Self

Set the sync function.

pub fn with_coroutine(self, coroutine: AsyncStructuredToolFunc) -> Self

Set the async function.

pub fn with_return_direct(self, return_direct: bool) -> Self

Set whether to return directly.

pub fn with_response_format(self, format: ResponseFormat) -> Self

Set the response format.

pub fn with_tags(self, tags: Vec<String>) -> Self

Set tags.

pub fn with_metadata(self, metadata: HashMap<String, Value>) -> Self

Set metadata.

pub fn with_extras(self, extras: HashMap<String, Value>) -> Self

Set extras.

pub fn with_handle_tool_error(self, handler: HandleToolError) -> Self

Set handle_tool_error.

pub fn with_handle_validation_error( self, handler: HandleValidationError, ) -> Self

Set handle_validation_error.

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

where F: Fn(HashMap<String, Value>) -> Result<Value> + Send + Sync + 'static,

Create a tool from a function.

This is the main way to create a StructuredTool.

pub fn from_function_with_async<F, AF, Fut>( func: F, coroutine: AF, name: impl Into<String>, description: impl Into<String>, args_schema: ArgsSchema, ) -> Self

where F: Fn(HashMap<String, Value>) -> Result<Value> + Send + Sync + 'static, AF: Fn(HashMap<String, Value>) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value>> + Send + 'static,

Create a tool from a sync and async function pair.

pub fn from_async_function<AF, Fut>( coroutine: AF, name: impl Into<String>, description: impl Into<String>, args_schema: ArgsSchema, ) -> Self

where AF: Fn(HashMap<String, Value>) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value>> + Send + 'static,

Create a tool from an async function only.

Trait Implementations

impl BaseTool for StructuredTool

fn name(&self) -> &str

Get the unique name of the tool.

fn description(&self) -> &str

Get the description of what the tool does.

fn args_schema(&self) -> Option<&ArgsSchema>

Get the args schema for the tool.

fn return_direct(&self) -> bool

Whether to return the tool’s output directly.

fn verbose(&self) -> bool

Whether to log the tool’s progress.

fn tags(&self) -> Option<&[String]>

Get tags associated with the tool.

fn metadata(&self) -> Option<&HashMap<String, Value>>

Get metadata associated with the tool.

fn handle_tool_error(&self) -> &HandleToolError

Get how to handle tool errors.

fn handle_validation_error(&self) -> &HandleValidationError

Get how to handle validation errors.

fn response_format(&self) -> ResponseFormat

Get the response format for the tool.

fn extras(&self) -> Option<&HashMap<String, Value>>

Get optional provider-specific extra fields.

fn run( &self, input: ToolInput, _config: Option<RunnableConfig>, ) -> Result<ToolOutput>

Run the tool synchronously.

fn arun<'life0, 'async_trait>( &'life0 self, input: ToolInput, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<ToolOutput>> + Send + 'async_trait>>

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

Run the tool asynchronously.

fn is_single_input(&self) -> bool

Check if the tool accepts only a single input argument.

fn args(&self) -> HashMap<String, Value>

Get the tool’s input arguments schema.

fn tool_call_schema(&self) -> ArgsSchema

Get the schema for tool calls, excluding injected arguments.

fn definition(&self) -> ToolDefinition

Get the tool definition for LLM function calling.

fn parameters_schema(&self) -> Value

Get the JSON schema for the tool’s parameters.

fn invoke<'life0, 'async_trait>( &'life0 self, tool_call: ToolCall, ) -> Pin<Box<dyn Future<Output = BaseMessage> + Send + 'async_trait>>

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

Invoke the tool with a ToolCall.

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

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

Invoke the tool directly with arguments.

impl Debug for StructuredTool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.