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

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

@@ -6,13 +6,13 @@ require 'time'
 module Algolia
   module Search
     class SearchParamsObject
-      # Text to search for in an index.
+      # Search query.
       attr_accessor :query
 
-      # Overrides the query parameter and performs a more generic search.
+      # 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](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) the query with numeric, facet, or tag filters.
+      # 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/).
       attr_accessor :filters
 
       attr_accessor :facet_filters
@@ -23,149 +23,143 @@ module Algolia
 
       attr_accessor :tag_filters
 
-      # Determines how to calculate [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores). If `false`, maximum score is kept. If `true`, score is summed.
+      # Whether to sum all filter scores.  If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
       attr_accessor :sum_or_filters_scores
 
-      # Restricts a query to only look at a subset of your [searchable attributes](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/).
+      # Restricts a search to a subset of your searchable attributes.
       attr_accessor :restrict_searchable_attributes
 
-      # Returns [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts), their facet values, and the number of matching facet values.
+      # Facets for which to retrieve facet values that match the search criteria and the number of matching facet values.  To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
       attr_accessor :facets
 
-      # Forces faceting to be applied after [de-duplication](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/) (with the distinct feature). Alternatively, the `afterDistinct` [modifier](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers) of `attributesForFaceting` allows for more granular control.
+      # Whether faceting should be applied after deduplication with `distinct`.  This leads to accurate facet counts when using faceting in combination with `distinct`. It's usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.
       attr_accessor :faceting_after_distinct
 
-      # Page to retrieve (the first page is `0`, not `1`).
+      # Page of search results to retrieve.
       attr_accessor :page
 
-      # Specifies the offset of the first hit to return. > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).
+      # Position of the first hit to retrieve.
       attr_accessor :offset
 
-      # Sets the number of hits to retrieve (for use with `offset`). > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).
+      # Number of hits to retrieve (used in combination with `offset`).
       attr_accessor :length
 
-      # Search for entries [around a central location](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filter-around-a-central-point), enabling a geographical search within a circular area.
+      # Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.  Only records included within circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
       attr_accessor :around_lat_lng
 
-      # Search for entries around a location. The location is automatically computed from the requester's IP address.
+      # Whether to obtain the coordinates from the request's IP address.
       attr_accessor :around_lat_lng_via_ip
 
       attr_accessor :around_radius
 
       attr_accessor :around_precision
 
-      # Minimum radius (in meters) used for a geographical search when `aroundRadius` isn't set.
+      # Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.
       attr_accessor :minimum_around_radius
 
-      # Search inside a [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
+      # 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
 
-      # Search inside a [polygon](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
+      # 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`.
       attr_accessor :inside_polygon
 
-      # Changes the default values of parameters that work best for a natural language query, such as `ignorePlurals`, `removeStopWords`, `removeWordsIfNoResults`, `analyticsTags`, and `ruleContexts`. These parameters work well together when the query consists of fuller natural language strings instead of keywords, for example when processing voice search queries.
+      # ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches):  - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
       attr_accessor :natural_languages
 
-      # Assigns [rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) to search queries.
+      # Assigns a rule context to the search query.  [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
       attr_accessor :rule_contexts
 
-      # Defines how much [Personalization affects results](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
+      # Impact that Personalization should have on this search.  The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
       attr_accessor :personalization_impact
 
-      # Associates a [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) with the current search.
+      # Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :user_token
 
-      # Incidates whether the search response includes [detailed ranking information](https://www.algolia.com/doc/guides/building-search-ui/going-further/backend-search/in-depth/understanding-the-api-response/#ranking-information).
+      # Whether the search response should include detailed ranking information.
       attr_accessor :get_ranking_info
 
-      # Enriches the API's response with information about how the query was processed.
-      attr_accessor :explain
-
-      # Whether to take into account an index's synonyms for a particular search.
+      # Whether to take into account an index's synonyms for this search.
       attr_accessor :synonyms
 
-      # Indicates whether a query ID parameter is included in the search response. This is required for [tracking click and conversion events](https://www.algolia.com/doc/guides/sending-events/concepts/event-types/#events-related-to-algolia-requests).
+      # Whether to include a `queryID` attribute in the response.  The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
       attr_accessor :click_analytics
 
-      # Indicates whether this query will be included in [analytics](https://www.algolia.com/doc/guides/search-analytics/guides/exclude-queries/).
+      # Whether this search will be included in Analytics.
       attr_accessor :analytics
 
       # Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
       attr_accessor :analytics_tags
 
-      # Whether to include or exclude a query from the processing-time percentile computation.
+      # Whether to include this search when calculating processing-time percentiles.
       attr_accessor :percentile_computation
 
-      # Incidates whether this search will be considered in A/B testing.
+      # Whether to enable A/B testing for this search.
       attr_accessor :enable_ab_test
 
-      # 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
@@ -176,49 +170,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
@@ -274,14 +268,12 @@ module Algolia
           :personalization_impact => :personalizationImpact,
           :user_token => :userToken,
           :get_ranking_info => :getRankingInfo,
-          :explain => :explain,
           :synonyms => :synonyms,
           :click_analytics => :clickAnalytics,
           :analytics => :analytics,
           :analytics_tags => :analyticsTags,
           :percentile_computation => :percentileComputation,
           :enable_ab_test => :enableABTest,
-          :attributes_for_faceting => :attributesForFaceting,
           :attributes_to_retrieve => :attributesToRetrieve,
           :ranking => :ranking,
           :custom_ranking => :customRanking,
@@ -363,14 +355,12 @@ module Algolia
           :personalization_impact => :Integer,
           :user_token => :String,
           :get_ranking_info => :Boolean,
-          :explain => :'Array<String>',
           :synonyms => :Boolean,
           :click_analytics => :Boolean,
           :analytics => :Boolean,
           :analytics_tags => :'Array<String>',
           :percentile_computation => :Boolean,
           :enable_ab_test => :Boolean,
-          :attributes_for_faceting => :'Array<String>',
           :attributes_to_retrieve => :'Array<String>',
           :ranking => :'Array<String>',
           :custom_ranking => :'Array<String>',
@@ -566,12 +556,6 @@ module Algolia
           self.get_ranking_info = attributes[:get_ranking_info]
         end
 
-        if attributes.key?(:explain)
-          if (value = attributes[:explain]).is_a?(Array)
-            self.explain = value
-          end
-        end
-
         if attributes.key?(:synonyms)
           self.synonyms = attributes[:synonyms]
         end
@@ -598,12 +582,6 @@ module Algolia
           self.enable_ab_test = attributes[:enable_ab_test]
         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
@@ -805,6 +783,20 @@ module Algolia
         end
       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
+
       # Custom attribute writer method with validation
       # @param [Object] length Value to be assigned
       def length=(length)
@@ -837,6 +829,24 @@ module Algolia
         @minimum_around_radius = minimum_around_radius
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] personalization_impact Value to be assigned
+      def personalization_impact=(personalization_impact)
+        if personalization_impact.nil?
+          raise ArgumentError, 'personalization_impact cannot be nil'
+        end
+
+        if personalization_impact > 100
+          raise ArgumentError, 'invalid value for "personalization_impact", must be smaller than or equal to 100.'
+        end
+
+        if personalization_impact < 0
+          raise ArgumentError, 'invalid value for "personalization_impact", must be greater than or equal to 0.'
+        end
+
+        @personalization_impact = personalization_impact
+      end
+
       # Custom attribute writer method with validation
       # @param [Object] hits_per_page Value to be assigned
       def hits_per_page=(hits_per_page)
@@ -887,6 +897,20 @@ 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)
@@ -919,14 +943,12 @@ module Algolia
           personalization_impact == other.personalization_impact &&
           user_token == other.user_token &&
           get_ranking_info == other.get_ranking_info &&
-          explain == other.explain &&
           synonyms == other.synonyms &&
           click_analytics == other.click_analytics &&
           analytics == other.analytics &&
           analytics_tags == other.analytics_tags &&
           percentile_computation == other.percentile_computation &&
           enable_ab_test == other.enable_ab_test &&
-          attributes_for_faceting == other.attributes_for_faceting &&
           attributes_to_retrieve == other.attributes_to_retrieve &&
           ranking == other.ranking &&
           custom_ranking == other.custom_ranking &&
@@ -983,7 +1005,7 @@ module Algolia
       # @return [Integer] Hash code
       def 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, explain, synonyms, click_analytics, analytics, analytics_tags, percentile_computation, enable_ab_test, 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
+         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/search/search_params_query.rb

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Search
     class SearchParamsQuery
-      # Text to search for in an index.
+      # Search query.
       attr_accessor :query
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/search/search_response.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,15 +81,16 @@ 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/).
       attr_accessor :query_id
 
+      # Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
       attr_accessor :hits
 
-      # Text to search for in an index.
+      # Search query.
       attr_accessor :query
 
       # URL-encoded string of all search parameters.
@@ -394,6 +395,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/search/search_rules_params.rb

@@ -7,26 +7,23 @@ module Algolia
   module Search
     # Rules search parameters.
     class SearchRulesParams
-      # Rule object query.
+      # Search query for rules.
       attr_accessor :query
 
       attr_accessor :anchoring
 
-      # 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 return rules that match the context (exact match).
       attr_accessor :context
 
-      # Requested page (the first page is page 0).
+      # Requested page of the API response.
       attr_accessor :page
 
       # Maximum number of hits per page.
       attr_accessor :hits_per_page
 
-      # Restricts responses to enabled rules. When not specified (default), _all_ rules are retrieved.
+      # If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned.
       attr_accessor :enabled
 
-      # Request options to send with the API call.
-      attr_accessor :request_options
-
       class EnumAttributeValidator
         attr_reader :datatype
         attr_reader :allowable_values
@@ -57,8 +54,7 @@ module Algolia
           :context => :context,
           :page => :page,
           :hits_per_page => :hitsPerPage,
-          :enabled => :enabled,
-          :request_options => :requestOptions
+          :enabled => :enabled
         }
       end
 
@@ -75,8 +71,7 @@ module Algolia
           :context => :String,
           :page => :Integer,
           :hits_per_page => :Integer,
-          :enabled => :Boolean,
-          :request_options => :'Array<Object>'
+          :enabled => :Boolean
         }
       end
 
@@ -127,12 +122,6 @@ module Algolia
         if attributes.key?(:enabled)
           self.enabled = attributes[:enabled]
         end
-
-        if attributes.key?(:request_options)
-          if (value = attributes[:request_options]).is_a?(Array)
-            self.request_options = value
-          end
-        end
       end
 
       # Custom attribute writer method with validation
@@ -178,8 +167,7 @@ module Algolia
           context == other.context &&
           page == other.page &&
           hits_per_page == other.hits_per_page &&
-          enabled == other.enabled &&
-          request_options == other.request_options
+          enabled == other.enabled
       end
 
       # @see the `==` method
@@ -191,7 +179,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [query, anchoring, context, page, hits_per_page, enabled, request_options].hash
+        [query, anchoring, context, page, hits_per_page, enabled].hash
       end
 
       # Builds the object from hash