AdvisorTool class

Consults a higher-intelligence advisor model mid-generation for guidance.

Inheritance

Constructors

AdvisorTool({bool? forwardTranscript, String? instructions, int? maxCompletionTokens, int? maxToolCalls, String? model, String? name, ReasoningEffort? reasoningEffort, int? maxReasoningTokens, bool? stream, double? temperature, List<OpenRouterServerTool>? tools, Map<String, dynamic>? additionalProperties})
consults a higher-intelligence advisor model (any OpenRouter model) for guidance mid-generation and returns its response. The advisor may run as a sub-agent with its own tools. Include multiple entries to offer several named advisors; at most one entry may omit name to act as the default advisor.

Properties

additionalProperties → Map<String, dynamic>?
Extra properties merged into the serialized tool.
final
forwardTranscript → bool?
Whether the full parent conversation is forwarded to the advisor.
final
hashCode → int
The hash code for this object.
no setterinherited
instructions → String?
System instructions for the advisor sub-agent.
final
maxCompletionTokens → int?
Maximum number of tokens in the advisor's output.
final
maxReasoningTokens → int?
Maximum number of reasoning tokens the advisor may use.
final
maxToolCalls → int?
Maximum number of tool-calling steps the advisor may take.
final
model → String?
The advisor model to consult (any OpenRouter model).
final
name → String?
The name for this advisor.
final
reasoningEffort → ReasoningEffort?
The reasoning effort configuration for the advisor call.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stream → bool?
Whether the advisor's advice streams incrementally.
final
temperature → double?
Sampling temperature for the advisor call.
final
tools → List<OpenRouterServerTool>?
List of tools the advisor sub-agent may use.
final
type → String
tool type
finalinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Serializes this advisor tool to its JSON representation.
override
toString() → String
A string representation of this object.
inherited

Operators

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