View Source Meilisearch.Settings.TypeTolerence (meilisearch_ex v1.0.0)
Link to this section Summary
Link to this section Types
@type t() :: %Meilisearch.Settings.TypeTolerence{ __meta__: Ecto.Schema.Metadata.t(), disableOnAttributes: [String.t()], disableOnWords: [String.t()], enabled: boolean(), minWordSizeForTypos: Meilisearch.Settings.TypeTolerence.MinWordSizesForTypos.t() }
Link to this section Functions
@spec get(Tesla.Client.t(), String.t()) :: {:ok, t()} | {:error, Meilisearch.Client.error()}
Get typo tolerance 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.TypoTolerance.get(client, "movies")
{:ok, %Meilisearch.Settings.TypoTolerance{
enabled: true,
disableOnWords: [],
disableOnAttributes: [],
minWordSizeForTypos: %Meilisearch.Settings.TypoTolerance.MinWordSizesForTypos{
oneTypo: 5,
twoTypos: 9
}
}}
@spec reset(Tesla.Client.t(), String.t()) :: {:ok, Meilisearch.SummarizedTask.t()} | {:error, Meilisearch.Client.error()}
Reset typo tolerance 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.TypoTolerance.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(), %{ enabled: boolean(), disableOnWords: [String.t()], disableOnAttributes: [String.t()], minWordSizeForTypos: %{oneTypo: integer(), twoTypos: integer()} }) :: {:ok, Meilisearch.SummarizedTask.t()} | {:error, Meilisearch.Client.error()}
Update typo tolerance 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.TypoTolerance.update(client, "movies", %{maxTotalHits: 100})
{:ok, %{
taskUid: 0,
indexUid: "movies",
status: :enqueued,
type: :settingsUpdate,
enqueuedAt: ~U[2021-08-12 10:00:00]
}}