Skip to content

Commit cdc54df

Browse files
algolia-botNixFrog
andcommitted
docs(SearchParams): Document that filter scores are supported in virtual replicas (generated)
algolia/api-clients-automation#5716 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Bertrand Le Mée <6178622+NixFrog@users.noreply.github.com>
1 parent e8b4e3d commit cdc54df

3 files changed

Lines changed: 18 additions & 12 deletions

File tree

client/src/commonMain/kotlin/com/algolia/client/model/composition/OptionalFilters.kt

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,13 @@ import kotlinx.serialization.json.*
1717
* Filters to promote or demote records in the search results. Optional filters work like facet
1818
* filters, but they don't exclude records from the search results. Records that match the optional
1919
* filter rank before records that don't match. If you're using a negative filter `facet:-value`,
20-
* matching records rank after records that don't match. - Optional filters don't work on virtual
21-
* replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters are
22-
* applied _before_ custom ranking attributes (in the default
20+
* matching records rank after records that don't match. - Optional filters are applied _after_
21+
* sort-by attributes. - Optional filters are applied _before_ custom ranking attributes (in the
22+
* default
2323
* [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria)). -
24-
* Optional filters don't work with numeric attributes.
24+
* Optional filters don't work with numeric attributes. - On virtual replicas, optional filters are
25+
* applied _after_ the replica's
26+
* [relevant sort](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort).
2527
*
2628
* Implementations:
2729
* - [List<OptionalFilters>] - *[OptionalFilters.of]*

client/src/commonMain/kotlin/com/algolia/client/model/recommend/OptionalFilters.kt

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,13 @@ import kotlinx.serialization.json.*
1717
* Filters to promote or demote records in the search results. Optional filters work like facet
1818
* filters, but they don't exclude records from the search results. Records that match the optional
1919
* filter rank before records that don't match. If you're using a negative filter `facet:-value`,
20-
* matching records rank after records that don't match. - Optional filters don't work on virtual
21-
* replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters are
22-
* applied _before_ custom ranking attributes (in the default
20+
* matching records rank after records that don't match. - Optional filters are applied _after_
21+
* sort-by attributes. - Optional filters are applied _before_ custom ranking attributes (in the
22+
* default
2323
* [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria)). -
24-
* Optional filters don't work with numeric attributes.
24+
* Optional filters don't work with numeric attributes. - On virtual replicas, optional filters are
25+
* applied _after_ the replica's
26+
* [relevant sort](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort).
2527
*
2628
* Implementations:
2729
* - [List<OptionalFilters>] - *[OptionalFilters.of]*

client/src/commonMain/kotlin/com/algolia/client/model/search/OptionalFilters.kt

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,13 @@ import kotlinx.serialization.json.*
1717
* Filters to promote or demote records in the search results. Optional filters work like facet
1818
* filters, but they don't exclude records from the search results. Records that match the optional
1919
* filter rank before records that don't match. If you're using a negative filter `facet:-value`,
20-
* matching records rank after records that don't match. - Optional filters don't work on virtual
21-
* replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters are
22-
* applied _before_ custom ranking attributes (in the default
20+
* matching records rank after records that don't match. - Optional filters are applied _after_
21+
* sort-by attributes. - Optional filters are applied _before_ custom ranking attributes (in the
22+
* default
2323
* [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria)). -
24-
* Optional filters don't work with numeric attributes.
24+
* Optional filters don't work with numeric attributes. - On virtual replicas, optional filters are
25+
* applied _after_ the replica's
26+
* [relevant sort](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort).
2527
*
2628
* Implementations:
2729
* - [List<OptionalFilters>] - *[OptionalFilters.of]*

0 commit comments

Comments
 (0)