Changes related to the next Meilisearch release (v1.3.0)

src/Contracts/SearchQuery.php

@@ -25,6 +25,10 @@ class SearchQuery
     private ?int $limit;
     private ?int $hitsPerPage;
     private ?int $page;
+    private ?array $vector;
+    private ?array $attributesToSearchOn = null;
+    private ?bool $showRankingScore = null;
+    private ?bool $showRankingScoreDetails = null;
 
     public function setQuery(string $q): SearchQuery
     {
@@ -103,6 +107,29 @@ public function setShowMatchesPosition(?bool $showMatchesPosition): SearchQuery
         return $this;
     }
 
+    public function setShowRankingScore(?bool $showRankingScore): SearchQuery
+    {
+        $this->showRankingScore = $showRankingScore;
+
+        return $this;
+    }
+
+    /**
+     * This is an EXPERIMENTAL feature, which may break without a major version.
+     * It's available after Meilisearch v1.3.
+     * To enable it properly and use ranking scoring details its required to opt-in through the /experimental-features route.
+     *
+     * More info: https://www.meilisearch.com/docs/reference/api/experimental-features
+     *
+     * @param bool $showRankingScoreDetails whether the feature is enabled or not
+     */
+    public function setShowRankingScoreDetails(?bool $showRankingScoreDetails): SearchQuery
+    {
+        $this->showRankingScoreDetails = $showRankingScoreDetails;
+
+        return $this;
+    }
+
     public function setSort(array $sort): SearchQuery
     {
         $this->sort = $sort;
@@ -152,6 +179,32 @@ public function setIndexUid(string $uid): SearchQuery
         return $this;
     }
 
+    /**
+     * This is an EXPERIMENTAL feature, which may break without a major version.
+     * It's available from Meilisearch v1.3.
+     * To enable it properly and use vector store capabilities it's required to activate it through the /experimental-features route.
+     *
+     * More info: https://www.meilisearch.com/docs/reference/api/experimental-features
+     *
+     * @param array<float> $vector a multi-level array floats
+     */
+    public function setVector(array $vector): SearchQuery
+    {
+        $this->vector = $vector;
+
+        return $this;
+    }
+
+    /**
+     * @param list<non-empty-string> $attributesToSearchOn
+     */
+    public function setAttributesToSearchOn(array $attributesToSearchOn): SearchQuery
+    {
+        $this->attributesToSearchOn = $attributesToSearchOn;
+
+        return $this;
+    }
+
     public function toArray(): array
     {
         return array_filter([
@@ -173,6 +226,10 @@ public function toArray(): array
             'limit' => $this->limit ?? null,
             'hitsPerPage' => $this->hitsPerPage ?? null,
             'page' => $this->page ?? null,
+            'vector' => $this->vector ?? null,
+            'attributesToSearchOn' => $this->attributesToSearchOn,
+            'showRankingScore' => $this->showRankingScore,
+            'showRankingScoreDetails' => $this->showRankingScoreDetails,
         ], function ($item) { return null !== $item; });
     }
 }

tests/Endpoints/IndexTest.php

@@ -34,7 +34,12 @@ public function testIndexGetSettings(): void
         );
         $this->assertSame([], $this->index->getFilterableAttributes());
         $this->assertSame(['*'], $this->index->getDisplayedAttributes());
-        $this->assertSame(['maxValuesPerFacet' => 100], $this->index->getFaceting());
+        $this->assertSame([
+            'maxValuesPerFacet' => 100,
+            'sortFacetValuesBy' => [
+                '*' => 'alpha',
+            ],
+        ], $this->index->getFaceting());
         $this->assertSame(['maxTotalHits' => 1000], $this->index->getPagination());
         $this->assertSame(
             [

tests/Endpoints/MultiSearchTest.php

@@ -73,4 +73,21 @@ public function testMultiSearch(): void
         $this->assertArrayHasKey('totalPages', $response['results'][1]);
         $this->assertCount(1, $response['results'][1]['hits']);
     }
+
+    public function testSupportedQueryParams(): void
+    {
+        $query = (new SearchQuery())
+            ->setIndexUid($this->booksIndex->getUid())
+            ->setVector([1, 0.9, [0.9874]])
+            ->setAttributesToSearchOn(['comment'])
+            ->setShowRankingScore(true)
+            ->setShowRankingScoreDetails(true);
+
+        $result = $query->toArray();
+
+        $this->assertEquals([1, 0.9, [0.9874]], $result['vector']);
+        $this->assertEquals(['comment'], $result['attributesToSearchOn']);
+        $this->assertEquals(true, $result['showRankingScore']);
+        $this->assertEquals(true, $result['showRankingScoreDetails']);
+    }
 }

tests/Endpoints/SearchTest.php

@@ -6,6 +6,7 @@
 
 use Meilisearch\Endpoints\Indexes;
 use Meilisearch\Exceptions\ApiException;
+use Meilisearch\Http\Client;
 use Tests\TestCase;
 
 final class SearchTest extends TestCase
@@ -687,6 +688,36 @@ public function testBasicSearchWithFacetsOptionAndMultipleFacets(): void
         $this->assertEquals($response->getRaw()['facetDistribution'], $response->getFacetDistribution());
     }
 
+    public function testVectorSearch(): void
+    {
+        $http = new Client($this->host, getenv('MEILISEARCH_API_KEY'));
+        $http->patch('/experimental-features', ['vectorStore' => true]);
+
+        $response = $this->index->addDocuments([
+            ['id' => 32, 'title' => 'The Witcher', '_vectors' => [1, 0.3]],
+            ['id' => 32, 'title' => 'Interestellar', '_vectors' => [0.5, 0.53]],
+        ]);
+        $this->index->waitForTask($response['taskUid']);
+
+        $response = $this->index->search('', ['vector' => [0.5921]]);
+        $hit = $response->getHits()[0];
+
+        $this->assertEquals($hit['title'], 'Interestellar');
+        $this->assertEquals($hit['_vectors'], [0.5, 0.53]);
+        $this->assertArrayHasKey('_semanticScore', $hit);
+    }
+
+    public function testShowRankingScoreDetails(): void
+    {
+        $http = new Client($this->host, getenv('MEILISEARCH_API_KEY'));
+        $http->patch('/experimental-features', ['scoreDetails' => true]);
+
+        $response = $this->index->search('the', ['showRankingScoreDetails' => true]);
+        $hit = $response->getHits()[0];
+
+        $this->assertArrayHasKey('_rankingScoreDetails', $hit);
+    }
+
     public function testBasicSearchWithTransformFacetsDritributionOptionToFilter(): void
     {
         $response = $this->index->updateFilterableAttributes(['genre']);
@@ -719,6 +750,23 @@ function (int $facetValue): bool { return 1 < $facetValue; },
         $this->assertEquals(2, $response->getFacetDistribution()['genre']['fantasy']);
     }
 
+    public function testSearchWithAttributesToSearchOn(): void
+    {
+        $response = $this->index->updateSearchableAttributes(['comment', 'title']);
+        $this->index->waitForTask($response['taskUid']);
+
+        $response = $this->index->search('the', ['attributesToSearchOn' => ['comment']]);
+
+        $this->assertEquals('The best book', $response->getHits()[0]['comment']);
+    }
+
+    public function testSearchWithShowRankingScore(): void
+    {
+        $response = $this->index->search('the', ['showRankingScore' => true]);
+
+        $this->assertArrayHasKey('_rankingScore', $response->getHits()[0]);
+    }
+
     public function testBasicSearchWithTransformFacetsDritributionOptionToMap(): void
     {
         $response = $this->index->updateFilterableAttributes(['genre']);