class Meilisearch::Crystal::SettingsAPI

• Meilisearch::Crystal::SettingsAPI
• Meilisearch::Crystal::API
• Reference
• Object

Overview

Whole-object and per-setting index configuration operations.

Defined in:

meilisearch/crystal/settings.cr

Macro Summary

• setting(name, path, type)

  Defines typed read and reset methods for an individual setting.

Instance Method Summary

• #dictionary(uid : String) : Array(String)
• #displayed_attributes(uid : String) : Array(String)
• #distinct_attribute(uid : String) : Union(String, Nil)
• #embedders(uid : String) : Hash(String, Embedder)
• #facet_search(uid : String) : Bool
• #faceting(uid : String) : Faceting
• #filterable_attributes(uid : String) : Array(String)
• #get(uid : String) : Settings
• #localized_attributes(uid : String) : Array(LocalizedAttribute)
• #non_separator_tokens(uid : String) : Array(String)
• #pagination(uid : String) : Pagination
• #prefix_search(uid : String) : PrefixSearch
• #proximity_precision(uid : String) : ProximityPrecision
• #ranking_rules(uid : String) : Array(String)
• #reset(uid : String) : TaskResult
• #reset_dictionary(uid : String) : TaskResult
• #reset_displayed_attributes(uid : String) : TaskResult
• #reset_distinct_attribute(uid : String) : TaskResult
• #reset_embedders(uid : String) : TaskResult
• #reset_facet_search(uid : String) : TaskResult
• #reset_faceting(uid : String) : TaskResult
• #reset_filterable_attributes(uid : String) : TaskResult
• #reset_localized_attributes(uid : String) : TaskResult
• #reset_non_separator_tokens(uid : String) : TaskResult
• #reset_pagination(uid : String) : TaskResult
• #reset_prefix_search(uid : String) : TaskResult
• #reset_proximity_precision(uid : String) : TaskResult
• #reset_ranking_rules(uid : String) : TaskResult
• #reset_search_cutoff_ms(uid : String) : TaskResult
• #reset_searchable_attributes(uid : String) : TaskResult
• #reset_separator_tokens(uid : String) : TaskResult
• #reset_sortable_attributes(uid : String) : TaskResult
• #reset_stop_words(uid : String) : TaskResult
• #reset_synonyms(uid : String) : TaskResult
• #reset_typo_tolerance(uid : String) : TaskResult
• #search_cutoff_ms(uid : String) : Union(Int64, Nil)
• #searchable_attributes(uid : String) : Array(String)
• #separator_tokens(uid : String) : Array(String)
• #sortable_attributes(uid : String) : Array(String)
• #stop_words(uid : String) : Array(String)
• #synonyms(uid : String) : Hash(String, Array(String))
• #typo_tolerance(uid : String) : TypoTolerance
• #update(uid : String, settings : Settings) : TaskResult

Macro Detail

Instance Method Detail