Struct MockObjectOutputTool 

pub struct MockObjectOutputTool;

Available on crate feature test-utils only.

A mock tool that returns a JSON object.

Trait Implementations

impl<'de> Deserialize<'de> for MockObjectOutputTool

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MockObjectOutputTool

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Tool for MockObjectOutputTool

const NAME: &'static str = "object_output"

The name of the tool. This name should be unique within a single ToolSet or other registration scope that dispatches tools by name.

type Error = MockToolError

The error type of the tool.

type Args = Value

The arguments type of the tool.

type Output = Value

The output type of the tool.

fn description(&self) -> String

Model-facing description of what the tool does.

fn parameters(&self) -> Value

JSON Schema for the tool arguments.

async fn call(&self, _args: Self::Args) -> Result<Self::Output, Self::Error>

The tool execution method. Both the arguments and return value are a String since these values are meant to be the output and input of LLM models (respectively)

fn name(&self) -> String

A method returning the name of the tool.

fn call_with_extensions( &self, args: Self::Args, _extensions: &ToolCallExtensions, ) -> impl Future<Output = Result<Self::Output, Self::Error>> + WasmCompatSend

Tool execution with per-call runtime extensions.

fn classify_error(&self, error: &Self::Error) -> ToolFailure

Classify an error returned by this tool into a structured ToolFailure.

fn call_structured( &self, args: Self::Args, extensions: &ToolCallExtensions, ) -> impl Future<Output = Result<ToolReturn<Self::Output>, Self::Error>> + WasmCompatSend

Execute the tool, returning a structured ToolReturn instead of a bare output.