Merge #631

631: Changes related to the next Meilisearch release (v1.8.0) r=curquiza a=meili-bot

Related to this issue: meilisearch/integration-guides#299

This PR:
- gathers the changes related to the next Meilisearch release (v1.8.0) so that this package is ready when the official release is out.
- should pass the tests against the [latest pre-release of Meilisearch](https://github.com/meilisearch/meilisearch/releases).
- might eventually contain test failures until the Meilisearch v1.8.0 is out.

⚠️ This PR should NOT be merged until the next release of Meilisearch (v1.8.0) is out.

_This PR is auto-generated for the [pre-release week](https://github.com/meilisearch/integration-guides/blob/main/resources/pre-release-week.md) purpose._


Co-authored-by: meili-bot <[email protected]>
Co-authored-by: Clémentine U. - curqui <[email protected]>
Co-authored-by: curquiza <[email protected]>
Co-authored-by: Bruno Casali <[email protected]>
Co-authored-by: Clémentine <[email protected]>

Author: 4 people

.code-samples.meilisearch.yaml

@@ -216,7 +216,8 @@ update_settings_1: |-
     ],
     'faceting' => [
       'maxValuesPerFacet' => 200
-    ]
+    ],
+    'searchCutoffMs' => 150
   ]);
 reset_settings_1: |-
   $client->index('movies')->resetSettings();
@@ -707,3 +708,13 @@ update_proximity_precision_settings_1: |-
   $client->index('books')->updateProximityPrecision('byAttribute');
 reset_proximity_precision_settings_1: |-
   $client->index('books')->resetProximityPrecision();
+get_search_cutoff_1: |-
+  $client->index('movies')->getSearchCutoffMs();
+update_search_cutoff_1: |-
+  $client->index('movies')->updateSearchCutoffMs(150);
+reset_search_cutoff_1: |-
+  $client->index('movies')->resetSearchCutoffMs();
+negative_search_1: |-
+  $client->index('movies')->search('-escape');
+negative_search_2: |-
+  $client->index('movies')->search('-"escape"');

src/Endpoints/Delegates/HandlesSettings.php

@@ -365,6 +365,23 @@ public function resetProximityPrecision(): array
         return $this->http->delete(self::PATH.'/'.$this->uid.'/settings/proximity-precision');
     }
 
+    // Settings - searchCutoffMs
+
+    public function getSearchCutoffMs(): ?int
+    {
+        return $this->http->get(self::PATH.'/'.$this->uid.'/settings/search-cutoff-ms');
+    }
+
+    public function updateSearchCutoffMs(int $value): array
+    {
+        return $this->http->put(self::PATH.'/'.$this->uid.'/settings/search-cutoff-ms', $value);
+    }
+
+    public function resetSearchCutoffMs(): array
+    {
+        return $this->http->delete(self::PATH.'/'.$this->uid.'/settings/search-cutoff-ms');
+    }
+
     // Settings - Experimental: Embedders (hybrid search)
 
     public function getEmbedders(): ?array

src/Search/SearchResult.php

@@ -20,6 +20,7 @@ class SearchResult implements \Countable, \IteratorAggregate
     private ?int $hitsCount;
     private ?int $offset;
     private ?int $limit;
+    private ?int $semanticHitCount;
 
     private ?int $hitsPerPage;
     private ?int $page;
@@ -65,6 +66,7 @@ public function __construct(array $body)
             $this->hitsCount = $body['totalHits'];
         }
 
+        $this->semanticHitCount = $body['semanticHitCount'] ?? 0;
         $this->hits = $body['hits'] ?? [];
         $this->processingTimeMs = $body['processingTimeMs'];
         $this->query = $body['query'];
@@ -137,6 +139,14 @@ public function getHitsCount(): int
         return $this->hitsCount;
     }
 
+    /**
+     * @return non-negative-int
+     */
+    public function getSemanticHitCount(): int
+    {
+        return $this->semanticHitCount;
+    }
+
     public function count(): int
     {
         return $this->hitsCount;

tests/Endpoints/SearchTest.php

@@ -700,6 +700,7 @@ public function testVectorSearch(): void
 
         $response = $index->search('', ['vector' => [1], 'hybrid' => ['semanticRatio' => 1.0]]);
 
+        self::assertSame(0, $response->getSemanticHitCount());
         self::assertEmpty($response->getHits());
     }
 

tests/Settings/EmbeddersTest.php

@@ -41,6 +41,7 @@ public function testUpdateEmbeddersWithOpenAi(): void
         $index->waitForTask($promise['taskUid']);
 
         $embedders = $index->getEmbedders();
+        $embedderConfig['apiKey'] = '<yoXXXXX...';
 
         self::assertSame($embedderConfig, $embedders['myEmbedder']);
     }
@@ -50,6 +51,7 @@ public function testUpdateEmbeddersWithUserProvided(): void
         $embedderConfig = [
             'source' => 'userProvided',
             'dimensions' => 1,
+            'distribution' => ['mean' => 0.7, 'sigma' => 0.3],
         ];
         $index = $this->createEmptyIndex($this->safeIndexName());
 
@@ -69,6 +71,7 @@ public function testUpdateEmbeddersWithHuggingFace(): void
             'source' => 'huggingFace',
             'model' => 'sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2',
             'documentTemplate' => "A movie titled '{{doc.title}}' whose description starts with {{doc.overview|truncatewords: 20}}",
+            'distribution' => ['mean' => 0.7, 'sigma' => 0.3],
         ];
         $index = $this->createEmptyIndex($this->safeIndexName());
 

tests/Settings/SearchCutoffMsTest.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Settings;
+
+use Meilisearch\Endpoints\Indexes;
+use Tests\TestCase;
+
+final class SearchCutoffMsTest extends TestCase
+{
+    private Indexes $index;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->index = $this->createEmptyIndex($this->safeIndexName());
+    }
+
+    public function testGetDefaultSearchCutoffMs(): void
+    {
+        $default = $this->index->getSearchCutoffMs();
+
+        self::assertNull($default);
+    }
+
+    public function testUpdateSearchCutoffMs(): void
+    {
+        $promise = $this->index->updateSearchCutoffMs(50);
+        $this->assertIsValidPromise($promise);
+        $this->index->waitForTask($promise['taskUid']);
+
+        self::assertSame(50, $this->index->getSearchCutoffMs());
+    }
+
+    public function testResetSearchCutoffMs(): void
+    {
+        $promise = $this->index->updateSearchCutoffMs(50);
+        $this->assertIsValidPromise($promise);
+        $this->index->waitForTask($promise['taskUid']);
+
+        $promise = $this->index->resetSearchCutoffMs();
+
+        $this->assertIsValidPromise($promise);
+        $this->index->waitForTask($promise['taskUid']);
+
+        self::assertNull($this->index->getSearchCutoffMs());
+    }
+}