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

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

@@ -6,10 +6,10 @@ require 'time'
 module Algolia
   module Search
     class ConsequenceQueryObject
-      # Words to remove.
+      # Words to remove from the search query.
       attr_accessor :remove
 
-      # Edits to apply.
+      # Changes to make to the search query.
       attr_accessor :edits
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -7,7 +7,7 @@ module Algolia
   module Search
     # Response and creation timestamp.
     class CreatedAtResponse
-      # Timestamp of creation in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+      # Timestamp of creation in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
       attr_accessor :created_at
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Search
     class Cursor
-      # Cursor indicating the location to resume browsing from. Must match the value returned by the previous call. Pass this value to the subsequent browse call to get the next page of results. When the end of the index has been reached, `cursor` is absent from the response.
+      # Cursor to get the next page of the response.  The parameter must match the value returned in the response of a previous request. The last page of the response does not return a `cursor` attribute.
       attr_accessor :cursor
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -8,22 +8,22 @@ module Algolia
     class DeleteByParams
       attr_accessor :facet_filters
 
-      # [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 :numeric_filters
 
       attr_accessor :tag_filters
 
-      # 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
 
       attr_accessor :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
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -7,7 +7,7 @@ module Algolia
   module Search
     # Response, taskID, and deletion timestamp.
     class DeletedAtResponse
-      # Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the `task` operation and this `taskID`.
+      # Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
       attr_accessor :task_id
 
       # Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.

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

@@ -7,19 +7,19 @@ module Algolia
   module Search
     # Dictionary entry.
     class DictionaryEntry
-      # Unique identifier for a dictionary object.
+      # Unique identifier for the dictionary entry.
       attr_accessor :object_id
 
-      # [Supported language ISO code](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/).
+      # ISO code of a [supported language](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/).
       attr_accessor :language
 
-      # Dictionary entry word. Usage depends on the type of dictionary entry. **`stopwordEntry`** The stop word you want to add or update. If the entry already exists in Algolia's standard dictionary, you can override its behavior by adding it to the custom dictionary and setting its `state` to `disabled`. **`compoundEntry`** When `decomposition` is empty: adds `word` as a compound atom. For example, atom “kino” decomposes the query “kopfkino” into \"kopf\" and \"kino\". When `decomposition` isn't empty: creates a decomposition exception. For example, when decomposition is set to the [\"hund\", \"hutte\"] exception, \"hundehutte\" decomposes into “hund” and “hutte”, discarding the linking \"e\".
+      # Matching dictionary word for `stopwords` and `compounds` dictionaries.
       attr_accessor :word
 
-      # Compound dictionary [word declensions](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/). If the entry already exists in Algolia's standard dictionary, you can override its behavior by adding it to the custom dictionary and setting its `state` to `disabled`.
+      # Matching words in the `plurals` dictionary including declensions.
       attr_accessor :words
 
-      # For compound entries, governs the behavior of the `word` parameter.
+      # Invividual components of a compound word in the `compounds` dictionary.
       attr_accessor :decomposition
 
       attr_accessor :state

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

@@ -5,9 +5,9 @@ require 'time'
 
 module Algolia
   module Search
-    # Custom entries for a dictionary.
+    # Dictionary type. If `null`, this dictionary type isn't supported for the language.
     class DictionaryLanguage
-      # If `0`, the dictionary hasn't been customized and only contains standard entries provided by Algolia. If `null`, that feature isn't available or isn't supported for that language.
+      # Number of custom dictionary entries.
       attr_accessor :nb_custom_entries
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Search
-    # Enable or turn off the built-in Algolia stop words for a specific language.
+    # Turn on or off the built-in Algolia stop words for a specific language.
     class DictionarySettingsParams
       attr_accessor :disable_standard_entries
 

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

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Search
-    # Enables [deduplication or grouping of results (Algolia's _distinct_ feature](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature)).
+    # Determines how many records of a group are included in the search results.  Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).  The `distinct` setting is ignored if `attributeForDistinct` is not set.
     module Distinct
       class << self
         # List of class defined in oneOf (OpenAPI v3)

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

@@ -11,7 +11,7 @@ module Algolia
       # Text or patterns to remove from the query string.
       attr_accessor :delete
 
-      # Text that should be inserted in place of the removed text inside the query string.
+      # Text to be added in place of the deleted text inside the query string.
       attr_accessor :insert
 
       class EnumAttributeValidator

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

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Search
-    # [Filter hits by facet value](https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/).
+    # Filter the search by facet values, so that only records with the same facet values are retrieved.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`.  While it's best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.
     module FacetFilters
       class << self
         # List of class defined in oneOf (OpenAPI v3)

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

@@ -9,10 +9,10 @@ module Algolia
       # Facet value.
       attr_accessor :value
 
-      # Markup text with `facetQuery` matches highlighted.
+      # Highlighted attribute value, including HTML tags.
       attr_accessor :highlighted
 
-      # Number of records containing this facet value. This takes into account the extra search parameters specified in the query. Like for a regular search query, the [counts may not be exhaustive](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
+      # Number of records with this facet value. [The count may be approximated](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
       attr_accessor :count
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -5,11 +5,11 @@ require 'time'
 
 module Algolia
   module Search
-    # Defines the ordering of facets (widgets).
+    # Order of facet names and facet values in your UI.
     class FacetOrdering
       attr_accessor :facets
 
-      # Ordering of facet values within an individual facet.
+      # Order of facet values. One object for each facet.
       attr_accessor :values
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -5,9 +5,9 @@ require 'time'
 
 module Algolia
   module Search
-    # Ordering of facets (widgets).
+    # Order of facet names.
     class Facets
-      # Pinned order of facet lists.
+      # Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
       attr_accessor :order
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -12,28 +12,28 @@ module Algolia
       # Timestamp of creation in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time).
       attr_accessor :created_at
 
-      # [Permissions](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl) associated with the key.
+      # Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint's reference. For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
       attr_accessor :acl
 
-      # Description of an API key for you and your team members.
+      # Description of an API key to help you identify this API key.
       attr_accessor :description
 
-      # Restricts this API key to a list of indices or index patterns. If the list is empty, all indices are allowed. Specify either an exact index name or a pattern with a leading or trailing wildcard character (or both). For example: - `dev_*` matches all indices starting with \"dev_\" - `*_dev` matches all indices ending with \"_dev\" - `*_products_*` matches all indices containing \"_products_\".
+      # Index names or patterns that this API key can access. By default, an API key can access all indices in the same application.  You can use leading and trailing wildcard characters (`*`):  - `dev_*` matches all indices starting with \"dev_\". - `*_dev` matches all indices ending with \"_dev\". - `*_products_*` matches all indices containing \"_products_\".
       attr_accessor :indexes
 
-      # Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced. > **Note**: Use this parameter to protect you from third-party attempts to retrieve your entire content by massively querying the index.
+      # Maximum number of results this API key can retrieve in one query. By default, there's no limit.
       attr_accessor :max_hits_per_query
 
-      # Maximum number of API calls per hour allowed from a given IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). Each time an API call is performed with this key, a check is performed. If there were more than the specified number of calls within the last hour, the API returns an error with the status code `429` (Too Many Requests).  > **Note**: Use this parameter to protect you from third-party attempts to retrieve your entire content by massively querying the index.
+      # Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) per hour.  If this limit is reached, the API returns an error with status code `429`. By default, there's no limit.
       attr_accessor :max_queries_per_ip_per_hour
 
-      # Force some [query parameters](https://www.algolia.com/doc/api-reference/api-parameters/) to be applied for each query made with this API key. It's a URL-encoded query string.
+      # Query parameters to add when making API requests with this API key.  To restrict this API key to specific IP addresses, add the `restrictSources` parameter. You can only add a single source, but you can provide a range of IP addresses.  Creating an API key fails if the request is made from an IP address that's outside the restricted range.
       attr_accessor :query_parameters
 
-      # Restrict this API key to specific [referrers](https://www.algolia.com/doc/guides/security/api-keys/in-depth/api-key-restrictions/#http-referrers). If empty, all referrers are allowed. For example: - `https://algolia.com/*` matches all referrers starting with \"https://algolia.com/\" - `*.algolia.com` matches all referrers ending with \".algolia.com\" - `*algolia.com*` allows everything in the domain \"algolia.com\".
+      # Allowed HTTP referrers for this API key.  By default, all referrers are allowed. You can use leading and trailing wildcard characters (`*`):  - `https://algolia.com/*` allows all referrers starting with \"https://algolia.com/\" - `*.algolia.com` allows all referrers ending with \".algolia.com\" - `*algolia.com*` allows all referrers in the domain \"algolia.com\".  Like all HTTP headers, referrers can be spoofed. Don't rely on them to secure your data. For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions).
       attr_accessor :referers
 
-      # Validity duration of a key (in seconds).  The key will automatically be removed after this time has expired. The default value of 0 never expires. Short-lived API keys are useful to grant temporary access to your data. For example, in mobile apps, you can't [control when users update your app](https://www.algolia.com/doc/guides/security/security-best-practices/#use-secured-api-keys-in-mobile-apps). So instead of encoding keys into your app as you would for a web app, you should dynamically fetch them from your mobile app's backend.
+      # Duration (in seconds) after which the API key expires. By default, API keys don't expire.
       attr_accessor :validity
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -5,15 +5,15 @@ require 'time'
 
 module Algolia
   module Search
-    # Record retrieval operation.
+    # Request body for retrieving records.
     class GetObjectsRequest
       # Attributes to retrieve. If not specified, all retrievable attributes are returned.
       attr_accessor :attributes_to_retrieve
 
-      # Record's objectID.
+      # Object ID for the record to retrieve.
       attr_accessor :object_id
 
-      # Name of the index containing the required records.
+      # Index from which to retrieve the records.
       attr_accessor :index_name
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Search
     class GetObjectsResponse
-      # Retrieved results.
+      # Retrieved records.
       attr_accessor :results
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Search
     class HasPendingMappingsResponse
-      # Indicates whether there are clusters undergoing migration, creation, or deletion.
+      # Whether there are clusters undergoing migration, creation, or deletion.
       attr_accessor :pending
 
       # Cluster pending mapping state: migrating, creating, deleting.

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

@@ -5,14 +5,14 @@ require 'time'
 
 module Algolia
   module Search
-    # Show highlighted section and words matched on a query.
+    # Surround words that match the query with HTML tags for highlighting.
     class HighlightResultOption
-      # Markup text with `facetQuery` matches highlighted.
+      # Highlighted attribute value, including HTML tags.
       attr_accessor :value
 
       attr_accessor :match_level
 
-      # List of words from the query that matched the object.
+      # List of matched words from the search query.
       attr_accessor :matched_words
 
       # Whether the entire attribute value is highlighted.

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

@@ -5,15 +5,15 @@ require 'time'
 
 module Algolia
   module Search
-    # A single hit.
+    # Search result.  A hit is a record from your index, augmented with special attributes for highlighting, snippeting, and ranking.
     class Hit
-      # 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/search/ignore_plurals.rb

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Search
-    # Treats singular, plurals, and other forms of declensions as matching terms. `ignorePlurals` is used in conjunction with the `queryLanguages` setting. _list_: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in `queryLanguages`. _true_: enables the ignore plurals feature, where singulars and plurals are considered equivalent (\"foot\" = \"feet\"). The languages supported here are either [every language](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) (this is the default) or those set by `queryLanguages`. _false_: turns off the ignore plurals feature, so that singulars and plurals aren't considered to be the same (\"foot\" will not find \"feet\").
+    # Treat singular, plurals, and other forms of declensions as equivalent. You should only use this feature for the languages used in your index.
     module IgnorePlurals
       class << self
         # List of class defined in oneOf (OpenAPI v3)