Struct FunctionTool

Source
pub struct FunctionTool<F> { /* private fields */ }
Expand description

A simple tool that wraps a function

Implementations§

Source§

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

Source

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

Create a new function tool

Source

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

Create a new function tool with custom schema

Trait Implementations§

Source§

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

Source§

fn name(&self) -> &str

Get the name of the tool
Source§

fn description(&self) -> &str

Get the description of the tool
Source§

fn schema(&self) -> ToolSchema

Get the schema for this tool
Source§

fn is_available(&self) -> bool

Check if the tool is available
Source§

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

Get the input schema for this tool
Source§

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

Get the output schema for this tool
Source§

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

Source§

fn invoke<'life0, 'async_trait>( &'life0 self, input: HashMap<String, Value>, _config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<ToolResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Invoke the tool with the given input

Auto Trait Implementations§

§

impl<F> Freeze for FunctionTool<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for FunctionTool<F>
where F: RefUnwindSafe,

§

impl<F> Send for FunctionTool<F>
where F: Send,

§

impl<F> Sync for FunctionTool<F>
where F: Sync,

§

impl<F> Unpin for FunctionTool<F>
where F: Unpin,

§

impl<F> UnwindSafe for FunctionTool<F>
where F: 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.

§

impl<T> Instrument for T

§

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

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

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.

§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,