Struct CustomTool 

pub struct CustomTool {
    pub name: String,
    pub description: Option<String>,
    pub format: Option<Format>,
}

A custom tool that processes input using a specified format. Learn more about custom tools.

Fields

name: String

The name of the custom tool, used to identify it in tool calls.

description: Option<String>

Optional description of the custom tool, used to provide more context.

format: Option<Format>

The input format for the custom tool. Default is unconstrained text.

Implementations

impl CustomTool

pub fn builder() -> CustomToolBuilder<((), (), ())>

Create a builder for building CustomTool. On the builder, call .name(...), .description(...)(optional), .format(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CustomTool.

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