Struct CustomTool 

#[non_exhaustive]
pub struct CustomTool {
    pub name: String,
    pub description: Option<String>,
    pub input_schema: Value,
    pub cache_control: Option<CacheControl>,
}

User-defined tool with a JSON Schema describing its input.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Tool name. Must be unique within a request.

description: Option<String>

Human-readable description; helps the model decide when to invoke.

input_schema: Value

JSON Schema for the tool’s input arguments.

cache_control: Option<CacheControl>

Optional cache breakpoint to apply to this tool’s definition.

Implementations

impl CustomTool

pub fn new(name: impl Into<String>, input_schema: Value) -> Self

Construct a custom tool with no description and no cache control.

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

Set the tool description.

pub fn cache_control(self, cache_control: CacheControl) -> Self

Apply a cache breakpoint at this tool’s definition.

pub fn with_ephemeral_cache(self) -> Self

Shorthand: apply an ephemeral cache breakpoint at the default (5-minute) TTL.

Trait Implementations

impl Clone for CustomTool

fn clone(&self) -> CustomTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomTool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CustomTool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CustomTool

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

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 CustomTool