Skip to main content

ExternalToolset

Struct ExternalToolset 

Source
pub struct ExternalToolset<Deps = ()> { /* private fields */ }
Expand description

Toolset for externally-executed tools.

This is used when tools need to be exposed to the model but will be executed by an external system. When any tool is called, it returns ToolError::CallDeferred so the agent knows to defer execution.

§Example

use serdes_ai_toolsets::ExternalToolset;
use serdes_ai_tools::ToolDefinition;

let external = ExternalToolset::new()
    .with_id("external_api")
    .definition(ToolDefinition::new("api_call", "Call external API"));

Implementations§

Source§

impl<Deps> ExternalToolset<Deps>

Source

pub fn new() -> Self

Create a new empty external toolset.

Source

pub fn with_id(self, id: impl Into<String>) -> Self

Set the toolset ID.

Source

pub fn with_max_retries(self, retries: u32) -> Self

Set max retries.

Source

pub fn definition(self, def: ToolDefinition) -> Self

Add a tool definition.

Source

pub fn definitions(self, defs: impl IntoIterator<Item = ToolDefinition>) -> Self

Add multiple tool definitions.

Source

pub fn len(&self) -> usize

Get the number of definitions.

Source

pub fn is_empty(&self) -> bool

Check if empty.

Trait Implementations§

Source§

impl<Deps: Send + Sync> AbstractToolset<Deps> for ExternalToolset<Deps>

Source§

fn id(&self) -> Option<&str>

Unique identifier for this toolset.
Source§

fn type_name(&self) -> &'static str

Type name for debugging.
Source§

fn get_tools<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 RunContext<Deps>, ) -> Pin<Box<dyn Future<Output = Result<HashMap<String, ToolsetTool>, ToolError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get all available tools. Read more
Source§

fn call_tool<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, name: &'life1 str, args: JsonValue, _ctx: &'life2 RunContext<Deps>, _tool: &'life3 ToolsetTool, ) -> Pin<Box<dyn Future<Output = Result<ToolReturn, ToolError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Call a tool by name.
Source§

fn label(&self) -> String

Human-readable label for error messages.
Source§

fn tool_name_conflict_hint(&self) -> String

Hint for resolving name conflicts.
Source§

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

Enter context (for resource setup). Read more
Source§

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

Exit context (for cleanup). Read more
Source§

impl<Deps> Debug for ExternalToolset<Deps>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<Deps> Default for ExternalToolset<Deps>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<Deps> Freeze for ExternalToolset<Deps>

§

impl<Deps> RefUnwindSafe for ExternalToolset<Deps>

§

impl<Deps> Send for ExternalToolset<Deps>

§

impl<Deps> Sync for ExternalToolset<Deps>

§

impl<Deps> Unpin for ExternalToolset<Deps>

§

impl<Deps> UnwindSafe for ExternalToolset<Deps>

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, 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