Skip to main content

ToolServer

Struct ToolServer 

Source
pub struct ToolServer { /* private fields */ }
Expand description

A tool registry under construction; ToolServer::run turns it into the shareable ToolServerHandle.

Implementations§

Source§

impl ToolServer

Source

pub fn new() -> Self

An empty registry.

Source

pub fn owner(self, label: impl Into<String>) -> Self

Name the registry: the owner segment of every key it mints (<owner>/tool:<name>#<n>, <owner>/retrieve:tools#<n>). The default is tools#<m> from a per-process counter, distinct per registry; name it when a host shares one table between registries and wants to read the keys.

Source

pub fn tool(self, tool: impl Tool + 'static) -> Self

Add a typed tool.

Source

pub fn dynamic_tool(self, tool: DynamicTool) -> Self

Add a runtime-defined tool.

Source

pub fn dynamic_tools(self, tools: Vec<DynamicTool>) -> Self

Add runtime-defined tools.

Source

pub fn registered_tool(self, tool: RegisteredTool) -> Self

Add a registration built elsewhere.

Source

pub fn retrieved_tools<I, F>( self, sample: usize, index: I, toolset: ToolSet, ) -> Self
where I: VectorStoreIndex<Filter = F> + 'static, F: DynamicSearchFilter + WasmCompatSend + WasmCompatSync + 'static,

Add retrievable tools: sample of them are advertised per request, chosen by index.

Source

pub fn retrieved_tools_handler( self, sample: usize, handler: impl Serve + 'static, toolset: ToolSet, ) -> Self

Add tools selected per request by a retrieval-family handler answering TopNIds, registered under a generated retrieval index key.

Source

pub fn run(self) -> ToolServerHandle

Start the registry.

Trait Implementations§

Source§

impl Default for ToolServer

Source§

fn default() -> Self

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

Auto Trait Implementations§

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> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

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