[ML] Replace "text embedding" with "dense embedding" #136321
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The name "text embedding" is used in many places where dense vector embeddings are handled, despite the type of the embedding vector not being exclusive to text embeddings. For example, image or multimodal embeddings may also produce a dense vector. To allow future reuse of classes related to dense vectors with multimodal embeddings, the naming is being changed to the more general "dense embedding". Classes which explicitly relate to text embeddings are not being renamed. This rename is internal to the code only and does not change the name of any JSON objects which currently use "text_embedding", as doing so would be a breaking change. - For everything not exclusively related to text embedding, rename classes, methods and variables to use "dense embedding" instead of "text embedding" - Use correct class name in ElasticTextEmbeddingPayload.TextEmbeddingFloat.PARSER - Correct the javadoc in DenseEmbeddingBitResults
DonalEvans
added
>refactoring
:ml
Collaborator
|
Pinging @elastic/ml-core (Team:ML) |
DonalEvans
commented
Oct 9, 2025
Comment on lines
-202
to
+203
| private static final ConstructingObjectParser<TextEmbeddingFloatResults, Void> PARSER = new ConstructingObjectParser<>( | ||
| TextEmbeddingByteResults.class.getSimpleName(), | ||
| private static final ConstructingObjectParser<DenseEmbeddingFloatResults, Void> PARSER = new ConstructingObjectParser<>( | ||
| DenseEmbeddingFloatResults.class.getSimpleName(), |
Contributor
Author
There was a problem hiding this comment.
This parser was previously using the incorrect class name, which would have led to any errors encountered when parsing to report the wrong class.
davidkyle
approved these changes
Oct 13, 2025
| namedWriteables.add(new NamedWriteableRegistry.Entry(InferenceResults.class, TextExpansionResults.NAME, TextExpansionResults::new)); | ||
| namedWriteables.add( | ||
| new NamedWriteableRegistry.Entry(InferenceResults.class, MlTextEmbeddingResults.NAME, MlTextEmbeddingResults::new) | ||
| new NamedWriteableRegistry.Entry(InferenceResults.class, MlDenseEmbeddingResults.NAME, MlDenseEmbeddingResults::new) |
Member
There was a problem hiding this comment.
++ this is why NAME can't change
| + embedding.embeddings().get(0).getClass().getName() | ||
| + ". Expected TextEmbeddingFloatResults.Embedding or TextEmbeddingByteResults.Embedding." | ||
| + ". Expected " | ||
| + DenseEmbeddingFloatResults.Embedding.class.getName() |
Member
There was a problem hiding this comment.
getSimpleName() is the class name without the package prefix and and is a bit more readable
Suggested change
| + DenseEmbeddingFloatResults.Embedding.class.getName() | |
| + DenseEmbeddingFloatResults.Embedding.class.getSimpleName() |
| "Validation call did not return expected results type." | ||
| + "Expected a result of type [" | ||
| + TextEmbeddingFloatResults.NAME | ||
| + DenseEmbeddingFloatResults.NAME |
Member
There was a problem hiding this comment.
Suggested change
| + DenseEmbeddingFloatResults.NAME | |
| + DenseEmbeddingResults.NAME |
The name without the specific element type
Contributor
Author
There was a problem hiding this comment.
DenseEmbeddingResults is an interface, so it doesn't have a NAME constant, so I'll use the simple class name instead.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The name "text embedding" is used in many places where dense vector embeddings are handled, despite the type of the embedding vector not being exclusive to text embeddings. For example, image or multimodal embeddings may also produce a dense vector. To allow future reuse of classes related to dense vectors with multimodal embeddings, the naming is being changed to the more general "dense embedding". Classes which explicitly relate to text embeddings are not being renamed.
This rename is internal to the code only and does not change the name of any JSON objects which currently use "text_embedding", as doing so would be a breaking change.