Index

A

accept_new_fields (meilisearch.config.Config.Paths attribute) actions (meilisearch.models.key.KeyUpdate attribute) add_documents() (meilisearch.index.Index method) add_documents_csv() (meilisearch.index.Index method)

add_documents_in_batches() (meilisearch.index.Index method) add_documents_json() (meilisearch.index.Index method) add_documents_ndjson() (meilisearch.index.Index method) add_documents_raw() (meilisearch.index.Index method) api_key (meilisearch.models.index.OpenAiEmbedder attribute)

B

BY_ATTRIBUTE (meilisearch.models.index.ProximityPrecision attribute)

BY_WORD (meilisearch.models.index.ProximityPrecision attribute)

C

cancel_tasks() (meilisearch.client.Client method) (meilisearch.task.TaskHandler method) canceled_by (meilisearch.models.task.Task attribute) Client (class in meilisearch.client) Config (class in meilisearch.config) Config.Paths (class in meilisearch.config)

create() (meilisearch.index.Index static method) create_dump() (meilisearch.client.Client method) create_index() (meilisearch.client.Client method) create_key() (meilisearch.client.Client method) create_snapshot() (meilisearch.client.Client method) created_at (meilisearch.models.key.Key attribute)

D

delete() (meilisearch.index.Index method) delete_all_documents() (meilisearch.index.Index method) delete_document() (meilisearch.index.Index method) delete_documents() (meilisearch.index.Index method) delete_index() (meilisearch.client.Client method) delete_key() (meilisearch.client.Client method) delete_tasks() (meilisearch.client.Client method) (meilisearch.task.TaskHandler method) description (meilisearch.models.key.KeyUpdate attribute) details (meilisearch.models.task.Task attribute) dictionary (meilisearch.config.Config.Paths attribute) dimensions (meilisearch.models.index.OpenAiEmbedder attribute) (meilisearch.models.index.UserProvidedEmbedder attribute)

disable_on_attributes (meilisearch.models.index.TypoTolerance attribute) disable_on_words (meilisearch.models.index.TypoTolerance attribute) displayed_attributes (meilisearch.config.Config.Paths attribute) distinct_attribute (meilisearch.config.Config.Paths attribute) Document (class in meilisearch.models.document) document (meilisearch.config.Config.Paths attribute) document_template (meilisearch.models.index.HuggingFaceEmbedder attribute) (meilisearch.models.index.OpenAiEmbedder attribute) document_template_max_bytes (meilisearch.models.index.HuggingFaceEmbedder attribute) (meilisearch.models.index.OpenAiEmbedder attribute) DocumentsResults (class in meilisearch.models.document) dumps (meilisearch.config.Config.Paths attribute) duration (meilisearch.models.task.Task attribute)

E

Embedders (class in meilisearch.models.index) embedders (meilisearch.config.Config.Paths attribute) (meilisearch.models.index.Embedders attribute) enabled (meilisearch.models.index.TypoTolerance attribute)

enqueued_at (meilisearch.models.task.Task attribute) (meilisearch.models.task.TaskInfo attribute) error (meilisearch.models.task.Task attribute) expires_at (meilisearch.models.key.KeyUpdate attribute)

F

facet_search (meilisearch.config.Config.Paths attribute) facet_search() (meilisearch.index.Index method) Faceting (class in meilisearch.models.index)

faceting (meilisearch.config.Config.Paths attribute) fetch_info() (meilisearch.index.Index method) filterable_attributes (meilisearch.config.Config.Paths attribute) finished_at (meilisearch.models.task.Task attribute)

G

generate_tenant_token() (meilisearch.client.Client method) get_all_stats() (meilisearch.client.Client method) get_dictionary() (meilisearch.index.Index method) get_displayed_attributes() (meilisearch.index.Index method) get_distinct_attribute() (meilisearch.index.Index method) get_document() (meilisearch.index.Index method) get_documents() (meilisearch.index.Index method) get_embedders() (meilisearch.index.Index method) get_faceting_settings() (meilisearch.index.Index method) get_filterable_attributes() (meilisearch.index.Index method) get_index() (meilisearch.client.Client method) get_indexes() (meilisearch.client.Client method) get_key() (meilisearch.client.Client method) get_keys() (meilisearch.client.Client method) get_non_separator_tokens() (meilisearch.index.Index method) get_pagination_settings() (meilisearch.index.Index method) get_primary_key() (meilisearch.index.Index method) get_proximity_precision() (meilisearch.index.Index method)

get_ranking_rules() (meilisearch.index.Index method) get_raw_index() (meilisearch.client.Client method) get_raw_indexes() (meilisearch.client.Client method) get_search_cutoff_ms() (meilisearch.index.Index method) get_searchable_attributes() (meilisearch.index.Index method) get_separator_tokens() (meilisearch.index.Index method) get_settings() (meilisearch.index.Index method) get_sortable_attributes() (meilisearch.index.Index method) get_stats() (meilisearch.index.Index method) get_stop_words() (meilisearch.index.Index method) get_synonyms() (meilisearch.index.Index method) get_task() (meilisearch.client.Client method) (meilisearch.index.Index method) (meilisearch.task.TaskHandler method) get_tasks() (meilisearch.client.Client method) (meilisearch.index.Index method) (meilisearch.task.TaskHandler method) get_typo_tolerance() (meilisearch.index.Index method) get_version() (meilisearch.client.Client method)

H

health (meilisearch.config.Config.Paths attribute)

health() (meilisearch.client.Client method) HuggingFaceEmbedder (class in meilisearch.models.index)

I

Index (class in meilisearch.index) index (meilisearch.config.Config.Paths attribute) index() (meilisearch.client.Client method) index_uid (meilisearch.models.task.Task attribute) (meilisearch.models.task.TaskInfo attribute)

indexes (meilisearch.models.key.KeyUpdate attribute) IndexStats (class in meilisearch.models.index) is_healthy() (meilisearch.client.Client method)

K

Key (class in meilisearch.models.key) key (meilisearch.models.key.Key attribute) (meilisearch.models.key.KeyUpdate attribute)

keys (meilisearch.config.Config.Paths attribute) KeysResults (class in meilisearch.models.key) KeyUpdate (class in meilisearch.models.key)

L

limit (meilisearch.models.key.KeysResults attribute)

M

max_total_hits (meilisearch.models.index.Pagination attribute) max_values_per_facet (meilisearch.models.index.Faceting attribute) meilisearch module meilisearch.client module meilisearch.config module meilisearch.errors module meilisearch.index module meilisearch.models module meilisearch.models.document module meilisearch.models.index module meilisearch.models.key module meilisearch.models.task module meilisearch.task module meilisearch.version module

MeilisearchApiError MeilisearchCommunicationError MeilisearchError MeilisearchTimeoutError min_word_size_for_typos (meilisearch.models.index.TypoTolerance attribute) MinWordSizeForTypos (class in meilisearch.models.index) model (meilisearch.models.index.HuggingFaceEmbedder attribute) (meilisearch.models.index.OpenAiEmbedder attribute) model_config (meilisearch.models.key.KeyUpdate attribute) module meilisearch meilisearch.client meilisearch.config meilisearch.errors meilisearch.index meilisearch.models meilisearch.models.document meilisearch.models.index meilisearch.models.key meilisearch.models.task meilisearch.task meilisearch.version multi_search (meilisearch.config.Config.Paths attribute) multi_search() (meilisearch.client.Client method)

N

name (meilisearch.models.key.KeyUpdate attribute)

non_separator_tokens (meilisearch.config.Config.Paths attribute)

O

offset (meilisearch.models.key.KeysResults attribute)

one_typo (meilisearch.models.index.MinWordSizeForTypos attribute) OpenAiEmbedder (class in meilisearch.models.index)

P

Pagination (class in meilisearch.models.index) pagination (meilisearch.config.Config.Paths attribute)

proximity_precision (meilisearch.config.Config.Paths attribute) ProximityPrecision (class in meilisearch.models.index)

Q

qualified_version() (in module meilisearch.version)

R

ranking_rules (meilisearch.config.Config.Paths attribute) reset_dictionary() (meilisearch.index.Index method) reset_displayed_attributes() (meilisearch.index.Index method) reset_distinct_attribute() (meilisearch.index.Index method) reset_embedders() (meilisearch.index.Index method) reset_faceting_settings() (meilisearch.index.Index method) reset_filterable_attributes() (meilisearch.index.Index method) reset_non_separator_tokens() (meilisearch.index.Index method) reset_pagination_settings() (meilisearch.index.Index method) reset_proximity_precision() (meilisearch.index.Index method)

reset_ranking_rules() (meilisearch.index.Index method) reset_search_cutoff_ms() (meilisearch.index.Index method) reset_searchable_attributes() (meilisearch.index.Index method) reset_separator_tokens() (meilisearch.index.Index method) reset_settings() (meilisearch.index.Index method) reset_sortable_attributes() (meilisearch.index.Index method) reset_stop_words() (meilisearch.index.Index method) reset_synonyms() (meilisearch.index.Index method) reset_typo_tolerance() (meilisearch.index.Index method) results (meilisearch.models.key.KeysResults attribute) revision (meilisearch.models.index.HuggingFaceEmbedder attribute)

S

search (meilisearch.config.Config.Paths attribute) search() (meilisearch.index.Index method) search_cutoff_ms (meilisearch.config.Config.Paths attribute) searchable_attributes (meilisearch.config.Config.Paths attribute) separator_tokens (meilisearch.config.Config.Paths attribute) setting (meilisearch.config.Config.Paths attribute) snapshots (meilisearch.config.Config.Paths attribute) sort_facet_values_by (meilisearch.models.index.Faceting attribute) sortable_attributes (meilisearch.config.Config.Paths attribute) source (meilisearch.models.index.HuggingFaceEmbedder attribute) (meilisearch.models.index.OpenAiEmbedder attribute) (meilisearch.models.index.UserProvidedEmbedder attribute)

started_at (meilisearch.models.task.Task attribute) stat (meilisearch.config.Config.Paths attribute) status (meilisearch.models.task.Task attribute) (meilisearch.models.task.TaskInfo attribute) stop_words (meilisearch.config.Config.Paths attribute) swap (meilisearch.config.Config.Paths attribute) swap_indexes() (meilisearch.client.Client method) synonyms (meilisearch.config.Config.Paths attribute)

T

Task (class in meilisearch.models.task) task (meilisearch.config.Config.Paths attribute) task_uid (meilisearch.models.task.TaskInfo attribute) TaskHandler (class in meilisearch.task) TaskInfo (class in meilisearch.models.task) TaskResults (class in meilisearch.models.task)

total (meilisearch.models.key.KeysResults attribute) two_typos (meilisearch.models.index.MinWordSizeForTypos attribute) type (meilisearch.models.task.Task attribute) (meilisearch.models.task.TaskInfo attribute) typo_tolerance (meilisearch.config.Config.Paths attribute) TypoTolerance (class in meilisearch.models.index)

U

uid (meilisearch.models.task.Task attribute) update() (meilisearch.index.Index method) update_dictionary() (meilisearch.index.Index method) update_displayed_attributes() (meilisearch.index.Index method) update_distinct_attribute() (meilisearch.index.Index method) update_documents() (meilisearch.index.Index method) update_documents_csv() (meilisearch.index.Index method) update_documents_in_batches() (meilisearch.index.Index method) update_documents_json() (meilisearch.index.Index method) update_documents_ndjson() (meilisearch.index.Index method) update_documents_raw() (meilisearch.index.Index method) update_embedders() (meilisearch.index.Index method) update_faceting_settings() (meilisearch.index.Index method) update_filterable_attributes() (meilisearch.index.Index method)

update_key() (meilisearch.client.Client method) update_non_separator_tokens() (meilisearch.index.Index method) update_pagination_settings() (meilisearch.index.Index method) update_proximity_precision() (meilisearch.index.Index method) update_ranking_rules() (meilisearch.index.Index method) update_search_cutoff_ms() (meilisearch.index.Index method) update_searchable_attributes() (meilisearch.index.Index method) update_separator_tokens() (meilisearch.index.Index method) update_settings() (meilisearch.index.Index method) update_sortable_attributes() (meilisearch.index.Index method) update_stop_words() (meilisearch.index.Index method) update_synonyms() (meilisearch.index.Index method) update_typo_tolerance() (meilisearch.index.Index method) updated_at (meilisearch.models.key.Key attribute) UserProvidedEmbedder (class in meilisearch.models.index)

V

validate_created_at() (meilisearch.models.key.Key method) validate_enqueued_at() (meilisearch.models.task.Task method) (meilisearch.models.task.TaskInfo method) validate_finished_at() (meilisearch.models.task.Task method)

validate_started_at() (meilisearch.models.task.Task method) validate_updated_at() (meilisearch.models.key.Key method) version (meilisearch.config.Config.Paths attribute) version() (meilisearch.client.Client method) version_error_hint_message() (in module meilisearch.errors)

W

wait_for_task() (meilisearch.client.Client method) (meilisearch.index.Index method) (meilisearch.task.TaskHandler method)