pub struct FunctionBuilder { /* private fields */ }Expand description
Builder for creating function definitions with fluent API
Implementations§
Source§impl FunctionBuilder
impl FunctionBuilder
Sourcepub fn description(self, description: impl Into<String>) -> Self
pub fn description(self, description: impl Into<String>) -> Self
Set the function description
Sourcepub fn required_string(
self,
name: impl Into<String>,
description: impl Into<String>,
) -> Self
pub fn required_string( self, name: impl Into<String>, description: impl Into<String>, ) -> Self
Add a required string parameter
Sourcepub fn optional_string(
self,
name: impl Into<String>,
description: impl Into<String>,
) -> Self
pub fn optional_string( self, name: impl Into<String>, description: impl Into<String>, ) -> Self
Add an optional string parameter
Sourcepub fn required_number(
self,
name: impl Into<String>,
description: impl Into<String>,
) -> Self
pub fn required_number( self, name: impl Into<String>, description: impl Into<String>, ) -> Self
Add a required number parameter
Sourcepub fn optional_number(
self,
name: impl Into<String>,
description: impl Into<String>,
) -> Self
pub fn optional_number( self, name: impl Into<String>, description: impl Into<String>, ) -> Self
Add an optional number parameter
Sourcepub fn required_integer(
self,
name: impl Into<String>,
description: impl Into<String>,
) -> Self
pub fn required_integer( self, name: impl Into<String>, description: impl Into<String>, ) -> Self
Add a required integer parameter
Sourcepub fn optional_integer(
self,
name: impl Into<String>,
description: impl Into<String>,
) -> Self
pub fn optional_integer( self, name: impl Into<String>, description: impl Into<String>, ) -> Self
Add an optional integer parameter
Sourcepub fn required_boolean(
self,
name: impl Into<String>,
description: impl Into<String>,
) -> Self
pub fn required_boolean( self, name: impl Into<String>, description: impl Into<String>, ) -> Self
Add a required boolean parameter
Sourcepub fn optional_boolean(
self,
name: impl Into<String>,
description: impl Into<String>,
) -> Self
pub fn optional_boolean( self, name: impl Into<String>, description: impl Into<String>, ) -> Self
Add an optional boolean parameter
Sourcepub fn required_array(
self,
name: impl Into<String>,
description: impl Into<String>,
item_schema: SchemaBuilder,
) -> Self
pub fn required_array( self, name: impl Into<String>, description: impl Into<String>, item_schema: SchemaBuilder, ) -> Self
Add a required array parameter
Sourcepub fn optional_array(
self,
name: impl Into<String>,
description: impl Into<String>,
item_schema: SchemaBuilder,
) -> Self
pub fn optional_array( self, name: impl Into<String>, description: impl Into<String>, item_schema: SchemaBuilder, ) -> Self
Add an optional array parameter
Sourcepub fn required_object(
self,
name: impl Into<String>,
description: impl Into<String>,
object_schema: SchemaBuilder,
) -> Self
pub fn required_object( self, name: impl Into<String>, description: impl Into<String>, object_schema: SchemaBuilder, ) -> Self
Add a required object parameter
Sourcepub fn optional_object(
self,
name: impl Into<String>,
description: impl Into<String>,
object_schema: SchemaBuilder,
) -> Self
pub fn optional_object( self, name: impl Into<String>, description: impl Into<String>, object_schema: SchemaBuilder, ) -> Self
Add an optional object parameter
Sourcepub fn required_enum(
self,
name: impl Into<String>,
description: impl Into<String>,
values: Vec<String>,
) -> Self
pub fn required_enum( self, name: impl Into<String>, description: impl Into<String>, values: Vec<String>, ) -> Self
Add a required enum parameter
Sourcepub fn optional_enum(
self,
name: impl Into<String>,
description: impl Into<String>,
values: Vec<String>,
) -> Self
pub fn optional_enum( self, name: impl Into<String>, description: impl Into<String>, values: Vec<String>, ) -> Self
Add an optional enum parameter
Sourcepub fn required_parameter(
self,
name: impl Into<String>,
schema: SchemaBuilder,
) -> Self
pub fn required_parameter( self, name: impl Into<String>, schema: SchemaBuilder, ) -> Self
Add a parameter with custom schema
Sourcepub fn optional_parameter(
self,
name: impl Into<String>,
schema: SchemaBuilder,
) -> Self
pub fn optional_parameter( self, name: impl Into<String>, schema: SchemaBuilder, ) -> Self
Add an optional parameter with custom schema
Sourcepub fn build(self) -> Result<FunctionTool>
pub fn build(self) -> Result<FunctionTool>
Build the function tool
Sourcepub fn build_tool(self) -> Result<Tool>
pub fn build_tool(self) -> Result<Tool>
Build as a Tool
Source§impl FunctionBuilder
Convenience functions for creating common function patterns
impl FunctionBuilder
Convenience functions for creating common function patterns
Sourcepub fn location_function(
name: impl Into<String>,
description: impl Into<String>,
) -> Self
pub fn location_function( name: impl Into<String>, description: impl Into<String>, ) -> Self
Create a function that takes a single location parameter
Sourcepub fn weather_function(
name: impl Into<String>,
description: impl Into<String>,
) -> Self
pub fn weather_function( name: impl Into<String>, description: impl Into<String>, ) -> Self
Create a function that takes location and optional unit
Sourcepub fn search_function(
name: impl Into<String>,
description: impl Into<String>,
) -> Self
pub fn search_function( name: impl Into<String>, description: impl Into<String>, ) -> Self
Create a function that searches with a query
Trait Implementations§
Source§impl Clone for FunctionBuilder
impl Clone for FunctionBuilder
Source§fn clone(&self) -> FunctionBuilder
fn clone(&self) -> FunctionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more