Skip to content

Update Default value of Oversample for bbq #127134

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 13 commits into from
Apr 28, 2025
Merged

Update Default value of Oversample for bbq #127134

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
54e2ba2
Unit test to validate default behavior
Samiul-TheSoccerFan Apr 22, 2025
70db95c
adding default value to oversample for bbq
Samiul-TheSoccerFan Apr 22, 2025
99c0904
Fix code style issue
Samiul-TheSoccerFan Apr 22, 2025
33bc393
Update docs/changelog/127134.yaml
Samiul-TheSoccerFan Apr 23, 2025
4009c63
Update changelog
Samiul-TheSoccerFan Apr 23, 2025
d7661c4
Adding index version to support only new indices
Samiul-TheSoccerFan Apr 23, 2025
278ad0e
Update index version name to better match
Samiul-TheSoccerFan Apr 23, 2025
6875dc1
Adding a simple yaml test to verify the yaml functionality for oversa…
Samiul-TheSoccerFan Apr 23, 2025
2251693
merge from main
Samiul-TheSoccerFan Apr 23, 2025
964fa6b
Refactor knn float to add rescore vector by default when index type i…
Samiul-TheSoccerFan Apr 24, 2025
0d0c24c
adding yaml tests to verify oversampel default value
Samiul-TheSoccerFan Apr 25, 2025
16a212b
Merge remote-tracking branch 'upstream/main' into update_default_over…
Samiul-TheSoccerFan Apr 25, 2025
bc780d8
Fixing format issue for not_exists
Samiul-TheSoccerFan Apr 25, 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
11 changes: 11 additions & 0 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 @@ -131,6 +131,7 @@ public static boolean isNotUnitVector(float magnitude) {
// vector
public static final int MAGNITUDE_BYTES = 4;
public static final int OVERSAMPLE_LIMIT = 10_000; // Max oversample allowed
private static final float DEFAULT_OVERSAMPLE = 3.0F; // Default oversample value

private static DenseVectorFieldMapper toType(FieldMapper in) {
return (DenseVectorFieldMapper) in;
Expand Down Expand Up @@ -1462,6 +1463,9 @@ public IndexOptions parseIndexOptions(String fieldName, Map<String, ?> indexOpti
RescoreVector rescoreVector = null;
if (indexVersion.onOrAfter(ADD_RESCORE_PARAMS_TO_QUANTIZED_VECTORS)) {
rescoreVector = RescoreVector.fromIndexOptions(indexOptionsMap, indexVersion);
if (rescoreVector == null) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should only happen on new indices. Please add a new index version to bar changing this on existing indices.

rescoreVector = new RescoreVector(DEFAULT_OVERSAMPLE);
}
}
MappingParser.checkNoRemainingFields(fieldName, indexOptionsMap);
return new BBQHnswIndexOptions(m, efConstruction, rescoreVector);
Expand All @@ -1483,6 +1487,9 @@ public IndexOptions parseIndexOptions(String fieldName, Map<String, ?> indexOpti
RescoreVector rescoreVector = null;
if (indexVersion.onOrAfter(ADD_RESCORE_PARAMS_TO_QUANTIZED_VECTORS)) {
rescoreVector = RescoreVector.fromIndexOptions(indexOptionsMap, indexVersion);
if (rescoreVector == null) {
rescoreVector = new RescoreVector(DEFAULT_OVERSAMPLE);
}
}
MappingParser.checkNoRemainingFields(fieldName, indexOptionsMap);
return new BBQFlatIndexOptions(rescoreVector);
Expand Down Expand Up @@ -2311,6 +2318,10 @@ int getVectorDimensions() {
ElementType getElementType() {
return elementType;
}

IndexOptions getIndexOptions() {
return indexOptions;
}
}

private final IndexOptions indexOptions;
Expand Down
54 changes: 54 additions & 0 deletions server/src/test/java/org/elasticsearch/index/mapper/vectors/DenseVectorFieldMapperTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1022,6 +1022,60 @@ public void testInvalidRescoreVector() {
}
}

public void testDefaultOversampleValue() throws IOException {
{
DocumentMapper mapperService = createDocumentMapper(fieldMapping(b -> {
b.field("type", "dense_vector");
b.field("dims", 128);
b.field("index", true);
b.field("similarity", "dot_product");
b.startObject("index_options");
b.field("type", "bbq_hnsw");
b.endObject();
}));

DenseVectorFieldMapper denseVectorFieldMapper = (DenseVectorFieldMapper) mapperService.mappers().getMapper("field");
DenseVectorFieldMapper.BBQHnswIndexOptions indexOptions = (DenseVectorFieldMapper.BBQHnswIndexOptions) denseVectorFieldMapper
.fieldType()
.getIndexOptions();
assertEquals(3.0F, indexOptions.rescoreVector.oversample(), 0.0F);
}
{
DocumentMapper mapperService = createDocumentMapper(fieldMapping(b -> {
b.field("type", "dense_vector");
b.field("dims", 128);
b.field("index", true);
b.field("similarity", "dot_product");
b.startObject("index_options");
b.field("type", "bbq_flat");
b.endObject();
}));

DenseVectorFieldMapper denseVectorFieldMapper = (DenseVectorFieldMapper) mapperService.mappers().getMapper("field");
DenseVectorFieldMapper.BBQFlatIndexOptions indexOptions = (DenseVectorFieldMapper.BBQFlatIndexOptions) denseVectorFieldMapper
.fieldType()
.getIndexOptions();
assertEquals(3.0F, indexOptions.rescoreVector.oversample(), 0.0F);
}
{
DocumentMapper mapperService = createDocumentMapper(fieldMapping(b -> {
b.field("type", "dense_vector");
b.field("dims", 128);
b.field("index", true);
b.field("similarity", "dot_product");
b.startObject("index_options");
b.field("type", "int8_hnsw");
b.endObject();
}));

DenseVectorFieldMapper denseVectorFieldMapper = (DenseVectorFieldMapper) mapperService.mappers().getMapper("field");
DenseVectorFieldMapper.Int8HnswIndexOptions indexOptions = (DenseVectorFieldMapper.Int8HnswIndexOptions) denseVectorFieldMapper
.fieldType()
.getIndexOptions();
assertNull(indexOptions.rescoreVector);
}
}

public void testDims() {
{
Exception e = expectThrows(MapperParsingException.class, () -> createMapperService(fieldMapping(b -> {
Expand Down