Struct Tool 

pub struct Tool {
    pub tool_type: ToolType,
    pub function: Option<FunctionTool>,
    pub max_keyword: Option<u32>,
    pub force_search: Option<bool>,
    pub limit: Option<u32>,
    pub user_location: Option<UserLocation>,
}

A tool that can be called by the model.

Fields

tool_type: ToolType

Tool type

function: Option<FunctionTool>

Function tool (if type is function)

max_keyword: Option<u32>

Maximum number of keywords for web search (web_search only)

force_search: Option<bool>

Force search even if model thinks it’s unnecessary (web_search only)

limit: Option<u32>

Limit the number of search results (web_search only)

user_location: Option<UserLocation>

User location for localized search (web_search only)

Implementations

impl Tool

pub fn function(name: impl Into<String>, description: impl Into<String>) -> Self

Create a new function tool.

pub fn function_with_params( name: impl Into<String>, description: impl Into<String>, parameters: HashMap<String, Value>, ) -> Self

Create a new function tool with parameters.

pub fn web_search() -> Self

Create a web search tool.

Note: You must first enable the “联网服务插件” (Web Search Plugin) in the MiMo console and set web_search_enabled(true) in your ChatRequest before using this feature.

pub fn max_keyword(self, max: u32) -> Self

Set maximum number of keywords for web search.

pub fn force_search(self, force: bool) -> Self

Set whether to force search.

pub fn limit(self, limit: u32) -> Self

Set the result limit for web search.

pub fn user_location(self, location: UserLocation) -> Self

Set the user location for localized search.

pub fn strict(self, strict: bool) -> Self

Set whether to use strict mode.

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<'de> Deserialize<'de> for Tool

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.