Enum Tools 

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

External capability attached to a chat request.

Variants cover caller-defined functions, knowledge retrieval, web search, and Model Context Protocol servers.

Examples

use zai_rs::model::tools::{Function, Tools, WebSearch};
use zai_rs::tool::web_search::SearchEngine;

let function_tool = Tools::Function {
    function: Function::new(
        "get_weather",
        "Get weather data",
        serde_json::json!({"type": "object"}),
    ),
};

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

The function definition (name, description, parameter schema).

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

The retrieval-tool descriptor.

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

The web-search-tool descriptor.

MCP

A provider-hosted MCP tool attached to a chat request.

This config asks the chat service to connect to an MCP server. It is distinct from crate::mcp::McpClient, which connects from this SDK.

Fields

mcp: MCP

The MCP-tool descriptor.

Trait Implementations

impl Clone for Tools

fn clone(&self) -> Tools

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tools

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

Formats the value using the given formatter.

impl From<Function> for Tools

fn from(function: Function) -> Self

Converts to this type from the input type.

impl Serialize for Tools

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for Tools

fn validate(&self) -> Result<(), ValidationErrors>