Welcome to meilisearch-python’s documentation!

meilisearch

• meilisearch package
  • Subpackages
    • meilisearch.models package
      • Submodules
      • meilisearch.models.document module
      • meilisearch.models.embedders module
      • meilisearch.models.index module
      • meilisearch.models.key module
      • meilisearch.models.task module
      • Module contents
  • Submodules
  • meilisearch.client module
    • Client
      • Client.MeilisearchApiError
      • Client.add_or_update_networks()
      • Client.cancel_tasks()
      • Client.create_chat_completion()
      • Client.create_dump()
      • Client.create_index()
      • Client.create_key()
      • Client.create_snapshot()
      • Client.delete_index()
      • Client.delete_key()
      • Client.delete_tasks()
      • Client.generate_tenant_token()
      • Client.get_all_networks()
      • Client.get_all_stats()
      • Client.get_batch()
      • Client.get_batches()
      • Client.get_chat_workspace_settings()
      • Client.get_chat_workspaces()
      • Client.get_index()
      • Client.get_indexes()
      • Client.get_key()
      • Client.get_keys()
      • Client.get_raw_index()
      • Client.get_raw_indexes()
      • Client.get_task()
      • Client.get_tasks()
      • Client.get_version()
      • Client.health()
      • Client.index()
      • Client.is_healthy()
      • Client.multi_search()
      • Client.swap_indexes()
      • Client.update_chat_workspace_settings()
      • Client.update_documents_by_function()
      • Client.update_key()
      • Client.version()
      • Client.wait_for_task()
  • meilisearch.config module
    • Config
      • Config.Paths
  • meilisearch.errors module
    • MeilisearchApiError
    • MeilisearchCommunicationError
    • MeilisearchError
    • MeilisearchTimeoutError
    • version_error_hint_message()
  • meilisearch.index module
    • Index
      • Index.add_documents()
      • Index.add_documents_csv()
      • Index.add_documents_in_batches()
      • Index.add_documents_json()
      • Index.add_documents_ndjson()
      • Index.add_documents_raw()
      • Index.create()
      • Index.delete()
      • Index.delete_all_documents()
      • Index.delete_document()
      • Index.delete_documents()
      • Index.facet_search()
      • Index.fetch_info()
      • Index.get_dictionary()
      • Index.get_displayed_attributes()
      • Index.get_distinct_attribute()
      • Index.get_document()
      • Index.get_documents()
      • Index.get_embedders()
      • Index.get_facet_search_settings()
      • Index.get_faceting_settings()
      • Index.get_filterable_attributes()
      • Index.get_localized_attributes()
      • Index.get_non_separator_tokens()
      • Index.get_pagination_settings()
      • Index.get_prefix_search()
      • Index.get_primary_key()
      • Index.get_proximity_precision()
      • Index.get_ranking_rules()
      • Index.get_search_cutoff_ms()
      • Index.get_searchable_attributes()
      • Index.get_separator_tokens()
      • Index.get_settings()
      • Index.get_similar_documents()
      • Index.get_sortable_attributes()
      • Index.get_stats()
      • Index.get_stop_words()
      • Index.get_synonyms()
      • Index.get_task()
      • Index.get_tasks()
      • Index.get_typo_tolerance()
      • Index.reset_dictionary()
      • Index.reset_displayed_attributes()
      • Index.reset_distinct_attribute()
      • Index.reset_embedders()
      • Index.reset_facet_search_settings()
      • Index.reset_faceting_settings()
      • Index.reset_filterable_attributes()
      • Index.reset_localized_attributes()
      • Index.reset_non_separator_tokens()
      • Index.reset_pagination_settings()
      • Index.reset_prefix_search()
      • Index.reset_proximity_precision()
      • Index.reset_ranking_rules()
      • Index.reset_search_cutoff_ms()
      • Index.reset_searchable_attributes()
      • Index.reset_separator_tokens()
      • Index.reset_settings()
      • Index.reset_sortable_attributes()
      • Index.reset_stop_words()
      • Index.reset_synonyms()
      • Index.reset_typo_tolerance()
      • Index.search()
      • Index.update()
      • Index.update_dictionary()
      • Index.update_displayed_attributes()
      • Index.update_distinct_attribute()
      • Index.update_documents()
      • Index.update_documents_csv()
      • Index.update_documents_in_batches()
      • Index.update_documents_json()
      • Index.update_documents_ndjson()
      • Index.update_documents_raw()
      • Index.update_embedders()
      • Index.update_facet_search_settings()
      • Index.update_faceting_settings()
      • Index.update_filterable_attributes()
      • Index.update_localized_attributes()
      • Index.update_non_separator_tokens()
      • Index.update_pagination_settings()
      • Index.update_prefix_search()
      • Index.update_proximity_precision()
      • Index.update_ranking_rules()
      • Index.update_search_cutoff_ms()
      • Index.update_searchable_attributes()
      • Index.update_separator_tokens()
      • Index.update_settings()
      • Index.update_sortable_attributes()
      • Index.update_stop_words()
      • Index.update_synonyms()
      • Index.update_typo_tolerance()
      • Index.wait_for_task()
  • meilisearch.task module
    • TaskHandler
      • TaskHandler.cancel_tasks()
      • TaskHandler.delete_tasks()
      • TaskHandler.get_batch()
      • TaskHandler.get_batches()
      • TaskHandler.get_task()
      • TaskHandler.get_tasks()
      • TaskHandler.wait_for_task()
  • meilisearch.version module
    • qualified_version()
  • Module contents

Indices and tables

• Index

• Module Index

• Search Page