fix(specs): optionalFilters additional explanation [skip-bc] (generated)

algolia/api-clients-automation#4353 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Kai Welke <[email protected]> Co-authored-by: shortcuts <[email protected]>
algolia · Jan 13, 2025 · faf22ee · faf22ee
1 parent e2932cd
commit faf22ee
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/algoliasearch/src/main/java/com/algolia/model/recommend/OptionalFilters.java b/algoliasearch/src/main/java/com/algolia/model/recommend/OptionalFilters.java
@@ -18,8 +18,10 @@
  * filters, but they don't exclude records from the search results. Records that match the optional
  * filter rank before records that don't match. If you're using a negative filter `facet:-value`,
  * matching records rank after records that don't match. - Optional filters don't work on virtual
- * replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don't
- * work with numeric attributes.
+ * replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters are
+ * applied _before_ custom ranking attributes (in the default
+ * [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/)).
+ * - Optional filters don't work with numeric attributes.
  */
 @JsonDeserialize(using = OptionalFilters.Deserializer.class)
 public interface OptionalFilters {

diff --git a/algoliasearch/src/main/java/com/algolia/model/search/OptionalFilters.java b/algoliasearch/src/main/java/com/algolia/model/search/OptionalFilters.java
@@ -18,8 +18,10 @@
  * filters, but they don't exclude records from the search results. Records that match the optional
  * filter rank before records that don't match. If you're using a negative filter `facet:-value`,
  * matching records rank after records that don't match. - Optional filters don't work on virtual
- * replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don't
- * work with numeric attributes.
+ * replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters are
+ * applied _before_ custom ranking attributes (in the default
+ * [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/)).
+ * - Optional filters don't work with numeric attributes.
  */
 @JsonDeserialize(using = OptionalFilters.Deserializer.class)
 public interface OptionalFilters {