Enum ModelToolDefinition 

pub enum ModelToolDefinition {
    Function(FunctionToolDefinition),
    Hosted(HostedToolDefinition),
}

One model-visible client function or provider-hosted tool definition.

Variants

Function(FunctionToolDefinition)

A function call that the client must execute.

Hosted(HostedToolDefinition)

A tool executed inside the provider response lifecycle.

Implementations

impl ModelToolDefinition

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

Creates a validated client function definition.

Errors

Returns an error for invalid names/descriptions or non-object, oversized, or excessively nested schemas.

pub fn hosted( description: impl Into<String>, input_schema: Value, options: HostedToolOptions, ) -> Result<Self, ModelRequestError>

Creates a validated provider-hosted definition.

Errors

Returns an error when the common model contract violates request bounds.

pub fn name(&self) -> &str

Returns the canonical model-visible name.

pub fn description(&self) -> &str

Returns the model-visible description.

pub const fn input_schema(&self) -> &Value

Returns the provider-neutral input JSON Schema.

pub const fn as_function(&self) -> Option<&FunctionToolDefinition>

Returns this definition as a client function.

pub const fn as_hosted(&self) -> Option<&HostedToolDefinition>

Returns this definition as a hosted tool.

pub const fn hosted_kind(&self) -> Option<HostedToolKind>

Returns the hosted capability kind, if any.

Trait Implementations

impl Clone for ModelToolDefinition

fn clone(&self) -> ModelToolDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelToolDefinition

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

Formats the value using the given formatter.

impl PartialEq for ModelToolDefinition

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ModelToolDefinition