Struct ToolBuilder 

pub struct ToolBuilder<I> { /* private fields */ }

Builds a Tool. I is the input type handed to the execute closure.

Implementations

impl<I> ToolBuilder<I>

pub fn description(self, description: impl Into<String>) -> Self

Fixed description.

pub fn description_fn<F, Fut>(self, function: F) -> Self

where F: Fn(DescriptionContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = String> + Send + 'static,

Description computed per call.

pub fn title(self, title: impl Into<String>) -> Self

Title.

pub fn input_schema(self, schema: Schema<JsonValue>) -> Self

Replaces the input schema (keeps the closure input type).

pub fn output_schema(self, schema: Schema<JsonValue>) -> Self

Output schema.

pub fn context_schema(self, schema: Schema<JsonValue>) -> Self

Context schema.

pub fn needs_approval(self, needs_approval: NeedsApproval) -> Self

Approval declaration.

pub fn needs_approval_if<F, Fut>(self, function: F) -> Self

where F: Fn(JsonValue, ToolContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = bool> + Send + 'static,

Approval decided per call from the validated input.

pub fn strict(self, strict: bool) -> Self

Strict-mode request.

pub fn input_example(self, example: JsonObject) -> Self

Adds an example input.

pub fn input_examples( self, examples: impl IntoIterator<Item = JsonObject>, ) -> Self

Adds example inputs.

pub fn metadata(self, metadata: JsonObject) -> Self

Metadata propagated to tool calls.

pub fn provider_options(self, options: ProviderOptions) -> Self

Provider options sent with the definition.

pub fn on_input_start<F, Fut>(self, function: F) -> Self

where F: Fn(ToolContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Hook called when the model starts producing input.

pub fn on_input_delta<F, Fut>(self, function: F) -> Self

where F: Fn(String, ToolContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Hook called for each input delta.

pub fn on_input_available<F, Fut>(self, function: F) -> Self

where F: Fn(JsonValue, ToolContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Hook called once the input is complete and valid.

pub fn to_model_output<F>(self, function: F) -> Self

where F: Fn(ModelOutputArgs<'_>) -> ToolResultOutput + Send + Sync + 'static,

Custom conversion of the output into what the model receives.

pub fn caller(self, definition: ToolCallerDefinition) -> Self

Declares how this tool calls other tools.

pub fn supports_deferred_results(self, supported: bool) -> Self

Marks a provider-executed tool as supporting deferred results. Ignored for other kinds.

pub fn execute_with(self, executor: Arc<dyn ToolExecute>) -> Self

Uses a custom executor.

pub fn build(self) -> Tool

Finishes the tool.

impl<I: DeserializeOwned + Send + 'static> ToolBuilder<I>

pub fn execute<F, Fut, O>(self, function: F) -> Self

where F: Fn(I, ToolContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<O, ToolError>> + Send + 'static, O: Serialize + 'static,

Executes with an async closure returning a single result.

pub fn execute_stream<F, S, O>(self, function: F) -> Self

where F: Fn(I, ToolContext) -> S + Send + Sync + 'static, S: Stream<Item = Result<O, ToolError>> + Send + 'static, O: Serialize + 'static,

Executes with a closure returning a stream; every item becomes a preliminary output and the last one is repeated as the final output.

Trait Implementations

impl<I> Debug for ToolBuilder<I>

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

Formats the value using the given formatter.