Enum KnownBuiltinTool 

#[non_exhaustive]
pub enum KnownBuiltinTool {
    WebSearch20250305 {
        name: String,
        max_uses: Option<u32>,
        allowed_domains: Option<Vec<String>>,
        blocked_domains: Option<Vec<String>>,
        user_location: Option<UserLocation>,
        cache_control: Option<CacheControl>,
    },
    Computer20250124 {
        name: String,
        display_width_px: u32,
        display_height_px: u32,
        display_number: Option<u32>,
        cache_control: Option<CacheControl>,
    },
    Bash20250124 {
        name: String,
        cache_control: Option<CacheControl>,
    },
    TextEditor20250124 {
        name: String,
        cache_control: Option<CacheControl>,
    },
    CodeExecution20250825 {
        name: String,
        cache_control: Option<CacheControl>,
    },
}

All server-side built-in tool variants known to this SDK version.

#[non_exhaustive] on both the enum (so adding a variant is non-breaking) and on each struct variant (so adding a field is non-breaking).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

WebSearch20250305

Web search tool, version 2025-03-05. The model can issue keyword searches; results are returned as KnownBlock::WebSearchToolResult blocks.

Fields

name: String

Tool name surfaced to the model. Conventionally "web_search".

max_uses: Option<u32>

Maximum number of search requests the model may make per turn.

allowed_domains: Option<Vec<String>>

If set, restrict searches to these domains.

blocked_domains: Option<Vec<String>>

If set, exclude these domains from search results.

user_location: Option<UserLocation>

Approximate user location to bias results.

cache_control: Option<CacheControl>

Optional cache breakpoint on the tool definition.

Computer20250124

Computer-use tool, version 2025-01-24. Lets the model take screenshots and synthesize mouse/keyboard input.

Fields

name: String

Tool name. Conventionally "computer".

display_width_px: u32

Display width in pixels.

display_height_px: u32

Display height in pixels.

display_number: Option<u32>

Optional X11 display number.

cache_control: Option<CacheControl>

Optional cache breakpoint.

Bash20250124

Bash tool, version 2025-01-24.

Fields

name: String

Tool name. Conventionally "bash".

cache_control: Option<CacheControl>

Optional cache breakpoint.

TextEditor20250124

Text editor tool, version 2025-01-24.

Fields

name: String

Tool name. Conventionally "str_replace_editor".

cache_control: Option<CacheControl>

Optional cache breakpoint.

CodeExecution20250825

Code execution tool, version 2025-08-25. Server-side sandboxed Python execution.

Fields

name: String

Tool name. Conventionally "code_execution".

cache_control: Option<CacheControl>

Optional cache breakpoint.

Trait Implementations

impl Clone for KnownBuiltinTool

fn clone(&self) -> KnownBuiltinTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KnownBuiltinTool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KnownBuiltinTool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<KnownBuiltinTool> for BuiltinTool

fn from(k: KnownBuiltinTool) -> Self

Converts to this type from the input type.

impl PartialEq for KnownBuiltinTool

fn eq(&self, other: &KnownBuiltinTool) -> 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 KnownBuiltinTool

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KnownBuiltinTool