Struct BuiltinToolCallPart 

pub struct BuiltinToolCallPart {
    pub tool_name: String,
    pub args: ToolCallArgs,
    pub tool_call_id: Option<String>,
    pub id: Option<String>,
    pub provider_details: Option<Map<String, Value>>,
}

A builtin tool call from a model (web search, code execution, etc.).

Builtin tools are provider-native capabilities like web search, code execution, and file search. They are distinct from user-defined function tools and require special handling for UI rendering and history management.

Fields

tool_name: String

Name of the builtin tool being called (e.g., “web_search”, “code_execution”).

args: ToolCallArgs

Arguments for the tool call.

tool_call_id: Option<String>

Unique identifier for this tool call (provider-assigned).

id: Option<String>

Optional unique identifier for this message part.

provider_details: Option<Map<String, Value>>

Provider-specific details/metadata.

Implementations

impl BuiltinToolCallPart

pub const PART_KIND: &'static str = "builtin-tool-call"

Part kind identifier.

pub fn new( tool_name: impl Into<String>, args: impl Into<ToolCallArgs>, ) -> BuiltinToolCallPart

Create a new builtin tool call part.

pub fn part_kind(&self) -> &'static str

Get the part kind.

pub fn with_tool_call_id(self, id: impl Into<String>) -> BuiltinToolCallPart

Set the tool call ID (provider-assigned identifier for the tool call).

pub fn with_part_id(self, id: impl Into<String>) -> BuiltinToolCallPart

Set the part ID (unique identifier for this message part).

pub fn with_provider_details( self, details: Map<String, Value>, ) -> BuiltinToolCallPart

Set provider-specific details.

pub fn args_as_dict(&self) -> Value

Get arguments as a dictionary/object.

pub fn args_as_json_str(&self) -> Result<String, Error>

Get arguments as JSON string.

Errors

Returns an error if serialization fails.

pub fn parse_args<T>(&self) -> Result<T, Error>

where T: for<'de> Deserialize<'de>,

Try to deserialize arguments into a typed struct.

Trait Implementations

impl Clone for BuiltinToolCallPart

fn clone(&self) -> BuiltinToolCallPart

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuiltinToolCallPart

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BuiltinToolCallPart

fn deserialize<__D>( __deserializer: __D, ) -> Result<BuiltinToolCallPart, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BuiltinToolCallPart> for ModelResponsePart

fn from(p: BuiltinToolCallPart) -> ModelResponsePart

Converts to this type from the input type.

impl PartialEq for BuiltinToolCallPart

fn eq(&self, other: &BuiltinToolCallPart) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BuiltinToolCallPart

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BuiltinToolCallPart