Supporting sparse semantic retrieval in neural search #333

zhichao-aws · 2023-09-22T06:03:07Z

Description

Support using sparse encoding model e.g. SPLADE in opensearch. We'll introduce a new sparse encoding doc ingest processor, and a new sparse encoding query clause.

related PR: opensearch-project/ml-commons#1301

Issues Resolved

#230

Check List

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
Commits are signed as per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

zhichao-aws · 2023-09-22T06:11:57Z

Some integ tests fail because new sparse models in ml-commons are invoked, while the PR in ml-commons haven't been merged.

zhichao-aws · 2023-09-22T06:13:03Z

We have finalized our code, it is ready for review now

zhichao-aws · 2023-09-22T07:02:07Z

The force push aimed to fix DCO

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

Signed-off-by: zane-neo <zaniu@amazon.com>

Signed-off-by: xinyual <xinyual@amazon.com>

Signed-off-by: zane-neo <zaniu@amazon.com>

navneet1v · 2023-09-26T01:46:41Z

src/main/java/org/opensearch/neuralsearch/ml/MLCommonsClientAccessor.java

+        @NonNull final List<String> inputText,
+        @NonNull final ActionListener<List<Map<String, ?>>> listener
+    ) {
+        retryableInferenceSentencesWithMapResult(modelId, inputText, 0, listener);


why we want to do no retires?

I think we are getting consistent with the existing inferenceSentences method. @zane-neo Could you please help answer this?

The 0 here doesn't mean no retry, it's only a initial value, this value will be increased till max retry time(3), this can be optimized to decrease in the future to make it more intuitive though.

release-notes/opensearch-neural-search.release-notes-2.10.0.0.md

src/main/java/org/opensearch/neuralsearch/ml/MLCommonsClientAccessor.java

jmazanec15 · 2023-09-26T04:13:15Z

src/main/java/org/opensearch/neuralsearch/ml/MLCommonsClientAccessor.java

@@ -144,4 +175,20 @@ private List<List<Float>> buildVectorFromResponse(MLOutput mlOutput) {
        return vector;
    }

+    private List<Map<String, ?>> buildMapResultFromResponse(MLOutput mlOutput) {
+        final ModelTensorOutput modelTensorOutput = (ModelTensorOutput) mlOutput;


Is this cast safe? Or should we check?

Same as the above one. Maybe we can use consistent code between the 2 use case. And If they need to be fixed, we can create another PR to fix them.

neural-search/src/main/java/org/opensearch/neuralsearch/ml/MLCommonsClientAccessor.java

Line 136 in 8484be9

final ModelTensorOutput modelTensorOutput = (ModelTensorOutput) mlOutput;

We can fix the other one in the future, but I want to understand how we know for certain this wont cause class cast on invalid input.

@zane-neo could you please help answer this?

The two inference method we created in neural-search(inferenceWithVectorResult & inferenceWithMapResult) are for text-embedding and sparse-embedding only, and they both return ModelTensorOutput. For later one in the future, it could be expanded to other use cases, e.g. remote inference, but in this case, it's still returning ModelTensorOutput. So it's safe to cast this output to ModelTensorOutput.

src/main/java/org/opensearch/neuralsearch/plugin/NeuralSearch.java

src/main/java/org/opensearch/neuralsearch/processor/NLPProcessor.java

src/test/java/org/opensearch/neuralsearch/ml/MLCommonsClientAccessorTests.java

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

zhichao-aws · 2023-09-26T10:05:07Z

@zhichao-aws can we add documentation on all the public classes and functions.

Sure

src/main/java/org/opensearch/neuralsearch/ml/MLCommonsClientAccessor.java

jmazanec15 · 2023-09-26T21:30:19Z

src/main/java/org/opensearch/neuralsearch/ml/MLCommonsClientAccessor.java

@@ -144,4 +175,20 @@ private List<List<Float>> buildVectorFromResponse(MLOutput mlOutput) {
        return vector;
    }

+    private List<Map<String, ?>> buildMapResultFromResponse(MLOutput mlOutput) {
+        final ModelTensorOutput modelTensorOutput = (ModelTensorOutput) mlOutput;


We can fix the other one in the future, but I want to understand how we know for certain this wont cause class cast on invalid input.

src/main/java/org/opensearch/neuralsearch/query/SparseEncodingQueryBuilder.java

jmazanec15 · 2023-09-26T21:34:42Z

src/main/java/org/opensearch/neuralsearch/query/SparseEncodingQueryBuilder.java

+        out.writeOptionalString(queryText);
+        out.writeOptionalString(modelId);


Why are these 2 optional? In the fromXContent it looks like they require a value.

Good point. In original design there were 2 query forms and in final proposal we only keep this one. But I didn't change here. Will fix this.

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

martin-gaievski · 2023-09-27T00:02:18Z

CHANGELOG.md

@@ -5,6 +5,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

 ## [Unreleased 3.0](https://github.com/opensearch-project/neural-search/compare/2.x...HEAD)
 ### Features
+Support sparse semantic retrieval by introducing `sparse_encoding` ingest processor and query builder ([#333](https://github.com/opensearch-project/neural-search/pull/333))


I think we typically have PR for one version, if that's for 2.11 it should be under 2.x

Sure, will fix this.

martin-gaievski · 2023-09-27T00:03:05Z

build.gradle

+    runtimeOnly group: 'com.google.code.gson', name: 'gson', version: '2.10.1'
+    runtimeOnly group: 'org.json', name: 'json', version: '20230227'


confirming, I've seen same behavior while working on multimodal

martin-gaievski · 2023-09-27T00:09:24Z

src/main/java/org/opensearch/neuralsearch/processor/TextEmbeddingProcessor.java

-        Map<String, Object> sourceAndMetadataMap,
-        Map<String, Object> treeRes
+    public void doExecute(
+        IngestDocument ingestDocument,


arguments should be final at least for public methods, that's the convention if I remember correctly

Good point. Furthermore, we can mark the two inheritor processor class final, since we can only have one behavior for one ingest processor

src/main/java/org/opensearch/neuralsearch/processor/factory/SparseEncodingProcessorFactory.java

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

martin-gaievski · 2023-09-27T00:11:38Z

src/main/java/org/opensearch/neuralsearch/util/TokenWeightUtil.java

+        Map<String, Float> result = new HashMap<>();
+        for (Map.Entry<?, ?> entry : ((Map<?, ?>) uncastedMap).entrySet()) {
+            if (!String.class.isAssignableFrom(entry.getKey().getClass()) || !Number.class.isAssignableFrom(entry.getValue().getClass())) {
+                throw new IllegalArgumentException("The expected inference result is a Map with String keys and  " + " Float values.");


why we use "+" to concatenate strings, you can just use everything as one string

I think it's the automatic tidy tool merge 2 lines. will remove the "+"

martin-gaievski · 2023-09-27T00:15:18Z

src/main/java/org/opensearch/neuralsearch/query/SparseEncodingQueryBuilder.java

+                modelId(),
+                List.of(queryText),
+                ActionListener.wrap(mapResultList -> {
+                    queryTokensSetOnce.set(TokenWeightUtil.fetchListOfTokenWeightMap(mapResultList).get(0));


is this safe to assume that list will have at least one element without checking is it's not empty?

Good point. Will add the check at the util class

martin-gaievski · 2023-09-27T00:16:31Z

src/main/java/org/opensearch/neuralsearch/query/SparseEncodingQueryBuilder.java

+    private static void validateForRewrite(String queryText, String modelId) {
+        if (StringUtils.isBlank(queryText) || StringUtils.isBlank(modelId)) {
+            throw new IllegalArgumentException(
+                QUERY_TEXT_FIELD.getPreferredName() + " and " + MODEL_ID_FIELD.getPreferredName() + " cannot be null."


please use String.format for this error message

Sure, has rewritten all strings having more than 2 args to String.format

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

* sparse mapper field and query builder Signed-off-by: zhichao-aws <zhichaog@amazon.com> * fix typo Signed-off-by: zhichao-aws <zhichaog@amazon.com> * Add map result support in neural search for non text embedding models Signed-off-by: zane-neo <zaniu@amazon.com> * Fix compilation failure issue Signed-off-by: zane-neo <zaniu@amazon.com> * Add more UTs Signed-off-by: zane-neo <zaniu@amazon.com> * add sparse encoding processor Signed-off-by: xinyual <xinyual@amazon.com> * add sparse encoding processor Signed-off-by: xinyual <xinyual@amazon.com> * remove guava in gradle Signed-off-by: xinyual <xinyual@amazon.com> * modify access control Signed-off-by: xinyual <xinyual@amazon.com> * Add map result support in neural search for non text embedding models Signed-off-by: zane-neo <zaniu@amazon.com> * Fix compilation failure issue Signed-off-by: zane-neo <zaniu@amazon.com> * change output logic Signed-off-by: xinyual <xinyual@amazon.com> * create abstract Signed-off-by: xinyual <xinyual@amazon.com> * create abstract proccesor Signed-off-by: xinyual <xinyual@amazon.com> * add abstract class Signed-off-by: xinyual <xinyual@amazon.com> * remove duplicate code Signed-off-by: xinyual <xinyual@amazon.com> * remove duplicate code Signed-off-by: xinyual <xinyual@amazon.com> * remove dl process Signed-off-by: xinyual <xinyual@amazon.com> * move static to abstract class Signed-off-by: xinyual <xinyual@amazon.com> * update query rewrite logic Signed-off-by: zhichao-aws <zhichaog@amazon.com> * modify header Signed-off-by: zhichao-aws <zhichaog@amazon.com> * merge conflict Signed-off-by: xinyual <xinyual@amazon.com> * delete index mapper, change to rank_features Signed-off-by: zhichao-aws <zhichaog@amazon.com> * remove unused import Signed-off-by: zhichao-aws <zhichaog@amazon.com> * list return result Signed-off-by: zhichao-aws <zhichaog@amazon.com> * refactor type and listTypeNestedMapKey, tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * forbid nested input. tidy. Signed-off-by: zhichao-aws <zhichaog@amazon.com> * tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * enable nested Signed-off-by: zhichao-aws <zhichaog@amazon.com> * fix test Signed-off-by: zhichao-aws <zhichaog@amazon.com> * Add ut it to sparse encoding processor (#6) * fix original UT problem Signed-off-by: xinyual <xinyual@amazon.com> * add UT IT Signed-off-by: xinyual <xinyual@amazon.com> * add more UT Signed-off-by: xinyual <xinyual@amazon.com> * add more ut Signed-off-by: xinyual <xinyual@amazon.com> * fix typo error Signed-off-by: xinyual <xinyual@amazon.com> --------- Signed-off-by: xinyual <xinyual@amazon.com> * utils, tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * rename to sparse_encoding query Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add validation and ut Signed-off-by: zhichao-aws <zhichaog@amazon.com> * sparse encoding query builder ut Signed-off-by: zhichao-aws <zhichaog@amazon.com> * rename Signed-off-by: zhichao-aws <zhichaog@amazon.com> * UT for utils Signed-off-by: zhichao-aws <zhichaog@amazon.com> * enrich sparse encoding IT mappings Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add it Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add it Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add integ test Signed-off-by: zhichao-aws <zhichaog@amazon.com> * rename resource file Signed-off-by: zhichao-aws <zhichaog@amazon.com> * tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * remove BoundedLinearQuery and TokenScoreUpperBound Signed-off-by: zhichao-aws <zhichaog@amazon.com> * tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add delta to loose the equal Signed-off-by: zhichao-aws <zhichaog@amazon.com> * move SparseEncodingQueryBuilder to upper level path Signed-off-by: zhichao-aws <zhichaog@amazon.com> * tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add it Signed-off-by: zhichao-aws <zhichaog@amazon.com> * Update src/main/java/org/opensearch/neuralsearch/ml/MLCommonsClientAccessor.java Co-authored-by: zane-neo <zaniu@amazon.com> Signed-off-by: zhichao-aws <zhichaog@amazon.com> * Update src/main/java/org/opensearch/neuralsearch/util/TokenWeightUtil.java Co-authored-by: zane-neo <zaniu@amazon.com> Signed-off-by: zhichao-aws <zhichaog@amazon.com> * restore gradle.propeties Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add release notes Signed-off-by: zhichao-aws <zhichaog@amazon.com> * change field modifier to private for NLPProcessor Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add comments Signed-off-by: zhichao-aws <zhichaog@amazon.com> * use StringUtils to check Signed-off-by: zhichao-aws <zhichaog@amazon.com> * null check Signed-off-by: zhichao-aws <zhichaog@amazon.com> * modify changelog Signed-off-by: zhichao-aws <zhichaog@amazon.com> * nit Signed-off-by: zhichao-aws <zhichaog@amazon.com> * nit Signed-off-by: zhichao-aws <zhichaog@amazon.com> * remove query tokens from user interface Signed-off-by: zhichao-aws <zhichaog@amazon.com> * fix test Signed-off-by: zhichao-aws <zhichaog@amazon.com> * tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * update function name Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add javadoc Signed-off-by: zhichao-aws <zhichaog@amazon.com> * remove debug log including inference result Signed-off-by: zhichao-aws <zhichaog@amazon.com> * make query text and model id required Signed-off-by: zhichao-aws <zhichaog@amazon.com> * minor changes based on comments Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add locale to String.format Signed-off-by: zhichao-aws <zhichaog@amazon.com> * update mock model url Signed-off-by: zhichao-aws <zhichaog@amazon.com> --------- Signed-off-by: zhichao-aws <zhichaog@amazon.com> Signed-off-by: zane-neo <zaniu@amazon.com> Signed-off-by: xinyual <xinyual@amazon.com> Co-authored-by: zane-neo <zaniu@amazon.com> Co-authored-by: xinyual <xinyual@amazon.com> (cherry picked from commit 7bef7a0)

…ject#333) * sparse mapper field and query builder Signed-off-by: zhichao-aws <zhichaog@amazon.com> * fix typo Signed-off-by: zhichao-aws <zhichaog@amazon.com> * Add map result support in neural search for non text embedding models Signed-off-by: zane-neo <zaniu@amazon.com> * Fix compilation failure issue Signed-off-by: zane-neo <zaniu@amazon.com> * Add more UTs Signed-off-by: zane-neo <zaniu@amazon.com> * add sparse encoding processor Signed-off-by: xinyual <xinyual@amazon.com> * add sparse encoding processor Signed-off-by: xinyual <xinyual@amazon.com> * remove guava in gradle Signed-off-by: xinyual <xinyual@amazon.com> * modify access control Signed-off-by: xinyual <xinyual@amazon.com> * Add map result support in neural search for non text embedding models Signed-off-by: zane-neo <zaniu@amazon.com> * Fix compilation failure issue Signed-off-by: zane-neo <zaniu@amazon.com> * change output logic Signed-off-by: xinyual <xinyual@amazon.com> * create abstract Signed-off-by: xinyual <xinyual@amazon.com> * create abstract proccesor Signed-off-by: xinyual <xinyual@amazon.com> * add abstract class Signed-off-by: xinyual <xinyual@amazon.com> * remove duplicate code Signed-off-by: xinyual <xinyual@amazon.com> * remove duplicate code Signed-off-by: xinyual <xinyual@amazon.com> * remove dl process Signed-off-by: xinyual <xinyual@amazon.com> * move static to abstract class Signed-off-by: xinyual <xinyual@amazon.com> * update query rewrite logic Signed-off-by: zhichao-aws <zhichaog@amazon.com> * modify header Signed-off-by: zhichao-aws <zhichaog@amazon.com> * merge conflict Signed-off-by: xinyual <xinyual@amazon.com> * delete index mapper, change to rank_features Signed-off-by: zhichao-aws <zhichaog@amazon.com> * remove unused import Signed-off-by: zhichao-aws <zhichaog@amazon.com> * list return result Signed-off-by: zhichao-aws <zhichaog@amazon.com> * refactor type and listTypeNestedMapKey, tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * forbid nested input. tidy. Signed-off-by: zhichao-aws <zhichaog@amazon.com> * tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * enable nested Signed-off-by: zhichao-aws <zhichaog@amazon.com> * fix test Signed-off-by: zhichao-aws <zhichaog@amazon.com> * Add ut it to sparse encoding processor (#6) * fix original UT problem Signed-off-by: xinyual <xinyual@amazon.com> * add UT IT Signed-off-by: xinyual <xinyual@amazon.com> * add more UT Signed-off-by: xinyual <xinyual@amazon.com> * add more ut Signed-off-by: xinyual <xinyual@amazon.com> * fix typo error Signed-off-by: xinyual <xinyual@amazon.com> --------- Signed-off-by: xinyual <xinyual@amazon.com> * utils, tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * rename to sparse_encoding query Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add validation and ut Signed-off-by: zhichao-aws <zhichaog@amazon.com> * sparse encoding query builder ut Signed-off-by: zhichao-aws <zhichaog@amazon.com> * rename Signed-off-by: zhichao-aws <zhichaog@amazon.com> * UT for utils Signed-off-by: zhichao-aws <zhichaog@amazon.com> * enrich sparse encoding IT mappings Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add it Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add it Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add integ test Signed-off-by: zhichao-aws <zhichaog@amazon.com> * rename resource file Signed-off-by: zhichao-aws <zhichaog@amazon.com> * tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * remove BoundedLinearQuery and TokenScoreUpperBound Signed-off-by: zhichao-aws <zhichaog@amazon.com> * tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add delta to loose the equal Signed-off-by: zhichao-aws <zhichaog@amazon.com> * move SparseEncodingQueryBuilder to upper level path Signed-off-by: zhichao-aws <zhichaog@amazon.com> * tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add it Signed-off-by: zhichao-aws <zhichaog@amazon.com> * Update src/main/java/org/opensearch/neuralsearch/ml/MLCommonsClientAccessor.java Co-authored-by: zane-neo <zaniu@amazon.com> Signed-off-by: zhichao-aws <zhichaog@amazon.com> * Update src/main/java/org/opensearch/neuralsearch/util/TokenWeightUtil.java Co-authored-by: zane-neo <zaniu@amazon.com> Signed-off-by: zhichao-aws <zhichaog@amazon.com> * restore gradle.propeties Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add release notes Signed-off-by: zhichao-aws <zhichaog@amazon.com> * change field modifier to private for NLPProcessor Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add comments Signed-off-by: zhichao-aws <zhichaog@amazon.com> * use StringUtils to check Signed-off-by: zhichao-aws <zhichaog@amazon.com> * null check Signed-off-by: zhichao-aws <zhichaog@amazon.com> * modify changelog Signed-off-by: zhichao-aws <zhichaog@amazon.com> * nit Signed-off-by: zhichao-aws <zhichaog@amazon.com> * nit Signed-off-by: zhichao-aws <zhichaog@amazon.com> * remove query tokens from user interface Signed-off-by: zhichao-aws <zhichaog@amazon.com> * fix test Signed-off-by: zhichao-aws <zhichaog@amazon.com> * tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * update function name Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add javadoc Signed-off-by: zhichao-aws <zhichaog@amazon.com> * remove debug log including inference result Signed-off-by: zhichao-aws <zhichaog@amazon.com> * make query text and model id required Signed-off-by: zhichao-aws <zhichaog@amazon.com> * minor changes based on comments Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add locale to String.format Signed-off-by: zhichao-aws <zhichaog@amazon.com> * update mock model url Signed-off-by: zhichao-aws <zhichaog@amazon.com> --------- Signed-off-by: zhichao-aws <zhichaog@amazon.com> Signed-off-by: zane-neo <zaniu@amazon.com> Signed-off-by: xinyual <xinyual@amazon.com> Co-authored-by: zane-neo <zaniu@amazon.com> Co-authored-by: xinyual <xinyual@amazon.com>

…343) * Supporting sparse semantic retrieval in neural search (#333) * sparse mapper field and query builder Signed-off-by: zhichao-aws <zhichaog@amazon.com> * fix typo Signed-off-by: zhichao-aws <zhichaog@amazon.com> * Add map result support in neural search for non text embedding models Signed-off-by: zane-neo <zaniu@amazon.com> * Fix compilation failure issue Signed-off-by: zane-neo <zaniu@amazon.com> * Add more UTs Signed-off-by: zane-neo <zaniu@amazon.com> * add sparse encoding processor Signed-off-by: xinyual <xinyual@amazon.com> * add sparse encoding processor Signed-off-by: xinyual <xinyual@amazon.com> * remove guava in gradle Signed-off-by: xinyual <xinyual@amazon.com> * modify access control Signed-off-by: xinyual <xinyual@amazon.com> * Add map result support in neural search for non text embedding models Signed-off-by: zane-neo <zaniu@amazon.com> * Fix compilation failure issue Signed-off-by: zane-neo <zaniu@amazon.com> * change output logic Signed-off-by: xinyual <xinyual@amazon.com> * create abstract Signed-off-by: xinyual <xinyual@amazon.com> * create abstract proccesor Signed-off-by: xinyual <xinyual@amazon.com> * add abstract class Signed-off-by: xinyual <xinyual@amazon.com> * remove duplicate code Signed-off-by: xinyual <xinyual@amazon.com> * remove duplicate code Signed-off-by: xinyual <xinyual@amazon.com> * remove dl process Signed-off-by: xinyual <xinyual@amazon.com> * move static to abstract class Signed-off-by: xinyual <xinyual@amazon.com> * update query rewrite logic Signed-off-by: zhichao-aws <zhichaog@amazon.com> * modify header Signed-off-by: zhichao-aws <zhichaog@amazon.com> * merge conflict Signed-off-by: xinyual <xinyual@amazon.com> * delete index mapper, change to rank_features Signed-off-by: zhichao-aws <zhichaog@amazon.com> * remove unused import Signed-off-by: zhichao-aws <zhichaog@amazon.com> * list return result Signed-off-by: zhichao-aws <zhichaog@amazon.com> * refactor type and listTypeNestedMapKey, tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * forbid nested input. tidy. Signed-off-by: zhichao-aws <zhichaog@amazon.com> * tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * enable nested Signed-off-by: zhichao-aws <zhichaog@amazon.com> * fix test Signed-off-by: zhichao-aws <zhichaog@amazon.com> * Add ut it to sparse encoding processor (#6) * fix original UT problem Signed-off-by: xinyual <xinyual@amazon.com> * add UT IT Signed-off-by: xinyual <xinyual@amazon.com> * add more UT Signed-off-by: xinyual <xinyual@amazon.com> * add more ut Signed-off-by: xinyual <xinyual@amazon.com> * fix typo error Signed-off-by: xinyual <xinyual@amazon.com> --------- Signed-off-by: xinyual <xinyual@amazon.com> * utils, tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * rename to sparse_encoding query Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add validation and ut Signed-off-by: zhichao-aws <zhichaog@amazon.com> * sparse encoding query builder ut Signed-off-by: zhichao-aws <zhichaog@amazon.com> * rename Signed-off-by: zhichao-aws <zhichaog@amazon.com> * UT for utils Signed-off-by: zhichao-aws <zhichaog@amazon.com> * enrich sparse encoding IT mappings Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add it Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add it Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add integ test Signed-off-by: zhichao-aws <zhichaog@amazon.com> * rename resource file Signed-off-by: zhichao-aws <zhichaog@amazon.com> * tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * remove BoundedLinearQuery and TokenScoreUpperBound Signed-off-by: zhichao-aws <zhichaog@amazon.com> * tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add delta to loose the equal Signed-off-by: zhichao-aws <zhichaog@amazon.com> * move SparseEncodingQueryBuilder to upper level path Signed-off-by: zhichao-aws <zhichaog@amazon.com> * tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add it Signed-off-by: zhichao-aws <zhichaog@amazon.com> * Update src/main/java/org/opensearch/neuralsearch/ml/MLCommonsClientAccessor.java Co-authored-by: zane-neo <zaniu@amazon.com> Signed-off-by: zhichao-aws <zhichaog@amazon.com> * Update src/main/java/org/opensearch/neuralsearch/util/TokenWeightUtil.java Co-authored-by: zane-neo <zaniu@amazon.com> Signed-off-by: zhichao-aws <zhichaog@amazon.com> * restore gradle.propeties Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add release notes Signed-off-by: zhichao-aws <zhichaog@amazon.com> * change field modifier to private for NLPProcessor Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add comments Signed-off-by: zhichao-aws <zhichaog@amazon.com> * use StringUtils to check Signed-off-by: zhichao-aws <zhichaog@amazon.com> * null check Signed-off-by: zhichao-aws <zhichaog@amazon.com> * modify changelog Signed-off-by: zhichao-aws <zhichaog@amazon.com> * nit Signed-off-by: zhichao-aws <zhichaog@amazon.com> * nit Signed-off-by: zhichao-aws <zhichaog@amazon.com> * remove query tokens from user interface Signed-off-by: zhichao-aws <zhichaog@amazon.com> * fix test Signed-off-by: zhichao-aws <zhichaog@amazon.com> * tidy Signed-off-by: zhichao-aws <zhichaog@amazon.com> * update function name Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add javadoc Signed-off-by: zhichao-aws <zhichaog@amazon.com> * remove debug log including inference result Signed-off-by: zhichao-aws <zhichaog@amazon.com> * make query text and model id required Signed-off-by: zhichao-aws <zhichaog@amazon.com> * minor changes based on comments Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add locale to String.format Signed-off-by: zhichao-aws <zhichaog@amazon.com> * update mock model url Signed-off-by: zhichao-aws <zhichaog@amazon.com> --------- Signed-off-by: zhichao-aws <zhichaog@amazon.com> Signed-off-by: zane-neo <zaniu@amazon.com> Signed-off-by: xinyual <xinyual@amazon.com> Co-authored-by: zane-neo <zaniu@amazon.com> Co-authored-by: xinyual <xinyual@amazon.com> (cherry picked from commit 7bef7a0) * Fix the compile error in [Backport/backport 333 to 2.x] (#344) * fix apache http version Signed-off-by: zhichao-aws <zhichaog@amazon.com> * add import Signed-off-by: zhichao-aws <zhichaog@amazon.com> --------- Signed-off-by: zhichao-aws <zhichaog@amazon.com> --------- Signed-off-by: zhichao-aws <zhichaog@amazon.com> Co-authored-by: zhichao-aws <zhichaog@amazon.com>

zhichao-aws requested review from heemin32, navneet1v, VijayanB, vamshin, jmazanec15, naveentatikonda, junqiu-lei, martin-gaievski, sean-zheng-amazon, model-collapse, wujunshen, zane-neo, ylwu-amzn and jngz-es as code owners September 22, 2023 06:03

zhichao-aws mentioned this pull request Sep 22, 2023

Add map result support in neural search for non text embedding models #270

Closed

5 tasks

xinyual force-pushed the feature/learned_sparse_main branch from 91f4d1f to 79ce678 Compare September 22, 2023 07:00

zhichao-aws and others added 11 commits September 22, 2023 15:09

sparse mapper field and query builder

5971c93

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

fix typo

0386a95

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

Add map result support in neural search for non text embedding models

489b6e8

Signed-off-by: zane-neo <zaniu@amazon.com>

Fix compilation failure issue

18022b8

Signed-off-by: zane-neo <zaniu@amazon.com>

Add more UTs

886cdeb

Signed-off-by: zane-neo <zaniu@amazon.com>

add sparse encoding processor

d336f88

Signed-off-by: xinyual <xinyual@amazon.com>

add sparse encoding processor

bb14947

Signed-off-by: xinyual <xinyual@amazon.com>

remove guava in gradle

5bb409b

Signed-off-by: xinyual <xinyual@amazon.com>

modify access control

8e8df7e

Signed-off-by: xinyual <xinyual@amazon.com>

Add map result support in neural search for non text embedding models

5e81ee5

Signed-off-by: zane-neo <zaniu@amazon.com>

Fix compilation failure issue

20dd78e

Signed-off-by: zane-neo <zaniu@amazon.com>

navneet1v reviewed Sep 26, 2023

View reviewed changes

jmazanec15 reviewed Sep 26, 2023

View reviewed changes

zhichao-aws added 8 commits September 26, 2023 06:20

modify changelog

c6c631e

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

nit

ec70c34

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

nit

9223e31

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

remove query tokens from user interface

ba10e27

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

fix test

9647ac9

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

tidy

169934a

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

update function name

a47c8b6

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

add javadoc

b48091f

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

jmazanec15 reviewed Sep 26, 2023

View reviewed changes

remove debug log including inference result

cfc847d

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

martin-gaievski reviewed Sep 27, 2023

View reviewed changes

make query text and model id required

508b462

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

martin-gaievski reviewed Sep 27, 2023

View reviewed changes

zhichao-aws added 2 commits September 27, 2023 09:07

minor changes based on comments

aae62d4

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

add locale to String.format

2d51bb9

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

jmazanec15 approved these changes Sep 27, 2023

View reviewed changes

zane-neo approved these changes Sep 27, 2023

View reviewed changes

update mock model url

9611411

Signed-off-by: zhichao-aws <zhichaog@amazon.com>

zane-neo merged commit 7bef7a0 into opensearch-project:main Sep 27, 2023
9 of 13 checks passed

zane-neo added the backport 2.x Label will add auto workflow to backport PR to 2.x branch label Sep 27, 2023

opensearch-trigger-bot bot mentioned this pull request Sep 27, 2023

[Backport 2.x] Supporting sparse semantic retrieval in neural search #343

Merged

martin-gaievski mentioned this pull request Nov 14, 2024

Tune the error message if model fails to generate embedding #229

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Supporting sparse semantic retrieval in neural search #333

Supporting sparse semantic retrieval in neural search #333

zhichao-aws commented Sep 22, 2023 •

edited

Loading

zhichao-aws commented Sep 22, 2023

zhichao-aws commented Sep 22, 2023

zhichao-aws commented Sep 22, 2023

navneet1v Sep 26, 2023

zhichao-aws Sep 26, 2023

zane-neo Sep 27, 2023

jmazanec15 Sep 26, 2023

zhichao-aws Sep 26, 2023 •

edited

Loading

jmazanec15 Sep 26, 2023

zhichao-aws Sep 27, 2023

zane-neo Sep 27, 2023

zhichao-aws commented Sep 26, 2023

jmazanec15 Sep 26, 2023

jmazanec15 Sep 26, 2023

zhichao-aws Sep 27, 2023

martin-gaievski Sep 27, 2023

zhichao-aws Sep 27, 2023

martin-gaievski Sep 27, 2023

martin-gaievski Sep 27, 2023

zhichao-aws Sep 27, 2023

martin-gaievski Sep 27, 2023

zhichao-aws Sep 27, 2023

martin-gaievski Sep 27, 2023

zhichao-aws Sep 27, 2023

martin-gaievski Sep 27, 2023

zhichao-aws Sep 27, 2023

		out.writeOptionalString(queryText);
		out.writeOptionalString(modelId);

		runtimeOnly group: 'com.google.code.gson', name: 'gson', version: '2.10.1'
		runtimeOnly group: 'org.json', name: 'json', version: '20230227'

Supporting sparse semantic retrieval in neural search #333

Supporting sparse semantic retrieval in neural search #333

Conversation

zhichao-aws commented Sep 22, 2023 • edited Loading

Description

Issues Resolved

Check List

zhichao-aws commented Sep 22, 2023

zhichao-aws commented Sep 22, 2023

zhichao-aws commented Sep 22, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhichao-aws Sep 26, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhichao-aws commented Sep 26, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhichao-aws commented Sep 22, 2023 •

edited

Loading

zhichao-aws Sep 26, 2023 •

edited

Loading