EmbeddingKind enum
Distinguishes indexing-time ("document") text from query-time ("query") text passed to EmbeddingModel.embed.
Some models (e.g. multilingual-e5-small) require a fixed textual prefix
("passage: " / "query: ") depending on which side of retrieval the
text is on — encoding a query the same way as a document degrades
retrieval quality for those models. EmbeddingKind lets a caller state
which side it's on without needing to know whether the loaded model
actually requires a prefix; models that don't need one (e.g.
bge-small-en-v1.5) simply ignore it.
Values
- document → const EmbeddingKind
-
Text being indexed (inserted or updated) into a vector index.
- query → const EmbeddingKind
-
Text used to query a vector index for nearest neighbours.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- index → int
-
A numeric identifier for the enumerated value.
no setterinherited
- name → String
-
Available on Enum, provided by the EnumName extension
The name of the enum value.no setter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
-
values
→ const List<
EmbeddingKind> - A constant List of the values in this enum, in order of their declaration.