algolia 3.8.0 → 3.8.1

data/lib/algolia/models/search/search_for_facets.rb

@@ -60,7 +60,6 @@ module Algolia
       # Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.
       attr_accessor :minimum_around_radius
 
-      # Coordinates for a rectangular area in which to search.  Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
       attr_accessor :inside_bounding_box
 
       # Coordinates of a polygon in which to search.  Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`.
@@ -176,7 +175,6 @@ module Algolia
       # Whether to support phrase matching and excluding words from search queries.  Use the `advancedSyntaxFeatures` parameter to control which feature is supported.
       attr_accessor :advanced_syntax
 
-      # Words that should be considered optional when found in the query.  By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher.  For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records:  - If `optionalWords` has less than 10 words, the required number of matched words increases by 1:   results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down).   For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.  For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
       attr_accessor :optional_words
 
       # Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). Attribute names are case-sensitive.  This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
@@ -201,9 +199,6 @@ module Algolia
       # Properties to include in the API response of `search` and `browse` requests.  By default, all response properties are included. To reduce the response size, you can select, which attributes should be included.  You can't exclude these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or any property triggered by the `getRankingInfo` parameter.  Don't exclude properties that you might need in your search UI.
       attr_accessor :response_fields
 
-      # Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
-      attr_accessor :max_facet_hits
-
       # Maximum number of facet values to return for each facet.
       attr_accessor :max_values_per_facet
 
@@ -229,6 +224,9 @@ module Algolia
       # Text to search inside the facet's values.
       attr_accessor :facet_query
 
+      # Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+      attr_accessor :max_facet_hits
+
       attr_accessor :type
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -304,7 +302,6 @@ module Algolia
           :replace_synonyms_in_highlight => :replaceSynonymsInHighlight,
           :min_proximity => :minProximity,
           :response_fields => :responseFields,
-          :max_facet_hits => :maxFacetHits,
           :max_values_per_facet => :maxValuesPerFacet,
           :sort_facet_values_by => :sortFacetValuesBy,
           :attribute_criteria_computed_by_min_proximity => :attributeCriteriaComputedByMinProximity,
@@ -314,6 +311,7 @@ module Algolia
           :facet => :facet,
           :index_name => :indexName,
           :facet_query => :facetQuery,
+          :max_facet_hits => :maxFacetHits,
           :type => :type
         }
       end
@@ -346,7 +344,7 @@ module Algolia
           :around_radius => :"AroundRadius",
           :around_precision => :"AroundPrecision",
           :minimum_around_radius => :"Integer",
-          :inside_bounding_box => :"Array<Array<Float>>",
+          :inside_bounding_box => :"InsideBoundingBox",
           :inside_polygon => :"Array<Array<Float>>",
           :natural_languages => :"Array<SupportedLanguage>",
           :rule_contexts => :"Array<String>",
@@ -387,7 +385,7 @@ module Algolia
           :mode => :"Mode",
           :semantic_search => :"SemanticSearch",
           :advanced_syntax => :"Boolean",
-          :optional_words => :"Array<String>",
+          :optional_words => :"OptionalWords",
           :disable_exact_on_attributes => :"Array<String>",
           :exact_on_single_word_query => :"ExactOnSingleWordQuery",
           :alternatives_as_exact => :"Array<AlternativesAsExact>",
@@ -396,7 +394,6 @@ module Algolia
           :replace_synonyms_in_highlight => :"Boolean",
           :min_proximity => :"Integer",
           :response_fields => :"Array<String>",
-          :max_facet_hits => :"Integer",
           :max_values_per_facet => :"Integer",
           :sort_facet_values_by => :"String",
           :attribute_criteria_computed_by_min_proximity => :"Boolean",
@@ -406,6 +403,7 @@ module Algolia
           :facet => :"String",
           :index_name => :"String",
           :facet_query => :"String",
+          :max_facet_hits => :"Integer",
           :type => :"SearchTypeFacet"
         }
       end
@@ -413,7 +411,10 @@ module Algolia
       # List of attributes with nullable: true
       def self.openapi_nullable
         Set.new(
-          []
+          [
+            :inside_bounding_box,
+            :optional_words
+          ]
         )
       end
 
@@ -533,9 +534,7 @@ module Algolia
         end
 
         if attributes.key?(:inside_bounding_box)
-          if (value = attributes[:inside_bounding_box]).is_a?(Array)
-            self.inside_bounding_box = value
-          end
+          self.inside_bounding_box = attributes[:inside_bounding_box]
         end
 
         if attributes.key?(:inside_polygon)
@@ -721,9 +720,7 @@ module Algolia
         end
 
         if attributes.key?(:optional_words)
-          if (value = attributes[:optional_words]).is_a?(Array)
-            self.optional_words = value
-          end
+          self.optional_words = attributes[:optional_words]
         end
 
         if attributes.key?(:disable_exact_on_attributes)
@@ -766,10 +763,6 @@ module Algolia
           end
         end
 
-        if attributes.key?(:max_facet_hits)
-          self.max_facet_hits = attributes[:max_facet_hits]
-        end
-
         if attributes.key?(:max_values_per_facet)
           self.max_values_per_facet = attributes[:max_values_per_facet]
         end
@@ -810,6 +803,10 @@ module Algolia
           self.facet_query = attributes[:facet_query]
         end
 
+        if attributes.key?(:max_facet_hits)
+          self.max_facet_hits = attributes[:max_facet_hits]
+        end
+
         if attributes.key?(:type)
           self.type = attributes[:type]
         else
@@ -892,7 +889,6 @@ module Algolia
           replace_synonyms_in_highlight == other.replace_synonyms_in_highlight &&
           min_proximity == other.min_proximity &&
           response_fields == other.response_fields &&
-          max_facet_hits == other.max_facet_hits &&
           max_values_per_facet == other.max_values_per_facet &&
           sort_facet_values_by == other.sort_facet_values_by &&
           attribute_criteria_computed_by_min_proximity == other.attribute_criteria_computed_by_min_proximity &&
@@ -902,6 +898,7 @@ module Algolia
           facet == other.facet &&
           index_name == other.index_name &&
           facet_query == other.facet_query &&
+          max_facet_hits == other.max_facet_hits &&
           type == other.type
       end
 
@@ -985,7 +982,6 @@ module Algolia
           replace_synonyms_in_highlight,
           min_proximity,
           response_fields,
-          max_facet_hits,
           max_values_per_facet,
           sort_facet_values_by,
           attribute_criteria_computed_by_min_proximity,
@@ -995,6 +991,7 @@ module Algolia
           facet,
           index_name,
           facet_query,
+          max_facet_hits,
           type
         ].hash
       end

data/lib/algolia/models/search/search_for_hits.rb

@@ -60,7 +60,6 @@ module Algolia
       # Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.
       attr_accessor :minimum_around_radius
 
-      # Coordinates for a rectangular area in which to search.  Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
       attr_accessor :inside_bounding_box
 
       # Coordinates of a polygon in which to search.  Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`.
@@ -176,7 +175,6 @@ module Algolia
       # Whether to support phrase matching and excluding words from search queries.  Use the `advancedSyntaxFeatures` parameter to control which feature is supported.
       attr_accessor :advanced_syntax
 
-      # Words that should be considered optional when found in the query.  By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher.  For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records:  - If `optionalWords` has less than 10 words, the required number of matched words increases by 1:   results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down).   For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.  For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
       attr_accessor :optional_words
 
       # Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). Attribute names are case-sensitive.  This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
@@ -201,9 +199,6 @@ module Algolia
       # Properties to include in the API response of `search` and `browse` requests.  By default, all response properties are included. To reduce the response size, you can select, which attributes should be included.  You can't exclude these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or any property triggered by the `getRankingInfo` parameter.  Don't exclude properties that you might need in your search UI.
       attr_accessor :response_fields
 
-      # Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
-      attr_accessor :max_facet_hits
-
       # Maximum number of facet values to return for each facet.
       attr_accessor :max_values_per_facet
 
@@ -298,7 +293,6 @@ module Algolia
           :replace_synonyms_in_highlight => :replaceSynonymsInHighlight,
           :min_proximity => :minProximity,
           :response_fields => :responseFields,
-          :max_facet_hits => :maxFacetHits,
           :max_values_per_facet => :maxValuesPerFacet,
           :sort_facet_values_by => :sortFacetValuesBy,
           :attribute_criteria_computed_by_min_proximity => :attributeCriteriaComputedByMinProximity,
@@ -338,7 +332,7 @@ module Algolia
           :around_radius => :"AroundRadius",
           :around_precision => :"AroundPrecision",
           :minimum_around_radius => :"Integer",
-          :inside_bounding_box => :"Array<Array<Float>>",
+          :inside_bounding_box => :"InsideBoundingBox",
           :inside_polygon => :"Array<Array<Float>>",
           :natural_languages => :"Array<SupportedLanguage>",
           :rule_contexts => :"Array<String>",
@@ -379,7 +373,7 @@ module Algolia
           :mode => :"Mode",
           :semantic_search => :"SemanticSearch",
           :advanced_syntax => :"Boolean",
-          :optional_words => :"Array<String>",
+          :optional_words => :"OptionalWords",
           :disable_exact_on_attributes => :"Array<String>",
           :exact_on_single_word_query => :"ExactOnSingleWordQuery",
           :alternatives_as_exact => :"Array<AlternativesAsExact>",
@@ -388,7 +382,6 @@ module Algolia
           :replace_synonyms_in_highlight => :"Boolean",
           :min_proximity => :"Integer",
           :response_fields => :"Array<String>",
-          :max_facet_hits => :"Integer",
           :max_values_per_facet => :"Integer",
           :sort_facet_values_by => :"String",
           :attribute_criteria_computed_by_min_proximity => :"Boolean",
@@ -403,7 +396,10 @@ module Algolia
       # List of attributes with nullable: true
       def self.openapi_nullable
         Set.new(
-          []
+          [
+            :inside_bounding_box,
+            :optional_words
+          ]
         )
       end
 
@@ -523,9 +519,7 @@ module Algolia
         end
 
         if attributes.key?(:inside_bounding_box)
-          if (value = attributes[:inside_bounding_box]).is_a?(Array)
-            self.inside_bounding_box = value
-          end
+          self.inside_bounding_box = attributes[:inside_bounding_box]
         end
 
         if attributes.key?(:inside_polygon)
@@ -711,9 +705,7 @@ module Algolia
         end
 
         if attributes.key?(:optional_words)
-          if (value = attributes[:optional_words]).is_a?(Array)
-            self.optional_words = value
-          end
+          self.optional_words = attributes[:optional_words]
         end
 
         if attributes.key?(:disable_exact_on_attributes)
@@ -756,10 +748,6 @@ module Algolia
           end
         end
 
-        if attributes.key?(:max_facet_hits)
-          self.max_facet_hits = attributes[:max_facet_hits]
-        end
-
         if attributes.key?(:max_values_per_facet)
           self.max_values_per_facet = attributes[:max_values_per_facet]
         end
@@ -870,7 +858,6 @@ module Algolia
           replace_synonyms_in_highlight == other.replace_synonyms_in_highlight &&
           min_proximity == other.min_proximity &&
           response_fields == other.response_fields &&
-          max_facet_hits == other.max_facet_hits &&
           max_values_per_facet == other.max_values_per_facet &&
           sort_facet_values_by == other.sort_facet_values_by &&
           attribute_criteria_computed_by_min_proximity == other.attribute_criteria_computed_by_min_proximity &&
@@ -961,7 +948,6 @@ module Algolia
           replace_synonyms_in_highlight,
           min_proximity,
           response_fields,
-          max_facet_hits,
           max_values_per_facet,
           sort_facet_values_by,
           attribute_criteria_computed_by_min_proximity,

data/lib/algolia/models/search/search_params_object.rb

@@ -58,7 +58,6 @@ module Algolia
       # Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.
       attr_accessor :minimum_around_radius
 
-      # Coordinates for a rectangular area in which to search.  Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
       attr_accessor :inside_bounding_box
 
       # Coordinates of a polygon in which to search.  Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`.
@@ -174,7 +173,6 @@ module Algolia
       # Whether to support phrase matching and excluding words from search queries.  Use the `advancedSyntaxFeatures` parameter to control which feature is supported.
       attr_accessor :advanced_syntax
 
-      # Words that should be considered optional when found in the query.  By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher.  For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records:  - If `optionalWords` has less than 10 words, the required number of matched words increases by 1:   results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down).   For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.  For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
       attr_accessor :optional_words
 
       # Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). Attribute names are case-sensitive.  This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
@@ -199,9 +197,6 @@ module Algolia
       # Properties to include in the API response of `search` and `browse` requests.  By default, all response properties are included. To reduce the response size, you can select, which attributes should be included.  You can't exclude these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or any property triggered by the `getRankingInfo` parameter.  Don't exclude properties that you might need in your search UI.
       attr_accessor :response_fields
 
-      # Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
-      attr_accessor :max_facet_hits
-
       # Maximum number of facet values to return for each facet.
       attr_accessor :max_values_per_facet
 
@@ -290,7 +285,6 @@ module Algolia
           :replace_synonyms_in_highlight => :replaceSynonymsInHighlight,
           :min_proximity => :minProximity,
           :response_fields => :responseFields,
-          :max_facet_hits => :maxFacetHits,
           :max_values_per_facet => :maxValuesPerFacet,
           :sort_facet_values_by => :sortFacetValuesBy,
           :attribute_criteria_computed_by_min_proximity => :attributeCriteriaComputedByMinProximity,
@@ -327,7 +321,7 @@ module Algolia
           :around_radius => :"AroundRadius",
           :around_precision => :"AroundPrecision",
           :minimum_around_radius => :"Integer",
-          :inside_bounding_box => :"Array<Array<Float>>",
+          :inside_bounding_box => :"InsideBoundingBox",
           :inside_polygon => :"Array<Array<Float>>",
           :natural_languages => :"Array<SupportedLanguage>",
           :rule_contexts => :"Array<String>",
@@ -368,7 +362,7 @@ module Algolia
           :mode => :"Mode",
           :semantic_search => :"SemanticSearch",
           :advanced_syntax => :"Boolean",
-          :optional_words => :"Array<String>",
+          :optional_words => :"OptionalWords",
           :disable_exact_on_attributes => :"Array<String>",
           :exact_on_single_word_query => :"ExactOnSingleWordQuery",
           :alternatives_as_exact => :"Array<AlternativesAsExact>",
@@ -377,7 +371,6 @@ module Algolia
           :replace_synonyms_in_highlight => :"Boolean",
           :min_proximity => :"Integer",
           :response_fields => :"Array<String>",
-          :max_facet_hits => :"Integer",
           :max_values_per_facet => :"Integer",
           :sort_facet_values_by => :"String",
           :attribute_criteria_computed_by_min_proximity => :"Boolean",
@@ -390,7 +383,10 @@ module Algolia
       # List of attributes with nullable: true
       def self.openapi_nullable
         Set.new(
-          []
+          [
+            :inside_bounding_box,
+            :optional_words
+          ]
         )
       end
 
@@ -506,9 +502,7 @@ module Algolia
         end
 
         if attributes.key?(:inside_bounding_box)
-          if (value = attributes[:inside_bounding_box]).is_a?(Array)
-            self.inside_bounding_box = value
-          end
+          self.inside_bounding_box = attributes[:inside_bounding_box]
         end
 
         if attributes.key?(:inside_polygon)
@@ -694,9 +688,7 @@ module Algolia
         end
 
         if attributes.key?(:optional_words)
-          if (value = attributes[:optional_words]).is_a?(Array)
-            self.optional_words = value
-          end
+          self.optional_words = attributes[:optional_words]
         end
 
         if attributes.key?(:disable_exact_on_attributes)
@@ -739,10 +731,6 @@ module Algolia
           end
         end
 
-        if attributes.key?(:max_facet_hits)
-          self.max_facet_hits = attributes[:max_facet_hits]
-        end
-
         if attributes.key?(:max_values_per_facet)
           self.max_values_per_facet = attributes[:max_values_per_facet]
         end
@@ -842,7 +830,6 @@ module Algolia
           replace_synonyms_in_highlight == other.replace_synonyms_in_highlight &&
           min_proximity == other.min_proximity &&
           response_fields == other.response_fields &&
-          max_facet_hits == other.max_facet_hits &&
           max_values_per_facet == other.max_values_per_facet &&
           sort_facet_values_by == other.sort_facet_values_by &&
           attribute_criteria_computed_by_min_proximity == other.attribute_criteria_computed_by_min_proximity &&
@@ -930,7 +917,6 @@ module Algolia
           replace_synonyms_in_highlight,
           min_proximity,
           response_fields,
-          max_facet_hits,
           max_values_per_facet,
           sort_facet_values_by,
           attribute_criteria_computed_by_min_proximity,

data/lib/algolia/models/search/settings_response.rb

@@ -57,6 +57,9 @@ module Algolia
       # Attribute that should be used to establish groups of results. Attribute names are case-sensitive.  All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results.  If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting _after_ deduplication, which will result in accurate facet counts.
       attr_accessor :attribute_for_distinct
 
+      # Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+      attr_accessor :max_facet_hits
+
       # Attributes to include in the API response.  To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive.  - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
       attr_accessor :attributes_to_retrieve
 
@@ -134,7 +137,6 @@ module Algolia
       # Whether to support phrase matching and excluding words from search queries.  Use the `advancedSyntaxFeatures` parameter to control which feature is supported.
       attr_accessor :advanced_syntax
 
-      # Words that should be considered optional when found in the query.  By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher.  For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records:  - If `optionalWords` has less than 10 words, the required number of matched words increases by 1:   results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down).   For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.  For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
       attr_accessor :optional_words
 
       # Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). Attribute names are case-sensitive.  This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
@@ -159,9 +161,6 @@ module Algolia
       # Properties to include in the API response of `search` and `browse` requests.  By default, all response properties are included. To reduce the response size, you can select, which attributes should be included.  You can't exclude these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or any property triggered by the `getRankingInfo` parameter.  Don't exclude properties that you might need in your search UI.
       attr_accessor :response_fields
 
-      # Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
-      attr_accessor :max_facet_hits
-
       # Maximum number of facet values to return for each facet.
       attr_accessor :max_values_per_facet
 
@@ -201,6 +200,7 @@ module Algolia
           :user_data => :userData,
           :custom_normalization => :customNormalization,
           :attribute_for_distinct => :attributeForDistinct,
+          :max_facet_hits => :maxFacetHits,
           :attributes_to_retrieve => :attributesToRetrieve,
           :ranking => :ranking,
           :custom_ranking => :customRanking,
@@ -238,7 +238,6 @@ module Algolia
           :replace_synonyms_in_highlight => :replaceSynonymsInHighlight,
           :min_proximity => :minProximity,
           :response_fields => :responseFields,
-          :max_facet_hits => :maxFacetHits,
           :max_values_per_facet => :maxValuesPerFacet,
           :sort_facet_values_by => :sortFacetValuesBy,
           :attribute_criteria_computed_by_min_proximity => :attributeCriteriaComputedByMinProximity,
@@ -274,6 +273,7 @@ module Algolia
           :user_data => :"Object",
           :custom_normalization => :"Hash<String, Hash<String, String>>",
           :attribute_for_distinct => :"String",
+          :max_facet_hits => :"Integer",
           :attributes_to_retrieve => :"Array<String>",
           :ranking => :"Array<String>",
           :custom_ranking => :"Array<String>",
@@ -302,7 +302,7 @@ module Algolia
           :mode => :"Mode",
           :semantic_search => :"SemanticSearch",
           :advanced_syntax => :"Boolean",
-          :optional_words => :"Array<String>",
+          :optional_words => :"OptionalWords",
           :disable_exact_on_attributes => :"Array<String>",
           :exact_on_single_word_query => :"ExactOnSingleWordQuery",
           :alternatives_as_exact => :"Array<AlternativesAsExact>",
@@ -311,7 +311,6 @@ module Algolia
           :replace_synonyms_in_highlight => :"Boolean",
           :min_proximity => :"Integer",
           :response_fields => :"Array<String>",
-          :max_facet_hits => :"Integer",
           :max_values_per_facet => :"Integer",
           :sort_facet_values_by => :"String",
           :attribute_criteria_computed_by_min_proximity => :"Boolean",
@@ -325,7 +324,9 @@ module Algolia
       # List of attributes with nullable: true
       def self.openapi_nullable
         Set.new(
-          []
+          [
+            :optional_words
+          ]
         )
       end
 
@@ -450,6 +451,10 @@ module Algolia
           self.attribute_for_distinct = attributes[:attribute_for_distinct]
         end
 
+        if attributes.key?(:max_facet_hits)
+          self.max_facet_hits = attributes[:max_facet_hits]
+        end
+
         if attributes.key?(:attributes_to_retrieve)
           if (value = attributes[:attributes_to_retrieve]).is_a?(Array)
             self.attributes_to_retrieve = value
@@ -577,9 +582,7 @@ module Algolia
         end
 
         if attributes.key?(:optional_words)
-          if (value = attributes[:optional_words]).is_a?(Array)
-            self.optional_words = value
-          end
+          self.optional_words = attributes[:optional_words]
         end
 
         if attributes.key?(:disable_exact_on_attributes)
@@ -622,10 +625,6 @@ module Algolia
           end
         end
 
-        if attributes.key?(:max_facet_hits)
-          self.max_facet_hits = attributes[:max_facet_hits]
-        end
-
         if attributes.key?(:max_values_per_facet)
           self.max_values_per_facet = attributes[:max_values_per_facet]
         end
@@ -677,6 +676,7 @@ module Algolia
           user_data == other.user_data &&
           custom_normalization == other.custom_normalization &&
           attribute_for_distinct == other.attribute_for_distinct &&
+          max_facet_hits == other.max_facet_hits &&
           attributes_to_retrieve == other.attributes_to_retrieve &&
           ranking == other.ranking &&
           custom_ranking == other.custom_ranking &&
@@ -714,7 +714,6 @@ module Algolia
           replace_synonyms_in_highlight == other.replace_synonyms_in_highlight &&
           min_proximity == other.min_proximity &&
           response_fields == other.response_fields &&
-          max_facet_hits == other.max_facet_hits &&
           max_values_per_facet == other.max_values_per_facet &&
           sort_facet_values_by == other.sort_facet_values_by &&
           attribute_criteria_computed_by_min_proximity == other.attribute_criteria_computed_by_min_proximity &&
@@ -751,6 +750,7 @@ module Algolia
           user_data,
           custom_normalization,
           attribute_for_distinct,
+          max_facet_hits,
           attributes_to_retrieve,
           ranking,
           custom_ranking,
@@ -788,7 +788,6 @@ module Algolia
           replace_synonyms_in_highlight,
           min_proximity,
           response_fields,
-          max_facet_hits,
           max_values_per_facet,
           sort_facet_values_by,
           attribute_criteria_computed_by_min_proximity,

data/lib/algolia/version.rb

@@ -1,5 +1,5 @@
 # Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 module Algolia
-  VERSION = "3.8.0".freeze
+  VERSION = "3.8.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.8.0
+  version: 3.8.1
 platform: ruby
 authors:
 - https://alg.li/support
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-14 00:00:00.000000000 Z
+date: 2024-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -466,12 +466,14 @@ files:
 - lib/algolia/models/recommend/highlight_result_option.rb
 - lib/algolia/models/recommend/ignore_plurals.rb
 - lib/algolia/models/recommend/index_settings_facets.rb
+- lib/algolia/models/recommend/inside_bounding_box.rb
 - lib/algolia/models/recommend/looking_similar_model.rb
 - lib/algolia/models/recommend/looking_similar_query.rb
 - lib/algolia/models/recommend/match_level.rb
 - lib/algolia/models/recommend/matched_geo_location.rb
 - lib/algolia/models/recommend/numeric_filters.rb
 - lib/algolia/models/recommend/optional_filters.rb
+- lib/algolia/models/recommend/optional_words.rb
 - lib/algolia/models/recommend/params_consequence.rb
 - lib/algolia/models/recommend/personalization.rb
 - lib/algolia/models/recommend/promote_consequence_object.rb
@@ -487,8 +489,6 @@ files:
 - lib/algolia/models/recommend/recommendations_hit.rb
 - lib/algolia/models/recommend/recommendations_request.rb
 - lib/algolia/models/recommend/recommendations_results.rb
-- lib/algolia/models/recommend/recommended_for_you_model.rb
-- lib/algolia/models/recommend/recommended_for_you_query.rb
 - lib/algolia/models/recommend/redirect.rb
 - lib/algolia/models/recommend/redirect_rule_index_data.rb
 - lib/algolia/models/recommend/redirect_rule_index_metadata.rb
@@ -594,6 +594,7 @@ files:
 - lib/algolia/models/search/hit.rb
 - lib/algolia/models/search/ignore_plurals.rb
 - lib/algolia/models/search/index_settings.rb
+- lib/algolia/models/search/inside_bounding_box.rb
 - lib/algolia/models/search/languages.rb
 - lib/algolia/models/search/list_api_keys_response.rb
 - lib/algolia/models/search/list_clusters_response.rb
@@ -611,6 +612,7 @@ files:
 - lib/algolia/models/search/operation_index_params.rb
 - lib/algolia/models/search/operation_type.rb
 - lib/algolia/models/search/optional_filters.rb
+- lib/algolia/models/search/optional_words.rb
 - lib/algolia/models/search/personalization.rb
 - lib/algolia/models/search/promote.rb
 - lib/algolia/models/search/promote_object_id.rb

data/lib/algolia/models/recommend/recommended_for_you_model.rb

@@ -1,31 +0,0 @@
-# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-require "date"
-require "time"
-
-module Algolia
-  module Recommend
-    class RecommendedForYouModel
-      RECOMMENDED_FOR_YOU = "recommended-for-you".freeze
-
-      def self.all_vars
-        @all_vars ||= [RECOMMENDED_FOR_YOU].freeze
-      end
-
-      # Builds the enum from string
-      # @param [String] The enum value in the form of the string
-      # @return [String] The enum value
-      def self.build_from_hash(value)
-        new.build_from_hash(value)
-      end
-
-      # Builds the enum from string
-      # @param [String] The enum value in the form of the string
-      # @return [String] The enum value
-      def build_from_hash(value)
-        return value if RecommendedForYouModel.all_vars.include?(value)
-        raise "Invalid ENUM value #{value} for class #RecommendedForYouModel"
-      end
-    end
-  end
-end