EmbeddingsOptions class

Per-call overrides. Unset fields fall back to the loaded bundle's defaults.

Available extensions

Constructors

EmbeddingsOptions({bool? truncate, int? batchSize, bool? normalize, EmbeddingsPoolingStrategy? pooling, int? nThreads, EmbeddingsInputType? inputType, int? dimensions})
factory
EmbeddingsOptions.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
EmbeddingsOptions.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

batchSize ↔ int
Unset = backend chooses (512, capped at 8192).
getter/setter pair
dimensions ↔ int
Matryoshka (MRL) output width: truncate each vector to this many floats and re-normalize. Unset = the model's native width. Accepts any width in 1, the native width; a width the model was not MRL-trained at is silently worse. This is the request-side width — EmbeddingsResult.dimension reports the width actually produced.
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setter
inputType ↔ EmbeddingsInputType
What the vector will be used for. Asymmetric embedders (bge, e5, nomic-embed, gte, EmbeddingGemma) prepend a different prompt for a query than for a document. The prefix table must be added to the model manifest as part of honouring this field; it does not exist today. A bundle that declares no prompts ignores input_type and returns the identical vector for QUERY and DOCUMENT — it never errors.
getter/setter pair
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
normalize ↔ bool
L2-normalize every vector to unit length (what cosine search expects). Unset = true. false returns the raw pooled vector.
getter/setter pair
nThreads ↔ int
getter/setter pair
pooling ↔ EmbeddingsPoolingStrategy
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
truncate ↔ bool
true = clip an over-long input to the model's context and embed it. false = fail the call. Unset = true. A backend may instead aggregate over a sliding window, which embeds the whole document rather than discarding its tail.
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
clearBatchSize() → void
clearDimensions() → 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
clearInputType() → void
clearNormalize() → void
clearNThreads() → void
clearPooling() → void
clearTruncate() → void
clone() → EmbeddingsOptions
Creates a deep copy of the fields in this message.
copyWith(void updates(EmbeddingsOptions)) → EmbeddingsOptions
Apply updates to a copy of this message.
createEmptyInstance() → EmbeddingsOptions
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
hasBatchSize() → bool
hasDimensions() → 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
hasInputType() → bool
hasNormalize() → bool
hasNThreads() → bool
hasPooling() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasTruncate() → 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 EmbeddingsOptions, provided by the EmbeddingsOptionsValidate 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