Skip to content

Granular Filterable attribute settings #5163

@curquiza

Description

@curquiza

Motivation

Let the user customize their relevancy to improve their indexing speed

Usage

https://meilisearch.notion.site/API-usage-Settings-to-opt-out-indexing-features-filterableAttributes-1764b06b651f80aba8bdf359b2df3ca8?pvs=74

TODO

Reminders when modifying the Setting API

  • Ensure the new setting route is at least tested by the test_setting_routes macro
  • Ensure Analytics are fully implemented
  • Ensure the dump serializing is consistent with the /settings route serializing, e.g., enums case can be different (camelCase in route and PascalCase in the dump)

Special cases when adding a setting for an experimental feature

  • ⚠️ API stability: The setting does not appear on the main settings route when the feature has never been enabled (e.g. mark it Unset when returned from the index in this situation. See an example)
  • The setting cannot be set when the feature is disabled, either by the main settings route or the subroute (see validate_settings function)
  • If possible, the setting is reset when the feature is disabled (hard if it requires reindexing)

Impacted teams

@meilisearch/docs-team @meilisearch/integration-team @meilisearch/cloud-team

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or improvementimpacts cloudThis issue involves changes for the Meilisearch's cloud teamimpacts docsThis issue involves changes in the Meilisearch's documentationimpacts integrationsThis issue involves changes in the Meilisearch's integrationsv1.14.0PRs/issues solved in v1.14.0 released on 2025-04-14

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions