Meili (Meili v0.1.0)

Copy Markdown View Source

An idiomatic, high-performance Meilisearch client for Elixir.

Summary

Functions

add_documents(client_or_uid, uid_or_documents, documents_or_opts \\ [], opts \\ [])

See Meili.Document.add_or_replace/4.

add_documents!(client_or_uid, uid_or_documents, documents_or_opts \\ [], opts \\ [])

See Meili.Document.add_or_replace!/4.

chat_completions(client_or_workspace, workspace_or_body \\ nil, body_or_opts \\ [], opts \\ [])

See Meili.Chat.completions/4.

chat_completions!(client_or_workspace, workspace_or_body \\ nil, body_or_opts \\ [], opts \\ [])

See Meili.Chat.completions!/4.

client(opts \\ [])

Builds a custom Meili.Client instance with the given options.

compact_index(client_or_uid, uid_or_nil \\ nil)

See Meili.Index.compact/2.

compact_index!(client_or_uid, uid_or_nil \\ nil)

See Meili.Index.compact!/2.

create_dump(client \\ nil)

See Meili.Dump.create/1.

create_dump!(client \\ nil)

See Meili.Dump.create!/1.

create_export(client_or_params, params_or_opts \\ [], opts \\ [])

See Meili.Export.create/3.

create_export!(client_or_params, params_or_opts \\ [], opts \\ [])

See Meili.Export.create!/3.

create_index(client_or_uid, uid_or_opts \\ [], opts \\ [])

See Meili.Index.create/3.

create_index!(client_or_uid, uid_or_opts \\ [], opts \\ [])

See Meili.Index.create!/3.

create_key(client_or_params, params_or_nil \\ nil)

See Meili.Key.create/2.

create_key!(client_or_params, params_or_nil \\ nil)

See Meili.Key.create!/2.

create_snapshot(client \\ nil)

See Meili.Snapshot.create/1.

create_snapshot!(client \\ nil)

See Meili.Snapshot.create!/1.

create_webhook(client_or_params, params_or_nil \\ nil)

See Meili.Webhook.create/2.

create_webhook!(client_or_params, params_or_nil \\ nil)

See Meili.Webhook.create!/2.

default_client()

Builds a Meili.Client from the global application environment.

delete_document(client_or_uid, uid_or_doc_id, doc_id_or_nil \\ nil)

See Meili.Document.delete/3.

delete_document!(client_or_uid, uid_or_doc_id, doc_id_or_nil \\ nil)

See Meili.Document.delete!/3.

delete_dynamic_search_rule(client_or_uid, uid_or_nil \\ nil)

See Meili.DynamicSearchRules.delete/2.

delete_dynamic_search_rule!(client_or_uid, uid_or_nil \\ nil)

See Meili.DynamicSearchRules.delete!/2.

delete_index(client_or_uid, uid_or_nil \\ nil)

See Meili.Index.delete/2.

delete_index!(client_or_uid, uid_or_nil \\ nil)

See Meili.Index.delete!/2.

delete_key(client_or_key, key_or_nil \\ nil)

See Meili.Key.delete/2.

delete_key!(client_or_key, key_or_nil \\ nil)

See Meili.Key.delete!/2.

delete_webhook(client_or_uuid, uuid_or_nil \\ nil)

See Meili.Webhook.delete/2.

delete_webhook!(client_or_uuid, uuid_or_nil \\ nil)

See Meili.Webhook.delete!/2.

edit_documents(client_or_uid, uid_or_queries, queries_or_opts \\ [], opts \\ [])

See Meili.Document.edit/4.

edit_documents!(client_or_uid, uid_or_queries, queries_or_opts \\ [], opts \\ [])

See Meili.Document.edit!/4.

generate_tenant_token(api_key_uid, search_rules, secret \\ nil, opts \\ [])

See Meili.Token.generate/4.

generate_tenant_token!(api_key_uid, search_rules, secret \\ nil, opts \\ [])

See Meili.Token.generate!/4.

get_batch(client_or_uid, uid_or_nil \\ nil)

See Meili.Batch.get/2.

get_batch!(client_or_uid, uid_or_nil \\ nil)

See Meili.Batch.get!/2.

get_document(client_or_uid, uid_or_doc_id, doc_id_or_opts \\ [], opts \\ [])

See Meili.Document.get/4.

get_document!(client_or_uid, uid_or_doc_id, doc_id_or_opts \\ [], opts \\ [])

See Meili.Document.get!/4.

get_dynamic_search_rule(client_or_uid, uid_or_nil \\ nil)

See Meili.DynamicSearchRules.get/2.

get_dynamic_search_rule!(client_or_uid, uid_or_nil \\ nil)

See Meili.DynamicSearchRules.get!/2.

get_experimental_features(client \\ nil)

See Meili.Features.get/1.

get_experimental_features!(client \\ nil)

See Meili.Features.get!/1.

get_index(client_or_uid, uid_or_nil \\ nil)

See Meili.Index.get/2.

get_index!(client_or_uid, uid_or_nil \\ nil)

See Meili.Index.get!/2.

get_key(client_or_key, key_or_nil \\ nil)

See Meili.Key.get/2.

get_key!(client_or_key, key_or_nil \\ nil)

See Meili.Key.get!/2.

get_network(client \\ nil)

See Meili.Network.get/1.

get_network!(client \\ nil)

See Meili.Network.get!/1.

get_settings(client_or_uid, uid_or_nil \\ nil)

See Meili.Settings.get/2.

get_settings!(client_or_uid, uid_or_nil \\ nil)

See Meili.Settings.get!/2.

get_webhook(client_or_uuid, uuid_or_nil \\ nil)

See Meili.Webhook.get/2.

get_webhook!(client_or_uuid, uuid_or_nil \\ nil)

See Meili.Webhook.get!/2.

list_batches(client_or_opts \\ nil, opts \\ [])

See Meili.Batch.list/2.

list_batches!(client_or_opts \\ nil, opts \\ [])

See Meili.Batch.list!/2.

list_dynamic_search_rules(client_or_opts \\ nil, opts \\ [])

See Meili.DynamicSearchRules.list/2.

list_dynamic_search_rules!(client_or_opts \\ nil, opts \\ [])

See Meili.DynamicSearchRules.list!/2.

list_indexes(client_or_opts \\ nil, opts \\ [])

See Meili.Index.list/2.

list_indexes!(client_or_opts \\ nil, opts \\ [])

See Meili.Index.list!/2.

list_keys(client_or_opts \\ nil, opts \\ [])

See Meili.Key.list/2.

list_keys!(client_or_opts \\ nil, opts \\ [])

See Meili.Key.list!/2.

list_webhooks(client \\ nil)

See Meili.Webhook.list/1.

list_webhooks!(client \\ nil)

See Meili.Webhook.list!/1.

reset_settings(client_or_uid, uid_or_nil \\ nil)

See Meili.Settings.reset/2.

reset_settings!(client_or_uid, uid_or_nil \\ nil)

See Meili.Settings.reset!/2.

search(client_or_uid, uid_or_query, query_or_opts \\ [], opts \\ [])

See Meili.Search.search/4.

search!(client_or_uid, uid_or_query, query_or_opts \\ [], opts \\ [])

See Meili.Search.search!/4.

search_similar(client_or_uid, uid_or_body, body_or_opts \\ [], opts \\ [])

See Meili.Search.similar/4.

search_similar!(client_or_uid, uid_or_body, body_or_opts \\ [], opts \\ [])

See Meili.Search.similar!/4.

update_documents(client_or_uid, uid_or_documents, documents_or_opts \\ [], opts \\ [])

See Meili.Document.add_or_update/4.

update_documents!(client_or_uid, uid_or_documents, documents_or_opts \\ [], opts \\ [])

See Meili.Document.add_or_update!/4.

update_dynamic_search_rule(client_or_uid, uid_or_params \\ nil, params_or_nil \\ nil)

See Meili.DynamicSearchRules.update/3.

update_dynamic_search_rule!(client_or_uid, uid_or_params \\ nil, params_or_nil \\ nil)

See Meili.DynamicSearchRules.update!/3.

update_experimental_features(client_or_features, features_or_nil \\ nil)

See Meili.Features.update/2.

update_experimental_features!(client_or_features, features_or_nil \\ nil)

See Meili.Features.update!/2.

update_key(client_or_key, key_or_params \\ nil, params_or_nil \\ nil)

See Meili.Key.update/3.

update_key!(client_or_key, key_or_params \\ nil, params_or_nil \\ nil)

See Meili.Key.update!/3.

update_network(client_or_params, params_or_nil \\ nil)

See Meili.Network.update/2.

update_network!(client_or_params, params_or_nil \\ nil)

See Meili.Network.update!/2.

update_settings(client_or_uid, uid_or_settings \\ [], settings_or_nil \\ [])

See Meili.Settings.update/3.

update_settings!(client_or_uid, uid_or_settings \\ [], settings_or_nil \\ [])

See Meili.Settings.update!/3.

update_webhook(client_or_uuid, uuid_or_params \\ nil, params_or_nil \\ nil)

See Meili.Webhook.update/3.

update_webhook!(client_or_uuid, uuid_or_params \\ nil, params_or_nil \\ nil)

See Meili.Webhook.update!/3.

wait_for_task(client_or_uid, uid_or_opts \\ [], opts \\ [])

See Meili.Task.wait_for_task/3.

wait_for_task!(client_or_uid, uid_or_opts \\ [], opts \\ [])

See Meili.Task.wait_for_task!/3.

Functions

add_documents(client_or_uid, uid_or_documents, documents_or_opts \\ [], opts \\ [])

See Meili.Document.add_or_replace/4.

add_documents!(client_or_uid, uid_or_documents, documents_or_opts \\ [], opts \\ [])

See Meili.Document.add_or_replace!/4.

chat_completions(client_or_workspace, workspace_or_body \\ nil, body_or_opts \\ [], opts \\ [])

See Meili.Chat.completions/4.

chat_completions!(client_or_workspace, workspace_or_body \\ nil, body_or_opts \\ [], opts \\ [])

See Meili.Chat.completions!/4.

client(opts \\ [])

Builds a custom Meili.Client instance with the given options.

Options

  • :url or :endpoint - The Meilisearch base URL (default: http://localhost:7700).
  • :key or :api_key - The API key or master key for authentication.
  • :req_options - Custom configuration options passed directly to Req.new/1.

compact_index(client_or_uid, uid_or_nil \\ nil)

See Meili.Index.compact/2.

compact_index!(client_or_uid, uid_or_nil \\ nil)

See Meili.Index.compact!/2.

create_dump(client \\ nil)

See Meili.Dump.create/1.

create_dump!(client \\ nil)

See Meili.Dump.create!/1.

create_export(client_or_params, params_or_opts \\ [], opts \\ [])

See Meili.Export.create/3.

create_export!(client_or_params, params_or_opts \\ [], opts \\ [])

See Meili.Export.create!/3.

create_index(client_or_uid, uid_or_opts \\ [], opts \\ [])

See Meili.Index.create/3.

create_index!(client_or_uid, uid_or_opts \\ [], opts \\ [])

See Meili.Index.create!/3.

create_key(client_or_params, params_or_nil \\ nil)

See Meili.Key.create/2.

create_key!(client_or_params, params_or_nil \\ nil)

See Meili.Key.create!/2.

create_snapshot(client \\ nil)

See Meili.Snapshot.create/1.

create_snapshot!(client \\ nil)

See Meili.Snapshot.create!/1.

create_webhook(client_or_params, params_or_nil \\ nil)

See Meili.Webhook.create/2.

create_webhook!(client_or_params, params_or_nil \\ nil)

See Meili.Webhook.create!/2.

default_client()

Builds a Meili.Client from the global application environment.

delete_document(client_or_uid, uid_or_doc_id, doc_id_or_nil \\ nil)

See Meili.Document.delete/3.

delete_document!(client_or_uid, uid_or_doc_id, doc_id_or_nil \\ nil)

See Meili.Document.delete!/3.

delete_dynamic_search_rule(client_or_uid, uid_or_nil \\ nil)

See Meili.DynamicSearchRules.delete/2.

delete_dynamic_search_rule!(client_or_uid, uid_or_nil \\ nil)

See Meili.DynamicSearchRules.delete!/2.

delete_index(client_or_uid, uid_or_nil \\ nil)

See Meili.Index.delete/2.

delete_index!(client_or_uid, uid_or_nil \\ nil)

See Meili.Index.delete!/2.

delete_key(client_or_key, key_or_nil \\ nil)

See Meili.Key.delete/2.

delete_key!(client_or_key, key_or_nil \\ nil)

See Meili.Key.delete!/2.

delete_webhook(client_or_uuid, uuid_or_nil \\ nil)

See Meili.Webhook.delete/2.

delete_webhook!(client_or_uuid, uuid_or_nil \\ nil)

See Meili.Webhook.delete!/2.

edit_documents(client_or_uid, uid_or_queries, queries_or_opts \\ [], opts \\ [])

See Meili.Document.edit/4.

edit_documents!(client_or_uid, uid_or_queries, queries_or_opts \\ [], opts \\ [])

See Meili.Document.edit!/4.

generate_tenant_token(api_key_uid, search_rules, secret \\ nil, opts \\ [])

See Meili.Token.generate/4.

generate_tenant_token!(api_key_uid, search_rules, secret \\ nil, opts \\ [])

See Meili.Token.generate!/4.

get_batch(client_or_uid, uid_or_nil \\ nil)

See Meili.Batch.get/2.

get_batch!(client_or_uid, uid_or_nil \\ nil)

See Meili.Batch.get!/2.

get_document(client_or_uid, uid_or_doc_id, doc_id_or_opts \\ [], opts \\ [])

See Meili.Document.get/4.

get_document!(client_or_uid, uid_or_doc_id, doc_id_or_opts \\ [], opts \\ [])

See Meili.Document.get!/4.

get_dynamic_search_rule(client_or_uid, uid_or_nil \\ nil)

See Meili.DynamicSearchRules.get/2.

get_dynamic_search_rule!(client_or_uid, uid_or_nil \\ nil)

See Meili.DynamicSearchRules.get!/2.

get_experimental_features(client \\ nil)

See Meili.Features.get/1.

get_experimental_features!(client \\ nil)

See Meili.Features.get!/1.

get_index(client_or_uid, uid_or_nil \\ nil)

See Meili.Index.get/2.

get_index!(client_or_uid, uid_or_nil \\ nil)

See Meili.Index.get!/2.

get_key(client_or_key, key_or_nil \\ nil)

See Meili.Key.get/2.

get_key!(client_or_key, key_or_nil \\ nil)

See Meili.Key.get!/2.

get_network(client \\ nil)

See Meili.Network.get/1.

get_network!(client \\ nil)

See Meili.Network.get!/1.

get_settings(client_or_uid, uid_or_nil \\ nil)

See Meili.Settings.get/2.

get_settings!(client_or_uid, uid_or_nil \\ nil)

See Meili.Settings.get!/2.

get_webhook(client_or_uuid, uuid_or_nil \\ nil)

See Meili.Webhook.get/2.

get_webhook!(client_or_uuid, uuid_or_nil \\ nil)

See Meili.Webhook.get!/2.

list_batches(client_or_opts \\ nil, opts \\ [])

See Meili.Batch.list/2.

list_batches!(client_or_opts \\ nil, opts \\ [])

See Meili.Batch.list!/2.

list_dynamic_search_rules(client_or_opts \\ nil, opts \\ [])

See Meili.DynamicSearchRules.list/2.

list_dynamic_search_rules!(client_or_opts \\ nil, opts \\ [])

See Meili.DynamicSearchRules.list!/2.

list_indexes(client_or_opts \\ nil, opts \\ [])

See Meili.Index.list/2.

list_indexes!(client_or_opts \\ nil, opts \\ [])

See Meili.Index.list!/2.

list_keys(client_or_opts \\ nil, opts \\ [])

See Meili.Key.list/2.

list_keys!(client_or_opts \\ nil, opts \\ [])

See Meili.Key.list!/2.

list_webhooks(client \\ nil)

See Meili.Webhook.list/1.

list_webhooks!(client \\ nil)

See Meili.Webhook.list!/1.

reset_settings(client_or_uid, uid_or_nil \\ nil)

See Meili.Settings.reset/2.

reset_settings!(client_or_uid, uid_or_nil \\ nil)

See Meili.Settings.reset!/2.

search(client_or_uid, uid_or_query, query_or_opts \\ [], opts \\ [])

See Meili.Search.search/4.

search!(client_or_uid, uid_or_query, query_or_opts \\ [], opts \\ [])

See Meili.Search.search!/4.

search_similar(client_or_uid, uid_or_body, body_or_opts \\ [], opts \\ [])

See Meili.Search.similar/4.

search_similar!(client_or_uid, uid_or_body, body_or_opts \\ [], opts \\ [])

See Meili.Search.similar!/4.

update_documents(client_or_uid, uid_or_documents, documents_or_opts \\ [], opts \\ [])

See Meili.Document.add_or_update/4.

update_documents!(client_or_uid, uid_or_documents, documents_or_opts \\ [], opts \\ [])

See Meili.Document.add_or_update!/4.

update_dynamic_search_rule(client_or_uid, uid_or_params \\ nil, params_or_nil \\ nil)

See Meili.DynamicSearchRules.update/3.

update_dynamic_search_rule!(client_or_uid, uid_or_params \\ nil, params_or_nil \\ nil)

See Meili.DynamicSearchRules.update!/3.

update_experimental_features(client_or_features, features_or_nil \\ nil)

See Meili.Features.update/2.

update_experimental_features!(client_or_features, features_or_nil \\ nil)

See Meili.Features.update!/2.

update_key(client_or_key, key_or_params \\ nil, params_or_nil \\ nil)

See Meili.Key.update/3.

update_key!(client_or_key, key_or_params \\ nil, params_or_nil \\ nil)

See Meili.Key.update!/3.

update_network(client_or_params, params_or_nil \\ nil)

See Meili.Network.update/2.

update_network!(client_or_params, params_or_nil \\ nil)

See Meili.Network.update!/2.

update_settings(client_or_uid, uid_or_settings \\ [], settings_or_nil \\ [])

See Meili.Settings.update/3.

update_settings!(client_or_uid, uid_or_settings \\ [], settings_or_nil \\ [])

See Meili.Settings.update!/3.

update_webhook(client_or_uuid, uuid_or_params \\ nil, params_or_nil \\ nil)

See Meili.Webhook.update/3.

update_webhook!(client_or_uuid, uuid_or_params \\ nil, params_or_nil \\ nil)

See Meili.Webhook.update!/3.

wait_for_task(client_or_uid, uid_or_opts \\ [], opts \\ [])

See Meili.Task.wait_for_task/3.

wait_for_task!(client_or_uid, uid_or_opts \\ [], opts \\ [])

See Meili.Task.wait_for_task!/3.