Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v1.12: New index settings: prefixSearch and facetSearch #3063

Open
4 tasks done
guimachiavelli opened this issue Dec 4, 2024 · 0 comments · May be fixed by #3070
Open
4 tasks done

v1.12: New index settings: prefixSearch and facetSearch #3063

guimachiavelli opened this issue Dec 4, 2024 · 0 comments · May be fixed by #3070
Milestone

Comments

@guimachiavelli
Copy link
Member

guimachiavelli commented Dec 4, 2024

v1.12 introduces two new settings to opt-out of features that affect indexing speed. Essentially, users skip specific indexing subprocesses, exchanging functionality/relevancy for more indexing speed. The concept is more or less the same as proximityPrecision.

Setting facetSearch to false disables all functionality related to the /facet-search route.

Setting prefix to disabled will significantly impact search result relevancy in many/most common scenarios. In short, searching for he will only return results matching that string and ignore terms like hello, head, and health.

  • facetSearch
    - { facetSearch: true | false }
    - PATCH /indexes/{index_uid}/settings -> update via global settings route
    - PUT /indexes/{index_uid}/settings/facet-search -> update via dedicated subroute
    - DELETE /indexes/{index_uid}/settings/facet-search -> reset
  • prefixSearch
    - PATCH /indexes/{index_uid}/settings -> update via global settings route
    - PUT /indexes/{index_uid}/settings/prefix-search -> update via dedicated subroute
    - DELETE /indexes/{index_uid}/settings/prefix-search -> reset
    - { prefixSearch: "disabled" | "indexingTime" }
    - disabled disables prefix search
    - indexingTime is the default behaviour, with Meilisearch calculating prefixes during indexing
  • new errors:
    • facet_search_disabled
      • triggered when hitting /facet-search with facetSearch set to false
    • invalid_settings_facet_search
    • invalid_settings_prefix_search

Tasks

  • Update /reference/api/settings.mdx
    • Create "Prefix search" section after "Proximity precision"
    • Create "Facet search" section after "Proximity precision"
  • Update /reference/errors/error_codes

References

@guimachiavelli guimachiavelli added this to the v1.12 milestone Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant