RAGQueryOptions class

RAGQueryOptions — per-query sampling and prompt overrides.

Available extensions

Constructors

RAGQueryOptions({String? question, String? systemPrompt, int? maxTokens, double? temperature, double? topP, int? topK, int? retrievalTopK, double? similarityThreshold, bool? stream, bool? disableThinking, bool? enableMultiQuery, int? multiQueryCount, String? scopePrefix})
factory
RAGQueryOptions.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
RAGQueryOptions.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

disableThinking ↔ bool
When true, suppress the answer model's thinking phase (maps to LLMGenerationOptions.disable_thinking so commons prepends the no-think directive instead of the app injecting "/no_think"). Default false.
getter/setter pair
enableMultiQuery ↔ bool
Multi-query expansion: when true, the answer LLM rewrites the question into multi_query_count variants; retrieval runs for the original plus each variant and the rankings are RRF-fused before rerank. Falls back to a single query if expansion yields nothing.
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setter
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
maxTokens ↔ int
Maximum tokens to generate in the answer.
getter/setter pair
multiQueryCount ↔ int
getter/setter pair
question ↔ String
The user question to answer. Required (empty = no-op).
getter/setter pair
retrievalTopK ↔ int
Retrieval overrides. 0/unset = use RAGConfiguration defaults.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scopePrefix ↔ String
Scoped retrieval: when set, only chunks whose document id begins with this prefix are eligible (e.g. a chat/collection namespace). Unset = search the whole index.
getter/setter pair
similarityThreshold ↔ double
Per-query similarity floor. optional so an explicit 0.0 (accept everything) is distinguishable from "unset" and can override a positive session-level default; unset falls back to RAGConfiguration.
getter/setter pair
stream ↔ bool
getter/setter pair
systemPrompt ↔ String
Optional system prompt override. Unset uses the pipeline default.
getter/setter pair
temperature ↔ double
Sampling temperature. 0.0 = greedy, higher = more random.
getter/setter pair
topK ↔ int
Top-k sampling parameter. 0 = disabled.
getter/setter pair
topP ↔ double
Nucleus (top-p) sampling parameter. 1.0 = disabled.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
Throws a StateError if the message has required fields without a value.
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearDisableThinking() → void
clearEnableMultiQuery() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearMaxTokens() → void
clearMultiQueryCount() → void
clearQuestion() → void
clearRetrievalTopK() → void
clearScopePrefix() → void
clearSimilarityThreshold() → void
clearStream() → void
clearSystemPrompt() → void
clearTemperature() → void
clearTopK() → void
clearTopP() → void
clone() → RAGQueryOptions
Creates a deep copy of the fields in this message.
copyWith(void updates(RAGQueryOptions)) → RAGQueryOptions
Apply updates to a copy of this message.
createEmptyInstance() → RAGQueryOptions
Creates an empty instance of the same message type as this.
deepCopy() → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Returns a writable deep copy of this message.
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasDisableThinking() → bool
hasEnableMultiQuery() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasMaxTokens() → bool
hasMultiQueryCount() → bool
hasQuestion() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasRetrievalTopK() → bool
hasScopePrefix() → bool
hasSimilarityThreshold() → bool
hasStream() → bool
hasSystemPrompt() → bool
hasTemperature() → bool
hasTopK() → bool
hasTopP() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Same as mergeFromBuffer, but takes a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(void updates(T)) → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Apply updates to a copy of this message.
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
validate() → void

Available on RAGQueryOptions, provided by the RAGQueryOptionsValidate extension

writeToBuffer() → Uint8List
Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
Same as writeToBuffer, but serializes to the given CodedBufferWriter.
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

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

Static Methods

create() → RAGQueryOptions
getDefault() → RAGQueryOptions