Meilisearch.Settings (meilisearch v0.20.0) View Source
Collection of functions used to manage settings.
Link to this section Summary
Functions
Get settings.
Get attributes for faceting.
Get displayed attributes.
Get distinct attribute.
Get ranking rules.
Get searchable attributes.
Get stop-words.
Get synonyms.
Reset settings.
Reset attributes for faceting.
Reset displayed attributes.
Reset distinct attribute.
Reset ranking rules.
Reset searchable attributes.
Reset stop-words.
Reset synonyms.
Update settings.
Update attributes for faceting.
Update displayed attributes.
Update distinct attribute.
Update ranking rules.
Update searchable attributes.
Update stop-words.
Update synonyms.
Link to this section Functions
Specs
get(String.t()) :: Meilisearch.HTTP.response()
Get settings.
Example
iex> Meilisearch.Settings.get("meilisearch_test")
{:ok,
%{
"rankingRules" => [
"typo",
"words",
"proximity",
"attribute",
"wordsPosition",
"exactness"
],
"attributesForFaceting" => [],
"displayedAttributes" => ["*"],
"distinctAttribute" => "id",
"searchableAttributes" => ["*"],
"stopWords" => [],
"synonyms" => %{}
}}Specs
get_attributes_for_faceting(String.t()) :: Meilisearch.HTTP.response()
Get attributes for faceting.
Example
iex> Meilisearch.Settings.get_attributes_for_faceting("meilisearch_test")
{:ok, []}Specs
get_displayed_attributes(String.t()) :: Meilisearch.HTTP.response()
Get displayed attributes.
Example
iex> Meilisearch.Settings.get_displayed_attributes("meilisearch_test")
{:ok, ["*"]}Specs
get_distinct_attribute(String.t()) :: Meilisearch.HTTP.response()
Get distinct attribute.
Example
iex> Meilisearch.Settings.get_distinct_attribute("meilisearch_test")
{:ok, "id"}Specs
get_ranking_rules(String.t()) :: Meilisearch.HTTP.response()
Get ranking rules.
Example
iex> Meilisearch.Settings.get_ranking_rules("meilisearch_test")
{:ok,
["typo",
"words",
"proximity",
"attribute",
"wordsPosition",
"exactness"
]
}Specs
get_searchable_attributes(String.t()) :: Meilisearch.HTTP.response()
Get searchable attributes.
Example
iex> Meilisearch.Settings.get_searchable_attributes("meilisearch_test")
{:ok, ["*"]}Specs
get_stop_words(String.t()) :: Meilisearch.HTTP.response()
Get stop-words.
Example
iex> Meilisearch.Settings.get_stop_words("meilisearch_test")
{:ok, []}Specs
get_synonyms(String.t()) :: Meilisearch.HTTP.response()
Get synonyms.
Example
iex> Meilisearch.Settings.get_synonyms("meilisearch_test")
{:ok, %{}}Specs
reset(String.t()) :: Meilisearch.HTTP.response()
Reset settings.
Example
iex> Meilisearch.Settings.reset("meilisearch_test")
{:ok, %{"updateId" => 1}}Specs
reset_attributes_for_faceting(String.t()) :: Meilisearch.HTTP.response()
Reset attributes for faceting.
Example
iex> Meilisearch.Settings.reset_attributes_for_faceting("meilisearch_test")
{:ok, %{"updateId" => 1}}Specs
reset_displayed_attributes(String.t()) :: Meilisearch.HTTP.response()
Reset displayed attributes.
Example
iex> Meilisearch.Settings.reset_displayed_attributes("meilisearch_test")
{:ok, %{"updateId" => 1}}Specs
reset_distinct_attribute(String.t()) :: Meilisearch.HTTP.response()
Reset distinct attribute.
Example
iex> Meilisearch.Settings.reset_distinct_attribute("meilisearch_test")
{:ok, %{"updateId" => 1}}Specs
reset_ranking_rules(String.t()) :: Meilisearch.HTTP.response()
Reset ranking rules.
Example
iex> Meilisearch.Settings.reset_ranking_rules("meilisearch_test")
{:ok, %{"updateId" => 1}}Specs
reset_searchable_attributes(String.t()) :: Meilisearch.HTTP.response()
Reset searchable attributes.
Example
iex> Meilisearch.Settings.reset_searchable_attributes("meilisearch_test")
{:ok, %{"updateId" => 1}}Specs
reset_stop_words(String.t()) :: Meilisearch.HTTP.response()
Reset stop-words.
Example
iex> Meilisearch.Settings.reset_stop_words("meilisearch_test")
{:ok, %{"updateId" => 1}}Specs
reset_synonyms(String.t()) :: Meilisearch.HTTP.response()
Reset synonyms.
Example
iex> Meilisearch.Settings.reset_synonyms("meilisearch_test")
{:ok, %{"updateId" => 1}}Specs
update(String.t(), any()) :: Meilisearch.HTTP.response()
Update settings.
Example
iex> Meilisearch.Settings.update("meilisearch_test", %{synonyms: %{alien: ["ufo"]}})
{:ok, %{"updateId" => 1}}
Link to this function
update_attributes_for_faceting(index_uid, attributes_for_faceting)
View SourceSpecs
update_attributes_for_faceting(String.t(), [String.t()]) :: Meilisearch.HTTP.response()
Update attributes for faceting.
Example
iex> Meilisearch.Settings.update_attributes_for_faceting(
"meilisearch_test",
["title"]
)
{:ok, %{"updateId" => 1}}Specs
update_displayed_attributes(String.t(), [String.t()]) :: Meilisearch.HTTP.response()
Update displayed attributes.
Example
iex> Meilisearch.Settings.update_displayed_attributes("meilisearch_test", ["title"])
{:ok, %{"updateId" => 1}}Specs
update_distinct_attribute(String.t(), String.t()) :: Meilisearch.HTTP.response()
Update distinct attribute.
Example
iex> Meilisearch.Settings.update_distinct_attribute("meilisearch_test", "id")
{:ok, %{"updateId" => 1}}Specs
update_ranking_rules(String.t(), [String.t()]) :: Meilisearch.HTTP.response()
Update ranking rules.
Example
iex> Meilisearch.Settings.update_ranking_rules(
"meilisearch_test",
["typo", "words", "proximity", "attribute"]
)
{:ok, %{"updateId" => 1}}Specs
update_searchable_attributes(String.t(), [String.t()]) :: Meilisearch.HTTP.response()
Update searchable attributes.
Example
iex> Meilisearch.Settings.update_searchable_attributes("meilisearch_test", ["title"])
{:ok, %{"updateId" => 1}}Specs
update_stop_words(String.t(), [String.t()]) :: Meilisearch.HTTP.response()
Update stop-words.
Example
iex> Meilisearch.Settings.update_stop_words("meilisearch_test", ["the", "of", "to"])
{:ok, %{"updateId" => 1}}Specs
update_synonyms(String.t(), any()) :: Meilisearch.HTTP.response()
Update synonyms.
Example
iex> Meilisearch.Settings.update_synonyms("meilisearch_test", %{alien: ["ufo"]})
{:ok, %{"updateId" => 1}}