Struct Tool 

pub struct Tool { /* private fields */ }

One tool exposed to the system language model.

Implementations

impl Tool

pub fn new<F>( name: impl Into<String>, description: impl Into<String>, parameters: GenerationSchema, handler: F, ) -> Self

where F: Fn(GeneratedContent) -> Result<ToolOutput, FMError> + Send + Sync + 'static,

Create a tool from a dynamic GeneratedContent handler.

pub fn json<Args, Output, F>( name: impl Into<String>, description: impl Into<String>, parameters: GenerationSchema, handler: F, ) -> Self

where Args: DeserializeOwned + Send + 'static, Output: ToPrompt, F: Fn(Args) -> Result<Output, FMError> + Send + Sync + 'static,

Create a tool whose handler receives decoded JSON arguments.

pub fn generable<Args, Output, F>( name: impl Into<String>, description: impl Into<String>, handler: F, ) -> Result<Self, FMError>

where Args: FromGeneratedContent + Generable + Send + 'static, Output: ToPrompt, F: Fn(Args) -> Result<Output, FMError> + Send + Sync + 'static,

Create a tool whose argument schema is inferred from a Generable type.

Errors

Returns an FMError if Args cannot produce a generation schema.

pub const fn spec(&self) -> &ToolSpec

Tool metadata as exposed to FoundationModels.

pub fn definition(&self) -> ToolDefinition

Convert this tool into a transcript tool definition.

pub fn with_schema_in_instructions(self, includes: bool) -> Self

Control whether the schema is included in the model’s tool instructions.

Trait Implementations

impl Debug for Tool

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

Formats the value using the given formatter.