Meilisearch PHP | Documentation

Errors

Table of Contents

src/Contracts/BatchesQuery.php 1
src/Contracts/BatchesResults.php 8
src/Contracts/ChatWorkspacesResults.php 8
src/Contracts/DocumentsQuery.php 5
src/Contracts/IndexesQuery.php 5
src/Contracts/KeysQuery.php 5
src/Contracts/MultiSearchFederation.php 5
src/Contracts/SearchQuery.php 8
src/Contracts/SimilarDocumentsQuery.php 3
src/Contracts/Task.php 2
src/Contracts/TaskDetails/DocumentAdditionOrUpdateDetails.php 3
src/Contracts/TaskDetails/DocumentDeletionDetails.php 2
src/Contracts/TaskDetails/DocumentEditionDetails.php 1
src/Contracts/TaskDetails/IndexDeletionDetails.php 2
src/Contracts/TaskDetails/SettingsUpdateDetails.php 5
src/Contracts/TaskDetails/TaskCancelationDetails.php 3
src/Contracts/TaskDetails/TaskDeletionDetails.php 3
src/Contracts/TasksQuery.php 1
src/Contracts/TasksResults.php 8
src/Endpoints/Delegates/HandlesSettings.php 15
src/Search/SearchResult.php 1

BatchesQuery.php

Type Line Description
ERROR 18 Tag "var" with body "@var non-negative-int|null" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.

BatchesResults.php

Type Line Description
ERROR 27 Tag "var" with body "@var non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 22 Tag "var" with body "@var non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 17 Tag "var" with body "@var non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 12 Tag "var" with body "@var non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 74 Tag "return" with body "@return non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 66 Tag "return" with body "@return non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 58 Tag "return" with body "@return non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 50 Tag "return" with body "@return non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.

ChatWorkspacesResults.php

Type Line Description
ERROR 22 Tag "var" with body "@var non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 17 Tag "var" with body "@var non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 12 Tag "var" with body "@var non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 86 Tag "return" with body "@return non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 73 Tag "return" with body "@return array{ results: array, offset: non-negative-int, limit: non-negative-int, total: non-negative-int }" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 60 Tag "return" with body "@return non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 52 Tag "return" with body "@return non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 44 Tag "return" with body "@return non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.

DocumentsQuery.php

Type Line Description
ERROR 17 Tag "var" with body "@var non-negative-int|null" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 12 Tag "var" with body "@var non-negative-int|null" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 146 Tag "return" with body "@return array{ offset?: non-negative-int, limit?: non-negative-int, fields?: non-empty-list<string>|non-empty-string, filter?: list<non-empty-string|list<non-empty-string>>, retrieveVectors?: bool, ids?: string, sort?: non-empty-list<string>, }" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 58 Tag "param" with body "@param non-negative-int $limit" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 46 Tag "param" with body "@param non-negative-int $offset" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.

IndexesQuery.php

Type Line Description
ERROR 17 Tag "var" with body "@var non-negative-int|null" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 12 Tag "var" with body "@var non-negative-int|null" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 49 Tag "return" with body "@return array{ offset?: non-negative-int, limit?: non-negative-int }" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 36 Tag "param" with body "@param non-negative-int $limit" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 24 Tag "param" with body "@param non-negative-int $offset" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.

KeysQuery.php

Type Line Description
ERROR 17 Tag "var" with body "@var non-negative-int|null" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 12 Tag "var" with body "@var non-negative-int|null" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 49 Tag "return" with body "@return array{ offset?: non-negative-int, limit?: non-negative-int }" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 36 Tag "param" with body "@param non-negative-int $limit" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 24 Tag "param" with body "@param non-negative-int $offset" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.

MultiSearchFederation.php

Type Line Description
ERROR 17 Tag "var" with body "@var non-negative-int|null" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 12 Tag "var" with body "@var non-negative-int|null" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 85 Tag "return" with body "@return array{ limit?: non-negative-int, offset?: non-negative-int, facetsByIndex?: array<non-empty-string, list<non-empty-string>>, mergeFacets?: array{maxValuesPerFacet: positive-int}, }" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 46 Tag "param" with body "@param non-negative-int $offset" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 34 Tag "param" with body "@param non-negative-int $limit" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.

SearchQuery.php

Type Line Description
ERROR 87 Tag "var" with body "@var non-negative-int|null" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 82 Tag "var" with body "@var non-negative-int|null" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 77 Tag "var" with body "@var non-negative-int|null" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 72 Tag "var" with body "@var non-negative-int|null" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 463 Tag "return" with body "@return array{ indexUid?: non-empty-string, q?: string, filter?: list<non-empty-string|list<non-empty-string>>, locales?: list<non-empty-string>, attributesToRetrieve?: list<non-empty-string>, attributesToCrop?: list<non-empty-string>, cropLength?: positive-int, attributesToHighlight?: list<non-empty-string>, cropMarker?: string, highlightPreTag?: string, highlightPostTag?: string, facets?: list<non-empty-string>, showMatchesPosition?: bool, sort?: list<non-empty-string>, matchingStrategy?: 'last'|'all'|'frequency', offset?: non-negative-int, limit?: non-negative-int, hitsPerPage?: non-negative-int, page?: non-negative-int, vector?: non-empty-list<float|non-empty-list<float>>, hybrid?: array<mixed>, attributesToSearchOn?: non-empty-list<non-empty-string>, showRankingScore?: bool, showRankingScoreDetails?: bool, rankingScoreThreshold?: float, distinct?: non-empty-string, federationOptions?: array<mixed> }" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 345 Tag "param" with body "@param non-negative-int|null $hitsPerPage" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 333 Tag "param" with body "@param non-negative-int|null $limit" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 321 Tag "param" with body "@param non-negative-int|null $offset" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.

SimilarDocumentsQuery.php

Type Line Description
ERROR 22 Tag "var" with body "@var non-negative-int|null" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 165 Tag "return" with body "@return array{ id: int|non-empty-string, embedder: non-empty-string, offset?: non-negative-int, limit?: positive-int, filter?: array<int, array<int, string>|string>, attributesToRetrieve?: list<non-empty-string>, showRankingScore?: bool, showRankingScoreDetails?: bool, retrieveVectors?: bool, rankingScoreThreshold?: int|float }" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 62 Tag "param" with body "@param non-negative-int|null $offset" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.

Task.php

Type Line Description
ERROR 49 Tag "return" with body "@return non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 29 Tag "param" with body "@param non-negative-int $taskUid" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.

DocumentAdditionOrUpdateDetails.php

Type Line Description
ERROR 21 Tag "param" with body "@param non-negative-int|null $indexedDocuments Number of documents indexed. `null` while the task status is enqueued or processing." has error "\Meilisearch\Contracts\TaskDetails\non-negative-int" is not a valid Fqsen.
ERROR 21 Tag "param" with body "@param non-negative-int $receivedDocuments number of documents received" has error "\Meilisearch\Contracts\TaskDetails\non-negative-int" is not a valid Fqsen.
ERROR 15 Tag "implements" with body "@implements TaskDetails<array{ receivedDocuments: non-negative-int, indexedDocuments: non-negative-int|null }>" has error "\Meilisearch\Contracts\TaskDetails\non-negative-int" is not a valid Fqsen.

DocumentDeletionDetails.php

Type Line Description
ERROR 23 Tag "param" with body "@param non-negative-int|null $providedIds number of documents queued for deletion" has error "\Meilisearch\Contracts\TaskDetails\non-negative-int" is not a valid Fqsen.
ERROR 16 Tag "implements" with body "@implements TaskDetails<array{ providedIds?: non-negative-int, originalFilter?: string|null, deletedDocuments?: non-negative-int|null }>" has error "\Meilisearch\Contracts\TaskDetails\non-negative-int" is not a valid Fqsen.

DocumentEditionDetails.php

Type Line Description
ERROR 18 Tag "implements" with body "@implements TaskDetails<array{ context: array<non-empty-string, scalar|null>, deletedDocuments: non-negative-int|null, editedDocuments: non-negative-int|null, function: string|null, originalFilter: string|null }>" has error "\Meilisearch\Contracts\TaskDetails\non-negative-int" is not a valid Fqsen.

IndexDeletionDetails.php

Type Line Description
ERROR 19 Tag "param" with body "@param non-negative-int|null $deletedDocuments Number of deleted documents. This should equal the total number of documents in the deleted index. `null` while the task status is enqueued or processing." has error "\Meilisearch\Contracts\TaskDetails\non-negative-int" is not a valid Fqsen.
ERROR 14 Tag "implements" with body "@implements TaskDetails<array{ deletedDocuments: non-negative-int|null }>" has error "\Meilisearch\Contracts\TaskDetails\non-negative-int" is not a valid Fqsen.

SettingsUpdateDetails.php

Type Line Description
ERROR 99 Tag "method" with body "@method (non-empty-array<non-empty-string, array{apiKey?: string, binaryQuantized?: bool, dimensions?: int, distribution?: array{mean: float, sigma: float}, documentTemplate?: string, documentTemplateMaxBytes?: int, indexingEmbedder?: array{model: string, source: string}, model?: string, pooling?: string, request?: array<string, mixed>, response?: array<string, mixed>, revision?: string, searchEmbedder?: array{model: string, source: string}, source?: string, url?: string}> | null) $embedders" has error non-empty-array is not a collection
ERROR 99 Tag "param" with body "@param non-negative-int|null $searchCutoffMs" has error "\Meilisearch\Contracts\TaskDetails\non-negative-int" is not a valid Fqsen.
ERROR 99 Tag "param" with body "@param array{maxTotalHits: non-negative-int}|null $pagination" has error "\Meilisearch\Contracts\TaskDetails\non-negative-int" is not a valid Fqsen.
ERROR 99 Tag "param" with body "@param array{maxValuesPerFacet: non-negative-int, sortFacetValuesBy: array<string, 'alpha'|'count'>}|null $faceting" has error "\Meilisearch\Contracts\TaskDetails\non-negative-int" is not a valid Fqsen.
ERROR 55 Tag "method" with body "@method TaskDetails<array{dictionary?: list<string>, displayedAttributes?: list<string>, distinctAttribute?: string, embedders?: non-empty-array<non-empty-string, array{apiKey?: string, binaryQuantized?: bool, dimensions?: int, distribution?: array{mean: float, sigma: float}, documentTemplate?: string, documentTemplateMaxBytes?: int, indexingEmbedder?: array{model: string, source: string}, model?: string, pooling?: string, request?: array<string, mixed>, response?: array<string, mixed>, revision?: string, searchEmbedder?: array{model: string, source: string}, source?: string, url?: string}>, faceting?: (array{maxValuesPerFacet: non-negative-int, sortFacetValuesBy: array<string, ('alpha' | 'count')>} | null), facetSearch?: bool, filterableAttributes?: (list<(string | array{attributePatterns: list<string>, features: array{facetSearch: bool, filter: array{equality: bool, comparison: bool}}})> | null), localizedAttributes?: list<array{locales: list<non-empty-string>, attributePatterns: list<string>}>, nonSeparatorTokens?: list<string>, pagination?: array{maxTotalHits: non-negative-int}, prefixSearch?: (non-empty-string | null), proximityPrecision?: ('byWord' | 'byAttribute'), rankingRules?: list<non-empty-string>, searchableAttributes?: list<non-empty-string>, searchCutoffMs?: non-negative-int, separatorTokens?: list<string>, sortableAttributes?: list<non-empty-string>, stopWords?: list<string>, synonyms?: array<string, list<string>>, typoTolerance?: array{enabled: bool, minWordSizeForTypos: array{oneTypo: int, twoTypos: int}, disableOnWords: list<string>, disableOnAttributes: list<string>, disableOnNumbers: bool}}>" has error non-empty-array is not a collection

TaskCancelationDetails.php

Type Line Description
ERROR 23 Tag "param" with body "@param non-negative-int|null $canceledTasks The number of tasks successfully canceled. If the task cancellation fails, this will be 0. null when the task status is enqueued or processing." has error "\Meilisearch\Contracts\TaskDetails\non-negative-int" is not a valid Fqsen.
ERROR 23 Tag "param" with body "@param non-negative-int|null $matchedTasks The number of matched tasks. If the API key used for the request doesn’t have access to an index, tasks relating to that index will not be included in matchedTasks." has error "\Meilisearch\Contracts\TaskDetails\non-negative-int" is not a valid Fqsen.
ERROR 16 Tag "implements" with body "@implements TaskDetails<array{ matchedTasks: non-negative-int|null, canceledTasks: non-negative-int|null, originalFilter: string|null }>" has error "\Meilisearch\Contracts\TaskDetails\non-negative-int" is not a valid Fqsen.

TaskDeletionDetails.php

Type Line Description
ERROR 23 Tag "param" with body "@param non-negative-int|null $deletedTasks The number of tasks successfully deleted. If the task deletion fails, this will be 0. null when the task status is enqueued or processing." has error "\Meilisearch\Contracts\TaskDetails\non-negative-int" is not a valid Fqsen.
ERROR 23 Tag "param" with body "@param non-negative-int|null $matchedTasks The number of matched tasks. If the API key used for the request doesn’t have access to an index, tasks relating to that index will not be included in matchedTasks." has error "\Meilisearch\Contracts\TaskDetails\non-negative-int" is not a valid Fqsen.
ERROR 16 Tag "implements" with body "@implements TaskDetails<array{ matchedTasks: non-negative-int|null, deletedTasks: non-negative-int|null, originalFilter: string|null }>" has error "\Meilisearch\Contracts\TaskDetails\non-negative-int" is not a valid Fqsen.

TasksQuery.php

Type Line Description
ERROR 18 Tag "var" with body "@var non-negative-int|null" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.

TasksResults.php

Type Line Description
ERROR 27 Tag "var" with body "@var non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 22 Tag "var" with body "@var non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 17 Tag "var" with body "@var non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 12 Tag "var" with body "@var non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 74 Tag "return" with body "@return non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 66 Tag "return" with body "@return non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 58 Tag "return" with body "@return non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.
ERROR 50 Tag "return" with body "@return non-negative-int" has error "\Meilisearch\Contracts\non-negative-int" is not a valid Fqsen.

HandlesSettings.php

Type Line Description
ERROR 596 Tag "param" with body "@param array{ description: string, documentTemplate: string, documentTemplateMaxBytes: int, searchParameters: array{ indexUid?: non-empty-string, q?: string, filter?: list<non-empty-string|list<non-empty-string>>, locales?: list<non-empty-string>, attributesToRetrieve?: list<non-empty-string>, attributesToCrop?: list<non-empty-string>, cropLength?: positive-int, attributesToHighlight?: list<non-empty-string>, cropMarker?: string, highlightPreTag?: string, highlightPostTag?: string, facets?: list<non-empty-string>, showMatchesPosition?: bool, sort?: list<non-empty-string>, matchingStrategy?: 'last'|'all'|'frequency', offset?: non-negative-int, limit?: non-negative-int, hitsPerPage?: non-negative-int, page?: non-negative-int, vector?: non-empty-list<float|non-empty-list<float>>, hybrid?: array<mixed>, attributesToSearchOn?: non-empty-list<non-empty-string>, showRankingScore?: bool, showRankingScoreDetails?: bool, rankingScoreThreshold?: float, distinct?: non-empty-string, federationOptions?: array<mixed> } } $chatSettings" has error "\Meilisearch\Endpoints\Delegates\non-negative-int" is not a valid Fqsen.
ERROR 596 Tag "since" with body "@since Meilisearch v1.15.1" has error
ERROR 553 Tag "return" with body "@return array{ description: string, documentTemplate: string, documentTemplateMaxBytes: int, searchParameters: array{ indexUid?: non-empty-string, q?: string, filter?: list<non-empty-string|list<non-empty-string>>, locales?: list<non-empty-string>, attributesToRetrieve?: list<non-empty-string>, attributesToCrop?: list<non-empty-string>, cropLength?: positive-int, attributesToHighlight?: list<non-empty-string>, cropMarker?: string, highlightPreTag?: string, highlightPostTag?: string, facets?: list<non-empty-string>, showMatchesPosition?: bool, sort?: list<non-empty-string>, matchingStrategy?: 'last'|'all'|'frequency', offset?: non-negative-int, limit?: non-negative-int, hitsPerPage?: non-negative-int, page?: non-negative-int, vector?: non-empty-list<float|non-empty-list<float>>, hybrid?: array<mixed>, attributesToSearchOn?: non-empty-list<non-empty-string>, showRankingScore?: bool, showRankingScoreDetails?: bool, rankingScoreThreshold?: float, distinct?: non-empty-string, federationOptions?: array<mixed> } }" has error "\Meilisearch\Endpoints\Delegates\non-negative-int" is not a valid Fqsen.
ERROR 553 Tag "since" with body "@since Meilisearch v1.15.1" has error
ERROR 508 Tag "since" with body "@since Meilisearch v1.12.0" has error
ERROR 500 Tag "since" with body "@since Meilisearch v1.12.0" has error
ERROR 490 Tag "since" with body "@since Meilisearch v1.12.0" has error
ERROR 478 Tag "since" with body "@since Meilisearch v1.12.0" has error
ERROR 470 Tag "since" with body "@since Meilisearch v1.12.0" has error
ERROR 462 Tag "since" with body "@since Meilisearch v1.12.0" has error
ERROR 452 Tag "since" with body "@since Meilisearch v1.13.0" has error
ERROR 444 Tag "since" with body "@since Meilisearch v1.13.0" has error
ERROR 436 Tag "since" with body "@since Meilisearch v1.13.0" has error
ERROR 421 Tag "param" with body "@param non-negative-int $value" has error "\Meilisearch\Endpoints\Delegates\non-negative-int" is not a valid Fqsen.
ERROR 413 Tag "return" with body "@return non-negative-int|null" has error "\Meilisearch\Endpoints\Delegates\non-negative-int" is not a valid Fqsen.

SearchResult.php

Type Line Description
ERROR 147 Tag "return" with body "@return non-negative-int" has error "\Meilisearch\Search\non-negative-int" is not a valid Fqsen.

Search results