Meili.Features (Meili v0.2.0)

Copy Markdown View Source

Manages Meilisearch experimental features.

Summary

Functions

Retrieves status of all experimental features.

Retrieves status of all experimental features, raising on error.

Updates one or more experimental features.

Updates experimental features, raising on error.

Functions

get(client \\ nil)

@spec get(Meili.Client.t() | nil) :: {:ok, map()} | {:error, Meili.Error.t()}

Retrieves status of all experimental features.

Examples

Meili.Features.get()
Meili.Features.get(client)

get!(client \\ nil)

@spec get!(Meili.Client.t() | nil) :: map() | no_return()

Retrieves status of all experimental features, raising on error.

Examples

Meili.Features.get!()
Meili.Features.get!(client)

update(client_or_features, features_or_nil \\ nil)

@spec update(Meili.Client.t() | map() | Keyword.t(), map() | Keyword.t() | nil) ::
  {:ok, map()} | {:error, Meili.Error.t()}

Updates one or more experimental features.

Keys are automatically camelized from snake_case to camelCase.

Examples

features = %{
  vector_store: true,
  metrics: false
}
Meili.Features.update(features)
Meili.Features.update(client, features)

update!(client_or_features, features_or_nil \\ nil)

@spec update!(Meili.Client.t() | map() | Keyword.t(), map() | Keyword.t() | nil) ::
  map() | no_return()

Updates experimental features, raising on error.

Examples

features = %{vector_store: true}
Meili.Features.update!(features)
Meili.Features.update!(client, features)