Class EnqueuedTask
Index
Constructors
Properties
Constructors
constructor
- new
Enqueued Task(task): EnqueuedTask Parameters
- task: EnqueuedTaskObject
Returns EnqueuedTask
Class Index<T>
Type Parameters
Index
Constructors
Properties
Methods
add
Properties
created
created
http
http
primary
primary
tasks
uid
uid: string
updated
updated
Methods
add
- add
Documents(documents, options?): Promise<EnqueuedTask> Add or replace multiples documents to an index
+Parameters
- documents: T[]
Array of Document objects to add/replace
+ Optionaloptions: DocumentOptionsOptions on document addition
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- documents: T[]
add
- add
Documents From String(documents, contentType, queryParams?): Promise<EnqueuedTask> 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'
+ OptionalqueryParams: RawDocumentAdditionOptions
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- documents: string
add
- add
Documents In Batches(documents, batchSize?, options?): Promise<EnqueuedTask[]> 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
+ Optionaloptions: DocumentOptionsOptions on document addition
+
Returns Promise<EnqueuedTask[]>
Promise containing array of enqueued task objects for each batch
+- documents: T[]
delete
- delete(): Promise<EnqueuedTask>
Delete an index.
+Returns Promise<EnqueuedTask>
Promise which resolves when index is deleted successfully
+
delete
- delete
All Documents(): Promise<EnqueuedTask> Delete all documents of an index
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
delete
- delete
Document(documentId): Promise<EnqueuedTask> Delete one document
+Parameters
- documentId: string | number
Id of Document to delete
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- documentId: string | number
delete
- delete
Documents(params): Promise<EnqueuedTask> Delete multiples documents of an index.
+Parameters
- params: DocumentsDeletionQuery | DocumentsIds
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 +
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- params: DocumentsDeletionQuery | DocumentsIds
fetch
fetch
get
get
get
get
get
- get
Documents<D>(parameters?): Promise<ResourceResults<D[]>> Get documents of an index.
+Type Parameters
- D extends Record<string, any> = T
Parameters
- parameters: DocumentsQuery<D> = {}
Parameters to browse the documents. Parameters can +contain the
+filterfield only available in Meilisearch v1.2 and newer
Returns Promise<ResourceResults<D[]>>
Promise containing the returned documents
+
get
get
get
get
- get
Localized Attributes(): Promise<LocalizedAttributes> Get the localized attributes settings.
+Returns Promise<LocalizedAttributes>
Promise containing object of localized attributes settings
+
get
get
- get
Pagination(): Promise<PaginationSettings> Get the pagination settings.
+Returns Promise<PaginationSettings>
Promise containing object of pagination settings
+
get
- get
Proximity Precision(): Promise<ProximityPrecision> Get the proximity precision settings of a Meilisearch index.
+Returns Promise<ProximityPrecision>
Promise containing the proximity precision settings
+
get
get
- get
Raw Info(): Promise<IndexObject> Get index information.
+Returns Promise<IndexObject>
Promise containing index information
+
get
get
- get
Search Cutoff Ms(): Promise<SearchCutoffMs> Get the SearchCutoffMs settings.
+Returns Promise<SearchCutoffMs>
Promise containing object of SearchCutoffMs settings
+
get
get
get
get
- get
Stats(): Promise<IndexStats> Get stats of an index
+Returns Promise<IndexStats>
Promise containing object with stats of the index
+
get
get
get
get
- get
Tasks(parameters?): Promise<TasksResults> Get the list of all the tasks of the index.
+Parameters
- parameters: TasksQuery = {}
Parameters to browse the tasks
+
Returns Promise<TasksResults>
Promise containing all tasks
+- parameters: TasksQuery = {}
get
- get
Typo Tolerance(): Promise<TypoTolerance> Get the typo tolerance settings.
+Returns Promise<TypoTolerance>
Promise containing the typo tolerance settings.
+
reset
- reset
Dictionary(): Promise<EnqueuedTask> Reset the dictionary settings to its default value
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
reset
- reset
Displayed Attributes(): Promise<EnqueuedTask> Reset the displayed-attributes.
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
reset
- reset
Distinct Attribute(): Promise<EnqueuedTask> Reset the distinct-attribute.
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
reset
- reset
Embedders(): Promise<EnqueuedTask> Reset the embedders settings to its default value
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
reset
- reset
Faceting(): Promise<EnqueuedTask> Reset the faceting settings.
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
reset
- reset
Filterable Attributes(): Promise<EnqueuedTask> Reset the filterable-attributes.
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
reset
- reset
Localized Attributes(): Promise<EnqueuedTask> Reset the localized attributes settings.
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
reset
- reset
Non Separator Tokens(): Promise<EnqueuedTask> Reset the non-separator tokens list to its default value
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
reset
- reset
Pagination(): Promise<EnqueuedTask> Reset the pagination settings.
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
reset
- reset
Proximity Precision(): Promise<EnqueuedTask> Reset the proximity precision settings to its default value
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
reset
- reset
Ranking Rules(): Promise<EnqueuedTask> Reset the ranking rules list to its default value
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
reset
- reset
Searchable Attributes(): Promise<EnqueuedTask> Reset the searchable-attributes.
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
reset
- reset
Search Cutoff Ms(): Promise<EnqueuedTask> Reset the SearchCutoffMs settings.
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
reset
- reset
Separator Tokens(): Promise<EnqueuedTask> Reset the separator tokens list to its default value
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
reset
- reset
Settings(): Promise<EnqueuedTask> Reset settings.
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
reset
- reset
Sortable Attributes(): Promise<EnqueuedTask> Reset the sortable-attributes.
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
reset
- reset
Stop Words(): Promise<EnqueuedTask> Reset the stop-words list to be empty again
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
reset
- reset
Synonyms(): Promise<EnqueuedTask> Reset the synonym list to be empty again
+Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+
reset
- reset
Typo Tolerance(): Promise<EnqueuedTask> Reset the typo tolerance settings.
+Returns Promise<EnqueuedTask>
Promise containing object of the enqueued update
+
search
- search<D, S>(query?, options?, config?): Promise<SearchResponse<D, S>>
Search for documents into an index
+Type Parameters
- D extends Record<string, any> = T
- S extends SearchParams = SearchParams
Parameters
Optionalquery: null | stringQuery string
+Optionaloptions: SSearch options
+Optionalconfig: Partial<Request>Additional request configuration options
+
Returns Promise<SearchResponse<D, S>>
Promise containing the search response
+
search
- search
For Facet Values(params, config?): Promise<SearchForFacetValuesResponse> Search for facet values
+Parameters
- params: SearchForFacetValuesParams
Parameters used to search on the facets
+ Optionalconfig: Partial<Request>Additional request configuration options
+
Returns Promise<SearchForFacetValuesResponse>
Promise containing the search response
+- params: SearchForFacetValuesParams
search
- search
Get<D, S>(query?, options?, config?): Promise<SearchResponse<D, S>> Search for documents into an index using the GET method
+Type Parameters
- D extends Record<string, any> = T
- S extends SearchParams = SearchParams
Parameters
Optionalquery: null | stringQuery string
+Optionaloptions: SSearch options
+Optionalconfig: Partial<Request>Additional request configuration options
+
Returns Promise<SearchResponse<D, S>>
Promise containing the search response
+
search
- search
Similar Documents<D, S>(params): Promise<SearchResponse<D, S>> Search for similar documents
+Type Parameters
- D extends Record<string, any> = T
- S extends SearchParams = SearchParams
Parameters
- params: SearchSimilarDocumentsParams
Parameters used to search for similar documents
+
Returns Promise<SearchResponse<D, S>>
Promise containing the search response
+
update
- update(data): Promise<EnqueuedTask>
Update an index.
+Parameters
- data: IndexOptions
Data to update
+
Returns Promise<EnqueuedTask>
Promise to the current Index object with updated information
+- data: IndexOptions
update
- update
Dictionary(dictionary): Promise<EnqueuedTask> Update the dictionary settings. Overwrite the old settings.
+Parameters
- dictionary: Dictionary
Array that contains the new dictionary settings.
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask or null
+- dictionary: Dictionary
update
- update
Displayed Attributes(displayedAttributes): Promise<EnqueuedTask> Update the displayed-attributes.
+Parameters
- displayedAttributes: DisplayedAttributes
Array of strings that contains attributes of +an index to display
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- displayedAttributes: DisplayedAttributes
update
- update
Distinct Attribute(distinctAttribute): Promise<EnqueuedTask> Update the distinct-attribute.
+Parameters
- distinctAttribute: DistinctAttribute
Field name of the distinct-attribute
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- distinctAttribute: DistinctAttribute
update
- update
Documents(documents, options?): Promise<EnqueuedTask> Add or update multiples documents to an index
+Parameters
- documents: Partial<T>[]
Array of Document objects to add/update
+ Optionaloptions: DocumentOptionsOptions on document update
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- documents: Partial<T>[]
update
- update
Documents By Function(options): Promise<EnqueuedTask> 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: UpdateDocumentsByFunctionOptions
Object containing the function string and related options
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- options: UpdateDocumentsByFunctionOptions
update
- update
Documents From String(documents, contentType, queryParams?): Promise<EnqueuedTask> 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'
+ OptionalqueryParams: RawDocumentAdditionOptionsOptions on raw document addition
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- documents: string
update
- update
Documents In Batches(documents, batchSize?, options?): Promise<EnqueuedTask[]> 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
+ Optionaloptions: DocumentOptionsOptions on document update
+
Returns Promise<EnqueuedTask[]>
Promise containing array of enqueued task objects for each batch
+- documents: Partial<T>[]
update
- update
Embedders(embedders): Promise<EnqueuedTask> Update the embedders settings. Overwrite the old settings.
+Parameters
- embedders: Embedders
Object that contains the new embedders settings.
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask or null
+- embedders: Embedders
update
- update
Faceting(faceting): Promise<EnqueuedTask> Update the faceting settings.
+Parameters
- faceting: Faceting
Faceting index settings object
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- faceting: Faceting
update
- update
Filterable Attributes(filterableAttributes): Promise<EnqueuedTask> Update the filterable-attributes.
+Parameters
- filterableAttributes: FilterableAttributes
Array of strings containing the attributes +that can be used as filters at query time
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- filterableAttributes: FilterableAttributes
update
- update
Localized Attributes(localizedAttributes): Promise<EnqueuedTask> Update the localized attributes settings.
+Parameters
- localizedAttributes: LocalizedAttributes
Localized attributes object
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- localizedAttributes: LocalizedAttributes
update
- update
Non Separator Tokens(nonSeparatorTokens): Promise<EnqueuedTask> Update the list of non-separator tokens. Overwrite the old list.
+Parameters
- nonSeparatorTokens: NonSeparatorTokens
Array that contains non-separator tokens.
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask or null
+- nonSeparatorTokens: NonSeparatorTokens
update
- update
Pagination(pagination): Promise<EnqueuedTask> Update the pagination settings.
+Parameters
- pagination: PaginationSettings
Pagination object
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- pagination: PaginationSettings
update
- update
Proximity Precision(proximityPrecision): Promise<EnqueuedTask> Update the proximity precision settings. Overwrite the old settings.
+Parameters
- proximityPrecision: ProximityPrecision
String that contains the new proximity +precision settings.
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask or null
+- proximityPrecision: ProximityPrecision
update
- update
Ranking Rules(rankingRules): Promise<EnqueuedTask> 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<EnqueuedTask>
Promise containing an EnqueuedTask
+- rankingRules: RankingRules
update
- update
Searchable Attributes(searchableAttributes): Promise<EnqueuedTask> 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<EnqueuedTask>
Promise containing an EnqueuedTask
+- searchableAttributes: SearchableAttributes
update
- update
Search Cutoff Ms(searchCutoffMs): Promise<EnqueuedTask> Update the SearchCutoffMs settings.
+Parameters
- searchCutoffMs: SearchCutoffMs
Object containing SearchCutoffMsSettings
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- searchCutoffMs: SearchCutoffMs
update
- update
Separator Tokens(separatorTokens): Promise<EnqueuedTask> Update the list of separator tokens. Overwrite the old list.
+Parameters
- separatorTokens: SeparatorTokens
Array that contains separator tokens.
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask or null
+- separatorTokens: SeparatorTokens
update
- update
Settings(settings): Promise<EnqueuedTask> Update all settings Any parameters not provided will be left unchanged.
+Parameters
- settings: Settings
Object containing parameters with their updated values
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- settings: Settings
update
- update
Sortable Attributes(sortableAttributes): Promise<EnqueuedTask> 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<EnqueuedTask>
Promise containing an EnqueuedTask
+- sortableAttributes: SortableAttributes
update
- update
Stop Words(stopWords): Promise<EnqueuedTask> Update the list of stop-words. Overwrite the old list.
+Parameters
- stopWords: StopWords
Array of strings that contains the stop-words.
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- stopWords: StopWords
update
- update
Synonyms(synonyms): Promise<EnqueuedTask> Update the list of synonyms. Overwrite the old list.
+Parameters
- synonyms: Synonyms
Mapping of synonyms with their associated words
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- synonyms: Synonyms
update
- update
Typo Tolerance(typoTolerance): Promise<EnqueuedTask> Update the typo tolerance settings.
+Parameters
- typoTolerance: TypoTolerance
Object containing the custom typo tolerance +settings.
+
Returns Promise<EnqueuedTask>
Promise containing object of the enqueued update
+- typoTolerance: TypoTolerance
wait
- wait
For Task(taskUid, waitOptions?): Promise<Task> Wait for a task to be processed.
+Parameters
- taskUid: number
Task identifier
+ - waitOptions: WaitOptions = {}
Options on timeout and interval
+
Returns Promise<Task>
Promise containing an array of tasks
+- taskUid: number
wait
- wait
For Tasks(taskUids, waitOptions?): Promise<Task[]> Wait for multiple tasks to be processed.
+Parameters
- taskUids: number[]
Tasks identifier
+ - waitOptions: WaitOptions = {}
Options on timeout and interval
+
Returns Promise<Task[]>
Promise containing an array of tasks
+- taskUids: number[]
Staticcreate
- create(uid, options?, config): Promise<EnqueuedTask>
Create an index.
+Parameters
- uid: string
Unique identifier of the Index
+ - options: IndexOptions = {}
Index options
+ - config: Config
Request configuration options
+
Returns Promise<EnqueuedTask>
Newly created Index object
+- uid: string
Class MeiliSearch
Hierarchy
- Client
- MeiliSearch
Index
Constructors
Properties
Methods
cancel
Constructors
constructor
- new
Meili Search(config): MeiliSearch Parameters
- config: Config
Returns MeiliSearch
Methods
cancel
- cancel
Tasks(parameters): Promise<EnqueuedTask> Cancel a list of enqueued or processing tasks.
+Parameters
- parameters: Omit<TasksQuery, "limit" | "from">
Parameters to filter the tasks.
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- parameters: Omit<TasksQuery, "limit" | "from">
create
- create
Dump(): Promise<EnqueuedTask> Creates a dump
+Returns Promise<EnqueuedTask>
Promise returning object of the enqueued task
+
create
- create
Index(uid, options?): Promise<EnqueuedTask> Create a new index
+Parameters
- uid: string
The index UID
+ - options: IndexOptions = {}
Index options
+
Returns Promise<EnqueuedTask>
Promise returning Index instance
+- uid: string
create
- create
Key(options): Promise<Key> Create one API key
+Parameters
- options: KeyCreation
Key options
+
Returns Promise<Key>
Promise returning a key
+- options: KeyCreation
create
- create
Snapshot(): Promise<EnqueuedTask> Creates a snapshot
+Returns Promise<EnqueuedTask>
Promise returning object of the enqueued task
+
delete
- delete
Index(uid): Promise<EnqueuedTask> Delete an index
+Parameters
- uid: string
The index UID
+
Returns Promise<EnqueuedTask>
Promise which resolves when index is deleted successfully
+- uid: string
delete
delete
delete
- delete
Tasks(parameters?): Promise<EnqueuedTask> Delete a list of tasks.
+Parameters
- parameters: Omit<TasksQuery, "limit" | "from"> = {}
Parameters to filter the tasks.
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- parameters: Omit<TasksQuery, "limit" | "from"> = {}
generate
- generate
Tenant Token(apiKeyUid, searchRules, options?): Promise<string> Generate a tenant token
+Parameters
- apiKeyUid: string
The uid of the api key used as issuer of the token.
+ - searchRules: TokenSearchRules
Search rules that are applied to every search.
+ Optionaloptions: TokenOptionsToken options to customize some aspect of the token.
+
Returns Promise<string>
The token in JWT format.
+- apiKeyUid: string
get
get
- get
Indexes(parameters?): Promise<IndexesResults<Index<Record<string, any>>[]>> Get all the indexes as Index instances.
+Parameters
- parameters: Pagination = {}
Parameters to browse the indexes
+
Returns Promise<IndexesResults<Index<Record<string, any>>[]>>
Promise returning array of raw index information
+- parameters: Pagination = {}
get
get
- get
Keys(parameters?): Promise<KeysResults> Get all API keys
+Parameters
- parameters: Pagination = {}
Parameters to browse the indexes
+
Returns Promise<KeysResults>
Promise returning an object with keys
+- parameters: Pagination = {}
get
- get
Raw Index(indexUid): Promise<IndexObject> Gather information about an index by calling MeiliSearch and return the raw +JSON response
+Parameters
- indexUid: string
The index UID
+
Returns Promise<IndexObject>
Promise returning index information
+- indexUid: string
get
- get
Raw Indexes(parameters?): Promise<IndexesResults<IndexObject[]>> Get all the indexes in their raw value (no Index instances).
+Parameters
- parameters: Pagination = {}
Parameters to browse the indexes
+
Returns Promise<IndexesResults<IndexObject[]>>
Promise returning array of raw index information
+- parameters: Pagination = {}
get
get
get
- get
Tasks(parameters?): Promise<TasksResults> Get the list of all client tasks
+Parameters
- parameters: TasksQuery = {}
Parameters to browse the tasks
+
Returns Promise<TasksResults>
Promise returning all tasks
+- parameters: TasksQuery = {}
get
health
index
is
multi
- multi
Search<T>(queries, config?): Promise<MultiSearchResponse<T>> Perform multiple search queries.
+It is possible to make multiple search queries on the same index or on +different ones
+Type Parameters
Parameters
- queries: MultiSearchParams
Search queries
+ Optionalconfig: Partial<Request>Additional request configuration options
+
Returns Promise<MultiSearchResponse<T>>
Promise containing the search responses
+- queries: MultiSearchParams
- multi
Search<T>(queries, config?): Promise<SearchResponse<T>> Type Parameters
Parameters
- queries: FederatedMultiSearchParams
Optionalconfig: Partial<Request>
Returns Promise<SearchResponse<T>>
swap
- swap
Indexes(params): Promise<EnqueuedTask> Swaps a list of index tuples.
+Parameters
- params: SwapIndexesParams
List of indexes tuples to swap.
+
Returns Promise<EnqueuedTask>
Promise returning object of the enqueued task
+- params: SwapIndexesParams
update
- update
Index(uid, options?): Promise<EnqueuedTask> Update an index
+Parameters
- uid: string
The index UID
+ - options: IndexOptions = {}
Index options to update
+
Returns Promise<EnqueuedTask>
Promise returning Index instance after updating
+- uid: string
update
wait
- wait
For Task(taskUid, waitOptions?): Promise<Task> Wait for a task to be finished.
+Parameters
- taskUid: number
Task identifier
+ - waitOptions: WaitOptions = {}
Options on timeout and interval
+
Returns Promise<Task>
Promise returning an array of tasks
+- taskUid: number
wait
- wait
For Tasks(taskUids, waitOptions?): Promise<Task[]> Wait for multiple tasks to be finished.
+Parameters
- taskUids: number[]
Tasks identifier
+ - waitOptions: WaitOptions = {}
Options on timeout and interval
+
Returns Promise<Task[]>
Promise returning an array of tasks
+- taskUids: number[]
Class MeiliSearchApiError
Hierarchy (view full)
- MeiliSearchError
- MeiliSearchApiError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Meili Search Api Error(response, responseBody?): MeiliSearchApiError Parameters
- response: Response
OptionalresponseBody: MeiliSearchErrorResponse
Returns MeiliSearchApiError
Properties
Optionalcause
message
message: string
name
name: string = "MeiliSearchApiError"
Readonlyresponse
response: Response
Optionalstack
stack?: string
Static Optionalprepare
prepare
Optional override for formatting stack traces
+Staticstack
stack
Class MeiliSearchError
Hierarchy (view full)
- Error
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Meili Search Error(...params): MeiliSearchError Parameters
Rest...params: [message?: string, options?: ErrorOptions]
Returns MeiliSearchError
Properties
Optionalcause
cause?: unknown
message
message: string
name
name: string = "MeiliSearchError"
Optionalstack
stack?: string
Static Optionalprepare
prepare
Optional override for formatting stack traces
+Staticstack
stack
Class MeiliSearchRequestError
Hierarchy (view full)
- MeiliSearchError
- MeiliSearchRequestError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Meili Search Request Error(url, cause): MeiliSearchRequestError Parameters
- url: string
- cause: unknown
Returns MeiliSearchRequestError
Properties
Optionalcause
cause?: unknown
message
message: string
name
name: string = "MeiliSearchRequestError"
Optionalstack
stack?: string
Static Optionalprepare
prepare
Optional override for formatting stack traces
+Staticstack
stack
Class MeiliSearchTimeOutError
Hierarchy (view full)
- MeiliSearchError
- MeiliSearchTimeOutError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Meili Search Time Out Error(message): MeiliSearchTimeOutError Parameters
- message: string
Returns MeiliSearchTimeOutError
Properties
Optionalcause
cause?: unknown
message
message: string
name
name: string = "MeiliSearchTimeOutError"
Optionalstack
stack?: string
Static Optionalprepare
prepare
Optional override for formatting stack traces
+Staticstack
stack
Class Task
Index
Constructors
Properties
canceled
Constructors
constructor
- new
Task(task): Task Parameters
- task: TaskObject
Returns Task
Properties
canceled
canceled
details
details: {
canceledTasks?: number;
deletedDocuments?: number;
deletedTasks?: number;
displayedAttributes?: DisplayedAttributes;
distinctAttribute?: DistinctAttribute;
filterableAttributes?: FilterableAttributes;
indexedDocuments?: number;
matchedTasks?: number;
originalFilter?: string;
primaryKey?: string;
providedIds?: number;
rankingRules?: RankingRules;
receivedDocuments?: number;
searchableAttributes?: SearchableAttributes;
sortableAttributes?: SortableAttributes;
stopWords?: StopWords;
swaps?: SwapIndexesParams;
synonyms?: Synonyms;
}
canceledTasks?: number;
deletedDocuments?: number;
deletedTasks?: number;
displayedAttributes?: DisplayedAttributes;
distinctAttribute?: DistinctAttribute;
filterableAttributes?: FilterableAttributes;
indexedDocuments?: number;
matchedTasks?: number;
originalFilter?: string;
primaryKey?: string;
providedIds?: number;
rankingRules?: RankingRules;
receivedDocuments?: number;
searchableAttributes?: SearchableAttributes;
sortableAttributes?: SortableAttributes;
stopWords?: StopWords;
swaps?: SwapIndexesParams;
synonyms?: Synonyms;
}
duration
duration: string
enqueued
enqueued
error
finished
finished
index
index
started
started
status
type
uid
uid: number
Class TaskClient
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Task Client(config): TaskClient Parameters
- config: Config
Returns TaskClient
Methods
cancel
- cancel
Tasks(parameters?): Promise<EnqueuedTask> Cancel a list of enqueued or processing tasks.
+Parameters
- parameters: Omit<TasksQuery, "limit" | "from"> = {}
Parameters to filter the tasks.
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- parameters: Omit<TasksQuery, "limit" | "from"> = {}
delete
- delete
Tasks(parameters?): Promise<EnqueuedTask> Delete a list tasks.
+Parameters
- parameters: Omit<TasksQuery, "limit" | "from"> = {}
Parameters to filter the tasks.
+
Returns Promise<EnqueuedTask>
Promise containing an EnqueuedTask
+- parameters: Omit<TasksQuery, "limit" | "from"> = {}
get
get
- get
Tasks(parameters?): Promise<TasksResults> Get tasks
+Parameters
- parameters: TasksQuery = {}
Parameters to browse the tasks
+
Returns Promise<TasksResults>
Promise containing all tasks
+- parameters: TasksQuery = {}
wait
- wait
For Task(taskUid, options?): Promise<Task> Wait for a task to be processed.
+Parameters
- taskUid: number
Task identifier
+ - options: WaitOptions = {}
Additional configuration options
+
Returns Promise<Task>
Promise returning a task after it has been processed
+- taskUid: number
wait
- wait
For Tasks(taskUids, options?): Promise<Task[]> Waits for multiple tasks to be processed
+Parameters
- taskUids: number[]
Tasks identifier list
+ - options: WaitOptions = {}
Wait options
+
Returns Promise<Task[]>
Promise returning a list of tasks after they have been processed
+- taskUids: number[]
diff --git a/hierarchy.html b/hierarchy.html
new file mode 100644
index 000000000..c3c01c193
--- /dev/null
+++ b/hierarchy.html
@@ -0,0 +1 @@
+
Meilisearch JS
Class Hierarchy
Meilisearch JS
+ 
+
Meilisearch JavaScript
++ Meilisearch | + Meilisearch Cloud | + Documentation | + Discord | + Roadmap | + Website | + FAQ +
+
+ 
+ 
+
+ 
+
+ 
+ 
+
⚡ The Meilisearch API client written for JavaScript
+Meilisearch JavaScript is the Meilisearch API client for JavaScript developers.
+Meilisearch is an open-source search engine. Learn more about Meilisearch.
+Table of Contents
-
+
- 📖 Documentation +
- ⚡ Supercharge your Meilisearch experience +
- 🔧 Installation +
- 🎬 Getting started +
- 🤖 Compatibility with Meilisearch +
- 💡 Learn more +
- ⚙️ Contributing +
- 📜 API resources +
📖 Documentation
This readme and Meilisearch JS documentation website contains all the information you need to start using this Meilisearch SDK.
+For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our main documentation website.
+⚡ Supercharge your Meilisearch experience
Say goodbye to server deployment and manual updates with Meilisearch Cloud. Get started with a 14-day free trial! No credit card required.
+🔧 Installation
We recommend installing meilisearch-js in your project with your package manager of choice.
npm install meilisearch
+meilisearch-js officially supports node versions >= 14 and <= 18.
Instead of using a package manager, you may also import the library directly into your HTML via a CDN.
+Run Meilisearch
To use one of our SDKs, you must first have a running Meilisearch instance. Consult our documentation for instructions on how to download and launch Meilisearch.
+Import
After installing meilisearch-js, you must import it into your application. There are many ways of doing that depending on your development environment.
import syntax
Usage in an ES module environment:
+import { MeiliSearch } from 'meilisearch'
const client = new MeiliSearch({
host: 'http://127.0.0.1:7700',
apiKey: 'masterKey',
})
+<script> tag
Usage in an HTML (or alike) file:
+<script src='https://cdn.jsdelivr.net/npm/meilisearch@latest/dist/bundles/meilisearch.umd.js'></script>
<script>
const client = new MeiliSearch({
host: 'http://127.0.0.1:7700',
apiKey: 'masterKey',
})
</script>
+require syntax
Usage in a back-end node.js or another environment supporting CommonJS modules:
+const { MeiliSearch } = require('meilisearch')
const client = new MeiliSearch({
host: 'http://127.0.0.1:7700',
apiKey: 'masterKey',
})
+React Native
To use meilisearch-js with React Native, you must also install react-native-url-polyfill.
Deno
Usage in a Deno environment:
+import { MeiliSearch } from "https://esm.sh/meilisearch"
const client = new MeiliSearch({
host: 'http://127.0.0.1:7700',
apiKey: 'masterKey',
})
+🎬 Getting started
Add documents
const { MeiliSearch } = require('meilisearch')
// Or if you are in a ES environment
import { MeiliSearch } from 'meilisearch'
;(async () => {
const client = new MeiliSearch({
host: 'http://127.0.0.1:7700',
apiKey: 'masterKey',
})
// An index is where the documents are stored.
const index = client.index('movies')
const documents = [
{ id: 1, title: 'Carol', genres: ['Romance', 'Drama'] },
{ id: 2, title: 'Wonder Woman', genres: ['Action', 'Adventure'] },
{ id: 3, title: 'Life of Pi', genres: ['Adventure', 'Drama'] },
{ id: 4, title: 'Mad Max: Fury Road', genres: ['Adventure', 'Science Fiction'] },
{ id: 5, title: 'Moana', genres: ['Fantasy', 'Action']},
{ id: 6, title: 'Philadelphia', genres: ['Drama'] },
]
// If the index 'movies' does not exist, Meilisearch creates it when you first add the documents.
let response = await index.addDocuments(documents)
console.log(response) // => { "uid": 0 }
})()
+Tasks such as document addition always return a unique identifier. You can use this identifier taskUid to check the status (enqueued, canceled, processing, succeeded or failed) of a task.
Basic search
// Meilisearch is typo-tolerant:
const search = await index.search('philoudelphia')
console.log(search)
+Output:
+{
"hits": [
{
"id": "6",
"title": "Philadelphia",
"genres": ["Drama"]
}
],
"offset": 0,
"limit": 20,
"estimatedTotalHits": 1,
"processingTimeMs": 1,
"query": "philoudelphia"
}
+Using search parameters
meilisearch-js supports all search parameters described in our main documentation website.
await index.search(
'wonder',
{
attributesToHighlight: ['*']
}
)
+{
"hits": [
{
"id": 2,
"title": "Wonder Woman",
"genres": ["Action", "Adventure"],
"_formatted": {
"id": "2",
"title": "<em>Wonder</em> Woman",
"genres": ["Action", "Adventure"]
}
}
],
"offset": 0,
"limit": 20,
"estimatedTotalHits": 1,
"processingTimeMs": 0,
"query": "wonder"
}
+Custom search with filters
To enable filtering, you must first add your attributes to the filterableAttributes index setting.
await index.updateFilterableAttributes([
'id',
'genres'
])
+You only need to perform this operation once per index.
+Note that Meilisearch rebuilds your index whenever you update filterableAttributes. Depending on the size of your dataset, this might take considerable time. You can track the process using the tasks API).
After you configured filterableAttributes, you can use the filter search parameter to refine your search:
await index.search(
'wonder',
{
filter: ['id > 1 AND genres = Action']
}
)
+{
"hits": [
{
"id": 2,
"title": "Wonder Woman",
"genres": ["Action","Adventure"]
}
],
"offset": 0,
"limit": 20,
"estimatedTotalHits": 1,
"processingTimeMs": 0,
"query": "wonder"
}
+Placeholder search
Placeholder search makes it possible to receive hits based on your parameters without having any query (q). For example, in a movies database you can run an empty query to receive all results filtered by genre.
await index.search(
'',
{
filter: ['genres = fantasy'],
facets: ['genres']
}
)
+{
"hits": [
{
"id": 2,
"title": "Wonder Woman",
"genres": ["Action","Adventure"]
},
{
"id": 5,
"title": "Moana",
"genres": ["Fantasy","Action"]
}
],
"offset": 0,
"limit": 20,
"estimatedTotalHits": 2,
"processingTimeMs": 0,
"query": "",
"facetDistribution": {
"genres": {
"Action": 2,
"Fantasy": 1,
"Adventure": 1
}
}
}
+Note that to enable faceted search on your dataset you need to add genres to the filterableAttributes index setting. For more information on filtering and faceting, consult our documentation settings.
Abortable search
You can abort a pending search request by providing an AbortSignal to the request.
+const controller = new AbortController()
index
.search('wonder', {}, {
signal: controller.signal,
})
.then((response) => {
/** ... */
})
.catch((e) => {
/** Catch AbortError here. */
})
controller.abort()
+Using Meilisearch behind a proxy
Custom request config
You can provide a custom request configuration. for example, with custom headers.
+const client: MeiliSearch = new MeiliSearch({
host: 'http://localhost:3000/api/meilisearch/proxy',
requestConfig: {
headers: {
Authorization: AUTH_TOKEN
},
// OR
credentials: 'include'
}
})
+Custom http client
You can use your own HTTP client, for example, with axios.
const client: MeiliSearch = new MeiliSearch({
host: 'http://localhost:3000/api/meilisearch/proxy',
httpClient: async (url, opts) => {
const response = await $axios.request({
url,
data: opts?.body,
headers: opts?.headers,
method: (opts?.method?.toLocaleUpperCase() as Method) ?? 'GET'
})
return response.data
}
})
+🤖 Compatibility with Meilisearch
This package guarantees compatibility with version v1.x of Meilisearch, but some features may not be present. Please check the issues for more info.
+💡 Learn more
The following sections in our main documentation website may interest you:
+-
+
- Manipulate documents: see the API references or read more about documents. +
- Search: see the API references or follow our guide on search parameters. +
- Manage the indexes: see the API references or read more about indexes. +
- Configure the index settings: see the API references or follow our guide on settings parameters. +
This repository also contains more examples.
+⚙️ Contributing
We welcome all contributions, big and small! If you want to know more about this SDK's development workflow or want to contribute to the repo, please visit our contributing guidelines for detailed instructions.
+📜 API resources
Search
Make a search request
client.index<T>('xxx').search(query: string, options: SearchParams = {}, config?: Partial<Request>): Promise<SearchResponse<T>>
+Make a search request using the GET method (slower than the search method)
client.index<T>('xxx').searchGet(query: string, options: SearchParams = {}, config?: Partial<Request>): Promise<SearchResponse<T>>
+Multi Search
Make multiple search requests
client.multiSearch(queries?: MultiSearchParams, config?: Partial<Request>): Promise<Promise<MultiSearchResponse<T>>>
+multiSearch uses the POST method when performing its request to Meilisearch.
Search For Facet Values
Search for facet values
client.index<T>('myIndex').searchForFacetValues(params: SearchForFacetValuesParams, config?: Partial<Request>): Promise<SearchForFacetValuesResponse>
+Documents
Add or replace multiple documents
client.index('myIndex').addDocuments(documents: Document<T>[]): Promise<EnqueuedTask>
+Add or replace multiple documents in string format
client.index('myIndex').addDocumentsFromString(documents: string, contentType: ContentType, queryParams: RawDocumentAdditionOptions): Promise<EnqueuedTask>
+Add or replace multiple documents in batches
client.index('myIndex').addDocumentsInBatches(documents: Document<T>[], batchSize = 1000): Promise<EnqueuedTask[]>
+Add or update multiple documents
client.index('myIndex').updateDocuments(documents: Array<Document<Partial<T>>>): Promise<EnqueuedTask>
+Add or update multiple documents in string format
client.index('myIndex').updateDocumentsFromString(documents: string, contentType: ContentType, queryParams: RawDocumentAdditionOptions): Promise<EnqueuedTask>
+Add or update multiple documents in batches
client.index('myIndex').updateDocumentsInBatches(documents: Array<Document<Partial<T>>>, batchSize = 1000): Promise<EnqueuedTask[]>
+Get Documents
client.index.getDocuments(parameters: DocumentsQuery = {}): Promise<DocumentsResults<T>>>
+Get one document
client.index('myIndex').getDocument(documentId: string): Promise<Document<T>>
+Delete one document
client.index('myIndex').deleteDocument(documentId: string | number): Promise<EnqueuedTask>
+Delete multiple documents
client.index('myIndex').deleteDocuments(params: DocumentsDeletionQuery | DocumentsIds): Promise<EnqueuedTask>
+Delete all documents
client.index('myIndex').deleteAllDocuments(): Promise<Types.EnqueuedTask>
+Tasks
Get all tasks
client.getTasks(parameters: TasksQuery): Promise<TasksResults>
+Get one task
client.getTask(uid: number): Promise<Task>
+Delete tasks
client.deleteTasks(parameters: DeleteTasksQuery = {}): Promise<EnqueuedTask>
+Cancel tasks
client.cancelTasks(parameters: CancelTasksQuery = {}): Promise<EnqueuedTask>
+Get all tasks of an index
client.index('myIndex').getTasks(parameters: TasksQuery): Promise<TasksResults>
+Get one task of an index
client.index('myIndex').getTask(uid: number): Promise<Task>
+Wait for one task
Using the client
client.waitForTask(uid: number, { timeOutMs?: number, intervalMs?: number }): Promise<Task>
+Using the index
client.index('myIndex').waitForTask(uid: number, { timeOutMs?: number, intervalMs?: number }): Promise<Task>
+Wait for multiple tasks
Using the client
client.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Task[]>
+Using the index
client.index('myIndex').waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Task[]>
+Indexes
Get all indexes in Index instances
client.getIndexes(parameters: IndexesQuery): Promise<IndexesResults<Index[]>>
+Get all indexes
client.getRawIndexes(parameters: IndexesQuery): Promise<IndexesResults<IndexObject[]>>
+Create a new index
client.createIndex<T>(uid: string, options?: IndexOptions): Promise<EnqueuedTask>
+Create a local reference to an index
client.index<T>(uid: string): Index<T>
+Get an index instance completed with information fetched from Meilisearch
client.getIndex<T>(uid: string): Promise<Index<T>>
+Get the raw index JSON response from Meilisearch
client.getRawIndex(uid: string): Promise<IndexObject>
+Get an object with information about the index
client.index('myIndex').getRawInfo(): Promise<IndexObject>
+Update Index
Using the client
client.updateIndex(uid: string, options: IndexOptions): Promise<EnqueuedTask>
+Using the index object
client.index('myIndex').update(data: IndexOptions): Promise<EnqueuedTask>
+Delete index
Using the client
client.deleteIndex(uid): Promise<void>
+Using the index object
client.index('myIndex').delete(): Promise<void>
+Get specific index stats
client.index('myIndex').getStats(): Promise<IndexStats>
+Return Index instance with updated information
client.index('myIndex').fetchInfo(): Promise<Index>
+Get Primary Key of an Index
client.index('myIndex').fetchPrimaryKey(): Promise<string | undefined>
+Swap two indexes
client.swapIndexes(params: SwapIndexesParams): Promise<EnqueuedTask>
+Settings
Get settings
client.index('myIndex').getSettings(): Promise<Settings>
+Update settings
client.index('myIndex').updateSettings(settings: Settings): Promise<EnqueuedTask>
+Reset settings
client.index('myIndex').resetSettings(): Promise<EnqueuedTask>
+Pagination Settings
Get pagination
client.index('myIndex').getPagination(): Promise<PaginationSettings>
+Update pagination
client.index('myIndex').updatePagination(pagination: PaginationSettings): Promise<EnqueuedTask>
+Reset pagination
client.index('myIndex').resetPagination(): Promise<EnqueuedTask>
+Synonyms
Get synonyms
client.index('myIndex').getSynonyms(): Promise<Synonyms>
+Update synonyms
client.index('myIndex').updateSynonyms(synonyms: Synonyms): Promise<EnqueuedTask>
+Reset synonyms
client.index('myIndex').resetSynonyms(): Promise<EnqueuedTask>
+Stop words
Get stop words
client.index('myIndex').getStopWords(): Promise<string[]>
+Update stop words
client.index('myIndex').updateStopWords(stopWords: string[] | null ): Promise<EnqueuedTask>
+Reset stop words
client.index('myIndex').resetStopWords(): Promise<EnqueuedTask>
+Ranking rules
Get ranking rules
client.index('myIndex').getRankingRules(): Promise<string[]>
+Update ranking rules
client.index('myIndex').updateRankingRules(rankingRules: string[] | null): Promise<EnqueuedTask>
+Reset ranking rules
client.index('myIndex').resetRankingRules(): Promise<EnqueuedTask>
+Distinct Attribute
Get distinct attribute
client.index('myIndex').getDistinctAttribute(): Promise<string | void>
+Update distinct attribute
client.index('myIndex').updateDistinctAttribute(distinctAttribute: string | null): Promise<EnqueuedTask>
+Reset distinct attribute
client.index('myIndex').resetDistinctAttribute(): Promise<EnqueuedTask>
+Searchable attributes
Get searchable attributes
client.index('myIndex').getSearchableAttributes(): Promise<string[]>
+Update searchable attributes
client.index('myIndex').updateSearchableAttributes(searchableAttributes: string[] | null): Promise<EnqueuedTask>
+Reset searchable attributes
client.index('myIndex').resetSearchableAttributes(): Promise<EnqueuedTask>
+Displayed attributes
Get displayed attributes
client.index('myIndex').getDisplayedAttributes(): Promise<string[]>
+Update displayed attributes
client.index('myIndex').updateDisplayedAttributes(displayedAttributes: string[] | null): Promise<EnqueuedTask>
+Reset displayed attributes
client.index('myIndex').resetDisplayedAttributes(): Promise<EnqueuedTask>
+Filterable attributes
Get filterable attributes
client.index('myIndex').getFilterableAttributes(): Promise<string[]>
+Update filterable attributes
client.index('myIndex').updateFilterableAttributes(filterableAttributes: string[] | null): Promise<EnqueuedTask>
+Reset filterable attributes
client.index('myIndex').resetFilterableAttributes(): Promise<EnqueuedTask>
+Sortable attributes
Get sortable attributes
client.index('myIndex').getSortableAttributes(): Promise<string[]>
+Update sortable attributes
client.index('myIndex').updateSortableAttributes(sortableAttributes: string[] | null): Promise<EnqueuedTask>
+Reset sortable attributes
client.index('myIndex').resetSortableAttributes(): Promise<EnqueuedTask>
+Faceting
Get faceting
client.index('myIndex').getFaceting(): Promise<Faceting>
+Update faceting
client.index('myIndex').updateFaceting(faceting: Faceting): Promise<EnqueuedTask>
+Reset faceting
client.index('myIndex').resetFaceting(): Promise<EnqueuedTask>
+Typo tolerance
Get typo tolerance
client.index('myIndex').getTypoTolerance(): Promise<TypoTolerance>
+Update typo tolerance
client.index('myIndex').updateTypoTolerance(typoTolerance: TypoTolerance | null): Promise<EnqueuedTask>
+Reset typo tolerance
client.index('myIndex').resetTypoTolerance(): Promise<EnqueuedTask>
+Separator tokens
Get separator tokens
client.index('myIndex').getSeparatorTokens(): Promise<SeparatorTokens>
+Update separator tokens
client.index('myIndex').updateSeparatorTokens(separatorTokens: SeparatorTokens | null): Promise<EnqueuedTask>
+Reset separator tokens
client.index('myIndex').resetSeparatorTokens(): Promise<EnqueuedTask>
+Non Separator tokens
Get non separator tokens
client.index('myIndex').getNonSeparatorTokens(): Promise<NonSeparatorTokens>
+Update non separator tokens
client.index('myIndex').updateNonSeparatorTokens(nonSeparatorTokens: NonSeparatorTokens | null): Promise<EnqueuedTask>
+Reset non separator tokens
client.index('myIndex').resetNonSeparatorTokens(): Promise<EnqueuedTask>
+Dictionary
Get dictionary
client.index('myIndex').getDictionary(): Promise<Dictionary>
+Update dictionary
client.index('myIndex').updateDictionary(dictionary: Dictionary | null): Promise<EnqueuedTask>
+Reset dictionary
client.index('myIndex').resetDictionary(): Promise<EnqueuedTask>
+Proximity Precision
Get proximity precision
client.index('myIndex').getProximityPrecision(): Promise<ProximityPrecision>
+Update proximity precision
client.index('myIndex').updateProximityPrecision(proximityPrecision: ProximityPrecision): Promise<EnqueuedTask>
+Reset proximity precision
client.index('myIndex').resetProximityPrecision(): Promise<EnqueuedTask>
+Embedders
⚠️ This feature is experimental. Activate the vectorStore experimental feature to use it
Get embedders
client.index('myIndex').getEmbedders(): Promise<Embedders>
+Update embedders
client.index('myIndex').updateEmbedders(embedders: Embedders): Promise<EnqueuedTask>
+Reset embedders
client.index('myIndex').resetEmbedders(): Promise<EnqueuedTask>
+SearchCutoffMs
Get SearchCutoffMs
client.index('myIndex').getSearchCutoffMs(): Promise<SearchCutoffMs>
+Update SearchCutoffMs
client.index('myIndex').updateSearchCutoffMs(searchCutoffMs: SearchCutoffMs): Promise<EnqueuedTask>
+Reset SearchCutoffMs
client.index('myIndex').resetSearchCutoffMs(): Promise<EnqueuedTask>
+Keys
Get keys
client.getKeys(parameters: KeysQuery): Promise<KeysResults>
+Get one key
client.getKey(keyOrUid: string): Promise<Key>
+Create a key
client.createKey(options: KeyCreation): Promise<Key>
+Update a key
client.updateKey(keyOrUid: string, options: KeyUpdate): Promise<Key>
+Delete a key
client.deleteKey(keyOrUid: string): Promise<void>
+isHealthy
Return true or false depending on the health of the server
client.isHealthy(): Promise<boolean>
+Health
Check if the server is healthy
client.health(): Promise<Health>
+Stats
Get database stats
client.getStats(): Promise<Stats>
+Version
Get binary version
client.getVersion(): Promise<Version>
+Dumps
Trigger a dump creation process
client.createDump(): Promise<EnqueuedTask>
+Snapshots
Trigger a snapshot on-demand process
client.createSnapshot(): Promise<EnqueuedTask>
++
Meilisearch provides and maintains many SDKs and integration tools like this one. We want to provide everyone with an amazing search experience for any kind of project. For a full overview of everything we create and maintain, take a look at the integration-guides repository.
+
diff --git a/modules.html b/modules.html
new file mode 100644
index 000000000..e306fa07e
--- /dev/null
+++ b/modules.html
@@ -0,0 +1,121 @@
+
Meilisearch JS
Index
References
Classes
Interfaces
Type Aliases
Cancel
Variables
Functions
References
default
Renames and re-exports MeiliSearchMeilisearch
Renames and re-exports MeiliSearchType Alias CancelTasksQuery
Type Alias CategoriesDistribution
Categories
[category: string]: number;
}
[category: string]: number;
}
Type Alias Config
Config: {
apiKey?: string;
clientAgents?: string[];
host: string;
httpClient?: ((input: string, init?: RequestInit) => Promise<any>);
requestConfig?: Partial<Omit<RequestInit, "body" | "method">>;
timeout?: number;
}
apiKey?: string;
clientAgents?: string[];
host: string;
httpClient?: ((input: string, init?: RequestInit) => Promise<any>);
requestConfig?: Partial<Omit<RequestInit, "body" | "method">>;
timeout?: number;
}
Type Alias ContentType
Content
Type Alias Crop
Crop: {
attributesToCrop?: string[];
cropLength?: number;
cropMarker?: string;
}
attributesToCrop?: string[];
cropLength?: number;
cropMarker?: string;
}
Type Alias DeleteTasksQuery
Type Alias Dictionary
Dictionary: string[] | null
Type Alias DisplayedAttributes
Displayed
Type Alias DistinctAttribute
Distinct
Type Alias Distribution
Distribution: {
mean: number;
sigma: number;
}
mean: number;
sigma: number;
}
Type Alias DocumentOptions
Document
primaryKey?: string;
}
primaryKey?: string;
}
diff --git a/types/DocumentsDeletionQuery.html b/types/DocumentsDeletionQuery.html
new file mode 100644
index 000000000..4eda2aa3d
--- /dev/null
+++ b/types/DocumentsDeletionQuery.html
@@ -0,0 +1 @@
+
Type Alias DocumentsDeletionQuery
Type Alias DocumentsIds
Documents
Type Alias DocumentsQuery<T>
Documents
fields?: Fields<T>;
filter?: Filter;
limit?: number;
offset?: number;
retrieveVectors?: boolean;
}
fields?: Fields<T>;
filter?: Filter;
limit?: number;
offset?: number;
retrieveVectors?: boolean;
}
Type Parameters
Type Alias Embedder
Embedder:
| OpenAiEmbedder
| HuggingFaceEmbedder
| UserProvidedEmbedder
| RestEmbedder
| OllamaEmbedder
| null
| OpenAiEmbedder
| HuggingFaceEmbedder
| UserProvidedEmbedder
| RestEmbedder
| OllamaEmbedder
| null
Type Alias Embedders
Type Alias EnqueuedTaskObject
Enqueued
canceledBy: number;
enqueuedAt: string;
indexUid?: string;
status: TaskStatus;
taskUid: number;
type: TaskTypes;
}
canceledBy: number;
enqueuedAt: string;
indexUid?: string;
status: TaskStatus;
taskUid: number;
type: TaskTypes;
}
Type Alias ErrorStatusCode
Type Alias Facet
Facet: string
Type Alias FacetDistribution
Type Alias FacetHit
Facet
count: number;
value: string;
}
count: number;
value: string;
}
Type Alias FacetOrder
Facet
Type Alias FacetStat
Facet
max: number;
min: number;
}
max: number;
min: number;
}
Type Alias FacetStats
Type Alias Faceting
Faceting: {
maxValuesPerFacet?: number | null;
sortFacetValuesBy?: Record<string, FacetOrder> | null;
}
maxValuesPerFacet?: number | null;
sortFacetValuesBy?: Record<string, FacetOrder> | null;
}
Type Alias FederatedMultiSearchParams
Federated
federation: MultiSearchFederation;
queries: MultiSearchQueryWithFederation[];
}
federation: MultiSearchFederation;
queries: MultiSearchQueryWithFederation[];
}
Type Alias FederationDetails
Federation
indexUid: string;
queriesPosition: number;
weightedRankingScore: number;
}
indexUid: string;
queriesPosition: number;
weightedRankingScore: number;
}
Type Alias FederationOptions
Federation
weight: number;
}
weight: number;
}
Type Alias FieldDistribution
Field
[field: string]: number;
}
[field: string]: number;
}
Type Alias Filter
Filter: string | (string | string[])[]
Type Alias FilterableAttributes
Filterable
Type Alias Health
Health: {
status: "available";
}
status: "available";
}
Type Alias Highlight
Highlight: {
attributesToHighlight?: string[];
highlightPostTag?: string;
highlightPreTag?: string;
}
attributesToHighlight?: string[];
highlightPostTag?: string;
highlightPreTag?: string;
}
Type Alias Hit<T>
Hit<T>: T & {
_federation?: FederationDetails;
_formatted?: Partial<T>;
_matchesPosition?: MatchesPosition<T>;
_rankingScore?: number;
_rankingScoreDetails?: RankingScoreDetails;
}
_federation?: FederationDetails;
_formatted?: Partial<T>;
_matchesPosition?: MatchesPosition<T>;
_rankingScore?: number;
_rankingScoreDetails?: RankingScoreDetails;
}
Type Parameters
Type Alias HuggingFaceEmbedder
Hugging
distribution?: Distribution;
documentTemplate?: string;
model?: string;
revision?: string;
source: "huggingFace";
}
distribution?: Distribution;
documentTemplate?: string;
model?: string;
revision?: string;
source: "huggingFace";
}
Type Alias HybridSearch
Hybrid
embedder?: string;
semanticRatio?: number;
}
embedder?: string;
semanticRatio?: number;
}
Type Alias IndexObject
Index
createdAt: Date;
primaryKey?: string;
uid: string;
updatedAt: Date;
}
createdAt: Date;
primaryKey?: string;
uid: string;
updatedAt: Date;
}
Type Alias IndexOptions
Index
primaryKey?: string;
}
primaryKey?: string;
}
Type Alias IndexStats
Index
fieldDistribution: FieldDistribution;
isIndexing: boolean;
numberOfDocuments: number;
}
fieldDistribution: FieldDistribution;
isIndexing: boolean;
numberOfDocuments: number;
}
Type Alias IndexesQuery
diff --git a/types/Key.html b/types/Key.html
new file mode 100644
index 000000000..c0f8080e2
--- /dev/null
+++ b/types/Key.html
@@ -0,0 +1 @@
+
Type Alias Key
Key: {
actions: string[];
createdAt: Date;
description: string;
expiresAt: Date;
indexes: string[];
key: string;
name: string | null;
uid: string;
updatedAt: Date;
}
actions: string[];
createdAt: Date;
description: string;
expiresAt: Date;
indexes: string[];
key: string;
name: string | null;
uid: string;
updatedAt: Date;
}
Type Alias KeyCreation
Key
actions: string[];
description?: string;
expiresAt: Date | null;
indexes: string[];
name?: string;
uid?: string;
}
actions: string[];
description?: string;
expiresAt: Date | null;
indexes: string[];
name?: string;
uid?: string;
}
Type Alias KeyUpdate
Key
description?: string;
name?: string;
}
description?: string;
name?: string;
}
Type Alias KeysQuery
Type Alias KeysResults
Type Alias Locale
Locale: string
Type Alias LocalizedAttribute
Type Alias LocalizedAttributes
diff --git a/types/MatchingStrategies.html b/types/MatchingStrategies.html
new file mode 100644
index 000000000..18e8245a2
--- /dev/null
+++ b/types/MatchingStrategies.html
@@ -0,0 +1 @@
+
Type Alias MatchingStrategies
Type Alias MeiliSearchErrorResponse
Meili
code: string;
link: string;
message: string;
type: string;
}
code: string;
link: string;
message: string;
type: string;
}
Type Alias MultiSearchFederation
Multi
limit?: number;
offset?: number;
}
limit?: number;
offset?: number;
}
Type Alias MultiSearchParams
Type Alias MultiSearchQuery
Type Alias MultiSearchQueryWithFederation
Type Alias MultiSearchResponse<T>
Type Parameters
Type Alias MultiSearchResult<T>
Type Parameters
Type Alias NonSeparatorTokens
Non
Type Alias OllamaEmbedder
Ollama
apiKey?: string;
dimensions?: number;
distribution?: Distribution;
documentTemplate?: string;
model?: string;
source: "ollama";
url?: string;
}
apiKey?: string;
dimensions?: number;
distribution?: Distribution;
documentTemplate?: string;
model?: string;
source: "ollama";
url?: string;
}
Type Alias OpenAiEmbedder
Open
apiKey?: string;
dimensions?: number;
distribution?: Distribution;
documentTemplate?: string;
model?: string;
source: "openAi";
url?: string;
}
apiKey?: string;
dimensions?: number;
distribution?: Distribution;
documentTemplate?: string;
model?: string;
source: "openAi";
url?: string;
}
Type Alias Pagination
Pagination: {
limit?: number;
offset?: number;
}
limit?: number;
offset?: number;
}
Type Alias PaginationSettings
Pagination
maxTotalHits?: number | null;
}
maxTotalHits?: number | null;
}
Type Alias ProximityPrecision
Proximity
Type Alias Query
Query: {
q?: string | null;
}
q?: string | null;
}
Type Alias RankingRules
Ranking
Type Alias RankingScoreDetails
Ranking
attribute?: {
attributes_query_word_order: number;
attributes_ranking_order: number;
order: number;
score: number;
};
exactness?: {
matchType: string;
order: number;
score: number;
};
proximity?: {
order: number;
score: number;
};
typo?: {
maxTypoCount: number;
order: number;
score: number;
typoCount: number;
};
words?: {
matchingWords: number;
maxMatchingWords: number;
order: number;
score: number;
};
[key: string]: Record<string, any> | undefined;
}
attribute?: {
attributes_query_word_order: number;
attributes_ranking_order: number;
order: number;
score: number;
};
exactness?: {
matchType: string;
order: number;
score: number;
};
proximity?: {
order: number;
score: number;
};
typo?: {
maxTypoCount: number;
order: number;
score: number;
typoCount: number;
};
words?: {
matchingWords: number;
maxMatchingWords: number;
order: number;
score: number;
};
[key: string]: Record<string, any> | undefined;
}
Type Alias RawDocumentAdditionOptions
Type Alias ResourceQuery
Type Alias ResourceResults<T>
Type Parameters
Type Alias RestEmbedder
Rest
apiKey?: string;
dimensions?: number;
distribution?: Distribution;
documentTemplate?: string;
headers?: Record<string, string>;
request: Record<string, any>;
response: Record<string, any>;
source: "rest";
url: string;
}
apiKey?: string;
dimensions?: number;
distribution?: Distribution;
documentTemplate?: string;
headers?: Record<string, string>;
request: Record<string, any>;
response: Record<string, any>;
source: "rest";
url: string;
}
Type Alias SearchCutoffMs
Search
Type Alias SearchForFacetValuesParams
Type Alias SearchForFacetValuesResponse
Search
facetHits: FacetHit[];
facetQuery: string | null;
processingTimeMs: number;
}
facetHits: FacetHit[];
facetQuery: string | null;
processingTimeMs: number;
}
Type Alias SearchParams
Search
attributesToRetrieve?: string[];
attributesToSearchOn?: string[] | null;
distinct?: string;
facetName?: string;
facetQuery?: string;
facets?: string[];
filter?: Filter;
hitsPerPage?: number;
hybrid?: HybridSearch;
locales?: Locale[];
matchingStrategy?: MatchingStrategies;
page?: number;
rankingScoreThreshold?: number;
retrieveVectors?: boolean;
showMatchesPosition?: boolean;
showRankingScore?: boolean;
showRankingScoreDetails?: boolean;
sort?: string[];
vector?: number[] | null;
}
attributesToRetrieve?: string[];
attributesToSearchOn?: string[] | null;
distinct?: string;
facetName?: string;
facetQuery?: string;
facets?: string[];
filter?: Filter;
hitsPerPage?: number;
hybrid?: HybridSearch;
locales?: Locale[];
matchingStrategy?: MatchingStrategies;
page?: number;
rankingScoreThreshold?: number;
retrieveVectors?: boolean;
showMatchesPosition?: boolean;
showRankingScore?: boolean;
showRankingScoreDetails?: boolean;
sort?: string[];
vector?: number[] | null;
}
Type Alias SearchRequestGET
Search
attributesToCrop?: string;
attributesToHighlight?: string;
attributesToRetrieve?: string;
attributesToSearchOn?: string | null;
distinct?: string;
facets?: string;
filter?: string;
hybridEmbedder?: string;
hybridSemanticRatio?: number;
locales?: Locale[];
rankingScoreThreshold?: number;
retrieveVectors?: boolean;
showMatchesPosition?: boolean;
sort?: string;
vector?: string | null;
}
attributesToCrop?: string;
attributesToHighlight?: string;
attributesToRetrieve?: string;
attributesToSearchOn?: string | null;
distinct?: string;
facets?: string;
filter?: string;
hybridEmbedder?: string;
hybridSemanticRatio?: number;
locales?: Locale[];
rankingScoreThreshold?: number;
retrieveVectors?: boolean;
showMatchesPosition?: boolean;
sort?: string;
vector?: string | null;
}
Type Alias SearchResponse<T, S>
Search
facetDistribution?: FacetDistribution;
facetStats?: FacetStats;
hits: Hits<T>;
processingTimeMs: number;
query: string;
} & (undefined extends S
? Partial<FinitePagination & InfinitePagination>
: true extends IsFinitePagination<NonNullable<S>>
? FinitePagination
: InfinitePagination)
facetDistribution?: FacetDistribution;
facetStats?: FacetStats;
hits: Hits<T>;
processingTimeMs: number;
query: string;
} & (undefined extends S
? Partial<FinitePagination & InfinitePagination>
: true extends IsFinitePagination<NonNullable<S>>
? FinitePagination
: InfinitePagination)
Type Parameters
- T = Record<string, any>
- S extends SearchParams | undefined = undefined
Type Alias SearchSimilarDocumentsParams
Search
attributesToRetrieve?: string[];
embedder?: string;
filter?: Filter;
id: string | number;
limit?: number;
offset?: number;
rankingScoreThreshold?: number;
showRankingScore?: boolean;
showRankingScoreDetails?: boolean;
}
attributesToRetrieve?: string[];
embedder?: string;
filter?: Filter;
id: string | number;
limit?: number;
offset?: number;
rankingScoreThreshold?: number;
showRankingScore?: boolean;
showRankingScoreDetails?: boolean;
}
Type Alias SearchableAttributes
Searchable
Type Alias SeparatorTokens
Separator
Type Alias Settings
Settings: {
dictionary?: Dictionary;
displayedAttributes?: DisplayedAttributes;
distinctAttribute?: DistinctAttribute;
embedders?: Embedders;
faceting?: Faceting;
filterableAttributes?: FilterableAttributes;
localizedAttributes?: LocalizedAttributes;
nonSeparatorTokens?: NonSeparatorTokens;
pagination?: PaginationSettings;
proximityPrecision?: ProximityPrecision;
rankingRules?: RankingRules;
searchableAttributes?: SearchableAttributes;
searchCutoffMs?: SearchCutoffMs;
separatorTokens?: SeparatorTokens;
sortableAttributes?: SortableAttributes;
stopWords?: StopWords;
synonyms?: Synonyms;
typoTolerance?: TypoTolerance;
}
dictionary?: Dictionary;
displayedAttributes?: DisplayedAttributes;
distinctAttribute?: DistinctAttribute;
embedders?: Embedders;
faceting?: Faceting;
filterableAttributes?: FilterableAttributes;
localizedAttributes?: LocalizedAttributes;
nonSeparatorTokens?: NonSeparatorTokens;
pagination?: PaginationSettings;
proximityPrecision?: ProximityPrecision;
rankingRules?: RankingRules;
searchableAttributes?: SearchableAttributes;
searchCutoffMs?: SearchCutoffMs;
separatorTokens?: SeparatorTokens;
sortableAttributes?: SortableAttributes;
stopWords?: StopWords;
synonyms?: Synonyms;
typoTolerance?: TypoTolerance;
}
Type Alias SortableAttributes
Sortable
Type Alias Stats
Type Alias StopWords
Stop
Type Alias SwapIndexesParams
Swap
indexes: string[];
}[]
indexes: string[];
}[]
Type Alias Synonyms
Synonyms: {
[field: string]: string[];
} | null
[field: string]: string[];
} | null
Type Alias TaskObject
Task
details: {
canceledTasks?: number;
deletedDocuments?: number;
deletedTasks?: number;
displayedAttributes?: DisplayedAttributes;
distinctAttribute?: DistinctAttribute;
filterableAttributes?: FilterableAttributes;
indexedDocuments?: number;
matchedTasks?: number;
originalFilter?: string;
primaryKey?: string;
providedIds?: number;
rankingRules?: RankingRules;
receivedDocuments?: number;
searchableAttributes?: SearchableAttributes;
sortableAttributes?: SortableAttributes;
stopWords?: StopWords;
swaps?: SwapIndexesParams;
synonyms?: Synonyms;
};
duration: string;
error: MeiliSearchErrorResponse | null;
finishedAt: string;
startedAt: string;
uid: number;
}
details: {
canceledTasks?: number;
deletedDocuments?: number;
deletedTasks?: number;
displayedAttributes?: DisplayedAttributes;
distinctAttribute?: DistinctAttribute;
filterableAttributes?: FilterableAttributes;
indexedDocuments?: number;
matchedTasks?: number;
originalFilter?: string;
primaryKey?: string;
providedIds?: number;
rankingRules?: RankingRules;
receivedDocuments?: number;
searchableAttributes?: SearchableAttributes;
sortableAttributes?: SortableAttributes;
stopWords?: StopWords;
swaps?: SwapIndexesParams;
synonyms?: Synonyms;
};
duration: string;
error: MeiliSearchErrorResponse | null;
finishedAt: string;
startedAt: string;
uid: number;
}
Type Alias TaskStatus
Type Alias TasksQuery
Tasks
afterEnqueuedAt?: Date;
afterFinishedAt?: Date;
afterStartedAt?: Date;
beforeEnqueuedAt?: Date;
beforeFinishedAt?: Date;
beforeStartedAt?: Date;
canceledBy?: number[];
from?: number;
indexUids?: string[];
limit?: number;
statuses?: TaskStatus[];
types?: TaskTypes[];
uids?: number[];
}
afterEnqueuedAt?: Date;
afterFinishedAt?: Date;
afterStartedAt?: Date;
beforeEnqueuedAt?: Date;
beforeFinishedAt?: Date;
beforeStartedAt?: Date;
canceledBy?: number[];
from?: number;
indexUids?: string[];
limit?: number;
statuses?: TaskStatus[];
types?: TaskTypes[];
uids?: number[];
}
Type Alias TasksResults
Type Alias TasksResultsObject
Type Alias TokenIndexRules
Type Alias TokenOptions
Token
apiKey?: string;
expiresAt?: Date;
}
apiKey?: string;
expiresAt?: Date;
}
Type Alias TokenSearchRules
Type Alias TypoTolerance
Typo
disableOnAttributes?: string[] | null;
disableOnWords?: string[] | null;
enabled?: boolean | null;
minWordSizeForTypos?: {
oneTypo?: number | null;
twoTypos?: number | null;
};
} | null
disableOnAttributes?: string[] | null;
disableOnWords?: string[] | null;
enabled?: boolean | null;
minWordSizeForTypos?: {
oneTypo?: number | null;
twoTypos?: number | null;
};
} | null
Type Alias UpdateDocumentsByFunctionOptions
Update
context?: Record<string, any>;
filter?: string | string[];
function: string;
}
context?: Record<string, any>;
filter?: string | string[];
function: string;
}
Type Alias UserProvidedEmbedder
Type Alias Version
Version: {
commitDate: string;
commitSha: string;
pkgVersion: string;
}
commitDate: string;
commitSha: string;
pkgVersion: string;
}
Type Alias WaitOptions
Wait
intervalMs?: number;
timeOutMs?: number;
}
intervalMs?: number;
timeOutMs?: number;
}
Variable ContentTypeEnumConst
Variable ErrorStatusCodeConst
Error
API_KEY_NOT_FOUND: string;
BAD_REQUEST: string;
DOCUMENT_NOT_FOUND: string;
DOCUMENTS_FIELDS_LIMIT_REACHED: string;
DUMP_NOT_FOUND: string;
DUMP_PROCESS_FAILED: string;
IMMUTABLE_API_KEY_ACTIONS: string;
IMMUTABLE_API_KEY_CREATED_AT: string;
IMMUTABLE_API_KEY_EXPIRES_AT: string;
IMMUTABLE_API_KEY_INDEXES: string;
IMMUTABLE_API_KEY_UID: string;
IMMUTABLE_API_KEY_UPDATED_AT: string;
IMMUTABLE_INDEX_CREATED_AT: string;
IMMUTABLE_INDEX_UID: string;
IMMUTABLE_INDEX_UPDATED_AT: string;
INDEX_ALREADY_EXISTS: string;
INDEX_CREATION_FAILED: string;
INDEX_NOT_ACCESSIBLE: string;
INDEX_NOT_FOUND: string;
INDEX_PRIMARY_KEY_ALREADY_EXISTS: string;
INTERNAL: string;
INVALID_API_KEY: string;
INVALID_API_KEY_ACTIONS: string;
INVALID_API_KEY_DESCRIPTION: string;
INVALID_API_KEY_EXPIRES_AT: string;
INVALID_API_KEY_INDEXES: string;
INVALID_API_KEY_LIMIT: string;
INVALID_API_KEY_OFFSET: string;
INVALID_CONTENT_TYPE: string;
INVALID_DOCUMENT_FIELDS: string;
INVALID_DOCUMENT_FILTER: string;
INVALID_DOCUMENT_GEO_FIELD: string;
INVALID_DOCUMENT_ID: string;
INVALID_DOCUMENT_LIMIT: string;
INVALID_DOCUMENT_OFFSET: string;
INVALID_DOCUMENT_VECTORS_FIELD: string;
INVALID_FACET_SEARCH_FACET_NAME: string;
INVALID_FACET_SEARCH_FACET_QUERY: string;
INVALID_INDEX_LIMIT: string;
INVALID_INDEX_OFFSET: string;
INVALID_INDEX_PRIMARY_KEY: string;
INVALID_INDEX_UID: string;
INVALID_RANKING_RULES: string;
INVALID_REQUEST: string;
INVALID_SEARCH_ATTRIBUTES_TO_CROP: string;
INVALID_SEARCH_ATTRIBUTES_TO_HIGHLIGHT: string;
INVALID_SEARCH_ATTRIBUTES_TO_RETRIEVE: string;
INVALID_SEARCH_ATTRIBUTES_TO_SEARCH_ON: string;
INVALID_SEARCH_CROP_LENGTH: string;
INVALID_SEARCH_CROP_MARKER: string;
INVALID_SEARCH_FACETS: string;
INVALID_SEARCH_FILTER: string;
INVALID_SEARCH_HIGHLIGHT_POST_TAG: string;
INVALID_SEARCH_HIGHLIGHT_PRE_TAG: string;
INVALID_SEARCH_HITS_PER_PAGE: string;
INVALID_SEARCH_LIMIT: string;
INVALID_SEARCH_MATCHING_STRATEGY: string;
INVALID_SEARCH_OFFSET: string;
INVALID_SEARCH_PAGE: string;
INVALID_SEARCH_Q: string;
INVALID_SEARCH_RANKING_SCORE_THRESHOLD: string;
INVALID_SEARCH_SHOW_MATCHES_POSITION: string;
INVALID_SEARCH_SORT: string;
INVALID_SEARCH_VECTOR: string;
INVALID_SETTINGS_DISPLAYED_ATTRIBUTES: string;
INVALID_SETTINGS_DISTINCT_ATTRIBUTE: string;
INVALID_SETTINGS_FACETING: string;
INVALID_SETTINGS_FILTERABLE_ATTRIBUTES: string;
INVALID_SETTINGS_LOCALIZED_ATTRIBUTES: string;
INVALID_SETTINGS_PAGINATION: string;
INVALID_SETTINGS_RANKING_RULES: string;
INVALID_SETTINGS_SEARCH_CUTOFF_MS: string;
INVALID_SETTINGS_SEARCHABLE_ATTRIBUTES: string;
INVALID_SETTINGS_SORTABLE_ATTRIBUTES: string;
INVALID_SETTINGS_STOP_WORDS: string;
INVALID_SETTINGS_SYNONYMS: string;
INVALID_SETTINGS_TYPO_TOLERANCE: string;
INVALID_SIMILAR_RANKING_SCORE_THRESHOLD: string;
INVALID_STATE: string;
INVALID_STORE_FILE: string;
INVALID_SWAP_DUPLICATE_INDEX_FOUND: string;
INVALID_SWAP_INDEXES: string;
INVALID_TASK_AFTER_ENQUEUED_AT: string;
INVALID_TASK_AFTER_FINISHED_AT: string;
INVALID_TASK_AFTER_STARTED_AT: string;
INVALID_TASK_BEFORE_ENQUEUED_AT: string;
INVALID_TASK_BEFORE_FINISHED_AT: string;
INVALID_TASK_BEFORE_STARTED_AT: string;
INVALID_TASK_CANCELED_BY: string;
INVALID_TASK_FROM: string;
INVALID_TASK_INDEX_UIDS: string;
INVALID_TASK_LIMIT: string;
INVALID_TASK_STATUSES: string;
INVALID_TASK_TYPES: string;
INVALID_TASK_UIDS: string;
IO_ERROR: string;
MALFORMED_PAYLOAD: string;
MAX_DATABASE_SIZE_LIMIT_REACHED: string;
MISSING_API_KEY_ACTIONS: string;
MISSING_API_KEY_EXPIRES_AT: string;
MISSING_API_KEY_INDEXES: string;
MISSING_AUTHORIZATION_HEADER: string;
MISSING_CONTENT_TYPE: string;
MISSING_DOCUMENT_FILTER: string;
MISSING_DOCUMENT_ID: string;
MISSING_FACET_SEARCH_FACET_NAME: string;
MISSING_INDEX_UID: string;
MISSING_MASTER_KEY: string;
MISSING_PAYLOAD: string;
MISSING_SWAP_INDEXES: string;
MISSING_TASK_FILTERS: string;
NO_SPACE_LEFT_ON_DEVICE: string;
PAYLOAD_TOO_LARGE: string;
PRIMARY_KEY_INFERENCE_FAILED: string;
TASK_NOT_FOUND: string;
TOO_MANY_OPEN_FILES: string;
UNRETRIEVABLE_DOCUMENT: string;
} = ...
API_KEY_NOT_FOUND: string;
BAD_REQUEST: string;
DOCUMENT_NOT_FOUND: string;
DOCUMENTS_FIELDS_LIMIT_REACHED: string;
DUMP_NOT_FOUND: string;
DUMP_PROCESS_FAILED: string;
IMMUTABLE_API_KEY_ACTIONS: string;
IMMUTABLE_API_KEY_CREATED_AT: string;
IMMUTABLE_API_KEY_EXPIRES_AT: string;
IMMUTABLE_API_KEY_INDEXES: string;
IMMUTABLE_API_KEY_UID: string;
IMMUTABLE_API_KEY_UPDATED_AT: string;
IMMUTABLE_INDEX_CREATED_AT: string;
IMMUTABLE_INDEX_UID: string;
IMMUTABLE_INDEX_UPDATED_AT: string;
INDEX_ALREADY_EXISTS: string;
INDEX_CREATION_FAILED: string;
INDEX_NOT_ACCESSIBLE: string;
INDEX_NOT_FOUND: string;
INDEX_PRIMARY_KEY_ALREADY_EXISTS: string;
INTERNAL: string;
INVALID_API_KEY: string;
INVALID_API_KEY_ACTIONS: string;
INVALID_API_KEY_DESCRIPTION: string;
INVALID_API_KEY_EXPIRES_AT: string;
INVALID_API_KEY_INDEXES: string;
INVALID_API_KEY_LIMIT: string;
INVALID_API_KEY_OFFSET: string;
INVALID_CONTENT_TYPE: string;
INVALID_DOCUMENT_FIELDS: string;
INVALID_DOCUMENT_FILTER: string;
INVALID_DOCUMENT_GEO_FIELD: string;
INVALID_DOCUMENT_ID: string;
INVALID_DOCUMENT_LIMIT: string;
INVALID_DOCUMENT_OFFSET: string;
INVALID_DOCUMENT_VECTORS_FIELD: string;
INVALID_FACET_SEARCH_FACET_NAME: string;
INVALID_FACET_SEARCH_FACET_QUERY: string;
INVALID_INDEX_LIMIT: string;
INVALID_INDEX_OFFSET: string;
INVALID_INDEX_PRIMARY_KEY: string;
INVALID_INDEX_UID: string;
INVALID_RANKING_RULES: string;
INVALID_REQUEST: string;
INVALID_SEARCH_ATTRIBUTES_TO_CROP: string;
INVALID_SEARCH_ATTRIBUTES_TO_HIGHLIGHT: string;
INVALID_SEARCH_ATTRIBUTES_TO_RETRIEVE: string;
INVALID_SEARCH_ATTRIBUTES_TO_SEARCH_ON: string;
INVALID_SEARCH_CROP_LENGTH: string;
INVALID_SEARCH_CROP_MARKER: string;
INVALID_SEARCH_FACETS: string;
INVALID_SEARCH_FILTER: string;
INVALID_SEARCH_HIGHLIGHT_POST_TAG: string;
INVALID_SEARCH_HIGHLIGHT_PRE_TAG: string;
INVALID_SEARCH_HITS_PER_PAGE: string;
INVALID_SEARCH_LIMIT: string;
INVALID_SEARCH_MATCHING_STRATEGY: string;
INVALID_SEARCH_OFFSET: string;
INVALID_SEARCH_PAGE: string;
INVALID_SEARCH_Q: string;
INVALID_SEARCH_RANKING_SCORE_THRESHOLD: string;
INVALID_SEARCH_SHOW_MATCHES_POSITION: string;
INVALID_SEARCH_SORT: string;
INVALID_SEARCH_VECTOR: string;
INVALID_SETTINGS_DISPLAYED_ATTRIBUTES: string;
INVALID_SETTINGS_DISTINCT_ATTRIBUTE: string;
INVALID_SETTINGS_FACETING: string;
INVALID_SETTINGS_FILTERABLE_ATTRIBUTES: string;
INVALID_SETTINGS_LOCALIZED_ATTRIBUTES: string;
INVALID_SETTINGS_PAGINATION: string;
INVALID_SETTINGS_RANKING_RULES: string;
INVALID_SETTINGS_SEARCH_CUTOFF_MS: string;
INVALID_SETTINGS_SEARCHABLE_ATTRIBUTES: string;
INVALID_SETTINGS_SORTABLE_ATTRIBUTES: string;
INVALID_SETTINGS_STOP_WORDS: string;
INVALID_SETTINGS_SYNONYMS: string;
INVALID_SETTINGS_TYPO_TOLERANCE: string;
INVALID_SIMILAR_RANKING_SCORE_THRESHOLD: string;
INVALID_STATE: string;
INVALID_STORE_FILE: string;
INVALID_SWAP_DUPLICATE_INDEX_FOUND: string;
INVALID_SWAP_INDEXES: string;
INVALID_TASK_AFTER_ENQUEUED_AT: string;
INVALID_TASK_AFTER_FINISHED_AT: string;
INVALID_TASK_AFTER_STARTED_AT: string;
INVALID_TASK_BEFORE_ENQUEUED_AT: string;
INVALID_TASK_BEFORE_FINISHED_AT: string;
INVALID_TASK_BEFORE_STARTED_AT: string;
INVALID_TASK_CANCELED_BY: string;
INVALID_TASK_FROM: string;
INVALID_TASK_INDEX_UIDS: string;
INVALID_TASK_LIMIT: string;
INVALID_TASK_STATUSES: string;
INVALID_TASK_TYPES: string;
INVALID_TASK_UIDS: string;
IO_ERROR: string;
MALFORMED_PAYLOAD: string;
MAX_DATABASE_SIZE_LIMIT_REACHED: string;
MISSING_API_KEY_ACTIONS: string;
MISSING_API_KEY_EXPIRES_AT: string;
MISSING_API_KEY_INDEXES: string;
MISSING_AUTHORIZATION_HEADER: string;
MISSING_CONTENT_TYPE: string;
MISSING_DOCUMENT_FILTER: string;
MISSING_DOCUMENT_ID: string;
MISSING_FACET_SEARCH_FACET_NAME: string;
MISSING_INDEX_UID: string;
MISSING_MASTER_KEY: string;
MISSING_PAYLOAD: string;
MISSING_SWAP_INDEXES: string;
MISSING_TASK_FILTERS: string;
NO_SPACE_LEFT_ON_DEVICE: string;
PAYLOAD_TOO_LARGE: string;
PRIMARY_KEY_INFERENCE_FAILED: string;
TASK_NOT_FOUND: string;
TOO_MANY_OPEN_FILES: string;
UNRETRIEVABLE_DOCUMENT: string;
} = ...
Type declaration
API_
KEY_ NOT_ FOUND: string BAD_
REQUEST: string DOCUMENT_
NOT_ FOUND: string DOCUMENTS_
FIELDS_ LIMIT_ REACHED: string DUMP_
NOT_ FOUND: string DUMP_
PROCESS_ FAILED: string IMMUTABLE_
API_ KEY_ ACTIONS: string IMMUTABLE_
API_ KEY_ CREATED_ AT: string IMMUTABLE_
API_ KEY_ EXPIRES_ AT: string IMMUTABLE_
API_ KEY_ INDEXES: string IMMUTABLE_
API_ KEY_ UID: string IMMUTABLE_
API_ KEY_ UPDATED_ AT: string IMMUTABLE_
INDEX_ CREATED_ AT: string IMMUTABLE_
INDEX_ UID: string IMMUTABLE_
INDEX_ UPDATED_ AT: string INDEX_
ALREADY_ EXISTS: string INDEX_
CREATION_ FAILED: string INDEX_
NOT_ ACCESSIBLE: string INDEX_
NOT_ FOUND: string INDEX_
PRIMARY_ KEY_ ALREADY_ EXISTS: string INTERNAL: string
INVALID_
API_ KEY: string INVALID_
API_ KEY_ ACTIONS: string INVALID_
API_ KEY_ DESCRIPTION: string INVALID_
API_ KEY_ EXPIRES_ AT: string INVALID_
API_ KEY_ INDEXES: string INVALID_
API_ KEY_ LIMIT: string INVALID_
API_ KEY_ OFFSET: string INVALID_
CONTENT_ TYPE: string INVALID_
DOCUMENT_ FIELDS: string INVALID_
DOCUMENT_ FILTER: string INVALID_
DOCUMENT_ GEO_ FIELD: string INVALID_
DOCUMENT_ ID: string INVALID_
DOCUMENT_ LIMIT: string INVALID_
DOCUMENT_ OFFSET: string INVALID_
DOCUMENT_ VECTORS_ FIELD: string INVALID_
FACET_ SEARCH_ FACET_ NAME: string INVALID_
FACET_ SEARCH_ FACET_ QUERY: string INVALID_
INDEX_ LIMIT: string INVALID_
INDEX_ OFFSET: string INVALID_
INDEX_ PRIMARY_ KEY: string INVALID_
INDEX_ UID: string INVALID_
RANKING_ RULES: string INVALID_
REQUEST: string INVALID_
SEARCH_ ATTRIBUTES_ TO_ CROP: string INVALID_
SEARCH_ ATTRIBUTES_ TO_ HIGHLIGHT: string INVALID_
SEARCH_ ATTRIBUTES_ TO_ RETRIEVE: string INVALID_
SEARCH_ ATTRIBUTES_ TO_ SEARCH_ ON: string INVALID_
SEARCH_ CROP_ LENGTH: string INVALID_
SEARCH_ CROP_ MARKER: string INVALID_
SEARCH_ FACETS: string INVALID_
SEARCH_ FILTER: string INVALID_
SEARCH_ HIGHLIGHT_ POST_ TAG: string INVALID_
SEARCH_ HIGHLIGHT_ PRE_ TAG: string INVALID_
SEARCH_ HITS_ PER_ PAGE: string INVALID_
SEARCH_ LIMIT: string INVALID_
SEARCH_ MATCHING_ STRATEGY: string INVALID_
SEARCH_ OFFSET: string INVALID_
SEARCH_ PAGE: string INVALID_
SEARCH_ Q: string INVALID_
SEARCH_ RANKING_ SCORE_ THRESHOLD: string INVALID_
SEARCH_ SHOW_ MATCHES_ POSITION: string INVALID_
SEARCH_ SORT: string INVALID_
SEARCH_ VECTOR: string INVALID_
SETTINGS_ DISPLAYED_ ATTRIBUTES: string INVALID_
SETTINGS_ DISTINCT_ ATTRIBUTE: string INVALID_
SETTINGS_ FACETING: string INVALID_
SETTINGS_ FILTERABLE_ ATTRIBUTES: string INVALID_
SETTINGS_ LOCALIZED_ ATTRIBUTES: string INVALID_
SETTINGS_ PAGINATION: string INVALID_
SETTINGS_ RANKING_ RULES: string INVALID_
SETTINGS_ SEARCH_ CUTOFF_ MS: string INVALID_
SETTINGS_ SEARCHABLE_ ATTRIBUTES: string INVALID_
SETTINGS_ SORTABLE_ ATTRIBUTES: string INVALID_
SETTINGS_ STOP_ WORDS: string INVALID_
SETTINGS_ SYNONYMS: string INVALID_
SETTINGS_ TYPO_ TOLERANCE: string INVALID_
SIMILAR_ RANKING_ SCORE_ THRESHOLD: string INVALID_
STATE: string INVALID_
STORE_ FILE: string INVALID_
SWAP_ DUPLICATE_ INDEX_ FOUND: string INVALID_
SWAP_ INDEXES: string INVALID_
TASK_ AFTER_ ENQUEUED_ AT: string INVALID_
TASK_ AFTER_ FINISHED_ AT: string INVALID_
TASK_ AFTER_ STARTED_ AT: string INVALID_
TASK_ BEFORE_ ENQUEUED_ AT: string INVALID_
TASK_ BEFORE_ FINISHED_ AT: string INVALID_
TASK_ BEFORE_ STARTED_ AT: string INVALID_
TASK_ CANCELED_ BY: string INVALID_
TASK_ FROM: string INVALID_
TASK_ INDEX_ UIDS: string INVALID_
TASK_ LIMIT: string INVALID_
TASK_ STATUSES: string INVALID_
TASK_ TYPES: string INVALID_
TASK_ UIDS: string IO_
ERROR: string MALFORMED_
PAYLOAD: string MAX_
DATABASE_ SIZE_ LIMIT_ REACHED: string MISSING_
API_ KEY_ ACTIONS: string MISSING_
API_ KEY_ EXPIRES_ AT: string MISSING_
API_ KEY_ INDEXES: string MISSING_
AUTHORIZATION_ HEADER: string MISSING_
CONTENT_ TYPE: string MISSING_
DOCUMENT_ FILTER: string MISSING_
DOCUMENT_ ID: string MISSING_
FACET_ SEARCH_ FACET_ NAME: string MISSING_
INDEX_ UID: string MISSING_
MASTER_ KEY: string MISSING_
PAYLOAD: string MISSING_
SWAP_ INDEXES: string MISSING_
TASK_ FILTERS: string NO_
SPACE_ LEFT_ ON_ DEVICE: string PAYLOAD_
TOO_ LARGE: string PRIMARY_
KEY_ INFERENCE_ FAILED: string TASK_
NOT_ FOUND: string TOO_
MANY_ OPEN_ FILES: string UNRETRIEVABLE_
DOCUMENT: string
Variable MatchingStrategiesConst
Matching
ALL: "all";
FREQUENCY: "frequency";
LAST: "last";
} = ...
ALL: "all";
FREQUENCY: "frequency";
LAST: "last";
} = ...
Variable TaskStatusConst
Task
TASK_CANCELED: "canceled";
TASK_ENQUEUED: "enqueued";
TASK_FAILED: "failed";
TASK_PROCESSING: "processing";
TASK_SUCCEEDED: "succeeded";
} = ...
TASK_CANCELED: "canceled";
TASK_ENQUEUED: "enqueued";
TASK_FAILED: "failed";
TASK_PROCESSING: "processing";
TASK_SUCCEEDED: "succeeded";
} = ...
Variable TaskTypesConst
Task
DOCUMENT_DELETION: "documentDeletion";
DOCUMENTS_ADDITION_OR_UPDATE: "documentAdditionOrUpdate";
DUMP_CREATION: "dumpCreation";
INDEX_CREATION: "indexCreation";
INDEX_DELETION: "indexDeletion";
INDEX_UPDATE: "indexUpdate";
INDEXES_SWAP: "indexSwap";
SETTINGS_UPDATE: "settingsUpdate";
SNAPSHOT_CREATION: "snapshotCreation";
TASK_CANCELATION: "taskCancelation";
TASK_DELETION: "taskDeletion";
} = ...
DOCUMENT_DELETION: "documentDeletion";
DOCUMENTS_ADDITION_OR_UPDATE: "documentAdditionOrUpdate";
DUMP_CREATION: "dumpCreation";
INDEX_CREATION: "indexCreation";
INDEX_DELETION: "indexDeletion";
INDEX_UPDATE: "indexUpdate";
INDEXES_SWAP: "indexSwap";
SETTINGS_UPDATE: "settingsUpdate";
SNAPSHOT_CREATION: "snapshotCreation";
TASK_CANCELATION: "taskCancelation";
TASK_DELETION: "taskDeletion";
} = ...
Request configuration options
+