Meilisearch PHP | Documentation

Settings extends Data

in package

• Application

implements ArrayAccess, JsonSerializable uses ReadOnlyArrayAccess

Tags

phpstan-type

EmbedderDistribution array{mean: float, sigma: float}

EmbedderFragments array<string, mixed>

EmbedderHeaders array<string, string>

EmbedderTemplate array<string, mixed>

SearchEmbedderConfig array{ apiKey?: string, binaryQuantized?: bool, dimensions?: int, distribution?: EmbedderDistribution, headers?: EmbedderHeaders, indexingFragments?: EmbedderFragments, model?: string, pooling?: string, request?: EmbedderTemplate, response?: EmbedderTemplate, revision?: string, searchFragments?: EmbedderFragments, source?: string, url?: string }

IndexingEmbedderConfig array{ apiKey?: string, binaryQuantized?: bool, dimensions?: int, distribution?: EmbedderDistribution, documentTemplate?: string, documentTemplateMaxBytes?: int, headers?: EmbedderHeaders, indexingFragments?: EmbedderFragments, model?: string, pooling?: string, request?: EmbedderTemplate, response?: EmbedderTemplate, revision?: string, searchFragments?: EmbedderFragments, source?: string, url?: string }

EmbedderConfig array{ apiKey?: string, binaryQuantized?: bool, dimensions?: int, distribution?: EmbedderDistribution, documentTemplate?: string, documentTemplateMaxBytes?: int, headers?: EmbedderHeaders, indexingFragments?: EmbedderFragments, indexingEmbedder?: IndexingEmbedderConfig, model?: string, pooling?: string, request?: EmbedderTemplate, response?: EmbedderTemplate, revision?: string, searchFragments?: EmbedderFragments, searchEmbedder?: SearchEmbedderConfig, source?: string, url?: string }

SearchEmbedderConfigUpdate array{ apiKey?: string|null, binaryQuantized?: bool|null, dimensions?: int|null, distribution?: EmbedderDistribution|null, headers?: EmbedderHeaders|null, indexingFragments?: EmbedderFragments|null, model?: string|null, pooling?: string|null, request?: EmbedderTemplate|null, response?: EmbedderTemplate|null, revision?: string|null, searchFragments?: EmbedderFragments|null, source?: string|null, url?: string|null }

IndexingEmbedderConfigUpdate array{ apiKey?: string|null, binaryQuantized?: bool|null, dimensions?: int|null, distribution?: EmbedderDistribution|null, documentTemplate?: string|null, documentTemplateMaxBytes?: int|null, headers?: EmbedderHeaders|null, indexingFragments?: EmbedderFragments|null, model?: string|null, pooling?: string|null, request?: EmbedderTemplate|null, response?: EmbedderTemplate|null, revision?: string|null, searchFragments?: EmbedderFragments|null, source?: string|null, url?: string|null }

EmbedderConfigUpdate array{ apiKey?: string|null, binaryQuantized?: bool|null, dimensions?: int|null, distribution?: EmbedderDistribution|null, documentTemplate?: string|null, documentTemplateMaxBytes?: int|null, headers?: EmbedderHeaders|null, indexingFragments?: EmbedderFragments|null, indexingEmbedder?: IndexingEmbedderConfigUpdate|null, model?: string|null, pooling?: string|null, request?: EmbedderTemplate|null, response?: EmbedderTemplate|null, revision?: string|null, searchFragments?: EmbedderFragments|null, searchEmbedder?: SearchEmbedderConfigUpdate|null, source?: string|null, url?: string|null }

SettingsEmbedders array<non-empty-string, EmbedderConfig>

SettingsEmbeddersUpdate array<non-empty-string, EmbedderConfigUpdate|null>

SettingsTypoTolerance array{ enabled?: bool, minWordSizeForTypos?: array{oneTypo?: int, twoTypos?: int}, disableOnWords?: list, disableOnAttributes?: list, disableOnNumbers?: bool }

SettingsChatSearchParameters array{ indexUid?: non-empty-string, q?: string, filter?: list<non-empty-string|list>, locales?: list, attributesToRetrieve?: list, attributesToCrop?: list, cropLength?: positive-int, attributesToHighlight?: list, cropMarker?: string, highlightPreTag?: string, highlightPostTag?: string, facets?: list, showMatchesPosition?: bool, sort?: list, 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>, hybrid?: array, attributesToSearchOn?: non-empty-list, showRankingScore?: bool, showRankingScoreDetails?: bool, rankingScoreThreshold?: float, distinct?: non-empty-string, federationOptions?: array }

RawSettings array{ dictionary?: list, displayedAttributes?: list, distinctAttribute?: string|null, embedders?: SettingsEmbedders|null, faceting?: array{ maxValuesPerFacet?: non-negative-int, sortFacetValuesBy?: array<non-empty-string, 'alpha'|'count'> }|null, facetSearch?: bool, filterableAttributes?: list<string|array{ attributePatterns: list, features?: array{ facetSearch: bool, filter: array{equality: bool, comparison: bool} } }>|null, localizedAttributes?: list<array{locales: list, attributePatterns: list}>, nonSeparatorTokens?: list, pagination?: array{maxTotalHits: non-negative-int}, prefixSearch?: 'indexingTime'|'disabled'|null, proximityPrecision?: 'byWord'|'byAttribute', rankingRules?: list, searchableAttributes?: list, searchCutoffMs?: non-negative-int|null, separatorTokens?: list, sortableAttributes?: list, stopWords?: list, synonyms?: array<string, list>|null, typoTolerance?: SettingsTypoTolerance|null, chat?: array{ description: string, documentTemplate: string, documentTemplateMaxBytes: int, searchParameters: SettingsChatSearchParameters } }

Table of Contents

Interfaces

ArrayAccess

JsonSerializable

Properties

$data  : array<string|int, mixed>

Methods

__construct()  : mixed

count()  : int

getIterator()  : ArrayIterator

jsonSerialize()  : object

offsetExists()  : bool

offsetGet()  : mixed

offsetSet()  : void

offsetUnset()  : void

toArray()  : RawSettings