Skip to main content

StructuredTool

Struct StructuredTool 

Source
pub struct StructuredTool<T: Tool> { /* private fields */ }
Expand description

Structured tool wrapper.

Wraps a Tool trait implementation as BaseTool, automatically handling JSON input parsing and output serialization.

Implementations§

Source§

impl<T: Tool> StructuredTool<T>

Source

pub fn new(tool: T, name: Option<&str>, description: Option<&str>) -> Self

Creates a structured tool.

§Arguments
  • tool - Inner tool instance.
  • name - Tool name (optional, defaults to “tool”).
  • description - Tool description (optional, defaults to “A tool”).

Trait Implementations§

Source§

impl<T: Tool> BaseTool for StructuredTool<T>

Source§

fn name(&self) -> &str

Returns the tool name. Read more
Source§

fn description(&self) -> &str

Returns the tool description. Read more
Source§

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

Execute the tool (string version). Read more
Source§

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

Returns the input JSON Schema. Read more
Source§

fn return_direct(&self) -> bool

Whether to return result directly to user. Read more
Source§

fn handle_error<'life0, 'async_trait>( &'life0 self, error: ToolError, ) -> Pin<Box<dyn Future<Output = String> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Handle execution error. Read more
Source§

impl<T: Tool> Debug for StructuredTool<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for StructuredTool<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for StructuredTool<T>
where T: RefUnwindSafe,

§

impl<T> Send for StructuredTool<T>

§

impl<T> Sync for StructuredTool<T>

§

impl<T> Unpin for StructuredTool<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for StructuredTool<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for StructuredTool<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more