algolia 3.34.4 → 3.35.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +26 -0
- data/Gemfile.lock +8 -8
- data/lib/algolia/api/analytics_client.rb +6 -6
- data/lib/algolia/api/composition_client.rb +2 -2
- data/lib/algolia/api/ingestion_client.rb +22 -22
- data/lib/algolia/api/search_client.rb +8 -8
- data/lib/algolia/defaults.rb +3 -0
- data/lib/algolia/models/composition/base_injection_query_parameters.rb +2 -2
- data/lib/algolia/models/composition/composition_behavior.rb +84 -183
- data/lib/algolia/models/composition/composition_injection_behavior.rb +209 -0
- data/lib/algolia/models/composition/composition_multifeed_behavior.rb +209 -0
- data/lib/algolia/models/composition/composition_rule.rb +0 -2
- data/lib/algolia/models/composition/ignore_plurals.rb +1 -1
- data/lib/algolia/models/composition/main_injection_query_parameters.rb +2 -2
- data/lib/algolia/models/composition/multifeed.rb +223 -0
- data/lib/algolia/models/composition/optional_filters.rb +1 -1
- data/lib/algolia/models/composition/optional_words.rb +1 -1
- data/lib/algolia/models/composition/params.rb +2 -2
- data/lib/algolia/models/composition/remove_stop_words.rb +1 -1
- data/lib/algolia/models/composition/time_range.rb +2 -2
- data/lib/algolia/models/ingestion/auth_o_auth.rb +13 -6
- data/lib/algolia/models/ingestion/auth_o_auth_partial.rb +11 -1
- data/lib/algolia/models/ingestion/authentication.rb +2 -2
- data/lib/algolia/models/ingestion/authentication_create_response.rb +1 -1
- data/lib/algolia/models/ingestion/authentication_update.rb +1 -10
- data/lib/algolia/models/ingestion/authentication_update_response.rb +1 -1
- data/lib/algolia/models/ingestion/delete_response.rb +1 -1
- data/lib/algolia/models/ingestion/destination.rb +2 -2
- data/lib/algolia/models/ingestion/destination_create_response.rb +1 -1
- data/lib/algolia/models/ingestion/destination_update_response.rb +1 -1
- data/lib/algolia/models/ingestion/event.rb +1 -1
- data/lib/algolia/models/ingestion/run.rb +3 -3
- data/lib/algolia/models/ingestion/run_response.rb +1 -1
- data/lib/algolia/models/ingestion/run_source_response.rb +1 -1
- data/lib/algolia/models/ingestion/source.rb +2 -2
- data/lib/algolia/models/ingestion/source_create_response.rb +1 -1
- data/lib/algolia/models/ingestion/source_update_response.rb +1 -1
- data/lib/algolia/models/ingestion/task.rb +3 -3
- data/lib/algolia/models/ingestion/task_create.rb +1 -1
- data/lib/algolia/models/ingestion/task_create_response.rb +1 -1
- data/lib/algolia/models/ingestion/task_create_v1.rb +2 -2
- data/lib/algolia/models/ingestion/task_replace.rb +1 -1
- data/lib/algolia/models/ingestion/task_update_response.rb +1 -1
- data/lib/algolia/models/ingestion/task_update_v1.rb +1 -1
- data/lib/algolia/models/ingestion/task_v1.rb +4 -4
- data/lib/algolia/models/ingestion/transformation.rb +2 -2
- data/lib/algolia/models/ingestion/transformation_create_response.rb +1 -1
- data/lib/algolia/models/ingestion/transformation_update_response.rb +1 -1
- data/lib/algolia/models/ingestion/watch_response.rb +1 -1
- data/lib/algolia/models/ingestion/window.rb +2 -2
- data/lib/algolia/models/insights/added_to_cart_object_ids.rb +1 -1
- data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb +1 -1
- data/lib/algolia/models/insights/clicked_filters.rb +1 -1
- data/lib/algolia/models/insights/clicked_object_ids.rb +1 -1
- data/lib/algolia/models/insights/clicked_object_ids_after_search.rb +2 -2
- data/lib/algolia/models/insights/converted_filters.rb +1 -1
- data/lib/algolia/models/insights/converted_object_ids.rb +1 -1
- data/lib/algolia/models/insights/converted_object_ids_after_search.rb +1 -1
- data/lib/algolia/models/insights/purchased_object_ids.rb +1 -1
- data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +1 -1
- data/lib/algolia/models/insights/viewed_filters.rb +1 -1
- data/lib/algolia/models/insights/viewed_object_ids.rb +1 -1
- data/lib/algolia/models/recommend/condition.rb +1 -1
- data/lib/algolia/models/recommend/fallback_params.rb +4 -4
- data/lib/algolia/models/recommend/ignore_plurals.rb +1 -1
- data/lib/algolia/models/recommend/optional_filters.rb +1 -1
- data/lib/algolia/models/recommend/optional_words.rb +1 -1
- data/lib/algolia/models/recommend/params_consequence.rb +1 -1
- data/lib/algolia/models/recommend/recommend_search_params.rb +4 -4
- data/lib/algolia/models/recommend/remove_stop_words.rb +1 -1
- data/lib/algolia/models/recommend/time_range.rb +2 -2
- data/lib/algolia/models/recommend/trending_facets_query.rb +4 -23
- data/lib/algolia/models/search/api_key.rb +1 -1
- data/lib/algolia/models/search/browse_params_object.rb +3 -3
- data/lib/algolia/models/search/browse_response.rb +0 -4
- data/lib/algolia/models/search/consequence.rb +10 -1
- data/lib/algolia/models/search/consequence_params.rb +3 -3
- data/lib/algolia/models/search/consequence_redirect.rb +210 -0
- data/lib/algolia/models/search/delete_by_params.rb +1 -1
- data/lib/algolia/models/search/event.rb +1 -1
- data/lib/algolia/models/search/get_api_key_response.rb +1 -1
- data/lib/algolia/models/search/ignore_plurals.rb +1 -1
- data/lib/algolia/models/search/index_settings.rb +3 -3
- data/lib/algolia/models/search/optional_filters.rb +1 -1
- data/lib/algolia/models/search/optional_words.rb +1 -1
- data/lib/algolia/models/search/remove_stop_words.rb +1 -1
- data/lib/algolia/models/search/search_for_facets.rb +3 -3
- data/lib/algolia/models/search/search_for_hits.rb +3 -3
- data/lib/algolia/models/search/search_params_object.rb +3 -3
- data/lib/algolia/models/search/search_response.rb +0 -4
- data/lib/algolia/models/search/secured_api_key_restrictions.rb +1 -1
- data/lib/algolia/models/search/settings_response.rb +3 -3
- data/lib/algolia/models/search/time_range.rb +2 -2
- data/lib/algolia/models/search/watch_response.rb +1 -1
- data/lib/algolia/transport/retry_strategy.rb +1 -2
- data/lib/algolia/transport/transport.rb +4 -4
- data/lib/algolia/version.rb +1 -1
- metadata +5 -1
|
@@ -11,7 +11,7 @@ module Algolia
|
|
|
11
11
|
# 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.
|
|
12
12
|
attr_accessor :similar_query
|
|
13
13
|
|
|
14
|
-
# Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper
|
|
14
|
+
# Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>`, where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>`, where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes if the facet attribute name or facet value contains 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).
|
|
15
15
|
attr_accessor :filters
|
|
16
16
|
|
|
17
17
|
attr_accessor :facet_filters
|
|
@@ -112,7 +112,7 @@ module Algolia
|
|
|
112
112
|
# Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation) (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`). Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
|
|
113
113
|
attr_accessor :decompounded_attributes
|
|
114
114
|
|
|
115
|
-
# Languages for language-specific processing steps, such as word detection and dictionary settings. **
|
|
115
|
+
# Languages for language-specific processing steps, such as word detection and dictionary settings. **Always specify an indexing 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).
|
|
116
116
|
attr_accessor :index_languages
|
|
117
117
|
|
|
118
118
|
# Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). Attribute names are case-sensitive.
|
|
@@ -151,7 +151,7 @@ module Algolia
|
|
|
151
151
|
# Attributes to include in the API response To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
|
|
152
152
|
attr_accessor :attributes_to_retrieve
|
|
153
153
|
|
|
154
|
-
# Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting,
|
|
154
|
+
# Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).
|
|
155
155
|
attr_accessor :ranking
|
|
156
156
|
|
|
157
157
|
# 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.
|
|
@@ -193,7 +193,7 @@ module Algolia
|
|
|
193
193
|
|
|
194
194
|
attr_accessor :remove_stop_words
|
|
195
195
|
|
|
196
|
-
# Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries
|
|
196
|
+
# Languages for language-specific query processing steps such as plurals, stop-word removal, 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, place the CJK language **first**. **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).
|
|
197
197
|
attr_accessor :query_languages
|
|
198
198
|
|
|
199
199
|
# Whether to split compound words in the query 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. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
|
|
@@ -7,7 +7,7 @@ require "time"
|
|
|
7
7
|
|
|
8
8
|
module Algolia
|
|
9
9
|
module Recommend
|
|
10
|
-
# Treat singular, plurals, and other forms of declensions as equivalent.
|
|
10
|
+
# Treat singular, plurals, and other forms of declensions as equivalent. Only use this feature for the languages used in your index.
|
|
11
11
|
module IgnorePlurals
|
|
12
12
|
class << self
|
|
13
13
|
# List of class defined in oneOf (OpenAPI v3)
|
|
@@ -7,7 +7,7 @@ require "time"
|
|
|
7
7
|
|
|
8
8
|
module Algolia
|
|
9
9
|
module Recommend
|
|
10
|
-
# 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
|
|
10
|
+
# 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 are applied _after_ sort-by attributes. - Optional filters are applied _before_ custom ranking attributes (in the default [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria)). - Optional filters don't work with numeric attributes. - On virtual replicas, optional filters are applied _after_ the replica's [relevant sort](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort).
|
|
11
11
|
module OptionalFilters
|
|
12
12
|
class << self
|
|
13
13
|
# List of class defined in oneOf (OpenAPI v3)
|
|
@@ -7,7 +7,7 @@ require "time"
|
|
|
7
7
|
|
|
8
8
|
module Algolia
|
|
9
9
|
module Recommend
|
|
10
|
-
# 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
|
|
10
|
+
# 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 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 optional, 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 fewer 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 2,000 need 2 matched words. - If `optionalWords` has 10 or more words, the required number of matched words increases by the number of optional words divided by 5 (rounded down). Example: with 18 optional words, results 1 to 1,000 require 1 matched word; results 1,001 to 2,000 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).
|
|
11
11
|
module OptionalWords
|
|
12
12
|
class << self
|
|
13
13
|
# List of class defined in oneOf (OpenAPI v3)
|
|
@@ -12,7 +12,7 @@ module Algolia
|
|
|
12
12
|
# Filter recommendations that match or don't match the same `facet:facet_value` combination as the viewed item.
|
|
13
13
|
attr_accessor :automatic_facet_filters
|
|
14
14
|
|
|
15
|
-
# Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper
|
|
15
|
+
# Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>`, where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>`, where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes if the facet attribute name or facet value contains 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).
|
|
16
16
|
attr_accessor :filters
|
|
17
17
|
|
|
18
18
|
# 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. Matches with higher weights (`<score=N>`) rank before matches with lower weights. If you're using a negative filter `facet:-value`, matching records rank after records that don't match.
|
|
@@ -12,7 +12,7 @@ module Algolia
|
|
|
12
12
|
# 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.
|
|
13
13
|
attr_accessor :similar_query
|
|
14
14
|
|
|
15
|
-
# Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper
|
|
15
|
+
# Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>`, where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>`, where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes if the facet attribute name or facet value contains 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).
|
|
16
16
|
attr_accessor :filters
|
|
17
17
|
|
|
18
18
|
attr_accessor :facet_filters
|
|
@@ -113,7 +113,7 @@ module Algolia
|
|
|
113
113
|
# Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation) (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`). Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
|
|
114
114
|
attr_accessor :decompounded_attributes
|
|
115
115
|
|
|
116
|
-
# Languages for language-specific processing steps, such as word detection and dictionary settings. **
|
|
116
|
+
# Languages for language-specific processing steps, such as word detection and dictionary settings. **Always specify an indexing 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).
|
|
117
117
|
attr_accessor :index_languages
|
|
118
118
|
|
|
119
119
|
# Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). Attribute names are case-sensitive.
|
|
@@ -152,7 +152,7 @@ module Algolia
|
|
|
152
152
|
# Attributes to include in the API response To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
|
|
153
153
|
attr_accessor :attributes_to_retrieve
|
|
154
154
|
|
|
155
|
-
# Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting,
|
|
155
|
+
# Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).
|
|
156
156
|
attr_accessor :ranking
|
|
157
157
|
|
|
158
158
|
# 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.
|
|
@@ -194,7 +194,7 @@ module Algolia
|
|
|
194
194
|
|
|
195
195
|
attr_accessor :remove_stop_words
|
|
196
196
|
|
|
197
|
-
# Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries
|
|
197
|
+
# Languages for language-specific query processing steps such as plurals, stop-word removal, 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, place the CJK language **first**. **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).
|
|
198
198
|
attr_accessor :query_languages
|
|
199
199
|
|
|
200
200
|
# Whether to split compound words in the query 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. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
|
|
@@ -7,7 +7,7 @@ require "time"
|
|
|
7
7
|
|
|
8
8
|
module Algolia
|
|
9
9
|
module Recommend
|
|
10
|
-
# Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words.
|
|
10
|
+
# Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words. Only use this feature for the languages used in your index.
|
|
11
11
|
module RemoveStopWords
|
|
12
12
|
class << self
|
|
13
13
|
# List of class defined in oneOf (OpenAPI v3)
|
|
@@ -8,10 +8,10 @@ require "time"
|
|
|
8
8
|
module Algolia
|
|
9
9
|
module Recommend
|
|
10
10
|
class TimeRange
|
|
11
|
-
#
|
|
11
|
+
# Timestamp when the rule should start to be active, measured in seconds since the Unix epoch.
|
|
12
12
|
attr_accessor :from
|
|
13
13
|
|
|
14
|
-
#
|
|
14
|
+
# Timestamp when the rule should stop to be active, measured in seconds since the Unix epoch.
|
|
15
15
|
attr_accessor :_until
|
|
16
16
|
|
|
17
17
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -17,25 +17,19 @@ module Algolia
|
|
|
17
17
|
# Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.
|
|
18
18
|
attr_accessor :max_recommendations
|
|
19
19
|
|
|
20
|
-
attr_accessor :query_parameters
|
|
21
|
-
|
|
22
20
|
# Facet attribute for which to retrieve trending facet values.
|
|
23
21
|
attr_accessor :facet_name
|
|
24
22
|
|
|
25
23
|
attr_accessor :model
|
|
26
24
|
|
|
27
|
-
attr_accessor :fallback_parameters
|
|
28
|
-
|
|
29
25
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
30
26
|
def self.attribute_map
|
|
31
27
|
{
|
|
32
28
|
:index_name => :indexName,
|
|
33
29
|
:threshold => :threshold,
|
|
34
30
|
:max_recommendations => :maxRecommendations,
|
|
35
|
-
:query_parameters => :queryParameters,
|
|
36
31
|
:facet_name => :facetName,
|
|
37
|
-
:model => :model
|
|
38
|
-
:fallback_parameters => :fallbackParameters
|
|
32
|
+
:model => :model
|
|
39
33
|
}
|
|
40
34
|
end
|
|
41
35
|
|
|
@@ -45,10 +39,8 @@ module Algolia
|
|
|
45
39
|
:index_name => :"String",
|
|
46
40
|
:threshold => :"Float",
|
|
47
41
|
:max_recommendations => :"Integer",
|
|
48
|
-
:query_parameters => :"RecommendSearchParams",
|
|
49
42
|
:facet_name => :"String",
|
|
50
|
-
:model => :"TrendingFacetsModel"
|
|
51
|
-
:fallback_parameters => :"FallbackParams"
|
|
43
|
+
:model => :"TrendingFacetsModel"
|
|
52
44
|
}
|
|
53
45
|
end
|
|
54
46
|
|
|
@@ -62,7 +54,6 @@ module Algolia
|
|
|
62
54
|
# List of class defined in allOf (OpenAPI v3)
|
|
63
55
|
def self.openapi_all_of
|
|
64
56
|
[
|
|
65
|
-
:"BaseRecommendRequest",
|
|
66
57
|
:"TrendingFacets"
|
|
67
58
|
]
|
|
68
59
|
end
|
|
@@ -106,10 +97,6 @@ module Algolia
|
|
|
106
97
|
self.max_recommendations = attributes[:max_recommendations]
|
|
107
98
|
end
|
|
108
99
|
|
|
109
|
-
if attributes.key?(:query_parameters)
|
|
110
|
-
self.query_parameters = attributes[:query_parameters]
|
|
111
|
-
end
|
|
112
|
-
|
|
113
100
|
if attributes.key?(:facet_name)
|
|
114
101
|
self.facet_name = attributes[:facet_name]
|
|
115
102
|
else
|
|
@@ -121,10 +108,6 @@ module Algolia
|
|
|
121
108
|
else
|
|
122
109
|
self.model = nil
|
|
123
110
|
end
|
|
124
|
-
|
|
125
|
-
if attributes.key?(:fallback_parameters)
|
|
126
|
-
self.fallback_parameters = attributes[:fallback_parameters]
|
|
127
|
-
end
|
|
128
111
|
end
|
|
129
112
|
|
|
130
113
|
# Checks equality by comparing each attribute.
|
|
@@ -135,10 +118,8 @@ module Algolia
|
|
|
135
118
|
index_name == other.index_name &&
|
|
136
119
|
threshold == other.threshold &&
|
|
137
120
|
max_recommendations == other.max_recommendations &&
|
|
138
|
-
query_parameters == other.query_parameters &&
|
|
139
121
|
facet_name == other.facet_name &&
|
|
140
|
-
model == other.model
|
|
141
|
-
fallback_parameters == other.fallback_parameters
|
|
122
|
+
model == other.model
|
|
142
123
|
end
|
|
143
124
|
|
|
144
125
|
# @see the `==` method
|
|
@@ -150,7 +131,7 @@ module Algolia
|
|
|
150
131
|
# Calculates hash code according to all attributes.
|
|
151
132
|
# @return [Integer] Hash code
|
|
152
133
|
def hash
|
|
153
|
-
[index_name, threshold, max_recommendations,
|
|
134
|
+
[index_name, threshold, max_recommendations, facet_name, model].hash
|
|
154
135
|
end
|
|
155
136
|
|
|
156
137
|
# Builds the object from hash
|
|
@@ -15,7 +15,7 @@ module Algolia
|
|
|
15
15
|
# Description of an API key to help you identify this API key.
|
|
16
16
|
attr_accessor :description
|
|
17
17
|
|
|
18
|
-
# 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_\"
|
|
18
|
+
# 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_\".
|
|
19
19
|
attr_accessor :indexes
|
|
20
20
|
|
|
21
21
|
# Maximum number of results this API key can retrieve in one query. By default, there's no limit.
|
|
@@ -14,7 +14,7 @@ module Algolia
|
|
|
14
14
|
# 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.
|
|
15
15
|
attr_accessor :similar_query
|
|
16
16
|
|
|
17
|
-
# Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper
|
|
17
|
+
# Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>`, where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>`, where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes if the facet attribute name or facet value contains 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).
|
|
18
18
|
attr_accessor :filters
|
|
19
19
|
|
|
20
20
|
attr_accessor :facet_filters
|
|
@@ -100,7 +100,7 @@ module Algolia
|
|
|
100
100
|
# Attributes to include in the API response To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
|
|
101
101
|
attr_accessor :attributes_to_retrieve
|
|
102
102
|
|
|
103
|
-
# Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting,
|
|
103
|
+
# Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).
|
|
104
104
|
attr_accessor :ranking
|
|
105
105
|
|
|
106
106
|
# 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.
|
|
@@ -145,7 +145,7 @@ module Algolia
|
|
|
145
145
|
|
|
146
146
|
attr_accessor :remove_stop_words
|
|
147
147
|
|
|
148
|
-
# Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries
|
|
148
|
+
# Languages for language-specific query processing steps such as plurals, stop-word removal, 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, place the CJK language **first**. **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).
|
|
149
149
|
attr_accessor :query_languages
|
|
150
150
|
|
|
151
151
|
# Whether to split compound words in the query 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. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
|
|
@@ -365,14 +365,10 @@ module Algolia
|
|
|
365
365
|
|
|
366
366
|
if attributes.key?(:query)
|
|
367
367
|
self.query = attributes[:query]
|
|
368
|
-
else
|
|
369
|
-
self.query = nil
|
|
370
368
|
end
|
|
371
369
|
|
|
372
370
|
if attributes.key?(:params)
|
|
373
371
|
self.params = attributes[:params]
|
|
374
|
-
else
|
|
375
|
-
self.params = nil
|
|
376
372
|
end
|
|
377
373
|
|
|
378
374
|
if attributes.key?(:cursor)
|
|
@@ -20,6 +20,8 @@ module Algolia
|
|
|
20
20
|
# Records you want to hide from the search results.
|
|
21
21
|
attr_accessor :hide
|
|
22
22
|
|
|
23
|
+
attr_accessor :redirect
|
|
24
|
+
|
|
23
25
|
# A JSON object with custom data that will be appended to the `userData` array in the response. This object isn't interpreted by the API and is limited to 1 kB of minified JSON.
|
|
24
26
|
attr_accessor :user_data
|
|
25
27
|
|
|
@@ -30,6 +32,7 @@ module Algolia
|
|
|
30
32
|
:promote => :promote,
|
|
31
33
|
:filter_promotes => :filterPromotes,
|
|
32
34
|
:hide => :hide,
|
|
35
|
+
:redirect => :redirect,
|
|
33
36
|
:user_data => :userData
|
|
34
37
|
}
|
|
35
38
|
end
|
|
@@ -41,6 +44,7 @@ module Algolia
|
|
|
41
44
|
:promote => :"Array<Promote>",
|
|
42
45
|
:filter_promotes => :"Boolean",
|
|
43
46
|
:hide => :"Array<ConsequenceHide>",
|
|
47
|
+
:redirect => :"ConsequenceRedirect",
|
|
44
48
|
:user_data => :"Object"
|
|
45
49
|
}
|
|
46
50
|
end
|
|
@@ -95,6 +99,10 @@ module Algolia
|
|
|
95
99
|
end
|
|
96
100
|
end
|
|
97
101
|
|
|
102
|
+
if attributes.key?(:redirect)
|
|
103
|
+
self.redirect = attributes[:redirect]
|
|
104
|
+
end
|
|
105
|
+
|
|
98
106
|
if attributes.key?(:user_data)
|
|
99
107
|
self.user_data = attributes[:user_data]
|
|
100
108
|
end
|
|
@@ -109,6 +117,7 @@ module Algolia
|
|
|
109
117
|
promote == other.promote &&
|
|
110
118
|
filter_promotes == other.filter_promotes &&
|
|
111
119
|
hide == other.hide &&
|
|
120
|
+
redirect == other.redirect &&
|
|
112
121
|
user_data == other.user_data
|
|
113
122
|
end
|
|
114
123
|
|
|
@@ -121,7 +130,7 @@ module Algolia
|
|
|
121
130
|
# Calculates hash code according to all attributes.
|
|
122
131
|
# @return [Integer] Hash code
|
|
123
132
|
def hash
|
|
124
|
-
[params, promote, filter_promotes, hide, user_data].hash
|
|
133
|
+
[params, promote, filter_promotes, hide, redirect, user_data].hash
|
|
125
134
|
end
|
|
126
135
|
|
|
127
136
|
# Builds the object from hash
|
|
@@ -11,7 +11,7 @@ module Algolia
|
|
|
11
11
|
# 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.
|
|
12
12
|
attr_accessor :similar_query
|
|
13
13
|
|
|
14
|
-
# Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper
|
|
14
|
+
# Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>`, where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>`, where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes if the facet attribute name or facet value contains 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).
|
|
15
15
|
attr_accessor :filters
|
|
16
16
|
|
|
17
17
|
attr_accessor :facet_filters
|
|
@@ -97,7 +97,7 @@ module Algolia
|
|
|
97
97
|
# Attributes to include in the API response To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
|
|
98
98
|
attr_accessor :attributes_to_retrieve
|
|
99
99
|
|
|
100
|
-
# Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting,
|
|
100
|
+
# Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).
|
|
101
101
|
attr_accessor :ranking
|
|
102
102
|
|
|
103
103
|
# 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.
|
|
@@ -142,7 +142,7 @@ module Algolia
|
|
|
142
142
|
|
|
143
143
|
attr_accessor :remove_stop_words
|
|
144
144
|
|
|
145
|
-
# Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries
|
|
145
|
+
# Languages for language-specific query processing steps such as plurals, stop-word removal, 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, place the CJK language **first**. **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).
|
|
146
146
|
attr_accessor :query_languages
|
|
147
147
|
|
|
148
148
|
# Whether to split compound words in the query 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. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
|