View Source Meilisearch.Settings.Faceting (meilisearch_ex v1.0.0)
Link to this section Summary
Link to this section Types
@type t() :: %Meilisearch.Settings.Faceting{ __meta__: Ecto.Schema.Metadata.t(), maxValuesPerFacet: integer() }
Link to this section Functions
@spec get(Tesla.Client.t(), String.t()) :: {:ok, t()} | {:error, Meilisearch.Client.error()}
Get faceting settings of an Index of your Meilsiearch instance. meili doc
examples
Examples
iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Settings.Faceting.get(client, "movies")
{:ok, %Meilisearch.Settings.Faceting{maxValuesPerFacet: 100}}
@spec reset(Tesla.Client.t(), String.t()) :: {:ok, Meilisearch.SummarizedTask.t()} | {:error, Meilisearch.Client.error()}
Reset faceting settings of an Index of your Meilsiearch instance. meili doc
examples
Examples
iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Settings.Faceting.reset(client, "movies")
{:ok, %{
taskUid: 0,
indexUid: "movies",
status: :enqueued,
type: :settingsUpdate,
enqueuedAt: ~U[2021-08-12 10:00:00]
}}
@spec update(Tesla.Client.t(), String.t(), %{maxValuesPerFacet: integer()}) :: {:ok, Meilisearch.SummarizedTask.t()} | {:error, Meilisearch.Client.error()}
Update faceting settings of an Index of your Meilsiearch instance. meili doc
examples
Examples
iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Settings.Faceting.update(client, "movies", %{maxValuesPerFacet: 2})
{:ok, %{
taskUid: 0,
indexUid: "movies",
status: :enqueued,
type: :settingsUpdate,
enqueuedAt: ~U[2021-08-12 10:00:00]
}}