algolia 3.23.0 → 3.24.0
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 +6 -0
- data/Gemfile.lock +1 -1
- data/lib/algolia/models/abtesting/ab_test.rb +13 -1
- data/lib/algolia/models/abtesting-v3/ab_test.rb +25 -2
- data/lib/algolia/models/composition/hit.rb +13 -4
- data/lib/algolia/models/composition/hit_metadata.rb +210 -0
- data/lib/algolia/models/composition/params.rb +2 -1
- data/lib/algolia/models/recommend/fallback_params.rb +26 -26
- data/lib/algolia/models/recommend/recommend_search_params.rb +26 -26
- data/lib/algolia/models/search/browse_params_object.rb +26 -26
- data/lib/algolia/models/search/consequence_params.rb +26 -26
- data/lib/algolia/models/search/index_settings.rb +18 -18
- data/lib/algolia/models/search/search_for_facets.rb +26 -26
- data/lib/algolia/models/search/search_for_hits.rb +26 -26
- data/lib/algolia/models/search/search_params_object.rb +26 -26
- data/lib/algolia/models/search/settings_response.rb +18 -18
- data/lib/algolia/version.rb +1 -1
- metadata +2 -1
|
@@ -14,7 +14,7 @@ module Algolia
|
|
|
14
14
|
# Search query.
|
|
15
15
|
attr_accessor :query
|
|
16
16
|
|
|
17
|
-
# Keywords to be used instead of the search query to conduct a more broader search
|
|
17
|
+
# 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.
|
|
18
18
|
attr_accessor :similar_query
|
|
19
19
|
|
|
20
20
|
# Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
|
|
@@ -28,16 +28,16 @@ module Algolia
|
|
|
28
28
|
|
|
29
29
|
attr_accessor :tag_filters
|
|
30
30
|
|
|
31
|
-
# Whether to sum all filter scores
|
|
31
|
+
# 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).
|
|
32
32
|
attr_accessor :sum_or_filters_scores
|
|
33
33
|
|
|
34
34
|
# Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
|
|
35
35
|
attr_accessor :restrict_searchable_attributes
|
|
36
36
|
|
|
37
|
-
# Facets for which to retrieve facet values that match the search criteria and the number of matching facet values
|
|
37
|
+
# 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).
|
|
38
38
|
attr_accessor :facets
|
|
39
39
|
|
|
40
|
-
# Whether faceting should be applied after deduplication with `distinct
|
|
40
|
+
# 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`.
|
|
41
41
|
attr_accessor :faceting_after_distinct
|
|
42
42
|
|
|
43
43
|
# Page of search results to retrieve.
|
|
@@ -67,13 +67,13 @@ module Algolia
|
|
|
67
67
|
# 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`.
|
|
68
68
|
attr_accessor :inside_polygon
|
|
69
69
|
|
|
70
|
-
# ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches)
|
|
70
|
+
# 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`.
|
|
71
71
|
attr_accessor :natural_languages
|
|
72
72
|
|
|
73
|
-
# Assigns a rule context to the search query
|
|
73
|
+
# 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.
|
|
74
74
|
attr_accessor :rule_contexts
|
|
75
75
|
|
|
76
|
-
# Impact that Personalization should have on this search
|
|
76
|
+
# 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).
|
|
77
77
|
attr_accessor :personalization_impact
|
|
78
78
|
|
|
79
79
|
# 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/).
|
|
@@ -85,7 +85,7 @@ module Algolia
|
|
|
85
85
|
# Whether to take into account an index's synonyms for this search.
|
|
86
86
|
attr_accessor :synonyms
|
|
87
87
|
|
|
88
|
-
# Whether to include a `queryID` attribute in the response
|
|
88
|
+
# 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/).
|
|
89
89
|
attr_accessor :click_analytics
|
|
90
90
|
|
|
91
91
|
# Whether this search will be included in Analytics.
|
|
@@ -100,19 +100,19 @@ module Algolia
|
|
|
100
100
|
# Whether to enable A/B testing for this search.
|
|
101
101
|
attr_accessor :enable_ab_test
|
|
102
102
|
|
|
103
|
-
# Attributes to include in the API response
|
|
103
|
+
# 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.
|
|
104
104
|
attr_accessor :attributes_to_retrieve
|
|
105
105
|
|
|
106
106
|
# Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
|
|
107
107
|
attr_accessor :ranking
|
|
108
108
|
|
|
109
|
-
# Relevancy threshold below which less relevant results aren't included in the results
|
|
109
|
+
# 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.
|
|
110
110
|
attr_accessor :relevancy_strictness
|
|
111
111
|
|
|
112
|
-
# Attributes to highlight
|
|
112
|
+
# Attributes to highlight By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive 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/).
|
|
113
113
|
attr_accessor :attributes_to_highlight
|
|
114
114
|
|
|
115
|
-
# Attributes for which to enable snippets. Attribute names are case-sensitive
|
|
115
|
+
# Attributes for which to enable snippets. Attribute names are case-sensitive 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.
|
|
116
116
|
attr_accessor :attributes_to_snippet
|
|
117
117
|
|
|
118
118
|
# HTML tag to insert before the highlighted parts in all highlighted results and snippets.
|
|
@@ -138,20 +138,20 @@ module Algolia
|
|
|
138
138
|
|
|
139
139
|
attr_accessor :typo_tolerance
|
|
140
140
|
|
|
141
|
-
# Whether to allow typos on numbers in the search query
|
|
141
|
+
# 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.
|
|
142
142
|
attr_accessor :allow_typos_on_numeric_tokens
|
|
143
143
|
|
|
144
|
-
# Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive
|
|
144
|
+
# Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive 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.
|
|
145
145
|
attr_accessor :disable_typo_tolerance_on_attributes
|
|
146
146
|
|
|
147
147
|
attr_accessor :ignore_plurals
|
|
148
148
|
|
|
149
149
|
attr_accessor :remove_stop_words
|
|
150
150
|
|
|
151
|
-
# Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries
|
|
151
|
+
# 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, 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/).
|
|
152
152
|
attr_accessor :query_languages
|
|
153
153
|
|
|
154
|
-
# Whether to split compound words in the query into their building blocks
|
|
154
|
+
# 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).
|
|
155
155
|
attr_accessor :decompound_query
|
|
156
156
|
|
|
157
157
|
# Whether to enable rules.
|
|
@@ -168,45 +168,45 @@ module Algolia
|
|
|
168
168
|
|
|
169
169
|
attr_accessor :semantic_search
|
|
170
170
|
|
|
171
|
-
# Whether to support phrase matching and excluding words from search queries
|
|
171
|
+
# Whether to support phrase matching and excluding words from search queries Use the `advancedSyntaxFeatures` parameter to control which feature is supported.
|
|
172
172
|
attr_accessor :advanced_syntax
|
|
173
173
|
|
|
174
174
|
attr_accessor :optional_words
|
|
175
175
|
|
|
176
|
-
# 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). Attribute names are case-sensitive
|
|
176
|
+
# 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). Attribute names are case-sensitive This can be useful for attributes with long values, where the likelihood 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.
|
|
177
177
|
attr_accessor :disable_exact_on_attributes
|
|
178
178
|
|
|
179
179
|
attr_accessor :exact_on_single_word_query
|
|
180
180
|
|
|
181
|
-
# Determine which plurals and synonyms should be considered an exact matches
|
|
181
|
+
# Determine which plurals and synonyms should be considered an exact matches By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching. For example - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)) - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
|
|
182
182
|
attr_accessor :alternatives_as_exact
|
|
183
183
|
|
|
184
|
-
# Advanced search syntax features you want to support
|
|
184
|
+
# Advanced search syntax features you want to support - `exactPhrase`. Phrases in quotes must match exactly. For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\" - `excludeWords`. Query words prefixed with a `-` must not occur in a record. For example, `search -engine` matches records that contain \"search\" but not \"engine\" This setting only has an effect if `advancedSyntax` is true.
|
|
185
185
|
attr_accessor :advanced_syntax_features
|
|
186
186
|
|
|
187
187
|
attr_accessor :distinct
|
|
188
188
|
|
|
189
|
-
# Whether to replace a highlighted word with the matched synonym
|
|
189
|
+
# 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 occurrences of \"house\" are replaced by \"home\" in the highlighted response.
|
|
190
190
|
attr_accessor :replace_synonyms_in_highlight
|
|
191
191
|
|
|
192
|
-
# Minimum proximity score for two matching words
|
|
192
|
+
# 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.
|
|
193
193
|
attr_accessor :min_proximity
|
|
194
194
|
|
|
195
|
-
# Properties to include in the API response of search and browse requests
|
|
195
|
+
# 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 properties should be included An empty list may lead to an empty API response (except properties you can't exclude) You can't exclude these properties: `message`, `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true Your search depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend on other properties, for example, for pagination. Before restricting the response size, check the impact on your search experience.
|
|
196
196
|
attr_accessor :response_fields
|
|
197
197
|
|
|
198
198
|
# Maximum number of facet values to return for each facet.
|
|
199
199
|
attr_accessor :max_values_per_facet
|
|
200
200
|
|
|
201
|
-
# Order in which to retrieve facet values
|
|
201
|
+
# Order in which to retrieve facet values - `count`. Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value - `alpha`. Retrieve facet values alphabetically This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
|
|
202
202
|
attr_accessor :sort_facet_values_by
|
|
203
203
|
|
|
204
|
-
# Whether the best matching attribute should be determined by minimum proximity
|
|
204
|
+
# 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.
|
|
205
205
|
attr_accessor :attribute_criteria_computed_by_min_proximity
|
|
206
206
|
|
|
207
207
|
attr_accessor :rendering_content
|
|
208
208
|
|
|
209
|
-
# Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/)
|
|
209
|
+
# 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.
|
|
210
210
|
attr_accessor :enable_re_ranking
|
|
211
211
|
|
|
212
212
|
attr_accessor :re_ranking_apply_filter
|
|
@@ -14,7 +14,7 @@ module Algolia
|
|
|
14
14
|
# Search query.
|
|
15
15
|
attr_accessor :query
|
|
16
16
|
|
|
17
|
-
# Keywords to be used instead of the search query to conduct a more broader search
|
|
17
|
+
# 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.
|
|
18
18
|
attr_accessor :similar_query
|
|
19
19
|
|
|
20
20
|
# Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
|
|
@@ -28,16 +28,16 @@ module Algolia
|
|
|
28
28
|
|
|
29
29
|
attr_accessor :tag_filters
|
|
30
30
|
|
|
31
|
-
# Whether to sum all filter scores
|
|
31
|
+
# 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).
|
|
32
32
|
attr_accessor :sum_or_filters_scores
|
|
33
33
|
|
|
34
34
|
# Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
|
|
35
35
|
attr_accessor :restrict_searchable_attributes
|
|
36
36
|
|
|
37
|
-
# Facets for which to retrieve facet values that match the search criteria and the number of matching facet values
|
|
37
|
+
# 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).
|
|
38
38
|
attr_accessor :facets
|
|
39
39
|
|
|
40
|
-
# Whether faceting should be applied after deduplication with `distinct
|
|
40
|
+
# 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`.
|
|
41
41
|
attr_accessor :faceting_after_distinct
|
|
42
42
|
|
|
43
43
|
# Page of search results to retrieve.
|
|
@@ -67,13 +67,13 @@ module Algolia
|
|
|
67
67
|
# 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`.
|
|
68
68
|
attr_accessor :inside_polygon
|
|
69
69
|
|
|
70
|
-
# ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches)
|
|
70
|
+
# 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`.
|
|
71
71
|
attr_accessor :natural_languages
|
|
72
72
|
|
|
73
|
-
# Assigns a rule context to the search query
|
|
73
|
+
# 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.
|
|
74
74
|
attr_accessor :rule_contexts
|
|
75
75
|
|
|
76
|
-
# Impact that Personalization should have on this search
|
|
76
|
+
# 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).
|
|
77
77
|
attr_accessor :personalization_impact
|
|
78
78
|
|
|
79
79
|
# 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/).
|
|
@@ -85,7 +85,7 @@ module Algolia
|
|
|
85
85
|
# Whether to take into account an index's synonyms for this search.
|
|
86
86
|
attr_accessor :synonyms
|
|
87
87
|
|
|
88
|
-
# Whether to include a `queryID` attribute in the response
|
|
88
|
+
# 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/).
|
|
89
89
|
attr_accessor :click_analytics
|
|
90
90
|
|
|
91
91
|
# Whether this search will be included in Analytics.
|
|
@@ -100,19 +100,19 @@ module Algolia
|
|
|
100
100
|
# Whether to enable A/B testing for this search.
|
|
101
101
|
attr_accessor :enable_ab_test
|
|
102
102
|
|
|
103
|
-
# Attributes to include in the API response
|
|
103
|
+
# 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.
|
|
104
104
|
attr_accessor :attributes_to_retrieve
|
|
105
105
|
|
|
106
106
|
# Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
|
|
107
107
|
attr_accessor :ranking
|
|
108
108
|
|
|
109
|
-
# Relevancy threshold below which less relevant results aren't included in the results
|
|
109
|
+
# 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.
|
|
110
110
|
attr_accessor :relevancy_strictness
|
|
111
111
|
|
|
112
|
-
# Attributes to highlight
|
|
112
|
+
# Attributes to highlight By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive 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/).
|
|
113
113
|
attr_accessor :attributes_to_highlight
|
|
114
114
|
|
|
115
|
-
# Attributes for which to enable snippets. Attribute names are case-sensitive
|
|
115
|
+
# Attributes for which to enable snippets. Attribute names are case-sensitive 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.
|
|
116
116
|
attr_accessor :attributes_to_snippet
|
|
117
117
|
|
|
118
118
|
# HTML tag to insert before the highlighted parts in all highlighted results and snippets.
|
|
@@ -138,20 +138,20 @@ module Algolia
|
|
|
138
138
|
|
|
139
139
|
attr_accessor :typo_tolerance
|
|
140
140
|
|
|
141
|
-
# Whether to allow typos on numbers in the search query
|
|
141
|
+
# 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.
|
|
142
142
|
attr_accessor :allow_typos_on_numeric_tokens
|
|
143
143
|
|
|
144
|
-
# Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive
|
|
144
|
+
# Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive 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.
|
|
145
145
|
attr_accessor :disable_typo_tolerance_on_attributes
|
|
146
146
|
|
|
147
147
|
attr_accessor :ignore_plurals
|
|
148
148
|
|
|
149
149
|
attr_accessor :remove_stop_words
|
|
150
150
|
|
|
151
|
-
# Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries
|
|
151
|
+
# 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, 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/).
|
|
152
152
|
attr_accessor :query_languages
|
|
153
153
|
|
|
154
|
-
# Whether to split compound words in the query into their building blocks
|
|
154
|
+
# 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).
|
|
155
155
|
attr_accessor :decompound_query
|
|
156
156
|
|
|
157
157
|
# Whether to enable rules.
|
|
@@ -168,45 +168,45 @@ module Algolia
|
|
|
168
168
|
|
|
169
169
|
attr_accessor :semantic_search
|
|
170
170
|
|
|
171
|
-
# Whether to support phrase matching and excluding words from search queries
|
|
171
|
+
# Whether to support phrase matching and excluding words from search queries Use the `advancedSyntaxFeatures` parameter to control which feature is supported.
|
|
172
172
|
attr_accessor :advanced_syntax
|
|
173
173
|
|
|
174
174
|
attr_accessor :optional_words
|
|
175
175
|
|
|
176
|
-
# 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). Attribute names are case-sensitive
|
|
176
|
+
# 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). Attribute names are case-sensitive This can be useful for attributes with long values, where the likelihood 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.
|
|
177
177
|
attr_accessor :disable_exact_on_attributes
|
|
178
178
|
|
|
179
179
|
attr_accessor :exact_on_single_word_query
|
|
180
180
|
|
|
181
|
-
# Determine which plurals and synonyms should be considered an exact matches
|
|
181
|
+
# Determine which plurals and synonyms should be considered an exact matches By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching. For example - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)) - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
|
|
182
182
|
attr_accessor :alternatives_as_exact
|
|
183
183
|
|
|
184
|
-
# Advanced search syntax features you want to support
|
|
184
|
+
# Advanced search syntax features you want to support - `exactPhrase`. Phrases in quotes must match exactly. For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\" - `excludeWords`. Query words prefixed with a `-` must not occur in a record. For example, `search -engine` matches records that contain \"search\" but not \"engine\" This setting only has an effect if `advancedSyntax` is true.
|
|
185
185
|
attr_accessor :advanced_syntax_features
|
|
186
186
|
|
|
187
187
|
attr_accessor :distinct
|
|
188
188
|
|
|
189
|
-
# Whether to replace a highlighted word with the matched synonym
|
|
189
|
+
# 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 occurrences of \"house\" are replaced by \"home\" in the highlighted response.
|
|
190
190
|
attr_accessor :replace_synonyms_in_highlight
|
|
191
191
|
|
|
192
|
-
# Minimum proximity score for two matching words
|
|
192
|
+
# 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.
|
|
193
193
|
attr_accessor :min_proximity
|
|
194
194
|
|
|
195
|
-
# Properties to include in the API response of search and browse requests
|
|
195
|
+
# 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 properties should be included An empty list may lead to an empty API response (except properties you can't exclude) You can't exclude these properties: `message`, `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true Your search depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend on other properties, for example, for pagination. Before restricting the response size, check the impact on your search experience.
|
|
196
196
|
attr_accessor :response_fields
|
|
197
197
|
|
|
198
198
|
# Maximum number of facet values to return for each facet.
|
|
199
199
|
attr_accessor :max_values_per_facet
|
|
200
200
|
|
|
201
|
-
# Order in which to retrieve facet values
|
|
201
|
+
# Order in which to retrieve facet values - `count`. Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value - `alpha`. Retrieve facet values alphabetically This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
|
|
202
202
|
attr_accessor :sort_facet_values_by
|
|
203
203
|
|
|
204
|
-
# Whether the best matching attribute should be determined by minimum proximity
|
|
204
|
+
# 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.
|
|
205
205
|
attr_accessor :attribute_criteria_computed_by_min_proximity
|
|
206
206
|
|
|
207
207
|
attr_accessor :rendering_content
|
|
208
208
|
|
|
209
|
-
# Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/)
|
|
209
|
+
# 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.
|
|
210
210
|
attr_accessor :enable_re_ranking
|
|
211
211
|
|
|
212
212
|
attr_accessor :re_ranking_apply_filter
|