VLMResult class

VLM generation result. Sources pre-IDL: Swift VLMTypes.swift:208 (text, promptTokens, completionTokens, totalTimeMs as Double, tokensPerSecond) Kotlin VLMTypes.kt:120 (text, promptTokens, imageTokens, completionTokens, totalTokens, timeToFirstTokenMs, imageEncodeTimeMs, totalTimeMs, tokensPerSecond) Dart vlm_types.dart:68 (text, promptTokens, completionTokens, totalTimeMs, tokensPerSecond) RN VLMTypes.ts:28 (text, promptTokens, completionTokens, totalTimeMs, tokensPerSecond) Web VLMTypes.ts:38 (VLMGenerationResult: text, promptTokens, imageTokens, completionTokens, totalTokens, timeToFirstTokenMs, imageEncodeTimeMs, totalTimeMs, tokensPerSecond, hardwareUsed) C ABI rac_vlm_types.h:268 (text, prompt_tokens, image_tokens, completion_tokens, total_tokens, time_to_first_token_ms, image_encode_time_ms, total_time_ms, tokens_per_second)

Streaming note: the VLM service emits VLMStreamEvent messages for per-token deltas and terminal results; this aggregate result is carried on the unary Generate RPC and on terminal stream events.

Available extensions

GeneratedMessageGenericExtensions

Constructors

VLMResult({String? text, int? promptTokens, int? completionTokens, Int64? totalTokens, Int64? processingTimeMs, double? tokensPerSecond, int? imageTokens, Int64? timeToFirstTokenMs, Int64? imageEncodeTimeMs, String? hardwareUsed, String? errorMessage, int? errorCode, String? finishReason, int? imagesProcessed}): factory
VLMResult.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]): factory
VLMResult.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]): factory

Properties

completionTokens ↔ int: getter/setter pair
errorCode ↔ int: getter/setter pair
errorMessage ↔ String: getter/setter pair
finishReason ↔ String: getter/setter pair
hardwareUsed ↔ String: getter/setter pair
hashCode → int: Calculates a hash code based on the contents of the protobuf.
no setterinherited
imageEncodeTimeMs ↔ Int64: getter/setter pair
imagesProcessed ↔ int: getter/setter pair
imageTokens ↔ int: Detailed VLM metrics from Kotlin/Web/C ABI.
getter/setter pair
info_ → BuilderInfo: no setter
isFrozen → bool: Returns true if this message is marked read-only. Otherwise false.
no setterinherited
processingTimeMs ↔ Int64: getter/setter pair
promptTokens ↔ int: getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
text ↔ String: getter/setter pair
timeToFirstTokenMs ↔ Int64: getter/setter pair
tokensPerSecond ↔ double: Swift VLMResult totalTimeMs (Double ms).
getter/setter pair
totalTokens ↔ Int64: 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
clearCompletionTokens() → 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
clearFinishReason() → void
clearHardwareUsed() → void
clearImageEncodeTimeMs() → void
clearImagesProcessed() → void
clearImageTokens() → void
clearProcessingTimeMs() → void
clearPromptTokens() → void
clearText() → void
clearTimeToFirstTokenMs() → void
clearTokensPerSecond() → void
clearTotalTokens() → void
clone() → VLMResult: Creates a deep copy of the fields in this message.
copyWith(void updates(VLMResult)) → VLMResult: Apply updates to a copy of this message.
createEmptyInstance() → VLMResult: 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
hasCompletionTokens() → bool
hasErrorCode() → bool
hasErrorMessage() → 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
hasFinishReason() → bool
hasHardwareUsed() → bool
hasImageEncodeTimeMs() → bool
hasImagesProcessed() → bool
hasImageTokens() → bool
hasProcessingTimeMs() → bool
hasPromptTokens() → bool
hasRequiredFields() → bool: Whether the message has required fields.
inherited
hasText() → bool
hasTimeToFirstTokenMs() → bool
hasTokensPerSecond() → 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 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
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() → VLMResult
getDefault() → VLMResult