Skip to content

Meilisearch JavaScript

Main Navigation Guide API Documentation

Appearance

Sidebar Navigation

Guide

Introduction

API

index

Classes

Index

Meilisearch

MeilisearchApiError

MeilisearchError

MeilisearchRequestError

MeilisearchRequestTimeOutError

MeilisearchTaskTimeOutError

Type Aliases

AddRemoteOptions

BaseRequestInit

Batch

BatchesResults

BatchProgress

BatchProgressStep

CategoriesDistribution

ChatCompletionRequest

ChatSettings

ChatSettingsPayload

ChatWorkspaceSettings

CompositeEmbedder

Config

ContentType

Crop

DeleteOrCancelTasksQuery

Dictionary

DisplayedAttributes

DistinctAttribute

Distribution

DocumentOptions

DocumentQuery

DocumentsDeletionQuery

DocumentsIds

DocumentsQuery

Embedder

EmbedderFragments

Embedders

EnqueuedTask

EnqueuedTaskPromise

ErrorStatusCode

ExtraRequestInit

Facet

FacetDistribution

FacetHit

Faceting

FacetOrder

FacetsByIndex

FacetStat

FacetStats

FederatedMultiSearchParams

FederationDetails

FederationOptions

FieldDistribution

FieldsFilter

FieldsQuery

FieldsResults

Filter

FilterableAttributes

ForeignKey

ForeignKeys

GranularFilterableAttribute

Health

Highlight

Hit

Hits

HttpRequestsRequestInit

HuggingFaceEmbedder

HybridSearch

IndexesQuery

IndexesResults

IndexField

IndexObject

IndexOptions

IndexStats

IndexSwap

InitializeNetworkOptions

Key

KeyCreation

KeysQuery

KeysResults

KeyUpdate

Locale

LocalizedAttribute

LocalizedAttributes

MainRequestOptions

MatchesPosition

MatchingStrategies

MediaBinary

MediaPayload

MeilisearchErrorResponse

MergeFacets

MultiSearchFederation

MultiSearchParams

MultiSearchQuery

MultiSearchQueryWithFederation

MultiSearchResponse

MultiSearchResponseOrSearchResponse

MultiSearchResult

Network

NonSeparatorTokens

OllamaEmbedder

OpenAiEmbedder

Pagination

PaginationSettings

Personalize

PrefixSearch

ProximityPrecision

Query

RankingRules

RankingScoreDetails

RawDocumentAdditionOptions

RecordAny

Remote

RemoveRemoteOptions

RenderTemplateParams

RenderTemplateResponse

RenderTemplateSource

RequestOptions

ResourceQuery

ResourceResults

RestEmbedder

ResultsWrapper

RuntimeTogglableFeatures

SearchableAttributes

SearchCutoffMs

SearchForFacetValuesParams

SearchForFacetValuesResponse

SearchParams

SearchRequestGET

SearchResponse

SearchRule

SearchRuleAction

SearchRuleCondition

SearchRuleListFilterPayload

SearchRuleListPayload

SearchRulePinAction

SearchRuleQueryCondition

SearchRuleSelector

SearchRuleTimeCondition

SearchRuleUpdatePayload

SearchSimilarDocumentsParams

SeparatorTokens

Settings

Shard

ShardInitialization

ShardUpdate

SortableAttributes

Stats

StopWords

Synonyms

Task

TaskDetails

TaskEnqueueOptions

TasksOrBatchesQuery

TasksResults

TaskStatus

TaskType

TaskUidOrEnqueuedTask

TenantTokenGeneratorOptions

TenantTokenHeader

TokenClaims

TokenIndexRules

TokenSearchRules

TypoTolerance

UpdateDocumentsByFunctionOptions

UpdateNetworkOptions

URLSearchParamsRecord

UserProvidedEmbedder

Version

WaitOptions

Webhook

WebhookCreatePayload

WebhookUpdatePayload

Variables

ContentTypeEnum

ErrorStatusCode

MatchingStrategies

token

Functions

generateTenantToken

On this page

Meilisearch JS

Modules

index
token

Pager

Next pageIntroduction