From ef8ac8cdf8a092d1ff6167458aac5daecd50e5be Mon Sep 17 00:00:00 2001 From: carlosdelest Date: Thu, 5 Dec 2024 16:47:23 +0100 Subject: [PATCH] Rename "rescore" to "rescore_vector" --- .../test/search.vectors/210_knn_search_profile.yml | 4 ++-- .../rest-api-spec/test/search.vectors/40_knn_search.yml | 2 +- .../test/search.vectors/41_knn_search_bbq_hnsw.yml | 2 +- .../test/search.vectors/41_knn_search_byte_quantized.yml | 2 +- .../search.vectors/41_knn_search_half_byte_quantized.yml | 2 +- .../test/search.vectors/42_knn_search_bbq_flat.yml | 2 +- .../test/search.vectors/42_knn_search_flat.yml | 2 +- .../test/search.vectors/42_knn_search_int4_flat.yml | 2 +- .../test/search.vectors/42_knn_search_int8_flat.yml | 2 +- .../rest-api-spec/test/search.vectors/45_knn_search_bit.yml | 2 +- .../test/search.vectors/45_knn_search_bit_flat.yml | 2 +- .../test/search.vectors/45_knn_search_byte.yml | 2 +- .../elasticsearch/search/retriever/KnnRetrieverBuilder.java | 6 +++--- .../org/elasticsearch/search/vectors/KnnSearchBuilder.java | 6 +++--- .../elasticsearch/search/vectors/KnnVectorQueryBuilder.java | 6 +++--- .../elasticsearch/search/vectors/RescoreVectorBuilder.java | 2 +- 16 files changed, 23 insertions(+), 23 deletions(-) diff --git a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/210_knn_search_profile.yml b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/210_knn_search_profile.yml index b642f2def53bf..ee66e1aa92213 100644 --- a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/210_knn_search_profile.yml +++ b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/210_knn_search_profile.yml @@ -104,7 +104,7 @@ setup: query_vector: [ 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0 ] k: 3 num_candidates: 3 - "rescore": + "rescore_vector": "oversample": 2.0 # We expect the knn search ops + rescoring num_cnaidates (for rescoring) per shard @@ -122,7 +122,7 @@ setup: k: 3 num_candidates: 3 similarity: 100000.0 - "rescore": + "rescore_vector": "oversample": 2.0 # We expect the knn search ops + rescoring num_cnaidates (for rescoring) per shard diff --git a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/40_knn_search.yml b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/40_knn_search.yml index e3179a0065c2e..82b1d0740070b 100644 --- a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/40_knn_search.yml +++ b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/40_knn_search.yml @@ -588,7 +588,7 @@ setup: query_vector: [-0.5, 90.0, -10, 14.8, -156.0] k: 3 num_candidates: 3 - rescore: + rescore_vector: oversample: 1.5 # Compare scores as hit IDs may change depending on how things are distributed diff --git a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/41_knn_search_bbq_hnsw.yml b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/41_knn_search_bbq_hnsw.yml index 92b882892cee4..f4cdd8b50ac4b 100644 --- a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/41_knn_search_bbq_hnsw.yml +++ b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/41_knn_search_bbq_hnsw.yml @@ -112,7 +112,7 @@ setup: query_vector: [ 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0] k: 3 num_candidates: 3 - rescore: + rescore_vector: oversample: 1.5 # Get rescoring scores - hit ordering may change depending on how things are distributed diff --git a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/41_knn_search_byte_quantized.yml b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/41_knn_search_byte_quantized.yml index 7ff20e1beb8a5..fbf6c7c5bfdca 100644 --- a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/41_knn_search_byte_quantized.yml +++ b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/41_knn_search_byte_quantized.yml @@ -397,7 +397,7 @@ setup: num_candidates: 3 field: vector query_vector: [0.5, 111.3, -13.0, 14.8, -156.0] - rescore: + rescore_vector: oversample: 1.5 # Get rescoring scores - hit ordering may change depending on how things are distributed diff --git a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/41_knn_search_half_byte_quantized.yml b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/41_knn_search_half_byte_quantized.yml index 867e47624873f..b170cd66ceefb 100644 --- a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/41_knn_search_half_byte_quantized.yml +++ b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/41_knn_search_half_byte_quantized.yml @@ -574,7 +574,7 @@ setup: query_vector: [-0.5, 90.0, -10, 14.8] k: 3 num_candidates: 3 - rescore: + rescore_vector: oversample: 1.5 # Get rescoring scores - hit ordering may change depending on how things are distributed diff --git a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/42_knn_search_bbq_flat.yml b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/42_knn_search_bbq_flat.yml index 48560747365eb..f28ca559b423b 100644 --- a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/42_knn_search_bbq_flat.yml +++ b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/42_knn_search_bbq_flat.yml @@ -111,7 +111,7 @@ setup: query_vector: [ 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0, -0.5, 90.0, -10, 14.8, -156.0] k: 3 num_candidates: 3 - rescore: + rescore_vector: oversample: 1.5 # Get rescoring scores - hit ordering may change depending on how things are distributed diff --git a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/42_knn_search_flat.yml b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/42_knn_search_flat.yml index 9258ce99a31aa..f0529f4209288 100644 --- a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/42_knn_search_flat.yml +++ b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/42_knn_search_flat.yml @@ -303,7 +303,7 @@ setup: query_vector: [-0.5, 90.0, -10, 14.8, -156.0] k: 3 num_candidates: 3 - rescore: + rescore_vector: oversample: 1.5 # Compare scores as hit IDs may change depending on how things are distributed diff --git a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/42_knn_search_int4_flat.yml b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/42_knn_search_int4_flat.yml index 3be3cf70cdc69..dbe751c87084b 100644 --- a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/42_knn_search_int4_flat.yml +++ b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/42_knn_search_int4_flat.yml @@ -370,7 +370,7 @@ setup: query_vector: [-0.5, 90.0, -10, 14.8] k: 3 num_candidates: 3 - rescore: + rescore_vector: oversample: 1.5 # Get rescoring scores - hit ordering may change depending on how things are distributed diff --git a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/42_knn_search_int8_flat.yml b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/42_knn_search_int8_flat.yml index 282dd7df1f038..def124a8baab8 100644 --- a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/42_knn_search_int8_flat.yml +++ b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/42_knn_search_int8_flat.yml @@ -287,7 +287,7 @@ setup: query_vector: [-0.5, 90.0, -10, 14.8, -156.0] k: 3 num_candidates: 3 - rescore: + rescore_vector: oversample: 1.5 # Get rescoring scores - hit ordering may change depending on how things are distributed diff --git a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/45_knn_search_bit.yml b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/45_knn_search_bit.yml index 342b206f42a8b..0a8f045ea2e77 100644 --- a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/45_knn_search_bit.yml +++ b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/45_knn_search_bit.yml @@ -453,7 +453,7 @@ setup: query_vector: [127.0, -128.0, 0.0, 1.0, -1.0] k: 3 num_candidates: 3 - rescore: + rescore_vector: oversample: 1.5 # Compare scores as hit IDs may change depending on how things are distributed diff --git a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/45_knn_search_bit_flat.yml b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/45_knn_search_bit_flat.yml index dd8e544417fd4..65836416558b7 100644 --- a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/45_knn_search_bit_flat.yml +++ b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/45_knn_search_bit_flat.yml @@ -269,7 +269,7 @@ setup: query_vector: [127, 127, -128, -128, 127] k: 3 num_candidates: 3 - rescore: + rescore_vector: oversample: 1.5 # Compare scores as hit IDs may change depending on how things are distributed diff --git a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/45_knn_search_byte.yml b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/45_knn_search_byte.yml index 9b105813f7ec6..2f637d9ca3e6d 100644 --- a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/45_knn_search_byte.yml +++ b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/search.vectors/45_knn_search_byte.yml @@ -302,7 +302,7 @@ setup: query_vector: [127, 127, -128, -128, 127] k: 3 num_candidates: 3 - rescore: + rescore_vector: oversample: 1.5 # Compare scores as hit IDs may change depending on how things are distributed diff --git a/server/src/main/java/org/elasticsearch/search/retriever/KnnRetrieverBuilder.java b/server/src/main/java/org/elasticsearch/search/retriever/KnnRetrieverBuilder.java index 65a1b3b7e9218..b29546ded75cd 100644 --- a/server/src/main/java/org/elasticsearch/search/retriever/KnnRetrieverBuilder.java +++ b/server/src/main/java/org/elasticsearch/search/retriever/KnnRetrieverBuilder.java @@ -54,7 +54,7 @@ public final class KnnRetrieverBuilder extends RetrieverBuilder { public static final ParseField QUERY_VECTOR_FIELD = new ParseField("query_vector"); public static final ParseField QUERY_VECTOR_BUILDER_FIELD = new ParseField("query_vector_builder"); public static final ParseField VECTOR_SIMILARITY = new ParseField("similarity"); - public static final ParseField RESCORE_FIELD = new ParseField("rescore"); + public static final ParseField RESCORE_VECTOR_FIELD = new ParseField("rescore_vector"); @SuppressWarnings("unchecked") public static final ConstructingObjectParser PARSER = new ConstructingObjectParser<>( @@ -96,7 +96,7 @@ public final class KnnRetrieverBuilder extends RetrieverBuilder { PARSER.declareField( optionalConstructorArg(), (p, c) -> RescoreVectorBuilder.fromXContent(p), - RESCORE_FIELD, + RESCORE_VECTOR_FIELD, ObjectParser.ValueType.OBJECT ); RetrieverBuilder.declareBaseParserFields(NAME, PARSER); @@ -281,7 +281,7 @@ public void doToXContent(XContentBuilder builder, Params params) throws IOExcept } if (rescoreVectorBuilder != null) { - builder.field(RESCORE_FIELD.getPreferredName(), rescoreVectorBuilder); + builder.field(RESCORE_VECTOR_FIELD.getPreferredName(), rescoreVectorBuilder); } } diff --git a/server/src/main/java/org/elasticsearch/search/vectors/KnnSearchBuilder.java b/server/src/main/java/org/elasticsearch/search/vectors/KnnSearchBuilder.java index 0f89dd44367f0..b18ce2dff65cb 100644 --- a/server/src/main/java/org/elasticsearch/search/vectors/KnnSearchBuilder.java +++ b/server/src/main/java/org/elasticsearch/search/vectors/KnnSearchBuilder.java @@ -56,7 +56,7 @@ public class KnnSearchBuilder implements Writeable, ToXContentFragment, Rewritea public static final ParseField NAME_FIELD = AbstractQueryBuilder.NAME_FIELD; public static final ParseField BOOST_FIELD = AbstractQueryBuilder.BOOST_FIELD; public static final ParseField INNER_HITS_FIELD = new ParseField("inner_hits"); - public static final ParseField RESCORE_FIELD = new ParseField("rescore"); + public static final ParseField RESCORE_VECTOR_FIELD = new ParseField("rescore_vector"); @SuppressWarnings("unchecked") private static final ConstructingObjectParser PARSER = new ConstructingObjectParser<>("knn", args -> { @@ -89,7 +89,7 @@ public class KnnSearchBuilder implements Writeable, ToXContentFragment, Rewritea PARSER.declareField( optionalConstructorArg(), (p, c) -> RescoreVectorBuilder.fromXContent(p), - RESCORE_FIELD, + RESCORE_VECTOR_FIELD, ObjectParser.ValueType.OBJECT ); PARSER.declareFieldArray( @@ -547,7 +547,7 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws builder.field(NAME_FIELD.getPreferredName(), queryName); } if (rescoreVectorBuilder != null) { - builder.field(RESCORE_FIELD.getPreferredName(), rescoreVectorBuilder); + builder.field(RESCORE_VECTOR_FIELD.getPreferredName(), rescoreVectorBuilder); } return builder; diff --git a/server/src/main/java/org/elasticsearch/search/vectors/KnnVectorQueryBuilder.java b/server/src/main/java/org/elasticsearch/search/vectors/KnnVectorQueryBuilder.java index e737e354d53a7..b99dadf7f34bc 100644 --- a/server/src/main/java/org/elasticsearch/search/vectors/KnnVectorQueryBuilder.java +++ b/server/src/main/java/org/elasticsearch/search/vectors/KnnVectorQueryBuilder.java @@ -69,7 +69,7 @@ public class KnnVectorQueryBuilder extends AbstractQueryBuilder PARSER = new ConstructingObjectParser<>( "knn", @@ -104,7 +104,7 @@ public class KnnVectorQueryBuilder extends AbstractQueryBuilder RescoreVectorBuilder.fromXContent(p), - RESCORE_FIELD, + RESCORE_VECTOR_FIELD, ObjectParser.ValueType.OBJECT ); PARSER.declareFieldArray( @@ -406,7 +406,7 @@ protected void doXContent(XContentBuilder builder, Params params) throws IOExcep builder.endArray(); } if (rescoreVectorBuilder != null) { - builder.field(RESCORE_FIELD.getPreferredName(), rescoreVectorBuilder); + builder.field(RESCORE_VECTOR_FIELD.getPreferredName(), rescoreVectorBuilder); } boostAndQueryNameToXContent(builder); builder.endObject(); diff --git a/server/src/main/java/org/elasticsearch/search/vectors/RescoreVectorBuilder.java b/server/src/main/java/org/elasticsearch/search/vectors/RescoreVectorBuilder.java index 4273a85b584f4..3619553a94674 100644 --- a/server/src/main/java/org/elasticsearch/search/vectors/RescoreVectorBuilder.java +++ b/server/src/main/java/org/elasticsearch/search/vectors/RescoreVectorBuilder.java @@ -26,7 +26,7 @@ public class RescoreVectorBuilder implements Writeable, ToXContentObject { public static final ParseField OVERSAMPLE_FIELD = new ParseField("oversample"); public static final float MIN_OVERSAMPLE = 1.0F; private static final ConstructingObjectParser PARSER = new ConstructingObjectParser<>( - "rescore", + "rescore_vector", args -> new RescoreVectorBuilder((Float) args[0]) );