Tools

Enum Tools 

Source
pub enum Tools {
    Function {
        function: Function,
    },
    Retrieval {
        retrieval: Retrieval,
    },
    WebSearch {
        web_search: WebSearch,
    },
    MCP {
        mcp: MCP,
    },
}
Expand description

Available tools that AI assistants can invoke during conversations.

This enum defines the different categories of external tools and capabilities that can be made available to AI models. Each tool type serves specific purposes and has its own configuration requirements.

§Tool Categories

§Function Tools

Custom user-defined functions that the AI can call with structured parameters. Useful for integrating external APIs, databases, or business logic.

§Retrieval Tools

Access to knowledge bases, document collections, or information retrieval systems. Enables the AI to query structured knowledge sources.

§Web Search Tools

Internet search capabilities for accessing current information. Allows the AI to perform web searches and retrieve up-to-date information.

§MCP Tools

Model Context Protocol tools for standardized tool integration. Provides a standardized interface for tool communication.

§Usage

// Function tool
let function_tool = Tools::Function {
    function: Function::new("get_weather", "Get weather data", parameters)
};

// Web search tool
let search_tool = Tools::WebSearch {
    web_search: WebSearch::new(SearchEngine::SearchPro)
        .with_enable(true)
        .with_count(10)
};

Variants§

§

Function

Custom function calling tool with parameters.

Allows the AI to invoke user-defined functions with structured arguments. Functions must be pre-defined with JSON schemas for parameter validation.

Fields

§function: Function
§

Retrieval

Knowledge retrieval system access tools.

Provides access to knowledge bases, document collections, or other structured information sources that the AI can query.

Fields

§retrieval: Retrieval
§

WebSearch

Web search capabilities for internet access.

Enables the AI to perform web searches and access current information from the internet. Supports various search engines and configurations.

Fields

§web_search: WebSearch
§

MCP

Model Context Protocol (MCP) tools.

Standardized tools that follow the Model Context Protocol specification, providing a consistent interface for tool integration and communication.

Fields

§mcp: MCP

Trait Implementations§

Source§

impl Clone for Tools

Source§

fn clone(&self) -> Tools

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Tools

Source§

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

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

impl From<Tools> for Vec<Tools>

Source§

fn from(tool: Tools) -> Self

Converts to this type from the input type.
Source§

impl Serialize for Tools

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Tools

§

impl RefUnwindSafe for Tools

§

impl Send for Tools

§

impl Sync for Tools

§

impl Unpin for Tools

§

impl UnwindSafe for Tools

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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
Source§

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