-
Notifications
You must be signed in to change notification settings - Fork 97
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
643: Changes related to the next Meilisearch release (v1.9.0) r=curquiza a=meili-bot Related to this issue: meilisearch/integration-guides#301 This PR: - gathers the changes related to the next Meilisearch release (v1.9.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.9.0 is out.⚠️ This PR should NOT be merged until the next release of Meilisearch (v1.9.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: Shalabh Agarwal <[email protected]> Co-authored-by: Many the fish <[email protected]> Co-authored-by: curquiza <[email protected]> Co-authored-by: Clémentine <[email protected]>
- Loading branch information
Showing
11 changed files
with
478 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Meilisearch\Contracts; | ||
|
|
||
| class SimilarDocumentsQuery | ||
| { | ||
| /** | ||
| * @var int|string | ||
| */ | ||
| private $id; | ||
| private ?int $offset = null; | ||
| private ?int $limit = null; | ||
| private ?string $embedder = null; | ||
| private ?array $attributesToRetrieve = null; | ||
| private ?bool $showRankingScore = null; | ||
| private ?bool $showRankingScoreDetails = null; | ||
| private ?bool $retrieveVectors = null; | ||
| private ?array $filter = null; | ||
|
|
||
| /** | ||
| * @param int|string $id | ||
| */ | ||
| public function __construct($id) | ||
| { | ||
| $this->id = $id; | ||
| } | ||
|
|
||
| /** | ||
| * @param non-negative-int $offset | ||
| */ | ||
| public function setOffset(?int $offset): SimilarDocumentsQuery | ||
| { | ||
| $this->offset = $offset; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @param positive-int $limit | ||
| */ | ||
| public function setLimit(?int $limit): SimilarDocumentsQuery | ||
| { | ||
| $this->limit = $limit; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @param array<int, array<int, string>|string> $filter an array of arrays representing filter conditions | ||
| */ | ||
| public function setFilter(array $filter): SimilarDocumentsQuery | ||
| { | ||
| $this->filter = $filter; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @param non-empty-string $embedder | ||
| */ | ||
| public function setEmbedder(string $embedder): SimilarDocumentsQuery | ||
| { | ||
| $this->embedder = $embedder; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @param list<non-empty-string> $attributesToRetrieve an array of attribute names to retrieve | ||
| */ | ||
| public function setAttributesToRetrieve(array $attributesToRetrieve): SimilarDocumentsQuery | ||
| { | ||
| $this->attributesToRetrieve = $attributesToRetrieve; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @param bool|null $showRankingScore boolean value to show ranking score | ||
| */ | ||
| public function setShowRankingScore(?bool $showRankingScore): SimilarDocumentsQuery | ||
| { | ||
| $this->showRankingScore = $showRankingScore; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @param bool|null $showRankingScoreDetails boolean value to show ranking score details | ||
| */ | ||
| public function setShowRankingScoreDetails(?bool $showRankingScoreDetails): SimilarDocumentsQuery | ||
| { | ||
| $this->showRankingScoreDetails = $showRankingScoreDetails; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @param bool|null $retrieveVectors boolean value to show _vector details | ||
| */ | ||
| public function setRetrieveVectors(?bool $retrieveVectors): SimilarDocumentsQuery | ||
| { | ||
| $this->retrieveVectors = $retrieveVectors; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @return array{id: int|string, offset: non-negative-int, limit: positive-int, filter: array<int, array<int, string>|string>, embedder: non-empty-string, attributesToRetrieve: list<non-empty-string>, showRankingScore: bool, showRankingScoreDetails: bool, retrieveVectors: bool} SimilarDocumentsQuery converted to an array with non null fields | ||
| */ | ||
| public function toArray(): array | ||
| { | ||
| return array_filter([ | ||
| 'id' => $this->id, | ||
| 'offset' => $this->offset, | ||
| 'limit' => $this->limit, | ||
| 'filter' => $this->filter, | ||
| 'embedder' => $this->embedder, | ||
| 'attributesToRetrieve' => $this->attributesToRetrieve, | ||
| 'showRankingScore' => $this->showRankingScore, | ||
| 'showRankingScoreDetails' => $this->showRankingScoreDetails, | ||
| 'retrieveVectors' => $this->retrieveVectors, | ||
| ], function ($item) { | ||
| return null !== $item; | ||
| }); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Meilisearch\Search; | ||
|
|
||
| class SimilarDocumentsSearchResult implements \Countable, \IteratorAggregate | ||
| { | ||
| /** | ||
| * @var array<int, array<string, mixed>> | ||
| */ | ||
| private array $hits; | ||
|
|
||
| /** | ||
| * `estimatedTotalHits` is the attributes returned by the Meilisearch server | ||
| * and its value will not be modified by the methods in this class. | ||
| * Please, use `hitsCount` if you want to know the real size of the `hits` array at any time. | ||
| */ | ||
| private int $estimatedTotalHits; | ||
| private int $hitsCount; | ||
| private int $offset; | ||
| private int $limit; | ||
| private int $processingTimeMs; | ||
| private string $id; | ||
|
|
||
| public function __construct(array $body) | ||
| { | ||
| $this->id = $body['id']; | ||
| $this->hits = $body['hits']; | ||
| $this->hitsCount = \count($body['hits']); | ||
| $this->processingTimeMs = $body['processingTimeMs']; | ||
| $this->offset = $body['offset']; | ||
| $this->limit = $body['limit']; | ||
| $this->estimatedTotalHits = $body['estimatedTotalHits']; | ||
| } | ||
|
|
||
| /** | ||
| * @return array<string, mixed>|null | ||
| */ | ||
| public function getHit(int $key): ?array | ||
| { | ||
| return $this->hits[$key]; | ||
| } | ||
|
|
||
| /** | ||
| * @return array<int, array<string, mixed>> | ||
| */ | ||
| public function getHits(): array | ||
| { | ||
| return $this->hits; | ||
| } | ||
|
|
||
| public function getOffset(): int | ||
| { | ||
| return $this->offset; | ||
| } | ||
|
|
||
| public function getLimit(): int | ||
| { | ||
| return $this->limit; | ||
| } | ||
|
|
||
| public function getEstimatedTotalHits(): int | ||
| { | ||
| return $this->estimatedTotalHits; | ||
| } | ||
|
|
||
| public function getProcessingTimeMs(): int | ||
| { | ||
| return $this->processingTimeMs; | ||
| } | ||
|
|
||
| public function getId(): string | ||
| { | ||
| return $this->id; | ||
| } | ||
|
|
||
| public function getHitsCount(): int | ||
| { | ||
| return $this->hitsCount; | ||
| } | ||
|
|
||
| /** | ||
| * Converts the SimilarDocumentsSearchResult to an array representation. | ||
| * | ||
| * @return array<string, mixed> | ||
| */ | ||
| public function toArray(): array | ||
| { | ||
| return [ | ||
| 'id' => $this->id, | ||
| 'hits' => $this->hits, | ||
| 'hitsCount' => $this->hitsCount, | ||
| 'processingTimeMs' => $this->processingTimeMs, | ||
| 'offset' => $this->offset, | ||
| 'limit' => $this->limit, | ||
| 'estimatedTotalHits' => $this->estimatedTotalHits, | ||
| ]; | ||
| } | ||
|
|
||
| public function getIterator(): \ArrayIterator | ||
| { | ||
| return new \ArrayIterator($this->hits); | ||
| } | ||
|
|
||
| public function count(): int | ||
| { | ||
| return $this->hitsCount; | ||
| } | ||
| } |
Oops, something went wrong.