RAGResult class
RAGResult — the full result of a RAG query.
- Available extensions
Constructors
-
RAGResult({String? answer, Iterable<
RAGSearchResult> ? retrievedChunks, String? contextUsed, Int64? retrievalTimeMs, Int64? generationTimeMs, Int64? totalTimeMs, int? promptTokens, int? completionTokens, int? totalTokens, String? errorMessage, int? errorCode, String? requestId, String? thinkingContent}) -
factory
-
RAGResult.fromBuffer(List<
int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]) -
factory
- RAGResult.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- answer ↔ String
-
The LLM-generated answer grounded in the retrieved context.
getter/setter pair
- completionTokens ↔ int
-
getter/setter pair
- contextUsed ↔ String
-
Full context string passed to the LLM (chunks joined into a prompt).
May be empty for queries with no matching chunks.
getter/setter pair
- errorCode ↔ int
-
getter/setter pair
- errorMessage ↔ String
-
getter/setter pair
- generationTimeMs ↔ Int64
-
Time spent in the LLM generation phase, in milliseconds.
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
trueif this message is marked read-only. Otherwisefalse.no setterinherited - promptTokens ↔ int
-
getter/setter pair
- requestId ↔ String
-
getter/setter pair
- retrievalTimeMs ↔ Int64
-
Time spent in the retrieval phase (vector search), in milliseconds.
getter/setter pair
-
retrievedChunks
→ PbList<
RAGSearchResult> -
Document chunks retrieved during vector search and used as context.
Order matches retrieval rank (highest similarity first).
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- thinkingContent ↔ String
-
Optional thinking/reasoning content extracted from the answer.
getter/setter pair
- totalTime → Duration
-
Available on RAGResult, provided by the RAGResultTimeConvenience extension
no setter - totalTimeMs ↔ Int64
-
Total end-to-end query time (retrieval + generation + overhead),
in milliseconds.
getter/setter pair
- totalTokens ↔ int
-
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
-
clearAnswer(
) → void -
clearCompletionTokens(
) → void -
clearContextUsed(
) → void -
clearErrorCode(
) → void -
clearErrorMessage(
) → 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
-
clearGenerationTimeMs(
) → void -
clearPromptTokens(
) → void -
clearRequestId(
) → void -
clearRetrievalTimeMs(
) → void -
clearThinkingContent(
) → void -
clearTotalTimeMs(
) → void -
clearTotalTokens(
) → void -
clone(
) → RAGResult - Creates a deep copy of the fields in this message.
-
copyWith(
void updates(RAGResult)) → RAGResult -
Apply
updatesto a copy of this message. -
createEmptyInstance(
) → RAGResult - 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
-
hasAnswer(
) → bool -
hasCompletionTokens(
) → bool -
hasContextUsed(
) → bool -
hasErrorCode(
) → bool -
hasErrorMessage(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
trueif a value ofextensionis present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber.inherited -
hasGenerationTimeMs(
) → bool -
hasPromptTokens(
) → bool -
hasRequestId(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasRetrievalTimeMs(
) → bool -
hasThinkingContent(
) → bool -
hasTotalTimeMs(
) → bool -
hasTotalTokens(
) → 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 aCodedBufferReaderinput.inherited -
mergeFromJson(
String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from
data, a JSON object, encoded as described byGeneratedMessage.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
otherinto 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
Applyupdatesto 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
-
writeToBuffer(
) → Uint8List -
Serialize the message as the protobuf binary format.
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
Same as
writeToBuffer, but serializes to the givenCodedBufferWriter.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(
) → RAGResult -
getDefault(
) → RAGResult