Tool<TInput extends Object> class

A tool that can be called by the LLM.

Constructors

Tool({required String name, required String description, required FutureOr onCall(TInput input), Schema? inputSchema, TInput inputFromJson(Map<String, dynamic>)?})

Creates a Tool.

Properties

description → String

Used to tell the model how/when/why to use the tool. You can provide few-shot examples as a part of the description.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

inputSchema → Schema

Schema to parse and validate tool's input arguments. Following the JSON Schema specification.

final, inherited

name → String

The unique name of the tool that clearly communicates its purpose.

final, inherited

onCall → FutureOr Function(TInput input)

The function that will be called when the tool is run.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

call(Map<String, dynamic> arguments) → Future

Runs the tool.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, Object?>

Serializes the tool to a JSON map.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited