TuulOptions class

The master configuration class for Tuul AI requests.

Use this class to define the prompt, target agent, session metadata, and specific model abilities for a generation task.

Available extensions

Constructors

TuulOptions({required PromptOptions promptOptions, StateOptions? stateOptions, SessionOptions? sessionOptions, AgentOptions? agentOptions, AbilityOptions? abilityOptions})
TuulOptions.fromJson(Map<String, dynamic> json)
Creates a TuulOptions instance from a JSON map.
factory

Properties

abilityOptions AbilityOptions?
final
agentOptions AgentOptions?
final
hashCode int
The hash code for this object.
no setterinherited
promptOptions PromptOptions
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
sessionOptions SessionOptions?
final
stateOptions StateOptions?
final

Methods

copyWith({PromptOptions? promptOptions, StateOptions? stateOptions, SessionOptions? sessionOptions, AgentOptions? agentOptions, AbilityOptions? abilityOptions}) TuulOptions
Returns a copy of the current options with specific fields replaced.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
Converts the configuration into a JSON map for API consumption.
toString() String
A string representation of this object.
inherited
validate() → void

Available on TuulOptions, provided by the TuulOptionsValidator extension

Validates the current TuulOptions instance and all its nested properties.

Operators

operator ==(Object other) bool
The equality operator.
inherited