AIFunction class abstract
Represents a function that can be invoked by an AI model.
- Inheritance
- Implementers
Constructors
-
AIFunction({required String? name, String? description, Map<
String, dynamic> ? parametersSchema, Map<String, dynamic> ? returnSchema, bool? isStrict}) - Creates a new AIFunction.
Properties
- additionalProperties ↔ AdditionalPropertiesDictionary?
-
Additional properties.
getter/setter pairinherited
- description → String?
-
A description of the tool.
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- isStrict → bool?
-
Whether the function requires strict schema adherence.
final
- name → String
-
The name of the tool.
finalinherited
-
parametersSchema
→ Map<
String, dynamic> ? -
The JSON schema describing the function's parameters.
final
-
returnSchema
→ Map<
String, dynamic> ? -
The JSON schema describing the function's return value.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
getService<
T> ({Object? key}) → T? -
Gets a service of the specified type.
inherited
-
invoke(
AIFunctionArguments? arguments, {CancellationToken? cancellationToken}) → Future< Object?> -
Invokes the function with the given
arguments. -
invokeCore(
AIFunctionArguments arguments, {CancellationToken? cancellationToken}) → Future< Object?> - Core implementation of function invocation.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited