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 · aa60809 · aa60809
1 parent 49d7bb8
commit aa60809
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/Sources/Recommend/Models/RecommendOptionalFilters.swift b/Sources/Recommend/Models/RecommendOptionalFilters.swift
@@ -10,6 +10,8 @@ import Foundation
 /// 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 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.
 public enum RecommendOptionalFilters: Codable, JSONEncodable, AbstractEncodable {
     case arrayOfRecommendOptionalFilters([RecommendOptionalFilters])

diff --git a/Sources/Search/Models/SearchOptionalFilters.swift b/Sources/Search/Models/SearchOptionalFilters.swift
@@ -10,6 +10,8 @@ import Foundation
 /// 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 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.
 public enum SearchOptionalFilters: Codable, JSONEncodable, AbstractEncodable {
     case arrayOfSearchOptionalFilters([SearchOptionalFilters])