algolia 3.0.0.alpha.12 → 3.0.0.alpha.13

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

@@ -6,73 +6,70 @@ require 'time'
 module Algolia
   module Recommend
     class IndexSettingsAsSearchParams
-      # Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/) and the [modifiers](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers) that can be applied: `filterOnly`, `searchable`, and `afterDistinct`.
-      attr_accessor :attributes_for_faceting
-
-      # Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. By default, the response includes all attributes.
+      # 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](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/).
+      # 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/).
       attr_accessor :ranking
 
-      # Specifies the [Custom ranking criterion](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Use the `asc` and `desc` modifiers to specify the ranking order: ascending or descending.
+      # 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.
       attr_accessor :custom_ranking
 
-      # Relevancy threshold below which less relevant results aren't included in the results.
+      # 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.
       attr_accessor :relevancy_strictness
 
-      # Attributes to highlight. Strings that match the search query in the attributes are highlighted by surrounding them with HTML tags (`highlightPreTag` and `highlightPostTag`).
+      # Attributes to highlight.  By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting.  With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI.  For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).
       attr_accessor :attributes_to_highlight
 
-      # Attributes to _snippet_. 'Snippeting' is shortening the attribute to a certain number of words. If not specified, the attribute is shortened to the 10 words around the matching string but you can specify the number. For example: `body:20`.
+      # Attributes for which to enable snippets.  Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted.
       attr_accessor :attributes_to_snippet
 
-      # HTML string to insert before the highlighted parts in all highlight and snippet results.
+      # HTML tag to insert before the highlighted parts in all highlighted results and snippets.
       attr_accessor :highlight_pre_tag
 
-      # HTML string to insert after the highlighted parts in all highlight and snippet results.
+      # HTML tag to insert after the highlighted parts in all highlighted results and snippets.
       attr_accessor :highlight_post_tag
 
       # String used as an ellipsis indicator when a snippet is truncated.
       attr_accessor :snippet_ellipsis_text
 
-      # Restrict highlighting and snippeting to items that matched the query.
+      # Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted.
       attr_accessor :restrict_highlight_and_snippet_arrays
 
       # Number of hits per page.
       attr_accessor :hits_per_page
 
-      # Minimum number of characters a word in the query string must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
+      # Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
       attr_accessor :min_word_sizefor1_typo
 
-      # Minimum number of characters a word in the query string must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
+      # Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
       attr_accessor :min_word_sizefor2_typos
 
       attr_accessor :typo_tolerance
 
-      # Whether to allow typos on numbers (\"numeric tokens\") in the query string.
+      # Whether to allow typos on numbers in the search query.  Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers.
       attr_accessor :allow_typos_on_numeric_tokens
 
-      # Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).
+      # Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).  Returning only exact matches can help when:  - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/). - Reducing the number of matches when you have too many.   This can happen with attributes that are long blocks of text, such as product descriptions.  Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
       attr_accessor :disable_typo_tolerance_on_attributes
 
       attr_accessor :ignore_plurals
 
       attr_accessor :remove_stop_words
 
-      # Characters that the engine shouldn't automatically [normalize](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
+      # Characters for which diacritics should be preserved.  By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics.
       attr_accessor :keep_diacritics_on_characters
 
-      # Sets your user's search language. This adjusts language-specific settings and features such as `ignorePlurals`, `removeStopWords`, and [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) word detection.
+      # [ISO code](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) for language-specific settings such as plurals, stop words, and word-detection dictionaries.  This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**.   **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
       attr_accessor :query_languages
 
-      # [Splits compound words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words) into their component word parts in the query.
+      # Whether to split compound words into their building blocks.  For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian.
       attr_accessor :decompound_query
 
-      # Incidates whether [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/) are enabled.
+      # Whether to enable rules.
       attr_accessor :enable_rules
 
-      # Incidates whether [Personalization](https://www.algolia.com/doc/guides/personalization/what-is-personalization/) is enabled.
+      # Whether to enable Personalization.
       attr_accessor :enable_personalization
 
       attr_accessor :query_type
@@ -83,49 +80,49 @@ module Algolia
 
       attr_accessor :semantic_search
 
-      # Enables the [advanced query syntax](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#advanced-syntax).
+      # 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 which should be considered [optional](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words) when found in a query.
+      # 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 dividied 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
 
-      # 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).
+      # 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).  This can be useful for attributes with long values, where the likelyhood 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.
       attr_accessor :disable_exact_on_attributes
 
       attr_accessor :exact_on_single_word_query
 
-      # Alternatives that should be considered an exact match by [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).
+      # 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>.
       attr_accessor :alternatives_as_exact
 
-      # Allows you to specify which advanced syntax features are active when `advancedSyntax` is enabled.
+      # 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.
       attr_accessor :advanced_syntax_features
 
       attr_accessor :distinct
 
-      # Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
+      # Whether to replace a highlighted word with the matched synonym.  By default, the original words are highlighted even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records matching either \"home\" or \"house\" are included in the search results, and either \"home\" or \"house\" are highlighted.  With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all occurences of \"house\" are replaced by \"home\" in the highlighted response.
       attr_accessor :replace_synonyms_in_highlight
 
-      # Precision of the [proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity).
+      # Minimum proximity score for two matching words.  This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) by equally scoring matches that are farther apart.  For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score.
       attr_accessor :min_proximity
 
-      # Attributes to include in the API response for search and browse queries.
+      # 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 hits to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+      # 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
 
-      # Controls how facet values are fetched.
+      # 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/).
       attr_accessor :sort_facet_values_by
 
-      # When the [Attribute criterion is ranked above Proximity](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute-and-proximity-combinations) in your ranking formula, Proximity is used to select which searchable attribute is matched in the Attribute ranking stage.
+      # 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.
       attr_accessor :attribute_criteria_computed_by_min_proximity
 
       attr_accessor :rendering_content
 
-      # Indicates whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).
+      # Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).  This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
       attr_accessor :enable_re_ranking
 
       attr_accessor :re_ranking_apply_filter
@@ -155,7 +152,6 @@ module Algolia
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :attributes_for_faceting => :attributesForFaceting,
           :attributes_to_retrieve => :attributesToRetrieve,
           :ranking => :ranking,
           :custom_ranking => :customRanking,
@@ -211,7 +207,6 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :attributes_for_faceting => :'Array<String>',
           :attributes_to_retrieve => :'Array<String>',
           :ranking => :'Array<String>',
           :custom_ranking => :'Array<String>',
@@ -283,12 +278,6 @@ module Algolia
           h[k.to_sym] = v
         end
 
-        if attributes.key?(:attributes_for_faceting)
-          if (value = attributes[:attributes_for_faceting]).is_a?(Array)
-            self.attributes_for_faceting = value
-          end
-        end
-
         if attributes.key?(:attributes_to_retrieve)
           if (value = attributes[:attributes_to_retrieve]).is_a?(Array)
             self.attributes_to_retrieve = value
@@ -540,13 +529,26 @@ module Algolia
         @max_facet_hits = max_facet_hits
       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
+
+        @max_values_per_facet = max_values_per_facet
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)
         return true if equal?(other)
 
         self.class == other.class &&
-          attributes_for_faceting == other.attributes_for_faceting &&
           attributes_to_retrieve == other.attributes_to_retrieve &&
           ranking == other.ranking &&
           custom_ranking == other.custom_ranking &&
@@ -602,8 +604,8 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [attributes_for_faceting, 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
+        [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/numeric_filters.rb

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Recommend
-    # [Filter on numeric attributes](https://www.algolia.com/doc/api-reference/api-parameters/numericFilters/).
+    # Filter by numeric facets.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparsions are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.
     module NumericFilters
       class << self
         # List of class defined in oneOf (OpenAPI v3)

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

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Recommend
-    # Create filters to boost or demote records.   Records that match the filter are ranked higher for positive and lower for negative optional filters. In contrast to regular filters, records that don't match the optional filter are still included in the results, only their ranking is affected.
+    # Filters to promote or demote records in the search results.  Optional filters work like facet 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.
     module OptionalFilters
       class << self
         # List of class defined in oneOf (OpenAPI v3)

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

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Recommend
-    # Additional search parameters.
+    # Parameters to apply to this search.  You can use all search parameters, plus special `automaticFacetFilters`, `automaticOptionalFacetFilters`, and `query`.
     class Params
       attr_accessor :query
 

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

@@ -7,10 +7,10 @@ module Algolia
   module Recommend
     # Record to promote.
     class PromoteObjectID
-      # Unique identifier of the record to promote.
+      # Unique record identifier.
       attr_accessor :object_id
 
-      # The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
+      # Position in the search results where you want to show the promoted records.
       attr_accessor :position
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -7,10 +7,10 @@ module Algolia
   module Recommend
     # Records to promote.
     class PromoteObjectIDs
-      # Unique identifiers of the records to promote.
+      # Object IDs of the records you want to promote.  The records are placed as a group at the `position`. For example, if you want to promote four records to position `0`, they will be the first four search results.
       attr_accessor :object_ids
 
-      # The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
+      # Position in the search results where you want to show the promoted records.
       attr_accessor :position
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -71,6 +71,20 @@ module Algolia
         end
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] object_ids Value to be assigned
+      def object_ids=(object_ids)
+        if object_ids.nil?
+          raise ArgumentError, 'object_ids cannot be nil'
+        end
+
+        if object_ids.length > 100
+          raise ArgumentError, 'invalid value for "object_ids", number of items must be less than or equal to 100.'
+        end
+
+        @object_ids = object_ids
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)

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

@@ -5,11 +5,12 @@ require 'time'
 
 module Algolia
   module Recommend
+    # Object with detailed information about the record's ranking.
     class RankingInfo
-      # This field is reserved for advanced usage.
+      # Whether a filter matched the query.
       attr_accessor :filters
 
-      # Position of the most important matched attribute in the attributes to index list.
+      # Position of the first matched word in the best matching attribute of the record.
       attr_accessor :first_matched_word
 
       # Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
@@ -28,19 +29,19 @@ module Algolia
       # Number of typos encountered when matching the record.
       attr_accessor :nb_typos
 
-      # Present and set to true if a Rule promoted the hit.
+      # Whether the record was promoted by a rule.
       attr_accessor :promoted
 
-      # When the query contains more than one word, the sum of the distances between matched words (in meters).
+      # Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
       attr_accessor :proximity_distance
 
-      # Custom ranking for the object, expressed as a single integer value.
+      # Overall ranking of the record, expressed as a single integer. This attribute is internal.
       attr_accessor :user_score
 
-      # Number of matched words, including prefixes and typos.
+      # Number of matched words.
       attr_accessor :words
 
-      # Wether the record are promoted by the re-ranking strategy.
+      # Whether the record is re-ranked.
       attr_accessor :promoted_by_re_ranking
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -177,6 +178,118 @@ module Algolia
         end
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] filters Value to be assigned
+      def filters=(filters)
+        if filters.nil?
+          raise ArgumentError, 'filters cannot be nil'
+        end
+
+        if filters < 0
+          raise ArgumentError, 'invalid value for "filters", must be greater than or equal to 0.'
+        end
+
+        @filters = filters
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] first_matched_word Value to be assigned
+      def first_matched_word=(first_matched_word)
+        if first_matched_word.nil?
+          raise ArgumentError, 'first_matched_word cannot be nil'
+        end
+
+        if first_matched_word < 0
+          raise ArgumentError, 'invalid value for "first_matched_word", must be greater than or equal to 0.'
+        end
+
+        @first_matched_word = first_matched_word
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] geo_distance Value to be assigned
+      def geo_distance=(geo_distance)
+        if geo_distance.nil?
+          raise ArgumentError, 'geo_distance cannot be nil'
+        end
+
+        if geo_distance < 0
+          raise ArgumentError, 'invalid value for "geo_distance", must be greater than or equal to 0.'
+        end
+
+        @geo_distance = geo_distance
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] geo_precision Value to be assigned
+      def geo_precision=(geo_precision)
+        if geo_precision.nil?
+          raise ArgumentError, 'geo_precision cannot be nil'
+        end
+
+        if geo_precision < 1
+          raise ArgumentError, 'invalid value for "geo_precision", must be greater than or equal to 1.'
+        end
+
+        @geo_precision = geo_precision
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] nb_exact_words Value to be assigned
+      def nb_exact_words=(nb_exact_words)
+        if nb_exact_words.nil?
+          raise ArgumentError, 'nb_exact_words cannot be nil'
+        end
+
+        if nb_exact_words < 0
+          raise ArgumentError, 'invalid value for "nb_exact_words", must be greater than or equal to 0.'
+        end
+
+        @nb_exact_words = nb_exact_words
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] nb_typos Value to be assigned
+      def nb_typos=(nb_typos)
+        if nb_typos.nil?
+          raise ArgumentError, 'nb_typos cannot be nil'
+        end
+
+        if nb_typos < 0
+          raise ArgumentError, 'invalid value for "nb_typos", must be greater than or equal to 0.'
+        end
+
+        @nb_typos = nb_typos
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] proximity_distance Value to be assigned
+      def proximity_distance=(proximity_distance)
+        if proximity_distance.nil?
+          raise ArgumentError, 'proximity_distance cannot be nil'
+        end
+
+        if proximity_distance < 0
+          raise ArgumentError, 'invalid value for "proximity_distance", must be greater than or equal to 0.'
+        end
+
+        @proximity_distance = proximity_distance
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] words Value to be assigned
+      def words=(words)
+        if words.nil?
+          raise ArgumentError, 'words cannot be nil'
+        end
+
+        if words < 1
+          raise ArgumentError, 'invalid value for "words", must be greater than or equal to 1.'
+        end
+
+        @words = words
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)

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

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Recommend
-    # When [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) is enabled, only records that match these filters will be affected by Dynamic Re-Ranking.
+    # Restrict [Dynamic Re-ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
     module ReRankingApplyFilter
       class << self
         # List of class defined in oneOf (OpenAPI v3)

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

@@ -7,13 +7,13 @@ module Algolia
   module Recommend
     # Recommend hit.
     class RecommendHit
-      # Unique object identifier.
+      # Unique record identifier.
       attr_accessor :object_id
 
-      # Show highlighted section and words matched on a query.
+      # Surround words that match the query with HTML tags for highlighting.
       attr_accessor :_highlight_result
 
-      # Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+      # Snippets that show the context around a matching search query.
       attr_accessor :_snippet_result
 
       attr_accessor :_ranking_info

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

@@ -8,7 +8,7 @@ module Algolia
     class RecommendationsHits
       attr_accessor :hits
 
-      # Text to search for in an index.
+      # Search query.
       attr_accessor :query
 
       # URL-encoded string of all search parameters.

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Recommend
     class RecommendationsQuery
-      # Algolia index name.
+      # 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.
@@ -17,7 +17,7 @@ module Algolia
 
       attr_accessor :model
 
-      # Unique object identifier.
+      # Unique record identifier.
       attr_accessor :object_id
 
       attr_accessor :query_parameters

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

@@ -15,7 +15,7 @@ module Algolia
       # Computed geographical location.
       attr_accessor :around_lat_lng
 
-      # Automatically-computed radius.
+      # Distance from a central coordinate provided by `aroundLatLng`.
       attr_accessor :automatic_radius
 
       attr_accessor :exhaustive
@@ -29,7 +29,7 @@ module Algolia
       # See the `typo` field of the `exhaustive` object in the response.
       attr_accessor :exhaustive_typo
 
-      # Mapping of each facet name to the corresponding facet counts.
+      # Facet counts.
       attr_accessor :facets
 
       # Statistics for numerical facets.
@@ -47,16 +47,16 @@ module Algolia
       # Warnings about the query.
       attr_accessor :message
 
-      # Number of hits the search query matched.
+      # Number of results (hits).
       attr_accessor :nb_hits
 
-      # Number of pages of results for the current query.
+      # Number of pages of results.
       attr_accessor :nb_pages
 
       # Number of hits selected and sorted by the relevant sort algorithm.
       attr_accessor :nb_sorted_hits
 
-      # Page to retrieve (the first page is `0`, not `1`).
+      # Page of search results to retrieve.
       attr_accessor :page
 
       # Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
@@ -81,7 +81,7 @@ module Algolia
       # Host name of the server that processed the request.
       attr_accessor :server_used
 
-      # Lets you store custom data in your indices.
+      # An object with custom data.  You can store up to 32 kB as custom data.
       attr_accessor :user_data
 
       # Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
@@ -89,7 +89,7 @@ module Algolia
 
       attr_accessor :hits
 
-      # Text to search for in an index.
+      # Search query.
       attr_accessor :query
 
       # URL-encoded string of all search parameters.
@@ -394,6 +394,20 @@ module Algolia
         @hits_per_page = hits_per_page
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] page Value to be assigned
+      def page=(page)
+        if page.nil?
+          raise ArgumentError, 'page cannot be nil'
+        end
+
+        if page < 0
+          raise ArgumentError, 'invalid value for "page", must be greater than or equal to 0.'
+        end
+
+        @page = page
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Recommend
     class RecommendedForYouQuery
-      # Algolia index name.
+      # 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.