View Source Meilisearch.Settings.RankingRules (meilisearch_ex v1.0.0)

Link to this section Summary

Functions

Get ranking rules settings of an Index of your Meilsiearch instance. meili doc

Reset ranking rules settings of an Index of your Meilsiearch instance. meili doc

Update ranking rules settings of an Index of your Meilsiearch instance. meili doc

Link to this section Functions

@spec get(Tesla.Client.t(), String.t()) ::
  {:ok, [String.t()]} | {:error, Meilisearch.Client.error()}

Get ranking rules 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.RankingRules.get(client, "movies")
{:ok, ["words", "typo", "proximity", "attribute", "sort", "exactness"]}
Link to this function

reset(client, index_uid)

View Source

Reset ranking rules 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.RankingRules.reset(client, "movies")
{:ok, %{
  taskUid: 0,
  indexUid: "movies",
  status: :enqueued,
  type: :settingsUpdate,
  enqueuedAt: ~U[2021-08-12 10:00:00]
}}
Link to this function

update(client, index_uid, params)

View Source
@spec update(Tesla.Client.t(), String.t(), [String.t()]) ::
  {:ok, Meilisearch.SummarizedTask.t()} | {:error, Meilisearch.Client.error()}

Update ranking rules 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.RankingRules.update(client, "movies", ["words", "typo", "proximity", "attribute", "sort", "exactness", "release_date:desc"])
{:ok, %{
  taskUid: 0,
  indexUid: "movies",
  status: :enqueued,
  type: :settingsUpdate,
  enqueuedAt: ~U[2021-08-12 10:00:00]
}}