pub struct FunctionToolDefinition { /* private fields */ }Expand description
Model-visible client function tool.
Implementations§
Source§impl FunctionToolDefinition
impl FunctionToolDefinition
Sourcepub fn new(
name: impl Into<String>,
description: impl Into<String>,
input_schema: Value,
) -> Result<Self, ModelRequestError>
pub fn new( name: impl Into<String>, description: impl Into<String>, input_schema: Value, ) -> Result<Self, ModelRequestError>
Creates a validated model-visible tool definition.
§Errors
Returns an error for invalid names/descriptions or non-object, oversized, or excessively nested schemas.
Sourcepub fn description(&self) -> &str
pub fn description(&self) -> &str
Returns the model-visible description.
Sourcepub const fn input_schema(&self) -> &Value
pub const fn input_schema(&self) -> &Value
Returns the provider-neutral input JSON Schema.
Trait Implementations§
Source§impl Clone for FunctionToolDefinition
impl Clone for FunctionToolDefinition
Source§fn clone(&self) -> FunctionToolDefinition
fn clone(&self) -> FunctionToolDefinition
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for FunctionToolDefinition
impl Debug for FunctionToolDefinition
Source§impl PartialEq for FunctionToolDefinition
impl PartialEq for FunctionToolDefinition
impl StructuralPartialEq for FunctionToolDefinition
Auto Trait Implementations§
impl Freeze for FunctionToolDefinition
impl RefUnwindSafe for FunctionToolDefinition
impl Send for FunctionToolDefinition
impl Sync for FunctionToolDefinition
impl Unpin for FunctionToolDefinition
impl UnsafeUnpin for FunctionToolDefinition
impl UnwindSafe for FunctionToolDefinition
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more