algolia 3.0.0.alpha.15 → 3.0.0.alpha.17

data/lib/algolia/models/recommend/{recommendations_query.rb → related_query.rb}

@@ -5,23 +5,23 @@ require 'time'
 
 module Algolia
   module Recommend
-    class RecommendationsQuery
+    class RelatedQuery
       # Index name.
       attr_accessor :index_name
 
-      # Recommendations with a confidence score lower than `threshold` won't appear in results. > **Note**: Each recommendation has a confidence score of 0 to 100. The closer the score is to 100, the more relevant the recommendations are.
+      # Minimum score a recommendation must have to be included in the response.
       attr_accessor :threshold
 
-      # Maximum number of recommendations to retrieve. If 0, all recommendations will be returned.
+      # Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.
       attr_accessor :max_recommendations
 
+      attr_accessor :query_parameters
+
       attr_accessor :model
 
       # Unique record identifier.
       attr_accessor :object_id
 
-      attr_accessor :query_parameters
-
       attr_accessor :fallback_parameters
 
       class EnumAttributeValidator
@@ -52,9 +52,9 @@ module Algolia
           :index_name => :indexName,
           :threshold => :threshold,
           :max_recommendations => :maxRecommendations,
+          :query_parameters => :queryParameters,
           :model => :model,
           :object_id => :objectID,
-          :query_parameters => :queryParameters,
           :fallback_parameters => :fallbackParameters
         }
       end
@@ -68,12 +68,12 @@ module Algolia
       def self.types_mapping
         {
           :index_name => :String,
-          :threshold => :Integer,
+          :threshold => :Float,
           :max_recommendations => :Integer,
-          :model => :RecommendationModels,
+          :query_parameters => :SearchParams,
+          :model => :RelatedModel,
           :object_id => :String,
-          :query_parameters => :SearchParamsObject,
-          :fallback_parameters => :SearchParamsObject
+          :fallback_parameters => :FallbackParams
         }
       end
 
@@ -86,7 +86,7 @@ module Algolia
       def self.openapi_all_of
         [
           :BaseRecommendRequest,
-          :BaseRecommendationsQuery
+          :RelatedProducts
         ]
       end
 
@@ -94,14 +94,14 @@ module Algolia
       # @param [Hash] attributes Model attributes in the form of hash
       def initialize(attributes = {})
         unless attributes.is_a?(Hash)
-          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::RecommendationsQuery` initialize method"
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::RelatedQuery` initialize method"
         end
 
         # check to see if the attribute exists and convert string to symbol for hash key
         attributes = attributes.each_with_object({}) do |(k, v), h|
           unless self.class.attribute_map.key?(k.to_sym)
             raise ArgumentError,
-                  "`#{k}` is not a valid attribute in `Algolia::RecommendationsQuery`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+                  "`#{k}` is not a valid attribute in `Algolia::RelatedQuery`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
           end
 
           h[k.to_sym] = v
@@ -115,12 +115,18 @@ module Algolia
 
         if attributes.key?(:threshold)
           self.threshold = attributes[:threshold]
+        else
+          self.threshold = nil
         end
 
         if attributes.key?(:max_recommendations)
           self.max_recommendations = attributes[:max_recommendations]
         end
 
+        if attributes.key?(:query_parameters)
+          self.query_parameters = attributes[:query_parameters]
+        end
+
         if attributes.key?(:model)
           self.model = attributes[:model]
         else
@@ -133,10 +139,6 @@ module Algolia
           self.object_id = nil
         end
 
-        if attributes.key?(:query_parameters)
-          self.query_parameters = attributes[:query_parameters]
-        end
-
         if attributes.key?(:fallback_parameters)
           self.fallback_parameters = attributes[:fallback_parameters]
         end
@@ -160,6 +162,24 @@ module Algolia
         @threshold = threshold
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] max_recommendations Value to be assigned
+      def max_recommendations=(max_recommendations)
+        if max_recommendations.nil?
+          raise ArgumentError, 'max_recommendations cannot be nil'
+        end
+
+        if max_recommendations > 1000
+          raise ArgumentError, 'invalid value for "max_recommendations", must be smaller than or equal to 1000.'
+        end
+
+        if max_recommendations < 1
+          raise ArgumentError, 'invalid value for "max_recommendations", must be greater than or equal to 1.'
+        end
+
+        @max_recommendations = max_recommendations
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)
@@ -169,9 +189,9 @@ module Algolia
           index_name == other.index_name &&
           threshold == other.threshold &&
           max_recommendations == other.max_recommendations &&
+          query_parameters == other.query_parameters &&
           model == other.model &&
           object_id == other.object_id &&
-          query_parameters == other.query_parameters &&
           fallback_parameters == other.fallback_parameters
       end
 
@@ -184,7 +204,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [index_name, threshold, max_recommendations, model, object_id, query_parameters, fallback_parameters].hash
+        [index_name, threshold, max_recommendations, query_parameters, model, object_id, fallback_parameters].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/recommend/{consequence_params.rb → search_params.rb}

@@ -5,11 +5,14 @@ require 'time'
 
 module Algolia
   module Recommend
-    class ConsequenceParams
+    class SearchParams
+      # Search query.
+      attr_accessor :query
+
       # Keywords to be used instead of the search query to conduct a more broader search.  Using the `similarQuery` parameter changes other settings:  - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`.  Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results.
       attr_accessor :similar_query
 
-      # Filter the search so that only records with matching values are included in the results.  These filters are supported:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
+      # Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
       attr_accessor :filters
 
       attr_accessor :facet_filters
@@ -96,10 +99,10 @@ module Algolia
       # Attributes to include in the API response.  To reduce the size of your response, you can retrieve only some of the attributes.  - `*` 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
 
-      # Determines the order in which Algolia returns your results.  By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list.  **Modifiers**  <dl> <dt><code>asc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in ascending order.</dd> <dt><code>desc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in descending order.</dd> </dl>  Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
+      # Determines the order in which Algolia returns your results.  By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list.  **Modifiers**  - `asc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in descending order.  Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
       attr_accessor :ranking
 
-      # Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/).  The custom ranking attributes decide which items are shown first if the other ranking criteria are equal.  Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order.  **Modifiers**  <dl> <dt><code>asc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in ascending order.</dd> <dt><code>desc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in descending order.</dd> </dl>  If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
+      # Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/).  The custom ranking attributes decide which items are shown first if the other ranking criteria are equal.  Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order.  **Modifiers**  - `asc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in ascending order.  - `desc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in descending order.  If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
       attr_accessor :custom_ranking
 
       # Relevancy threshold below which less relevant results aren't included in the results.  You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
@@ -178,10 +181,10 @@ module Algolia
 
       attr_accessor :exact_on_single_word_query
 
-      # Alternatives of query words that should be considered as exact matches by the Exact ranking criterion.  <dl> <dt><code>ignorePlurals</code></dt> <dd>  Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches.  </dd> <dt><code>singleWordSynonym</code></dt> <dd> Single-word synonyms, such as \"NY/NYC\" are considered exact matches. </dd> <dt><code>multiWordsSynonym</code></dt> <dd> Multi-word synonyms, such as \"NY/New York\" are considered exact matches. </dd> </dl>.
+      # Alternatives of query words that should be considered as exact matches by the Exact ranking criterion.  - `ignorePlurals`.   Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches.  - `singleWordSynonym`.   Single-word synonyms, such as \"NY/NYC\" are considered exact matches.  - `multiWordsSynonym`.   Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
       attr_accessor :alternatives_as_exact
 
-      # Advanced search syntax features you want to support.  <dl> <dt><code>exactPhrase</code></dt> <dd>  Phrases in quotes must match exactly. For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\".  </dd> <dt><code>excludeWords</code></dt> <dd>  Query words prefixed with a `-` must not occur in a record. For example, `search -engine` matches records that contain \"search\" but not \"engine\".  </dd> </dl>  This setting only has an effect if `advancedSyntax` is true.
+      # Advanced search syntax features you want to support.  - `exactPhrase`.   Phrases in quotes must match exactly.   For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\".  - `excludeWords`.   Query words prefixed with a `-` must not occur in a record.   For example, `search -engine` matches records that contain \"search\" but not \"engine\".  This setting only has an effect if `advancedSyntax` is true.
       attr_accessor :advanced_syntax_features
 
       attr_accessor :distinct
@@ -201,7 +204,7 @@ module Algolia
       # Maximum number of facet values to return for each facet.
       attr_accessor :max_values_per_facet
 
-      # Order in which to retrieve facet values.  <dl> <dt><code>count</code></dt> <dd> Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value. </dd> <dt><code>alpha</code></dt> <dd>Retrieve facet values alphabetically.</dd> </dl>  This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
+      # Order in which to retrieve facet values.  - `count`.   Facet values are retrieved by decreasing count.   The count is the number of matching records containing this facet value.  - `alpha`.   Retrieve facet values alphabetically.  This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
       attr_accessor :sort_facet_values_by
 
       # Whether the best matching attribute should be determined by minimum proximity.  This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.
@@ -214,12 +217,6 @@ module Algolia
 
       attr_accessor :re_ranking_apply_filter
 
-      attr_accessor :query
-
-      attr_accessor :automatic_facet_filters
-
-      attr_accessor :automatic_optional_facet_filters
-
       class EnumAttributeValidator
         attr_reader :datatype
         attr_reader :allowable_values
@@ -245,6 +242,7 @@ module Algolia
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
+          :query => :query,
           :similar_query => :similarQuery,
           :filters => :filters,
           :facet_filters => :facetFilters,
@@ -319,10 +317,7 @@ module Algolia
           :attribute_criteria_computed_by_min_proximity => :attributeCriteriaComputedByMinProximity,
           :rendering_content => :renderingContent,
           :enable_re_ranking => :enableReRanking,
-          :re_ranking_apply_filter => :reRankingApplyFilter,
-          :query => :query,
-          :automatic_facet_filters => :automaticFacetFilters,
-          :automatic_optional_facet_filters => :automaticOptionalFacetFilters
+          :re_ranking_apply_filter => :reRankingApplyFilter
         }
       end
 
@@ -334,6 +329,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
+          :query => :String,
           :similar_query => :String,
           :filters => :String,
           :facet_filters => :FacetFilters,
@@ -408,10 +404,7 @@ module Algolia
           :attribute_criteria_computed_by_min_proximity => :Boolean,
           :rendering_content => :RenderingContent,
           :enable_re_ranking => :Boolean,
-          :re_ranking_apply_filter => :ReRankingApplyFilter,
-          :query => :ConsequenceQuery,
-          :automatic_facet_filters => :AutomaticFacetFilters,
-          :automatic_optional_facet_filters => :AutomaticFacetFilters
+          :re_ranking_apply_filter => :ReRankingApplyFilter
         }
       end
 
@@ -425,9 +418,7 @@ module Algolia
       # List of class defined in allOf (OpenAPI v3)
       def self.openapi_all_of
         [
-          :BaseSearchParamsWithoutQuery,
-          :IndexSettingsAsSearchParams,
-          :Params
+          :SearchParamsObject
         ]
       end
 
@@ -435,19 +426,23 @@ module Algolia
       # @param [Hash] attributes Model attributes in the form of hash
       def initialize(attributes = {})
         unless attributes.is_a?(Hash)
-          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::ConsequenceParams` initialize method"
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::SearchParams` initialize method"
         end
 
         # check to see if the attribute exists and convert string to symbol for hash key
         attributes = attributes.each_with_object({}) do |(k, v), h|
           unless self.class.attribute_map.key?(k.to_sym)
             raise ArgumentError,
-                  "`#{k}` is not a valid attribute in `Algolia::ConsequenceParams`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+                  "`#{k}` is not a valid attribute in `Algolia::SearchParams`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
           end
 
           h[k.to_sym] = v
         end
 
+        if attributes.key?(:query)
+          self.query = attributes[:query]
+        end
+
         if attributes.key?(:similar_query)
           self.similar_query = attributes[:similar_query]
         end
@@ -785,18 +780,6 @@ module Algolia
         if attributes.key?(:re_ranking_apply_filter)
           self.re_ranking_apply_filter = attributes[:re_ranking_apply_filter]
         end
-
-        if attributes.key?(:query)
-          self.query = attributes[:query]
-        end
-
-        if attributes.key?(:automatic_facet_filters)
-          self.automatic_facet_filters = attributes[:automatic_facet_filters]
-        end
-
-        if attributes.key?(:automatic_optional_facet_filters)
-          self.automatic_optional_facet_filters = attributes[:automatic_optional_facet_filters]
-        end
       end
 
       # Custom attribute writer method with validation
@@ -933,6 +916,7 @@ module Algolia
         return true if equal?(other)
 
         self.class == other.class &&
+          query == other.query &&
           similar_query == other.similar_query &&
           filters == other.filters &&
           facet_filters == other.facet_filters &&
@@ -1007,10 +991,7 @@ module Algolia
           attribute_criteria_computed_by_min_proximity == other.attribute_criteria_computed_by_min_proximity &&
           rendering_content == other.rendering_content &&
           enable_re_ranking == other.enable_re_ranking &&
-          re_ranking_apply_filter == other.re_ranking_apply_filter &&
-          query == other.query &&
-          automatic_facet_filters == other.automatic_facet_filters &&
-          automatic_optional_facet_filters == other.automatic_optional_facet_filters
+          re_ranking_apply_filter == other.re_ranking_apply_filter
       end
 
       # @see the `==` method
@@ -1022,8 +1003,8 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [similar_query, filters, facet_filters, optional_filters, numeric_filters, tag_filters, sum_or_filters_scores, restrict_searchable_attributes, facets,
-         faceting_after_distinct, page, offset, length, around_lat_lng, around_lat_lng_via_ip, around_radius, around_precision, minimum_around_radius, inside_bounding_box, inside_polygon, natural_languages, rule_contexts, personalization_impact, user_token, get_ranking_info, synonyms, click_analytics, analytics, analytics_tags, percentile_computation, enable_ab_test, attributes_to_retrieve, ranking, custom_ranking, relevancy_strictness, attributes_to_highlight, attributes_to_snippet, highlight_pre_tag, highlight_post_tag, snippet_ellipsis_text, restrict_highlight_and_snippet_arrays, hits_per_page, min_word_sizefor1_typo, min_word_sizefor2_typos, typo_tolerance, allow_typos_on_numeric_tokens, disable_typo_tolerance_on_attributes, ignore_plurals, remove_stop_words, keep_diacritics_on_characters, query_languages, decompound_query, enable_rules, enable_personalization, query_type, remove_words_if_no_results, mode, semantic_search, advanced_syntax, optional_words, disable_exact_on_attributes, exact_on_single_word_query, alternatives_as_exact, advanced_syntax_features, distinct, 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, rendering_content, enable_re_ranking, re_ranking_apply_filter, query, automatic_facet_filters, automatic_optional_facet_filters].hash
+        [query, similar_query, filters, facet_filters, optional_filters, numeric_filters, tag_filters, sum_or_filters_scores, restrict_searchable_attributes, facets,
+         faceting_after_distinct, page, offset, length, around_lat_lng, around_lat_lng_via_ip, around_radius, around_precision, minimum_around_radius, inside_bounding_box, inside_polygon, natural_languages, rule_contexts, personalization_impact, user_token, get_ranking_info, synonyms, click_analytics, analytics, analytics_tags, percentile_computation, enable_ab_test, attributes_to_retrieve, ranking, custom_ranking, relevancy_strictness, attributes_to_highlight, attributes_to_snippet, highlight_pre_tag, highlight_post_tag, snippet_ellipsis_text, restrict_highlight_and_snippet_arrays, hits_per_page, min_word_sizefor1_typo, min_word_sizefor2_typos, typo_tolerance, allow_typos_on_numeric_tokens, disable_typo_tolerance_on_attributes, ignore_plurals, remove_stop_words, keep_diacritics_on_characters, query_languages, decompound_query, enable_rules, enable_personalization, query_type, remove_words_if_no_results, mode, semantic_search, advanced_syntax, optional_words, disable_exact_on_attributes, exact_on_single_word_query, alternatives_as_exact, advanced_syntax_features, distinct, 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, rendering_content, enable_re_ranking, re_ranking_apply_filter].hash
       end
 
       # Builds the object from hash

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

@@ -12,7 +12,7 @@ module Algolia
       # Keywords to be used instead of the search query to conduct a more broader search.  Using the `similarQuery` parameter changes other settings:  - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`.  Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results.
       attr_accessor :similar_query
 
-      # Filter the search so that only records with matching values are included in the results.  These filters are supported:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
+      # Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
       attr_accessor :filters
 
       attr_accessor :facet_filters
@@ -99,10 +99,10 @@ module Algolia
       # Attributes to include in the API response.  To reduce the size of your response, you can retrieve only some of the attributes.  - `*` 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
 
-      # Determines the order in which Algolia returns your results.  By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list.  **Modifiers**  <dl> <dt><code>asc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in ascending order.</dd> <dt><code>desc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in descending order.</dd> </dl>  Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
+      # Determines the order in which Algolia returns your results.  By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list.  **Modifiers**  - `asc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in descending order.  Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
       attr_accessor :ranking
 
-      # Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/).  The custom ranking attributes decide which items are shown first if the other ranking criteria are equal.  Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order.  **Modifiers**  <dl> <dt><code>asc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in ascending order.</dd> <dt><code>desc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in descending order.</dd> </dl>  If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
+      # Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/).  The custom ranking attributes decide which items are shown first if the other ranking criteria are equal.  Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order.  **Modifiers**  - `asc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in ascending order.  - `desc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in descending order.  If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
       attr_accessor :custom_ranking
 
       # Relevancy threshold below which less relevant results aren't included in the results.  You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
@@ -181,10 +181,10 @@ module Algolia
 
       attr_accessor :exact_on_single_word_query
 
-      # Alternatives of query words that should be considered as exact matches by the Exact ranking criterion.  <dl> <dt><code>ignorePlurals</code></dt> <dd>  Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches.  </dd> <dt><code>singleWordSynonym</code></dt> <dd> Single-word synonyms, such as \"NY/NYC\" are considered exact matches. </dd> <dt><code>multiWordsSynonym</code></dt> <dd> Multi-word synonyms, such as \"NY/New York\" are considered exact matches. </dd> </dl>.
+      # Alternatives of query words that should be considered as exact matches by the Exact ranking criterion.  - `ignorePlurals`.   Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches.  - `singleWordSynonym`.   Single-word synonyms, such as \"NY/NYC\" are considered exact matches.  - `multiWordsSynonym`.   Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
       attr_accessor :alternatives_as_exact
 
-      # Advanced search syntax features you want to support.  <dl> <dt><code>exactPhrase</code></dt> <dd>  Phrases in quotes must match exactly. For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\".  </dd> <dt><code>excludeWords</code></dt> <dd>  Query words prefixed with a `-` must not occur in a record. For example, `search -engine` matches records that contain \"search\" but not \"engine\".  </dd> </dl>  This setting only has an effect if `advancedSyntax` is true.
+      # Advanced search syntax features you want to support.  - `exactPhrase`.   Phrases in quotes must match exactly.   For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\".  - `excludeWords`.   Query words prefixed with a `-` must not occur in a record.   For example, `search -engine` matches records that contain \"search\" but not \"engine\".  This setting only has an effect if `advancedSyntax` is true.
       attr_accessor :advanced_syntax_features
 
       attr_accessor :distinct
@@ -204,7 +204,7 @@ module Algolia
       # Maximum number of facet values to return for each facet.
       attr_accessor :max_values_per_facet
 
-      # Order in which to retrieve facet values.  <dl> <dt><code>count</code></dt> <dd> Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value. </dd> <dt><code>alpha</code></dt> <dd>Retrieve facet values alphabetically.</dd> </dl>  This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
+      # Order in which to retrieve facet values.  - `count`.   Facet values are retrieved by decreasing count.   The count is the number of matching records containing this facet value.  - `alpha`.   Retrieve facet values alphabetically.  This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
       attr_accessor :sort_facet_values_by
 
       # Whether the best matching attribute should be determined by minimum proximity.  This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.

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

@@ -5,12 +5,12 @@ require 'time'
 
 module Algolia
   module Recommend
-    # Recommend rules search parameters.
+    # Recommend rules parameters.
     class SearchRecommendRulesParams
       # Search query.
       attr_accessor :query
 
-      # Restricts responses to the specified [contextual rule](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#creating-contextual-rules).
+      # Only search for rules with matching context.
       attr_accessor :context
 
       # Requested page of the API response.
@@ -19,9 +19,18 @@ module Algolia
       # Maximum number of hits per page.
       attr_accessor :hits_per_page
 
-      # Restricts responses to enabled rules. When absent (default), _all_ rules are retrieved.
+      # Whether to only show rules where the value of their `enabled` property matches this parameter. If absent, show all rules, regardless of their `enabled` property.
       attr_accessor :enabled
 
+      # Filter expression. This only searches for rules matching the filter expression.
+      attr_accessor :filters
+
+      # Include facets and facet values in the response. Use `['*']` to include all facets.
+      attr_accessor :facets
+
+      # Maximum number of values to return for each facet.
+      attr_accessor :max_values_per_facet
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
@@ -29,7 +38,10 @@ module Algolia
           :context => :context,
           :page => :page,
           :hits_per_page => :hitsPerPage,
-          :enabled => :enabled
+          :enabled => :enabled,
+          :filters => :filters,
+          :facets => :facets,
+          :max_values_per_facet => :maxValuesPerFacet
         }
       end
 
@@ -45,15 +57,16 @@ module Algolia
           :context => :String,
           :page => :Integer,
           :hits_per_page => :Integer,
-          :enabled => :Boolean
+          :enabled => :Boolean,
+          :filters => :String,
+          :facets => :'Array<String>',
+          :max_values_per_facet => :Integer
         }
       end
 
       # List of attributes with nullable: true
       def self.openapi_nullable
-        Set.new([
-                  :enabled
-                ])
+        Set.new([])
       end
 
       # Initializes the object
@@ -92,6 +105,20 @@ module Algolia
         if attributes.key?(:enabled)
           self.enabled = attributes[:enabled]
         end
+
+        if attributes.key?(:filters)
+          self.filters = attributes[:filters]
+        end
+
+        if attributes.key?(:facets)
+          if (value = attributes[:facets]).is_a?(Array)
+            self.facets = value
+          end
+        end
+
+        if attributes.key?(:max_values_per_facet)
+          self.max_values_per_facet = attributes[:max_values_per_facet]
+        end
       end
 
       # Custom attribute writer method with validation
@@ -126,6 +153,24 @@ module Algolia
         @hits_per_page = hits_per_page
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] max_values_per_facet Value to be assigned
+      def max_values_per_facet=(max_values_per_facet)
+        if max_values_per_facet.nil?
+          raise ArgumentError, 'max_values_per_facet cannot be nil'
+        end
+
+        if max_values_per_facet > 1000
+          raise ArgumentError, 'invalid value for "max_values_per_facet", must be smaller than or equal to 1000.'
+        end
+
+        if max_values_per_facet < 1
+          raise ArgumentError, 'invalid value for "max_values_per_facet", must be greater than or equal to 1.'
+        end
+
+        @max_values_per_facet = max_values_per_facet
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)
@@ -136,7 +181,10 @@ module Algolia
           context == other.context &&
           page == other.page &&
           hits_per_page == other.hits_per_page &&
-          enabled == other.enabled
+          enabled == other.enabled &&
+          filters == other.filters &&
+          facets == other.facets &&
+          max_values_per_facet == other.max_values_per_facet
       end
 
       # @see the `==` method
@@ -148,7 +196,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [query, context, page, hits_per_page, enabled].hash
+        [query, context, page, hits_per_page, enabled, filters, facets, max_values_per_facet].hash
       end
 
       # Builds the object from hash

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Recommend
     class SearchRecommendRulesResponse
-      # Fetched rules.
+      # Recommend rules that match the search criteria.
       attr_accessor :hits
 
       # Number of results (hits).
@@ -36,7 +36,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :hits => :'Array<RuleResponse>',
+          :hits => :'Array<RecommendRule>',
           :nb_hits => :Integer,
           :page => :Integer,
           :nb_pages => :Integer

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

@@ -10,10 +10,10 @@ module Algolia
       # Recommendation score.
       attr_accessor :_score
 
-      # Facet name for trending models.
+      # Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
       attr_accessor :facet_name
 
-      # Facet value for trending models.
+      # Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
       attr_accessor :facet_value
 
       # Attribute mapping from ruby-style variable name to JSON key.