Reminders when modifying the API

Oct 13, 2025 by talynt.org 86 views

Exhaustive Facet Search: Unlocking Advanced Search Capabilities

Introduction

In the realm of search engines, facet search is a powerful tool that enables users to filter search results based on specific attributes or categories. However, when it comes to exhaustive facet search, there are nuances to consider. In this article, we will delve into the concept of exhaustive facet search, its usage, and the implications for related teams.

Motivation

When using a paginated search with facet distribution, the facet search is more exhaustive than the non-paginated one. However, the facet-search has only one mode of exhaustivity when processing the counts, making them inconsistent with facet distribution counts coming from a paginated search. This inconsistency can lead to inaccurate results and a poor user experience.

Usage

To perform an exhaustive facet search, you can use the following API endpoint:

POST /index/:index_uid/facet-search

Body:

{
  "facetQuery": "blob",
  "facetName": "genres",
  "q": "",
  "exhaustiveFacetCount": true
}

In this example, we are performing a facet search on the genres attribute, with the exhaustiveFacetCount parameter set to true. This will ensure that the facet search is exhaustive and consistent with the facet distribution counts coming from a paginated search.

Reminders when modifying the API

When modifying the API, it is essential to follow these reminders to ensure that the changes are properly implemented and tested:

Update the openAPI file with utoipa:
- If a new module has been introduced, create a new structure deriving the OpenAPI proc-macro and nest it in the main openAPI structure.
- If a new route has been introduced, add the path decorator to it and add the route at the top of the file in its openAPI structure.
- If a structure which is deserialized or serialized in the API has been introduced or modified, it must derive the schema or the IntoParams proc-macro.
- Once everything is done, start Meilisearch with the swagger flag, open the scalar page on your browser, and ensure everything works as expected.

Reminders when modifying the Setting API

When modifying the Setting API, it is essential to follow these reminders to ensure that the changes are properly implemented and tested:

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.

Special cases when adding a setting for an experimental feature

When adding a setting for an experimental feature, there are special cases to consider:

API stability: The setting does not appear on the main settings route when the feature has never been enabled.
The setting cannot be set when the feature is disabled.
If possible, the setting is reset when the feature is disabled.

Impacted teams

The exhaustive facet search feature will impact the following teams:

Related product team resources: PRD (internal only)
@meilisearch/docs-team when there is any API change, e.g. settings addition

Conclusion

In conclusion, exhaustive facet search is a powerful tool that enables users to filter search results based on specific attributes or categories. However, it requires careful consideration of the nuances involved, including the implications for related teams. By following the reminders outlined in this article, developers can ensure that the changes are properly implemented and tested, resulting in a better user experience and more accurate results.

Future Work

Future work on exhaustive facet search may include:

Improving the performance of exhaustive facet search
Adding support for multiple facet queries
Enhancing the analytics for exhaustive facet search

Related Resources

For more information on exhaustive facet search, please refer to the following resources:

PRD (internal only)
Meilisearch documentation
Meilisearch API documentation
Exhaustive Facet Search: Q&A

Introduction

In our previous article, we explored the concept of exhaustive facet search and its usage. However, we understand that there may be questions and concerns that need to be addressed. In this article, we will provide a Q&A section to help clarify any doubts and provide further information on exhaustive facet search.

Q: What is exhaustive facet search?

A: Exhaustive facet search is a type of search that allows users to filter search results based on specific attributes or categories. It is called "exhaustive" because it returns all possible values for a given attribute, rather than just a subset of values.

Q: How does exhaustive facet search differ from non-exhaustive facet search?

A: Non-exhaustive facet search returns a subset of values for a given attribute, whereas exhaustive facet search returns all possible values. This means that exhaustive facet search can be more comprehensive and accurate, but it may also be slower and more resource-intensive.

Q: What are the benefits of using exhaustive facet search?

A: The benefits of using exhaustive facet search include:

More comprehensive and accurate results
Ability to filter search results based on specific attributes or categories
Improved user experience

Q: What are the limitations of using exhaustive facet search?

A: The limitations of using exhaustive facet search include:

Slower performance and increased resource usage
Potential for increased complexity and difficulty in implementation

Q: How do I implement exhaustive facet search in my application?

A: To implement exhaustive facet search in your application, you will need to use the following API endpoint:

POST /index/:index_uid/facet-search

Body:

{
  "facetQuery": "blob",
  "facetName": "genres",
  "q": "",
  "exhaustiveFacetCount": true
}

Q: What are the implications of using exhaustive facet search for related teams?

A: The implications of using exhaustive facet search for related teams include:

Potential impact on performance and resource usage
Potential impact on complexity and difficulty in implementation
Potential need for additional testing and validation

Q: How do I test and validate exhaustive facet search in my application?

A: To test and validate exhaustive facet search in your application, you will need to:

Use the API endpoint and body outlined above
Test the performance and resource usage of the application
Validate the accuracy and comprehensiveness of the search results

Q: What are some best practices for implementing exhaustive facet search in my application?

A: Some best practices for implementing exhaustive facet search in your application include:

Using the API endpoint and body outlined above
Testing and validating the performance and resource usage of the application
Validating the accuracy and comprehensiveness of the search results
Considering the implications for related teams and adjusting the implementation accordingly

Conclusion

In conclusion, exhaustive facet search is a powerful tool that can improve the accuracy and comprehensiveness of search results. However, it requires careful consideration of the nuances involved, including the implications for related teams. By following the best practices outlined in this article, developers can ensure that the implementation of exhaustive facet search is successful and effective.

Related Resources

For more information on exhaustive facet search, please refer to the following resources: