pub struct ToolDescriptor {
pub name: String,
pub description: String,
pub effect: Effect,
pub input_schema: Value,
}Expand description
The metadata a ToolSet exposes for one tool when
enumerating tools for a model: everything the model needs to decide whether
and how to call it.
This is a snapshot, owned and cloneable, so it can be serialized into a model request or sent over a future control plane without holding a borrow on the registry.
Fields§
§name: StringThe name the model calls the tool by.
description: StringThe human-readable description handed to the model.
effect: EffectThe side-effect class governing retry and resume behavior.
input_schema: ValueThe JSON Schema the tool’s input must satisfy.
Trait Implementations§
Source§impl Clone for ToolDescriptor
impl Clone for ToolDescriptor
Source§fn clone(&self) -> ToolDescriptor
fn clone(&self) -> ToolDescriptor
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 ToolDescriptor
impl Debug for ToolDescriptor
Source§impl PartialEq for ToolDescriptor
impl PartialEq for ToolDescriptor
impl StructuralPartialEq for ToolDescriptor
Auto Trait Implementations§
impl Freeze for ToolDescriptor
impl RefUnwindSafe for ToolDescriptor
impl Send for ToolDescriptor
impl Sync for ToolDescriptor
impl Unpin for ToolDescriptor
impl UnsafeUnpin for ToolDescriptor
impl UnwindSafe for ToolDescriptor
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