Add retrieveVectors

Author: Strift

src/main/java/com/meilisearch/sdk/IndexSearchRequest.java

@@ -38,13 +38,14 @@ public class IndexSearchRequest {
     private FederationOptions federationOptions;
     protected String[] locales;
     protected String distinct;
+    protected Boolean retrieveVectors;
 
     /**
      * Constructor for MultiSearchRequest for building search queries with the default values:
      * offset: 0, limit: 20, attributesToRetrieve: ["*"], attributesToCrop: null, cropLength: 200,
      * attributesToHighlight: null, filter: null, showMatchesPosition: false, facets: null, sort:
      * null, showRankingScore: false, showRankingScoreDetails: false, rankingScoreThreshold: null
-     * distinct: null
+     * distinct: null, retrieveVectors: false
      *
      * @param indexUid uid of the requested index String
      */
@@ -106,7 +107,8 @@ public String toString() {
                         .putOpt("rankingScoreThreshold", this.rankingScoreThreshold)
                         .putOpt("attributesToSearchOn", this.attributesToSearchOn)
                         .putOpt("locales", this.locales)
-                        .putOpt("distinct", this.distinct);
+                        .putOpt("distinct", this.distinct)
+                        .putOpt("retrieveVectors", this.retrieveVectors);
 
         return jsonObject.toString();
     }

src/main/java/com/meilisearch/sdk/SearchRequest.java

@@ -45,11 +45,13 @@ public class SearchRequest {
     protected String distinct;
     protected Hybrid hybrid;
     protected Double[] vector;
+    protected Boolean retrieveVectors;
     /**
      * Constructor for SearchRequest for building search queries with the default values: offset: 0,
      * limit: 20, attributesToRetrieve: ["*"], attributesToCrop: null, cropLength: 200,
      * attributesToHighlight: null, filter: null, showMatchesPosition: false, facets: null, sort:
-     * null, showRankingScore: false, showRankingScoreDetails: false, rankingScoreThreshold: null
+     * null, showRankingScore: false, showRankingScoreDetails: false, rankingScoreThreshold: null,
+     * retrieveVectors: false
      *
      * @param q Query String
      */
@@ -107,11 +109,11 @@ public String toString() {
                         .putOpt("rankingScoreThreshold", this.rankingScoreThreshold)
                         .putOpt("locales", this.locales)
                         .putOpt("distinct", this.distinct)
-                        .putOpt("vector", this.vector);
+                        .putOpt("vector", this.vector)
+                        .putOpt("retrieveVectors", this.retrieveVectors);
 
-        // Add hybrid parameter if it exists
         if (this.hybrid != null) {
-            jsonObject.put("hybrid", this.hybrid.toJSONObject());
+            jsonObject.put("hybrid", new JSONObject(this.hybrid.toString()));
         }
 
         return jsonObject.toString();

src/test/java/com/meilisearch/integration/SearchTest.java

@@ -1149,6 +1149,48 @@ public void testVectorSearch() throws Exception {
         assertThat(searchResult.getHits().get(0).get("title"), is("Escape Room"));
     }
 
+    /** Test vector search with retrieveVectors option */
+    @Test
+    public void testVectorSearchWithRetrieveVectors() throws Exception {
+        String indexUid = "testVectorSearchWithRetrieveVectors";
+        Index index = client.index(indexUid);
+        HashMap<String, Embedder> embedders = new HashMap<>();
+        embedders.put(
+                "manual", new Embedder().setSource(EmbedderSource.USER_PROVIDED).setDimensions(3));
+
+        Settings settings = new Settings();
+        settings.setEmbedders(embedders);
+
+        index.updateSettings(settings);
+
+        TestData<Movie> testData = this.getTestData(VECTOR_MOVIES, Movie.class);
+        TaskInfo task = index.addDocuments(testData.getRaw());
+
+        index.waitForTask(task.getTaskUid());
+
+        SearchRequest searchRequest =
+                SearchRequest.builder()
+                        .vector(new Double[] {0.1, 0.6, 0.8})
+                        .hybrid(Hybrid.builder().semanticRatio(0.5).embedder("manual").build())
+                        .retrieveVectors(true)
+                        .build();
+
+        SearchResult searchResult = (SearchResult) index.search(searchRequest);
+
+        assertThat(searchResult.getHits(), hasSize(5));
+        // The most similar document should be "Escape Room" since its vector [0.1, 0.6, 0.8]
+        assertThat(searchResult.getHits().get(0).get("id"), is("522681"));
+        assertThat(searchResult.getHits().get(0).get("title"), is("Escape Room"));
+
+        // Verify that vectors are returned in the response
+        Map<String, Object> escapeRoomHit = searchResult.getHits().get(0);
+        assertThat(escapeRoomHit.containsKey("_vectors"), is(true));
+
+        @SuppressWarnings("unchecked")
+        Map<String, Object> vectors = (Map<String, Object>) escapeRoomHit.get("_vectors");
+        assertThat(vectors.containsKey("manual"), is(true));
+    }
+
     /** Test Search with locales */
     @Test
     public void testSearchWithLocales() throws Exception {

src/test/java/com/meilisearch/sdk/SearchRequestTest.java

@@ -8,6 +8,7 @@
 import com.meilisearch.sdk.model.Hybrid;
 import com.meilisearch.sdk.model.MatchingStrategy;
 import org.junit.jupiter.api.Test;
+import org.json.JSONObject;
 
 class SearchRequestTest {
 
@@ -425,4 +426,13 @@ void toStringWithHybridOnlyEmbedder() {
         String expected = "{\"q\":\"This is a Test\",\"hybrid\":{\"embedder\":\"default\"}}";
         assertThat(classToTest.toString(), is(equalTo(expected)));
     }
+
+    @Test
+    void toStringWithRetrieveVectors() {
+        SearchRequest searchRequest = new SearchRequest("test")
+                .setRetrieveVectors(true);
+        String result = searchRequest.toString();
+        JSONObject json = new JSONObject(result);
+        assertThat(json.getBoolean("retrieveVectors"), is(true));
+    }
 }