From faf22eec2b38bf82c86c41471f186be24a7f5f48 Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Mon, 13 Jan 2025 12:48:47 +0000 Subject: [PATCH] fix(specs): optionalFilters additional explanation [skip-bc] (generated) https://github.com/algolia/api-clients-automation/pull/4353 Co-authored-by: algolia-bot Co-authored-by: Kai Welke Co-authored-by: shortcuts --- .../java/com/algolia/model/recommend/OptionalFilters.java | 6 ++++-- .../main/java/com/algolia/model/search/OptionalFilters.java | 6 ++++-- 2 files changed, 8 insertions(+), 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 index 6ad85ec21..6bf003343 100644 --- 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 index 709d077e6..04907c7a1 100644 --- 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 {