Supporting sparse semantic retrieval in neural search (#333)

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

Hide file tree

Showing 24 changed files with 2,273 additions and 315 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased 2.x](https://github.com/opensearch-project/neural-search/compare/2.10...2.x)
 ### Features
+Support sparse semantic retrieval by introducing `sparse_encoding` ingest processor and query builder ([#333](https://github.com/opensearch-project/neural-search/pull/333))
 ### Enhancements
 ### Bug Fixes
 ### Infrastructure

diff --git a/build.gradle b/build.gradle
@@ -151,6 +151,8 @@ dependencies {
     runtimeOnly group: 'org.reflections', name: 'reflections', version: '0.9.12'
     runtimeOnly group: 'org.javassist', name: 'javassist', version: '3.29.2-GA'
     runtimeOnly group: 'org.opensearch', name: 'common-utils', version: "${opensearch_build}"
+    runtimeOnly group: 'com.google.code.gson', name: 'gson', version: '2.10.1'
+    runtimeOnly group: 'org.json', name: 'json', version: '20230227'
 }
 
 // In order to add the jar to the classpath, we need to unzip the

diff --git a/src/main/java/org/opensearch/neuralsearch/ml/MLCommonsClientAccessor.java b/src/main/java/org/opensearch/neuralsearch/ml/MLCommonsClientAccessor.java
@@ -8,13 +8,15 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Map;
 import java.util.stream.Collectors;
 
 import lombok.NonNull;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.log4j.Log4j2;
 
 import org.opensearch.core.action.ActionListener;
+import org.opensearch.core.common.util.CollectionUtils;
 import org.opensearch.ml.client.MachineLearningNodeClient;
 import org.opensearch.ml.common.FunctionName;
 import org.opensearch.ml.common.dataset.MLInputDataset;
@@ -100,10 +102,38 @@ public void inferenceSentences(
         @NonNull final List<String> inputText,
         @NonNull final ActionListener<List<List<Float>>> listener
     ) {
-        inferenceSentencesWithRetry(targetResponseFilters, modelId, inputText, 0, listener);
+        retryableInferenceSentencesWithVectorResult(targetResponseFilters, modelId, inputText, 0, listener);
     }
 
-    private void inferenceSentencesWithRetry(
+    public void inferenceSentencesWithMapResult(
+        @NonNull final String modelId,
+        @NonNull final List<String> inputText,
+        @NonNull final ActionListener<List<Map<String, ?>>> listener
+    ) {
+        retryableInferenceSentencesWithMapResult(modelId, inputText, 0, listener);
+    }
+
+    private void retryableInferenceSentencesWithMapResult(
+        final String modelId,
+        final List<String> inputText,
+        final int retryTime,
+        final ActionListener<List<Map<String, ?>>> listener
+    ) {
+        MLInput mlInput = createMLInput(null, inputText);
+        mlClient.predict(modelId, mlInput, ActionListener.wrap(mlOutput -> {
+            final List<Map<String, ?>> result = buildMapResultFromResponse(mlOutput);
+            listener.onResponse(result);
+        }, e -> {
+            if (RetryUtil.shouldRetry(e, retryTime)) {
+                final int retryTimeAdd = retryTime + 1;
+                retryableInferenceSentencesWithMapResult(modelId, inputText, retryTimeAdd, listener);
+            } else {
+                listener.onFailure(e);
+            }
+        }));
+    }
+
+    private void retryableInferenceSentencesWithVectorResult(
         final List<String> targetResponseFilters,
         final String modelId,
         final List<String> inputText,
@@ -113,12 +143,11 @@ private void inferenceSentencesWithRetry(
         MLInput mlInput = createMLInput(targetResponseFilters, inputText);
         mlClient.predict(modelId, mlInput, ActionListener.wrap(mlOutput -> {
             final List<List<Float>> vector = buildVectorFromResponse(mlOutput);
-            log.debug("Inference Response for input sentence {} is : {} ", inputText, vector);
             listener.onResponse(vector);
         }, e -> {
             if (RetryUtil.shouldRetry(e, retryTime)) {
                 final int retryTimeAdd = retryTime + 1;
-                inferenceSentencesWithRetry(targetResponseFilters, modelId, inputText, retryTimeAdd, listener);
+                retryableInferenceSentencesWithVectorResult(targetResponseFilters, modelId, inputText, retryTimeAdd, listener);
             } else {
                 listener.onFailure(e);
             }
@@ -144,4 +173,22 @@ private List<List<Float>> buildVectorFromResponse(MLOutput mlOutput) {
         return vector;
     }
 
+    private List<Map<String, ?>> buildMapResultFromResponse(MLOutput mlOutput) {
+        final ModelTensorOutput modelTensorOutput = (ModelTensorOutput) mlOutput;
+        final List<ModelTensors> tensorOutputList = modelTensorOutput.getMlModelOutputs();
+        if (CollectionUtils.isEmpty(tensorOutputList) || CollectionUtils.isEmpty(tensorOutputList.get(0).getMlModelTensors())) {
+            throw new IllegalStateException(
+                "Empty model result produced. Expected at least [1] tensor output and [1] model tensor, but got [0]"
+            );
+        }
+        List<Map<String, ?>> resultMaps = new ArrayList<>();
+        for (ModelTensors tensors : tensorOutputList) {
+            List<ModelTensor> tensorList = tensors.getMlModelTensors();
+            for (ModelTensor tensor : tensorList) {
+                resultMaps.add(tensor.getDataAsMap());
+            }
+        }
+        return resultMaps;
+    }
+
 }
diff --git a/src/main/java/org/opensearch/neuralsearch/plugin/NeuralSearch.java b/src/main/java/org/opensearch/neuralsearch/plugin/NeuralSearch.java
@@ -9,7 +9,6 @@
 
 import java.util.Arrays;
 import java.util.Collection;
-import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
@@ -31,15 +30,18 @@
 import org.opensearch.neuralsearch.ml.MLCommonsClientAccessor;
 import org.opensearch.neuralsearch.processor.NormalizationProcessor;
 import org.opensearch.neuralsearch.processor.NormalizationProcessorWorkflow;
+import org.opensearch.neuralsearch.processor.SparseEncodingProcessor;
 import org.opensearch.neuralsearch.processor.TextEmbeddingProcessor;
 import org.opensearch.neuralsearch.processor.combination.ScoreCombinationFactory;
 import org.opensearch.neuralsearch.processor.combination.ScoreCombiner;
 import org.opensearch.neuralsearch.processor.factory.NormalizationProcessorFactory;
+import org.opensearch.neuralsearch.processor.factory.SparseEncodingProcessorFactory;
 import org.opensearch.neuralsearch.processor.factory.TextEmbeddingProcessorFactory;
 import org.opensearch.neuralsearch.processor.normalization.ScoreNormalizationFactory;
 import org.opensearch.neuralsearch.processor.normalization.ScoreNormalizer;
 import org.opensearch.neuralsearch.query.HybridQueryBuilder;
 import org.opensearch.neuralsearch.query.NeuralQueryBuilder;
+import org.opensearch.neuralsearch.query.SparseEncodingQueryBuilder;
 import org.opensearch.neuralsearch.search.query.HybridQueryPhaseSearcher;
 import org.opensearch.plugins.ActionPlugin;
 import org.opensearch.plugins.ExtensiblePlugin;
@@ -62,7 +64,7 @@ public class NeuralSearch extends Plugin implements ActionPlugin, SearchPlugin,
     private MLCommonsClientAccessor clientAccessor;
     private NormalizationProcessorWorkflow normalizationProcessorWorkflow;
     private final ScoreNormalizationFactory scoreNormalizationFactory = new ScoreNormalizationFactory();
-    private final ScoreCombinationFactory scoreCombinationFactory = new ScoreCombinationFactory();;
+    private final ScoreCombinationFactory scoreCombinationFactory = new ScoreCombinationFactory();
 
     @Override
     public Collection<Object> createComponents(
@@ -79,6 +81,7 @@ public Collection<Object> createComponents(
         final Supplier<RepositoriesService> repositoriesServiceSupplier
     ) {
         NeuralQueryBuilder.initialize(clientAccessor);
+        SparseEncodingQueryBuilder.initialize(clientAccessor);
         normalizationProcessorWorkflow = new NormalizationProcessorWorkflow(new ScoreNormalizer(), new ScoreCombiner());
         return List.of(clientAccessor);
     }
@@ -87,14 +90,20 @@ public Collection<Object> createComponents(
     public List<QuerySpec<?>> getQueries() {
         return Arrays.asList(
             new QuerySpec<>(NeuralQueryBuilder.NAME, NeuralQueryBuilder::new, NeuralQueryBuilder::fromXContent),
-            new QuerySpec<>(HybridQueryBuilder.NAME, HybridQueryBuilder::new, HybridQueryBuilder::fromXContent)
+            new QuerySpec<>(HybridQueryBuilder.NAME, HybridQueryBuilder::new, HybridQueryBuilder::fromXContent),
+            new QuerySpec<>(SparseEncodingQueryBuilder.NAME, SparseEncodingQueryBuilder::new, SparseEncodingQueryBuilder::fromXContent)
         );
     }
 
     @Override
     public Map<String, Processor.Factory> getProcessors(Processor.Parameters parameters) {
         clientAccessor = new MLCommonsClientAccessor(new MachineLearningNodeClient(parameters.client));
-        return Collections.singletonMap(TextEmbeddingProcessor.TYPE, new TextEmbeddingProcessorFactory(clientAccessor, parameters.env));
+        return Map.of(
+            TextEmbeddingProcessor.TYPE,
+            new TextEmbeddingProcessorFactory(clientAccessor, parameters.env),
+            SparseEncodingProcessor.TYPE,
+            new SparseEncodingProcessorFactory(clientAccessor, parameters.env)
+        );
     }
 
     @Override