Enum Tool 

pub enum Tool {
    Function {
        name: String,
        description: Option<String>,
        parameters: Option<Value>,
        strict: Option<bool>,
    },
    WebSearch,
    WebExtractor,
    CodeInterpreter,
    WebSearchImage,
    ImageSearch,
    FileSearch {
        vector_store_ids: Vec<String>,
    },
    Mcp {
        server_protocol: String,
        server_label: String,
        server_url: String,
        server_description: Option<String>,
        headers: Option<HashMap<String, String>>,
    },
}

A tool the model may call while generating a response.

Variants

Function

A user-defined function.

Fields

name: String

The name of the function. Must be non-empty, at most 128 characters, and match ^[a-zA-Z0-9_-]+$; names must be unique.

description: Option<String>

A description of what the function does.

parameters: Option<Value>

The function parameters, described as a JSON Schema object. Omitting this defines a function with no parameters.

strict: Option<bool>

Whether to enable strict schema adherence for the parameters.

WebSearch

A server-side web search tool.

WebExtractor

Qwen: a web page extraction tool. Must be used together with web_search.

CodeInterpreter

Qwen: a code interpreter tool that executes code and returns the result. Some models require thinking mode to be enabled.

WebSearchImage

Qwen: a text-to-image search tool.

ImageSearch

Qwen: an image-to-image search tool; the input must contain an image URL.

FileSearch

Qwen: a knowledge-base search tool over one uploaded vector store.

Fields

vector_store_ids: Vec<String>

The knowledge-base (vector store) IDs to search. Currently only one ID is supported.

Mcp

Qwen: a Model Context Protocol (MCP) tool.

Fields

server_protocol: String

The protocol used to talk to the MCP server, e.g. sse.

server_label: String

A label identifying the MCP server.

server_url: String

The endpoint URL of the MCP server.

server_description: Option<String>

A description of the MCP server for the model.

headers: Option<HashMap<String, String>>

Request headers, e.g. Authorization.

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Tool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tool

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

Formats the value using the given formatter.

impl Serialize for Tool

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

where __S: Serializer,

Serialize this value into the given Serde serializer.