Skip to main content

FunctionTool

Struct FunctionTool 

Source
pub struct FunctionTool<T, F>
where T: DeserializeOwned + Send + Sync + 'static, F: Fn(T) -> Pin<Box<dyn Future<Output = Result<String>> + Send>> + Send + Sync,
{ /* private fields */ }
Expand description

A tool implementation using a function

Implementations§

Source§

impl<T, F> FunctionTool<T, F>
where T: DeserializeOwned + Send + Sync + 'static, F: Fn(T) -> Pin<Box<dyn Future<Output = Result<String>> + Send>> + Send + Sync,

Source

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

Create a new function tool

Source

pub fn with_ephemeral(self, config: EphemeralConfig) -> Self

Set ephemeral configuration

Trait Implementations§

Source§

impl<T, F> Tool for FunctionTool<T, F>
where T: DeserializeOwned + Send + Sync + 'static, F: Fn(T) -> Pin<Box<dyn Future<Output = Result<String>> + Send>> + Send + Sync,

Source§

fn name(&self) -> &str

Get the tool name
Source§

fn description(&self) -> &str

Get the tool description
Source§

fn definition(&self) -> ToolDefinition

Get the tool definition (JSON Schema)
Source§

fn execute<'life0, 'async_trait>( &'life0 self, args: Value, ) -> Pin<Box<dyn Future<Output = Result<ToolResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Execute the tool with given arguments
Source§

fn ephemeral(&self) -> EphemeralConfig

Whether tool outputs should be ephemeral (removed from context after use)

Auto Trait Implementations§

§

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

§

impl<T, F> RefUnwindSafe for FunctionTool<T, F>

§

impl<T, F> Send for FunctionTool<T, F>

§

impl<T, F> Sync for FunctionTool<T, F>

§

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

§

impl<T, F> UnsafeUnpin for FunctionTool<T, F>
where F: UnsafeUnpin,

§

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