-
Notifications
You must be signed in to change notification settings - Fork 128
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.
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
Add parent join support for lucene knn #1182
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
202 changes: 202 additions & 0 deletions
202
src/test/java/org/opensearch/knn/index/NestedSearchIT.java
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,202 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.knn.index; | ||
|
|
||
| import lombok.SneakyThrows; | ||
| import org.apache.hc.core5.http.io.entity.EntityUtils; | ||
| import org.junit.After; | ||
| import org.opensearch.client.Request; | ||
| import org.opensearch.client.Response; | ||
| import org.opensearch.common.xcontent.XContentFactory; | ||
| import org.opensearch.core.rest.RestStatus; | ||
| import org.opensearch.core.xcontent.MediaTypeRegistry; | ||
| import org.opensearch.core.xcontent.XContentBuilder; | ||
| import org.opensearch.knn.KNNRestTestCase; | ||
| import org.opensearch.knn.index.util.KNNEngine; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| import static org.opensearch.knn.common.KNNConstants.DIMENSION; | ||
| import static org.opensearch.knn.common.KNNConstants.K; | ||
| import static org.opensearch.knn.common.KNNConstants.KNN; | ||
| import static org.opensearch.knn.common.KNNConstants.KNN_ENGINE; | ||
| import static org.opensearch.knn.common.KNNConstants.KNN_METHOD; | ||
| import static org.opensearch.knn.common.KNNConstants.METHOD_HNSW; | ||
| import static org.opensearch.knn.common.KNNConstants.METHOD_PARAMETER_EF_CONSTRUCTION; | ||
| import static org.opensearch.knn.common.KNNConstants.METHOD_PARAMETER_M; | ||
| import static org.opensearch.knn.common.KNNConstants.METHOD_PARAMETER_SPACE_TYPE; | ||
| import static org.opensearch.knn.common.KNNConstants.NAME; | ||
| import static org.opensearch.knn.common.KNNConstants.PARAMETERS; | ||
| import static org.opensearch.knn.common.KNNConstants.PATH; | ||
| import static org.opensearch.knn.common.KNNConstants.QUERY; | ||
| import static org.opensearch.knn.common.KNNConstants.TYPE; | ||
| import static org.opensearch.knn.common.KNNConstants.TYPE_KNN_VECTOR; | ||
| import static org.opensearch.knn.common.KNNConstants.TYPE_NESTED; | ||
| import static org.opensearch.knn.common.KNNConstants.VECTOR; | ||
|
|
||
| public class NestedSearchIT extends KNNRestTestCase { | ||
| private static final String INDEX_NAME = "test-index-nested-search"; | ||
| private static final String FIELD_NAME_NESTED = "test-nested"; | ||
| private static final String FIELD_NAME_VECTOR = "test-vector"; | ||
| private static final String PROPERTIES_FIELD = "properties"; | ||
| private static final int EF_CONSTRUCTION = 128; | ||
| private static final int M = 16; | ||
| private static final SpaceType SPACE_TYPE = SpaceType.L2; | ||
|
|
||
| @After | ||
| @SneakyThrows | ||
| public final void cleanUp() { | ||
| deleteKNNIndex(INDEX_NAME); | ||
| } | ||
|
|
||
| @SneakyThrows | ||
| public void testNestedSearch_whenKIsTwo_thenReturnTwoResults() { | ||
| createKnnIndex(2, KNNEngine.LUCENE.getName()); | ||
|
|
||
| String doc1 = NestedKnnDocBuilder.create(FIELD_NAME_NESTED) | ||
| .add(FIELD_NAME_VECTOR, new Float[] { 1f, 1f }, new Float[] { 1f, 1f }) | ||
| .build(); | ||
| addNestedKnnDoc(INDEX_NAME, "1", doc1); | ||
|
|
||
| String doc2 = NestedKnnDocBuilder.create(FIELD_NAME_NESTED) | ||
| .add(FIELD_NAME_VECTOR, new Float[] { 2f, 2f }, new Float[] { 2f, 2f }) | ||
| .build(); | ||
| addNestedKnnDoc(INDEX_NAME, "2", doc2); | ||
|
|
||
| Float[] queryVector = { 1f, 1f }; | ||
| Response response = queryNestedField(INDEX_NAME, 2, queryVector); | ||
|
|
||
| List<Object> hits = (List<Object>) ((Map<String, Object>) createParser( | ||
| MediaTypeRegistry.getDefaultMediaType().xContent(), | ||
| EntityUtils.toString(response.getEntity()) | ||
| ).map().get("hits")).get("hits"); | ||
| assertEquals(2, hits.size()); | ||
| } | ||
|
|
||
| /** | ||
| * { | ||
| * "properties": { | ||
| * "test-nested": { | ||
| * "type": "nested", | ||
| * "properties": { | ||
| * "test-vector": { | ||
| * "type": "knn_vector", | ||
| * "dimension": 3, | ||
| * "method": { | ||
| * "name": "hnsw", | ||
| * "space_type": "l2", | ||
| * "engine": "lucene", | ||
| * "parameters": { | ||
| * "ef_construction": 128, | ||
| * "m": 24 | ||
| * } | ||
heemin32 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * } | ||
| * } | ||
| * } | ||
| * } | ||
| * } | ||
| * } | ||
| */ | ||
| private void createKnnIndex(final int dimension, final String engine) throws Exception { | ||
| XContentBuilder builder = XContentFactory.jsonBuilder() | ||
| .startObject() | ||
| .startObject(PROPERTIES_FIELD) | ||
| .startObject(FIELD_NAME_NESTED) | ||
| .field(TYPE, TYPE_NESTED) | ||
| .startObject(PROPERTIES_FIELD) | ||
| .startObject(FIELD_NAME_VECTOR) | ||
| .field(TYPE, TYPE_KNN_VECTOR) | ||
| .field(DIMENSION, dimension) | ||
| .startObject(KNN_METHOD) | ||
| .field(NAME, METHOD_HNSW) | ||
| .field(METHOD_PARAMETER_SPACE_TYPE, SPACE_TYPE) | ||
| .field(KNN_ENGINE, engine) | ||
| .startObject(PARAMETERS) | ||
| .field(METHOD_PARAMETER_M, M) | ||
| .field(METHOD_PARAMETER_EF_CONSTRUCTION, EF_CONSTRUCTION) | ||
| .endObject() | ||
| .endObject() | ||
| .endObject() | ||
| .endObject() | ||
| .endObject() | ||
| .endObject() | ||
| .endObject(); | ||
|
|
||
| String mapping = builder.toString(); | ||
| createKnnIndex(INDEX_NAME, mapping); | ||
| } | ||
|
|
||
| @SneakyThrows | ||
| private void ingestTestData() { | ||
| String doc1 = NestedKnnDocBuilder.create(FIELD_NAME_NESTED) | ||
| .add(FIELD_NAME_VECTOR, new Float[] { 1f, 1f }, new Float[] { 1f, 1f }) | ||
| .build(); | ||
| addNestedKnnDoc(INDEX_NAME, "1", doc1); | ||
|
|
||
| String doc2 = NestedKnnDocBuilder.create(FIELD_NAME_NESTED) | ||
| .add(FIELD_NAME_VECTOR, new Float[] { 2f, 2f }, new Float[] { 2f, 2f }) | ||
| .build(); | ||
| addNestedKnnDoc(INDEX_NAME, "2", doc2); | ||
| } | ||
|
|
||
| private void addNestedKnnDoc(final String index, final String docId, final String document) throws IOException { | ||
| Request request = new Request("POST", "/" + index + "/_doc/" + docId + "?refresh=true"); | ||
|
|
||
| request.setJsonEntity(document); | ||
| client().performRequest(request); | ||
|
|
||
| request = new Request("POST", "/" + index + "/_refresh"); | ||
| Response response = client().performRequest(request); | ||
| assertEquals(request.getEndpoint() + ": failed", RestStatus.OK, RestStatus.fromCode(response.getStatusLine().getStatusCode())); | ||
| } | ||
|
|
||
| private Response queryNestedField(final String index, final int k, final Object[] vector) throws IOException { | ||
| XContentBuilder builder = XContentFactory.jsonBuilder().startObject().startObject(QUERY); | ||
| builder.startObject(TYPE_NESTED); | ||
| builder.field(PATH, FIELD_NAME_NESTED); | ||
| builder.startObject(QUERY).startObject(KNN).startObject(FIELD_NAME_NESTED + "." + FIELD_NAME_VECTOR); | ||
| builder.field(VECTOR, vector); | ||
| builder.field(K, k); | ||
| builder.endObject().endObject().endObject().endObject().endObject().endObject(); | ||
|
|
||
| Request request = new Request("POST", "/" + index + "/_search"); | ||
| request.setJsonEntity(builder.toString()); | ||
|
|
||
| Response response = client().performRequest(request); | ||
| assertEquals(request.getEndpoint() + ": failed", RestStatus.OK, RestStatus.fromCode(response.getStatusLine().getStatusCode())); | ||
|
|
||
| return response; | ||
| } | ||
|
|
||
| private static class NestedKnnDocBuilder { | ||
| private XContentBuilder builder; | ||
|
|
||
| public NestedKnnDocBuilder(final String fieldName) throws IOException { | ||
| builder = XContentFactory.jsonBuilder().startObject().startArray(fieldName); | ||
| } | ||
|
|
||
| public static NestedKnnDocBuilder create(final String fieldName) throws IOException { | ||
| return new NestedKnnDocBuilder(fieldName); | ||
| } | ||
|
|
||
| public NestedKnnDocBuilder add(final String fieldName, final Object[]... vectors) throws IOException { | ||
| for (Object[] vector : vectors) { | ||
| builder.startObject(); | ||
| builder.field(fieldName, vector); | ||
| builder.endObject(); | ||
| } | ||
| return this; | ||
| } | ||
|
|
||
| public String build() throws IOException { | ||
| builder.endArray().endObject(); | ||
| return builder.toString(); | ||
| } | ||
|
|
||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
who is setting this parent filter in the CreateQueryRequest?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
opensearch-project/OpenSearch#10246