Enum ToolReference 

pub enum ToolReference {
    Function {
        name: String,
    },
    Mcp {
        server_label: String,
        name: Option<String>,
    },
    FileSearch,
    WebSearchPreview,
    ComputerUsePreview,
    CodeInterpreter,
    ImageGeneration,
}

Tool reference for ToolChoice::AllowedTools

Represents a reference to a specific tool in the allowed_tools array. Different tool types have different required fields.

Variants

Function

Reference to a function tool

Fields

name: String

Mcp

Reference to an MCP tool

Fields

server_label: String

name: Option<String>

FileSearch

File search hosted tool

WebSearchPreview

Web search preview hosted tool

ComputerUsePreview

Computer use preview hosted tool

CodeInterpreter

Code interpreter hosted tool

ImageGeneration

Image generation hosted tool

Implementations

impl ToolReference

pub fn identifier(&self) -> String

Get a unique identifier for this tool reference

pub fn function_name(&self) -> Option<&str>

Get the tool name if this is a function tool

Trait Implementations

impl Clone for ToolReference

fn clone(&self) -> ToolReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolReference

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolReference

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolReference

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

where __S: Serializer,

Serialize this value into the given Serde serializer.