Skip to content

Fix default index options when dimensions are unset for legacy indices #130540

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 3, 2025
Merged

Fix default index options when dimensions are unset for legacy indices #130540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0a6dd4a
Fix default index options when dimensions are unset for legacy indices
jimczi Jul 3, 2025
c605af0
fix boolean logic
jimczi Jul 3, 2025
03537e6
fix index creation yaml
jimczi Jul 3, 2025
c2654ee
Merge branch 'main' into default_dense_vector_dims
jimczi Jul 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/40_knn_search.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -605,6 +605,40 @@ setup:
- match: { hits.hits.0._score: $knn_score0 }
- match: { hits.hits.1._score: $knn_score1 }
- match: { hits.hits.2._score: $knn_score2 }

---
"Dimensions are dynamically set":
- do:
indices.create:
index: test_index
body:
mappings:
properties:
embedding:
type: dense_vector

- do:
index:
index: test_index
id: "0"
body:
embedding: [ 0.5, 111.3, -13.0, 14.8, -156.0 ]

- do:
indices.get_mapping:
index: test_index

- match: { test_index.mappings.properties.embedding.type: dense_vector }
- match: { test_index.mappings.properties.embedding.dims: 5 }

- do:
catch: bad_request
index:
index: test_index
id: "0"
body:
embedding: [ 0.5, 111.3 ]

---
"Updating dim to null is not allowed":
- requires:
Expand Down
87 changes: 31 additions & 56 deletions server/src/main/java/org/elasticsearch/index/mapper/vectors/DenseVectorFieldMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,9 @@ public Builder(String name, IndexVersion indexVersionCreated) {
|| previous.updatableTo(current)
);
if (defaultInt8Hnsw || defaultBBQ8Hnsw) {
this.indexOptions.alwaysSerialize();
if (defaultBBQ8Hnsw == false || (dims != null && dims.isConfigured())) {
this.indexOptions.alwaysSerialize();
}
}
this.indexed.addValidator(v -> {
if (v) {
Expand All @@ -365,21 +367,31 @@ public Builder(String name, IndexVersion indexVersionCreated) {
}

private DenseVectorIndexOptions defaultIndexOptions(boolean defaultInt8Hnsw, boolean defaultBBQHnsw) {
if (this.dims != null && this.dims.isConfigured() && elementType.getValue() == ElementType.FLOAT && this.indexed.getValue()) {
if (defaultBBQHnsw && this.dims.getValue() >= BBQ_DIMS_DEFAULT_THRESHOLD) {
return new BBQHnswIndexOptions(
Lucene99HnswVectorsFormat.DEFAULT_MAX_CONN,
Lucene99HnswVectorsFormat.DEFAULT_BEAM_WIDTH,
new RescoreVector(DEFAULT_OVERSAMPLE)
);
} else if (defaultInt8Hnsw) {
return new Int8HnswIndexOptions(
Lucene99HnswVectorsFormat.DEFAULT_MAX_CONN,
Lucene99HnswVectorsFormat.DEFAULT_BEAM_WIDTH,
null,
null
);
}
if (elementType.getValue() != ElementType.FLOAT || indexed.getValue() == false) {
return null;
}

boolean dimIsConfigured = dims != null && dims.isConfigured();
if (defaultBBQHnsw && dimIsConfigured == false) {
// Delay selecting the default index options until dimensions are configured.
// This applies only to indices that are eligible to use BBQ as the default,
// since prior to this change, the default was selected eagerly.
return null;
}

if (defaultBBQHnsw && dimIsConfigured && dims.getValue() >= BBQ_DIMS_DEFAULT_THRESHOLD) {
return new BBQHnswIndexOptions(
Lucene99HnswVectorsFormat.DEFAULT_MAX_CONN,
Lucene99HnswVectorsFormat.DEFAULT_BEAM_WIDTH,
new RescoreVector(DEFAULT_OVERSAMPLE)
);
} else if (defaultInt8Hnsw) {
return new Int8HnswIndexOptions(
Lucene99HnswVectorsFormat.DEFAULT_MAX_CONN,
Lucene99HnswVectorsFormat.DEFAULT_BEAM_WIDTH,
null,
null
);
}
return null;
}
Expand Down Expand Up @@ -2853,46 +2865,9 @@ public void parse(DocumentParserContext context) throws IOException {
}
if (fieldType().dims == null) {
int dims = fieldType().elementType.parseDimensionCount(context);
final boolean defaultInt8Hnsw = indexCreatedVersion.onOrAfter(IndexVersions.DEFAULT_DENSE_VECTOR_TO_INT8_HNSW);
final boolean defaultBBQ8Hnsw = indexCreatedVersion.onOrAfter(IndexVersions.DEFAULT_DENSE_VECTOR_TO_BBQ_HNSW);
DenseVectorIndexOptions denseVectorIndexOptions = fieldType().indexOptions;
if (denseVectorIndexOptions == null && fieldType().getElementType() == ElementType.FLOAT && fieldType().isIndexed()) {
if (defaultBBQ8Hnsw && dims >= BBQ_DIMS_DEFAULT_THRESHOLD) {
denseVectorIndexOptions = new BBQHnswIndexOptions(
Lucene99HnswVectorsFormat.DEFAULT_MAX_CONN,
Lucene99HnswVectorsFormat.DEFAULT_BEAM_WIDTH,
new RescoreVector(DEFAULT_OVERSAMPLE)
);
} else if (defaultInt8Hnsw) {
denseVectorIndexOptions = new Int8HnswIndexOptions(
Lucene99HnswVectorsFormat.DEFAULT_MAX_CONN,
Lucene99HnswVectorsFormat.DEFAULT_BEAM_WIDTH,
null,
null
);
}
}
if (denseVectorIndexOptions != null) {
denseVectorIndexOptions.validateDimension(dims);
}
DenseVectorFieldType updatedDenseVectorFieldType = new DenseVectorFieldType(
fieldType().name(),
indexCreatedVersion,
fieldType().elementType,
dims,
fieldType().indexed,
fieldType().similarity,
denseVectorIndexOptions,
fieldType().meta(),
fieldType().isSyntheticSource
);
Mapper update = new DenseVectorFieldMapper(
leafName(),
updatedDenseVectorFieldType,
builderParams,
denseVectorIndexOptions,
indexCreatedVersion
);
DenseVectorFieldMapper.Builder builder = (Builder) getMergeBuilder();
builder.dimensions(dims);
Mapper update = builder.build(context.createDynamicMapperBuilderContext());
context.addDynamicMapper(update);
return;
}
Expand Down