Class: Index<T>

Options on document addition

Returns

RawDocumentAdditionOptions

Promise containing an EnqueuedTask

addDocumentsFromString()

addDocumentsFromString(documents, contentType, queryParams?): EnqueuedTaskPromise

Defined in: src/indexes.ts:384

Add or replace multiples documents in a string format to an index. It only supports csv, ndjson and json formats.

Parameters

documents

string

Documents provided in a string to add/replace

contentType

ContentType

Content type of your document: 'text/csv'|'application/x-ndjson'|'application/json'

queryParams?

Returns

Promise containing an EnqueuedTask

addDocumentsInBatches()

addDocumentsInBatches(documents, batchSize?, options?): EnqueuedTaskPromise[]

Defined in: src/indexes.ts:405

Add or replace multiples documents to an index in batches

Parameters

documents

T[]

Array of Document objects to add/replace

batchSize?

number = 1000

Size of the batch

options?

Options on document addition

Returns

EnqueuedTaskPromise[]

Promise containing array of enqueued task objects for each batch

compact()

compact(): EnqueuedTaskPromise

Defined in: src/indexes.ts:549

Compact the index database to reclaim space and improve read performance.

Returns

Promise containing an EnqueuedTask

delete()

delete(): EnqueuedTaskPromise

Defined in: src/indexes.ts:277

Delete an index.

Returns

Promise which resolves when index is deleted successfully

deleteAllDocuments()

deleteAllDocuments(options?): EnqueuedTaskPromise

Defined in: src/indexes.ts:537

Delete all documents of an index

Parameters

options?

Returns

Promise containing an EnqueuedTask

deleteDocument()

deleteDocument(documentId, options?): EnqueuedTaskPromise

Defined in: src/indexes.ts:493

Delete one document

Parameters

documentId

string | number

Id of Document to delete

options?

Task enqueue options (e.g. customMetadata)

Returns

DocumentsDeletionQuery | DocumentsIds

Promise containing an EnqueuedTask

deleteDocuments()

deleteDocuments(params, options?): EnqueuedTaskPromise

Defined in: src/indexes.ts:514

Delete multiples documents of an index.

Parameters

params

Params value can be:

DocumentsDeletionQuery: An object containing the parameters to customize your document deletion. Only available in Meilisearch v1.2 and newer
DocumentsIds: An array of document ids to delete

options?

Returns

Promise containing an EnqueuedTask

fetchInfo()

fetchInfo(): Promise<Index<T>>

Defined in: src/indexes.ts:221

Fetch and update Index information.

Returns

Promise<Index<T>>

Promise to the current Index object with updated information

fetchPrimaryKey()

fetchPrimaryKey(): Promise<string | undefined>

Defined in: src/indexes.ts:231

Get Primary Key.

Returns

Promise<string | undefined>

Promise containing the Primary Key of the index

getChat()

getChat(): Promise<ChatSettings>

Defined in: src/indexes.ts:1468

Get the index's chat settings.

Returns

Promise<ChatSettings>

Promise containing a ChatSettings object

getDictionary()

getDictionary(): Promise<string[]>

Defined in: src/indexes.ts:1151

Get the dictionary settings of a Meilisearch index.

Returns

Promise<string[]>

Promise containing the dictionary settings

getDisplayedAttributes()

getDisplayedAttributes(): Promise<string[]>

Defined in: src/indexes.ts:950

Get the displayed-attributes

Returns

Promise<string[]>

Promise containing array of displayed-attributes

getDistinctAttribute()

getDistinctAttribute(): Promise<DistinctAttribute>

Defined in: src/indexes.ts:783

Get the distinct-attribute

Returns

Promise<DistinctAttribute>

Promise containing the distinct-attribute of the index

getDocument()

getDocument<D>(documentId, parameters?): Promise<D>

Defined in: src/indexes.ts:345

Get one document

Type Parameters

D

D extends RecordAny = T

Parameters

documentId

string | number

Document ID

parameters?

DocumentQuery<T>

Parameters applied on a document

Returns

Promise<D>

Promise containing Document response

getDocuments()

getDocuments<D>(params?): Promise<ResourceResults<D[]>>

Defined in: src/indexes.ts:310

Get documents of an index.

Type Parameters

D

D extends RecordAny = T

Parameters

params?

DocumentsQuery<D>

Parameters to browse the documents. Parameters can contain the filter field only available in Meilisearch v1.2 and newer, and the sort field available in Meilisearch v1.16 and newer

Returns

Promise<ResourceResults<D[]>>

Promise containing the returned documents

getEmbedders()

getEmbedders(): Promise<Embedders>

Defined in: src/indexes.ts:1232

Get the embedders settings of a Meilisearch index.

Returns

Promise<Embedders>

Promise containing the embedders settings

getFaceting()

getFaceting(): Promise<Faceting>

Defined in: src/indexes.ts:1032

Get the faceting settings.

Returns

Promise<Faceting>

Promise containing object of faceting index settings

getFacetSearch()

getFacetSearch(): Promise<boolean>

Defined in: src/indexes.ts:1390

Get the facet search settings.

Returns

Promise<boolean>

Promise containing object of facet search settings

getFields()

getFields(params?, extraRequestInit?): Promise<FieldsResults>

Defined in: src/indexes.ts:1500

Retrieve fields from an index with optional filtering and pagination. This endpoint allows you to query fields based on their properties (searchable, filterable, displayed, sortable, distinct, rankingRule, and localized).

Parameters

params?

FieldsQuery

Query parameters including pagination and filter options

extraRequestInit?

Additional request configuration options

Returns

Promise<FieldsResults>

Promise containing the fields results with pagination info

getFilterableAttributes()

getFilterableAttributes(): Promise<FilterableAttributes>

Defined in: src/indexes.ts:824

Get the filterable-attributes

Returns

Promise<FilterableAttributes>

Promise containing an array of filterable-attributes

getForeignKeys()

getForeignKeys(): Promise<ForeignKey[]>

Defined in: src/indexes.ts:1351

Get the foreign keys settings.

Returns

Promise<ForeignKey[]>

Promise containing an array of foreign key settings

getLocalizedAttributes()

getLocalizedAttributes(): Promise<LocalizedAttributes>

Defined in: src/indexes.ts:1310

Get the localized attributes settings.

Returns

Promise<LocalizedAttributes>

Promise containing object of localized attributes settings

getNonSeparatorTokens()

getNonSeparatorTokens(): Promise<string[]>

Defined in: src/indexes.ts:1110

Get the list of all non-separator tokens.

Returns

Promise<string[]>

Promise containing array of non-separator tokens

getPagination()

getPagination(): Promise<PaginationSettings>

Defined in: src/indexes.ts:626

Get the pagination settings.

Returns

Promise<PaginationSettings>

Promise containing object of pagination settings

getPrefixSearch()

getPrefixSearch(): Promise<PrefixSearch>

Defined in: src/indexes.ts:1429

Get the prefix search settings.

Returns

Promise<PrefixSearch>

Promise containing object of prefix search settings

getProximityPrecision()

getProximityPrecision(): Promise<ProximityPrecision>

Defined in: src/indexes.ts:1190

Get the proximity precision settings of a Meilisearch index.

Returns

Promise<ProximityPrecision>

Promise containing the proximity precision settings

getRankingRules()

getRankingRules(): Promise<string[]>

Defined in: src/indexes.ts:743

Get the list of all ranking-rules

Returns

Promise<string[]>

Promise containing array of ranking-rules

getRawInfo()

getRawInfo(): Promise<IndexObject>

Defined in: src/indexes.ts:206

Get index information.

Returns

Promise<IndexObject>

Promise containing index information

getSearchableAttributes()

getSearchableAttributes(): Promise<string[]>

Defined in: src/indexes.ts:908

Get the searchable-attributes

Returns

Promise<string[]>

Promise containing array of searchable-attributes

getSearchCutoffMs()

getSearchCutoffMs(): Promise<SearchCutoffMs>

Defined in: src/indexes.ts:1271

Get the SearchCutoffMs settings.

Returns

Promise<SearchCutoffMs>

Promise containing object of SearchCutoffMs settings

getSeparatorTokens()

getSeparatorTokens(): Promise<string[]>

Defined in: src/indexes.ts:1071

Get the list of all separator tokens.

Returns

Promise<string[]>

Promise containing array of separator tokens

getSettings()

getSettings(): Promise<Settings>

Defined in: src/indexes.ts:587

Retrieve all settings

Returns

Promise<Settings>

Promise containing Settings object

getSortableAttributes()

getSortableAttributes(): Promise<string[]>

Defined in: src/indexes.ts:866

Get the sortable-attributes

Returns

Promise<string[]>

Promise containing array of sortable-attributes

getStats()

getStats(): Promise<IndexStats>

Defined in: src/indexes.ts:292

Get stats of an index

Returns

Promise<IndexStats>

Promise containing object with stats of the index

getStopWords()

getStopWords(): Promise<string[]>

Defined in: src/indexes.ts:704

Get the list of all stop-words

Returns

Promise<string[]>

Promise containing array of stop-words

getSynonyms()

getSynonyms(): Promise<Record<string, string[]>>

Defined in: src/indexes.ts:665

Get the list of all synonyms

Returns

Promise<Record<string, string[]>>

Promise containing record of synonym mappings

getTypoTolerance()

getTypoTolerance(): Promise<TypoTolerance>

Defined in: src/indexes.ts:992

Get the typo tolerance settings.

Returns

Promise<TypoTolerance>

Promise containing the typo tolerance settings.

resetDictionary()

resetDictionary(): EnqueuedTaskPromise

Defined in: src/indexes.ts:1175

Reset the dictionary settings to its default value

Returns

Promise containing an EnqueuedTask

resetDisplayedAttributes()

resetDisplayedAttributes(): EnqueuedTaskPromise

Defined in: src/indexes.ts:977

Reset the displayed-attributes.

Returns

Promise containing an EnqueuedTask

resetDistinctAttribute()

resetDistinctAttribute(): EnqueuedTaskPromise

Defined in: src/indexes.ts:809

Reset the distinct-attribute.

Returns

Promise containing an EnqueuedTask

resetEmbedders()

resetEmbedders(): EnqueuedTaskPromise

Defined in: src/indexes.ts:1256

Reset the embedders settings to its default value

Returns

Promise containing an EnqueuedTask

resetFaceting()

resetFaceting(): EnqueuedTaskPromise

Defined in: src/indexes.ts:1056

Reset the faceting settings.

Returns

Promise containing an EnqueuedTask

resetFacetSearch()

resetFacetSearch(): EnqueuedTaskPromise

Defined in: src/indexes.ts:1414

Reset the facet search settings.

Returns

Promise containing an EnqueuedTask

resetFilterableAttributes()

resetFilterableAttributes(): EnqueuedTaskPromise

Defined in: src/indexes.ts:851

Reset the filterable-attributes.

Returns

Promise containing an EnqueuedTask

resetForeignKeys()

resetForeignKeys(): EnqueuedTaskPromise

Defined in: src/indexes.ts:1375

Reset the foreign keys settings.

Returns

Promise containing an EnqueuedTask

resetLocalizedAttributes()

resetLocalizedAttributes(): EnqueuedTaskPromise

Defined in: src/indexes.ts:1336

Reset the localized attributes settings.

Returns

Promise containing an EnqueuedTask

resetNonSeparatorTokens()

resetNonSeparatorTokens(): EnqueuedTaskPromise

Defined in: src/indexes.ts:1136

Reset the non-separator tokens list to its default value

Returns

Promise containing an EnqueuedTask

resetPagination()

resetPagination(): EnqueuedTaskPromise

Defined in: src/indexes.ts:650

Reset the pagination settings.

Returns

Promise containing an EnqueuedTask

resetPrefixSearch()

resetPrefixSearch(): EnqueuedTaskPromise

Defined in: src/indexes.ts:1453

Reset the prefix search settings.

Returns

Promise containing an EnqueuedTask

resetProximityPrecision()

resetProximityPrecision(): EnqueuedTaskPromise

Defined in: src/indexes.ts:1217

Reset the proximity precision settings to its default value

Returns

Promise containing an EnqueuedTask

resetRankingRules()

resetRankingRules(): EnqueuedTaskPromise

Defined in: src/indexes.ts:768

Reset the ranking rules list to its default value

Returns

Promise containing an EnqueuedTask

resetSearchableAttributes()

resetSearchableAttributes(): EnqueuedTaskPromise

Defined in: src/indexes.ts:935

Reset the searchable-attributes.

Returns

Promise containing an EnqueuedTask

resetSearchCutoffMs()

resetSearchCutoffMs(): EnqueuedTaskPromise

Defined in: src/indexes.ts:1295

Reset the SearchCutoffMs settings.

Returns

Promise containing an EnqueuedTask

resetSeparatorTokens()

resetSeparatorTokens(): EnqueuedTaskPromise

Defined in: src/indexes.ts:1095

Reset the separator tokens list to its default value

Returns

Promise containing an EnqueuedTask

resetSettings()

resetSettings(): EnqueuedTaskPromise

Defined in: src/indexes.ts:611

Reset settings.

Returns

Promise containing an EnqueuedTask

resetSortableAttributes()

resetSortableAttributes(): EnqueuedTaskPromise

Defined in: src/indexes.ts:893

Reset the sortable-attributes.

Returns

Promise containing an EnqueuedTask

resetStopWords()

resetStopWords(): EnqueuedTaskPromise

Defined in: src/indexes.ts:728

Reset the stop-words list to be empty again

Returns

Promise containing an EnqueuedTask

resetSynonyms()

resetSynonyms(): EnqueuedTaskPromise

Defined in: src/indexes.ts:689

Reset the synonym list to be empty again

Returns

Promise containing an EnqueuedTask

resetTypoTolerance()

resetTypoTolerance(): EnqueuedTaskPromise

Defined in: src/indexes.ts:1017

Reset the typo tolerance settings.

Returns

Promise containing object of the enqueued update

search()

search<D, S>(query?, options?, extraRequestInit?): Promise<SearchResponse<D, S>>

Defined in: src/indexes.ts:105

Search for documents into an index

Type Parameters

D

D extends RecordAny = T

S

S extends SearchParams = SearchParams

Parameters

query?

string | null

Query string

options?

S

Search options

extraRequestInit?

SearchForFacetValuesParams

Returns

Promise<SearchResponse<D, S>>

Promise containing the search response

searchForFacetValues()

searchForFacetValues(params, extraRequestInit?): Promise<SearchForFacetValuesResponse>

Defined in: src/indexes.ts:170

Search for facet values

Parameters

params

Parameters used to search on the facets

extraRequestInit?

Returns

Promise<SearchForFacetValuesResponse>

Promise containing the search response

searchGet()

searchGet<D, S>(query?, options?, extraRequestInit?): Promise<SearchResponse<D, S>>

Defined in: src/indexes.ts:125

Search for documents into an index using the GET method

Type Parameters

D

D extends RecordAny = T

S

S extends SearchParams = SearchParams

Parameters

query?

string | null

Query string

options?

S

Search options

extraRequestInit?

SearchSimilarDocumentsParams

Returns

Promise<SearchResponse<D, S>>

Promise containing the search response

searchSimilarDocuments()

searchSimilarDocuments<D, S>(params): Promise<SearchResponse<D, S>>

Defined in: src/indexes.ts:187

Search for similar documents

Type Parameters

D

D extends RecordAny = T

S

S extends SearchParams = SearchParams

Parameters

params

Parameters used to search for similar documents

Returns

Promise<SearchResponse<D, S>>

Promise containing the search response

update()

update(data?): EnqueuedTaskPromise

Defined in: src/indexes.ts:265

Update an index.

Parameters

data?

IndexOptions

Data to update

Returns

Promise to the current Index object with updated information

updateChat()

updateChat(chatSettings): EnqueuedTaskPromise

Defined in: src/indexes.ts:1480

Update the index's chat settings.

Parameters

chatSettings

ChatSettingsPayload

ChatSettingsPayload object

Returns

Promise containing an EnqueuedTask

updateDictionary()

updateDictionary(dictionary): EnqueuedTaskPromise

Defined in: src/indexes.ts:1163

Update the dictionary settings. Overwrite the old settings.

Parameters

dictionary

Dictionary

Array that contains the new dictionary settings.

Returns

Promise containing an EnqueuedTask or null

updateDisplayedAttributes()

updateDisplayedAttributes(displayedAttributes): EnqueuedTaskPromise

Defined in: src/indexes.ts:963

Update the displayed-attributes.

Parameters

displayedAttributes

DisplayedAttributes

Array of strings that contains attributes of an index to display

Returns

Promise containing an EnqueuedTask

updateDistinctAttribute()

updateDistinctAttribute(distinctAttribute): EnqueuedTaskPromise

Defined in: src/indexes.ts:795

Update the distinct-attribute.

Parameters

distinctAttribute

DistinctAttribute

Field name of the distinct-attribute

Returns

Promise containing an EnqueuedTask

updateDocuments()

updateDocuments(documents, options?): EnqueuedTaskPromise

Defined in: src/indexes.ts:428

Add or update multiples documents to an index

Parameters

documents

Partial<T>[]

Array of Document objects to add/update

options?

Options on document update

Returns

UpdateDocumentsByFunctionOptions

Promise containing an EnqueuedTask

updateDocumentsByFunction()

updateDocumentsByFunction(options, taskOptions?): EnqueuedTaskPromise

Defined in: src/indexes.ts:567

This is an EXPERIMENTAL feature, which may break without a major version. It's available after Meilisearch v1.10.

More info about the feature: https://github.com/orgs/meilisearch/discussions/762 More info about experimental features in general: https://www.meilisearch.com/docs/reference/api/experimental-features

Parameters

options

Object containing the function string and related options

taskOptions?

Returns

RawDocumentAdditionOptions

Promise containing an EnqueuedTask

updateDocumentsFromString()

updateDocumentsFromString(documents, contentType, queryParams?): EnqueuedTaskPromise

Defined in: src/indexes.ts:473

Add or update multiples documents in a string format to an index. It only supports csv, ndjson and json formats.

Parameters

documents

string

Documents provided in a string to add/update

contentType

ContentType

Content type of your document: 'text/csv'|'application/x-ndjson'|'application/json'

queryParams?

Options on raw document addition

Returns

Promise containing an EnqueuedTask

updateDocumentsInBatches()

updateDocumentsInBatches(documents, batchSize?, options?): EnqueuedTaskPromise[]

Defined in: src/indexes.ts:447

Add or update multiples documents to an index in batches

Parameters

documents

Partial<T>[]

Array of Document objects to add/update

batchSize?

number = 1000

Size of the batch

options?

Options on document update

Returns

EnqueuedTaskPromise[]

Promise containing array of enqueued task objects for each batch

updateEmbedders()

updateEmbedders(embedders): EnqueuedTaskPromise

Defined in: src/indexes.ts:1244

Update the embedders settings. Overwrite the old settings.

Parameters

embedders

Embedders

Object that contains the new embedders settings.

Returns

Promise containing an EnqueuedTask or null

updateFaceting()

updateFaceting(faceting): EnqueuedTaskPromise

Defined in: src/indexes.ts:1044

Update the faceting settings.

Parameters

faceting

Faceting

Faceting index settings object

Returns

Promise containing an EnqueuedTask

updateFacetSearch()

updateFacetSearch(facetSearch): EnqueuedTaskPromise

Defined in: src/indexes.ts:1402

Update the facet search settings.

Parameters

facetSearch

boolean

Boolean value

Returns

Promise containing an EnqueuedTask

updateFilterableAttributes()

updateFilterableAttributes(filterableAttributes): EnqueuedTaskPromise

Defined in: src/indexes.ts:837

Update the filterable-attributes.

Parameters

filterableAttributes

FilterableAttributes

Array of strings containing the attributes that can be used as filters at query time

Returns

Promise containing an EnqueuedTask

updateForeignKeys()

updateForeignKeys(foreignKeys): EnqueuedTaskPromise

Defined in: src/indexes.ts:1363

Update the foreign keys settings.

Parameters

foreignKeys

ForeignKeys

Foreign keys array

Returns

Promise containing an EnqueuedTask

updateLocalizedAttributes()

updateLocalizedAttributes(localizedAttributes): EnqueuedTaskPromise

Defined in: src/indexes.ts:1322

Update the localized attributes settings.

Parameters

localizedAttributes

LocalizedAttributes

Localized attributes object

Returns

Promise containing an EnqueuedTask

updateNonSeparatorTokens()

updateNonSeparatorTokens(nonSeparatorTokens): EnqueuedTaskPromise

Defined in: src/indexes.ts:1122

Update the list of non-separator tokens. Overwrite the old list.

Parameters

nonSeparatorTokens

NonSeparatorTokens

Array that contains non-separator tokens.

Returns

Promise containing an EnqueuedTask or null

updatePagination()

updatePagination(pagination): EnqueuedTaskPromise

Defined in: src/indexes.ts:638

Update the pagination settings.

Parameters

pagination

PaginationSettings

Pagination object

Returns

Promise containing an EnqueuedTask

updatePrefixSearch()

updatePrefixSearch(prefixSearch): EnqueuedTaskPromise

Defined in: src/indexes.ts:1441

Update the prefix search settings.

Parameters

prefixSearch

PrefixSearch

PrefixSearch value

Returns

Promise containing an EnqueuedTask

updateProximityPrecision()

updateProximityPrecision(proximityPrecision): EnqueuedTaskPromise

Defined in: src/indexes.ts:1203

Update the proximity precision settings. Overwrite the old settings.

Parameters

proximityPrecision

ProximityPrecision

String that contains the new proximity precision settings.

Returns

Promise containing an EnqueuedTask or null

updateRankingRules()

updateRankingRules(rankingRules): EnqueuedTaskPromise

Defined in: src/indexes.ts:756

Update the list of ranking-rules. Overwrite the old list.

Parameters

rankingRules

RankingRules

Array that contain ranking rules sorted by order of importance.

Returns

Promise containing an EnqueuedTask

updateSearchableAttributes()

updateSearchableAttributes(searchableAttributes): EnqueuedTaskPromise

Defined in: src/indexes.ts:921

Update the searchable-attributes.

Parameters

searchableAttributes

SearchableAttributes

Array of strings that contains searchable attributes sorted by order of importance(most to least important)

Returns

Promise containing an EnqueuedTask

updateSearchCutoffMs()

updateSearchCutoffMs(searchCutoffMs): EnqueuedTaskPromise

Defined in: src/indexes.ts:1283

Update the SearchCutoffMs settings.

Parameters

searchCutoffMs

SearchCutoffMs

Object containing SearchCutoffMsSettings

Returns

Promise containing an EnqueuedTask

updateSeparatorTokens()

updateSeparatorTokens(separatorTokens): EnqueuedTaskPromise

Defined in: src/indexes.ts:1083

Update the list of separator tokens. Overwrite the old list.

Parameters

separatorTokens

SeparatorTokens

Array that contains separator tokens.

Returns

Promise containing an EnqueuedTask or null

updateSettings()

updateSettings(settings): EnqueuedTaskPromise

Defined in: src/indexes.ts:599

Update all settings Any parameters not provided will be left unchanged.

Parameters

settings

Settings

Object containing parameters with their updated values

Returns

Promise containing an EnqueuedTask

updateSortableAttributes()

updateSortableAttributes(sortableAttributes): EnqueuedTaskPromise

Defined in: src/indexes.ts:879

Update the sortable-attributes.

Parameters

sortableAttributes

SortableAttributes

Array of strings containing the attributes that can be used to sort search results at query time

Returns

Promise containing an EnqueuedTask

updateStopWords()

updateStopWords(stopWords): EnqueuedTaskPromise

Defined in: src/indexes.ts:716

Update the list of stop-words. Overwrite the old list.

Parameters

stopWords

StopWords

Array of strings that contains the stop-words.

Returns

Promise containing an EnqueuedTask

updateSynonyms()

updateSynonyms(synonyms): EnqueuedTaskPromise

Defined in: src/indexes.ts:677

Update the list of synonyms. Overwrite the old list.

Parameters

synonyms

Synonyms

Mapping of synonyms with their associated words

Returns

Promise containing an EnqueuedTask

updateTypoTolerance()

updateTypoTolerance(typoTolerance): EnqueuedTaskPromise

Defined in: src/indexes.ts:1005

Update the typo tolerance settings.

Parameters

typoTolerance

TypoTolerance

Object containing the custom typo tolerance settings.

Returns

Promise containing object of the enqueued update

create()

static create(uid, options?, config): EnqueuedTaskPromise

Defined in: src/indexes.ts:244

Create an index.

Parameters

uid

string

Unique identifier of the Index

options?

IndexOptions = {}

Index options

config

Config

Request configuration options

Returns