algolia 3.0.0.alpha.12 → 3.0.0.alpha.13
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.openapi-generator/FILES +1 -0
- data/CHANGELOG.md +6 -0
- data/Gemfile.lock +4 -4
- data/lib/algolia/api/abtesting_client.rb +8 -4
- data/lib/algolia/api/analytics_client.rb +146 -282
- data/lib/algolia/api/ingestion_client.rb +4 -4
- data/lib/algolia/api/insights_client.rb +7 -7
- data/lib/algolia/api/recommend_client.rb +12 -12
- data/lib/algolia/api/search_client.rb +242 -242
- data/lib/algolia/models/abtesting/ab_test_response.rb +1 -1
- data/lib/algolia/models/analytics/search_no_result_event.rb +1 -1
- data/lib/algolia/models/analytics/top_search.rb +1 -1
- data/lib/algolia/models/analytics/top_search_with_analytics.rb +1 -1
- data/lib/algolia/models/ingestion/action_type.rb +2 -1
- data/lib/algolia/models/ingestion/source_ga4_big_query_export.rb +223 -0
- data/lib/algolia/models/ingestion/source_input.rb +1 -0
- data/lib/algolia/models/ingestion/source_type.rb +2 -1
- data/lib/algolia/models/ingestion/source_update_input.rb +1 -0
- data/lib/algolia/models/ingestion/streaming_trigger.rb +221 -0
- data/lib/algolia/models/ingestion/streaming_trigger_type.rb +32 -0
- data/lib/algolia/models/ingestion/streaming_utils_input.rb +199 -0
- data/lib/algolia/models/ingestion/task_create_trigger.rb +1 -0
- data/lib/algolia/models/ingestion/task_input.rb +2 -1
- data/lib/algolia/models/ingestion/trigger.rb +1 -0
- data/lib/algolia/models/ingestion/trigger_type.rb +2 -1
- data/lib/algolia/models/insights/added_to_cart_object_ids.rb +6 -6
- data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb +6 -6
- data/lib/algolia/models/insights/clicked_filters.rb +6 -6
- data/lib/algolia/models/insights/clicked_object_ids.rb +6 -6
- data/lib/algolia/models/insights/clicked_object_ids_after_search.rb +7 -7
- data/lib/algolia/models/insights/converted_filters.rb +6 -6
- data/lib/algolia/models/insights/converted_object_ids.rb +6 -6
- data/lib/algolia/models/insights/converted_object_ids_after_search.rb +6 -6
- data/lib/algolia/models/insights/discount.rb +1 -1
- data/lib/algolia/models/insights/insights_events.rb +1 -1
- data/lib/algolia/models/insights/object_data.rb +1 -1
- data/lib/algolia/models/insights/object_data_after_search.rb +1 -1
- data/lib/algolia/models/insights/price.rb +1 -1
- data/lib/algolia/models/insights/purchased_object_ids.rb +6 -6
- data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +6 -6
- data/lib/algolia/models/insights/viewed_filters.rb +6 -6
- data/lib/algolia/models/insights/viewed_object_ids.rb +6 -6
- data/lib/algolia/models/recommend/around_precision.rb +1 -1
- data/lib/algolia/models/recommend/around_precision_from_value_inner.rb +3 -0
- data/lib/algolia/models/recommend/around_radius.rb +1 -1
- data/lib/algolia/models/recommend/automatic_facet_filter.rb +4 -4
- data/lib/algolia/models/recommend/automatic_facet_filters.rb +1 -1
- data/lib/algolia/models/recommend/base_recommend_request.rb +1 -1
- data/lib/algolia/models/recommend/base_recommendations_query.rb +1 -1
- data/lib/algolia/models/recommend/base_recommended_for_you_query_parameters.rb +1 -1
- data/lib/algolia/models/recommend/base_search_params.rb +58 -38
- data/lib/algolia/models/recommend/base_search_params_without_query.rb +57 -37
- data/lib/algolia/models/recommend/base_search_response.rb +20 -6
- data/lib/algolia/models/recommend/condition.rb +32 -7
- data/lib/algolia/models/recommend/consequence.rb +33 -5
- data/lib/algolia/models/recommend/consequence_hide.rb +2 -2
- data/lib/algolia/models/recommend/consequence_params.rb +101 -79
- data/lib/algolia/models/recommend/consequence_query.rb +1 -1
- data/lib/algolia/models/recommend/consequence_query_object.rb +2 -2
- data/lib/algolia/models/recommend/deleted_at_response.rb +1 -1
- data/lib/algolia/models/recommend/distinct.rb +1 -1
- data/lib/algolia/models/recommend/edit.rb +1 -1
- data/lib/algolia/models/recommend/facet_filters.rb +1 -1
- data/lib/algolia/models/recommend/facet_ordering.rb +2 -2
- data/lib/algolia/models/recommend/facets.rb +2 -2
- data/lib/algolia/models/recommend/highlight_result_option.rb +3 -3
- data/lib/algolia/models/recommend/ignore_plurals.rb +1 -1
- data/lib/algolia/models/recommend/index_settings_as_search_params.rb +46 -44
- data/lib/algolia/models/recommend/numeric_filters.rb +1 -1
- data/lib/algolia/models/recommend/optional_filters.rb +1 -1
- data/lib/algolia/models/recommend/params.rb +1 -1
- data/lib/algolia/models/recommend/promote_object_id.rb +2 -2
- data/lib/algolia/models/recommend/promote_object_ids.rb +16 -2
- data/lib/algolia/models/recommend/ranking_info.rb +120 -7
- data/lib/algolia/models/recommend/re_ranking_apply_filter.rb +1 -1
- data/lib/algolia/models/recommend/recommend_hit.rb +3 -3
- data/lib/algolia/models/recommend/recommendations_hits.rb +1 -1
- data/lib/algolia/models/recommend/recommendations_query.rb +2 -2
- data/lib/algolia/models/recommend/recommendations_results.rb +21 -7
- data/lib/algolia/models/recommend/recommended_for_you_query.rb +1 -1
- data/lib/algolia/models/recommend/recommended_for_you_query_parameters.rb +102 -80
- data/lib/algolia/models/recommend/remove_stop_words.rb +1 -1
- data/lib/algolia/models/recommend/rendering_content.rb +1 -1
- data/lib/algolia/models/recommend/search_params_object.rb +102 -80
- data/lib/algolia/models/recommend/search_params_query.rb +1 -1
- data/lib/algolia/models/recommend/search_recommend_rules_params.rb +2 -2
- data/lib/algolia/models/recommend/search_recommend_rules_response.rb +17 -3
- data/lib/algolia/models/recommend/semantic_search.rb +2 -2
- data/lib/algolia/models/recommend/snippet_result_option.rb +2 -2
- data/lib/algolia/models/recommend/tag_filters.rb +1 -1
- data/lib/algolia/models/recommend/trending_facets_query.rb +1 -1
- data/lib/algolia/models/recommend/trending_items_query.rb +1 -1
- data/lib/algolia/models/recommend/typo_tolerance.rb +1 -1
- data/lib/algolia/models/recommend/value.rb +1 -1
- data/lib/algolia/models/search/add_api_key_response.rb +1 -1
- data/lib/algolia/models/search/api_key.rb +8 -8
- data/lib/algolia/models/search/around_precision.rb +1 -1
- data/lib/algolia/models/search/around_precision_from_value_inner.rb +3 -0
- data/lib/algolia/models/search/around_radius.rb +1 -1
- data/lib/algolia/models/search/automatic_facet_filter.rb +4 -4
- data/lib/algolia/models/search/automatic_facet_filters.rb +1 -1
- data/lib/algolia/models/search/base_index_settings.rb +44 -18
- data/lib/algolia/models/search/base_search_params.rb +58 -38
- data/lib/algolia/models/search/base_search_params_without_query.rb +57 -37
- data/lib/algolia/models/search/base_search_response.rb +20 -6
- data/lib/algolia/models/search/batch_dictionary_entries_params.rb +3 -3
- data/lib/algolia/models/search/batch_response.rb +2 -2
- data/lib/algolia/models/search/browse_params_object.rb +103 -81
- data/lib/algolia/models/search/browse_response.rb +23 -8
- data/lib/algolia/models/search/built_in_operation.rb +2 -2
- data/lib/algolia/models/search/condition.rb +32 -7
- data/lib/algolia/models/search/consequence.rb +33 -5
- data/lib/algolia/models/search/consequence_hide.rb +2 -2
- data/lib/algolia/models/search/consequence_params.rb +101 -79
- data/lib/algolia/models/search/consequence_query.rb +1 -1
- data/lib/algolia/models/search/consequence_query_object.rb +2 -2
- data/lib/algolia/models/search/created_at_response.rb +1 -1
- data/lib/algolia/models/search/cursor.rb +1 -1
- data/lib/algolia/models/search/delete_by_params.rb +4 -4
- data/lib/algolia/models/search/deleted_at_response.rb +1 -1
- data/lib/algolia/models/search/dictionary_entry.rb +5 -5
- data/lib/algolia/models/search/dictionary_language.rb +2 -2
- data/lib/algolia/models/search/dictionary_settings_params.rb +1 -1
- data/lib/algolia/models/search/distinct.rb +1 -1
- data/lib/algolia/models/search/edit.rb +1 -1
- data/lib/algolia/models/search/facet_filters.rb +1 -1
- data/lib/algolia/models/search/facet_hits.rb +2 -2
- data/lib/algolia/models/search/facet_ordering.rb +2 -2
- data/lib/algolia/models/search/facets.rb +2 -2
- data/lib/algolia/models/search/get_api_key_response.rb +8 -8
- data/lib/algolia/models/search/get_objects_request.rb +3 -3
- data/lib/algolia/models/search/get_objects_response.rb +1 -1
- data/lib/algolia/models/search/has_pending_mappings_response.rb +1 -1
- data/lib/algolia/models/search/highlight_result_option.rb +3 -3
- data/lib/algolia/models/search/hit.rb +4 -4
- data/lib/algolia/models/search/ignore_plurals.rb +1 -1
- data/lib/algolia/models/search/index_settings.rb +89 -61
- data/lib/algolia/models/search/index_settings_as_search_params.rb +46 -44
- data/lib/algolia/models/search/log.rb +39 -11
- data/lib/algolia/models/search/log_query.rb +1 -1
- data/lib/algolia/models/search/multiple_batch_response.rb +2 -2
- data/lib/algolia/models/search/numeric_filters.rb +1 -1
- data/lib/algolia/models/search/operation_index_params.rb +2 -2
- data/lib/algolia/models/search/optional_filters.rb +1 -1
- data/lib/algolia/models/search/params.rb +1 -1
- data/lib/algolia/models/search/promote_object_id.rb +2 -2
- data/lib/algolia/models/search/promote_object_ids.rb +16 -2
- data/lib/algolia/models/search/ranking_info.rb +120 -7
- data/lib/algolia/models/search/re_ranking_apply_filter.rb +1 -1
- data/lib/algolia/models/search/remove_stop_words.rb +1 -1
- data/lib/algolia/models/search/rendering_content.rb +1 -1
- data/lib/algolia/models/search/rule.rb +23 -5
- data/lib/algolia/models/search/save_object_response.rb +3 -3
- data/lib/algolia/models/search/save_synonym_response.rb +1 -1
- data/lib/algolia/models/search/search_dictionary_entries_params.rb +18 -4
- data/lib/algolia/models/search/search_dictionary_entries_response.rb +251 -0
- data/lib/algolia/models/search/search_for_facet_values_request.rb +1 -1
- data/lib/algolia/models/search/search_for_facet_values_response.rb +1 -0
- data/lib/algolia/models/search/search_for_facets.rb +103 -81
- data/lib/algolia/models/search/search_for_facets_options.rb +2 -2
- data/lib/algolia/models/search/search_for_hits.rb +103 -81
- data/lib/algolia/models/search/search_for_hits_options.rb +1 -1
- data/lib/algolia/models/search/search_hits.rb +2 -1
- data/lib/algolia/models/search/search_params_object.rb +102 -80
- data/lib/algolia/models/search/search_params_query.rb +1 -1
- data/lib/algolia/models/search/search_response.rb +22 -7
- data/lib/algolia/models/search/search_rules_params.rb +8 -20
- data/lib/algolia/models/search/search_rules_response.rb +2 -2
- data/lib/algolia/models/search/search_synonyms_params.rb +16 -2
- data/lib/algolia/models/search/search_synonyms_response.rb +2 -2
- data/lib/algolia/models/search/search_user_ids_params.rb +15 -1
- data/lib/algolia/models/search/search_user_ids_response.rb +16 -2
- data/lib/algolia/models/search/secured_api_key_restrictions.rb +5 -5
- data/lib/algolia/models/search/semantic_search.rb +2 -2
- data/lib/algolia/models/search/snippet_result_option.rb +2 -2
- data/lib/algolia/models/search/tag_filters.rb +1 -1
- data/lib/algolia/models/search/time_range.rb +2 -2
- data/lib/algolia/models/search/typo_tolerance.rb +1 -1
- data/lib/algolia/models/search/updated_at_response.rb +1 -1
- data/lib/algolia/models/search/updated_at_with_object_id_response.rb +2 -2
- data/lib/algolia/models/search/updated_rule_response.rb +2 -2
- data/lib/algolia/models/search/user_hit.rb +1 -1
- data/lib/algolia/models/search/user_id.rb +1 -1
- data/lib/algolia/models/search/value.rb +1 -1
- data/lib/algolia/version.rb +1 -1
- metadata +7 -2
@@ -6,10 +6,10 @@ require 'time'
|
|
6
6
|
module Algolia
|
7
7
|
module Recommend
|
8
8
|
class ConsequenceParams
|
9
|
-
#
|
9
|
+
# 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.
|
10
10
|
attr_accessor :similar_query
|
11
11
|
|
12
|
-
# [
|
12
|
+
# Filter the search so that only records with matching values are included in the results. These filters are supported: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
|
13
13
|
attr_accessor :filters
|
14
14
|
|
15
15
|
attr_accessor :facet_filters
|
@@ -20,149 +20,143 @@ module Algolia
|
|
20
20
|
|
21
21
|
attr_accessor :tag_filters
|
22
22
|
|
23
|
-
#
|
23
|
+
# 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).
|
24
24
|
attr_accessor :sum_or_filters_scores
|
25
25
|
|
26
|
-
# Restricts a
|
26
|
+
# Restricts a search to a subset of your searchable attributes.
|
27
27
|
attr_accessor :restrict_searchable_attributes
|
28
28
|
|
29
|
-
#
|
29
|
+
# 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).
|
30
30
|
attr_accessor :facets
|
31
31
|
|
32
|
-
#
|
32
|
+
# 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`.
|
33
33
|
attr_accessor :faceting_after_distinct
|
34
34
|
|
35
|
-
# Page
|
35
|
+
# Page of search results to retrieve.
|
36
36
|
attr_accessor :page
|
37
37
|
|
38
|
-
#
|
38
|
+
# Position of the first hit to retrieve.
|
39
39
|
attr_accessor :offset
|
40
40
|
|
41
|
-
#
|
41
|
+
# Number of hits to retrieve (used in combination with `offset`).
|
42
42
|
attr_accessor :length
|
43
43
|
|
44
|
-
#
|
44
|
+
# Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
|
45
45
|
attr_accessor :around_lat_lng
|
46
46
|
|
47
|
-
#
|
47
|
+
# Whether to obtain the coordinates from the request's IP address.
|
48
48
|
attr_accessor :around_lat_lng_via_ip
|
49
49
|
|
50
50
|
attr_accessor :around_radius
|
51
51
|
|
52
52
|
attr_accessor :around_precision
|
53
53
|
|
54
|
-
# Minimum radius (in meters)
|
54
|
+
# Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.
|
55
55
|
attr_accessor :minimum_around_radius
|
56
56
|
|
57
|
-
#
|
57
|
+
# Coordinates for a rectangular area in which to search. Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
|
58
58
|
attr_accessor :inside_bounding_box
|
59
59
|
|
60
|
-
#
|
60
|
+
# 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`.
|
61
61
|
attr_accessor :inside_polygon
|
62
62
|
|
63
|
-
#
|
63
|
+
# 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`.
|
64
64
|
attr_accessor :natural_languages
|
65
65
|
|
66
|
-
# Assigns
|
66
|
+
# 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.
|
67
67
|
attr_accessor :rule_contexts
|
68
68
|
|
69
|
-
#
|
69
|
+
# 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).
|
70
70
|
attr_accessor :personalization_impact
|
71
71
|
|
72
|
-
#
|
72
|
+
# 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/).
|
73
73
|
attr_accessor :user_token
|
74
74
|
|
75
|
-
#
|
75
|
+
# Whether the search response should include detailed ranking information.
|
76
76
|
attr_accessor :get_ranking_info
|
77
77
|
|
78
|
-
#
|
79
|
-
attr_accessor :explain
|
80
|
-
|
81
|
-
# Whether to take into account an index's synonyms for a particular search.
|
78
|
+
# Whether to take into account an index's synonyms for this search.
|
82
79
|
attr_accessor :synonyms
|
83
80
|
|
84
|
-
#
|
81
|
+
# 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/).
|
85
82
|
attr_accessor :click_analytics
|
86
83
|
|
87
|
-
#
|
84
|
+
# Whether this search will be included in Analytics.
|
88
85
|
attr_accessor :analytics
|
89
86
|
|
90
87
|
# Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
91
88
|
attr_accessor :analytics_tags
|
92
89
|
|
93
|
-
# Whether to include
|
90
|
+
# Whether to include this search when calculating processing-time percentiles.
|
94
91
|
attr_accessor :percentile_computation
|
95
92
|
|
96
|
-
#
|
93
|
+
# Whether to enable A/B testing for this search.
|
97
94
|
attr_accessor :enable_ab_test
|
98
95
|
|
99
|
-
# Attributes
|
100
|
-
attr_accessor :attributes_for_faceting
|
101
|
-
|
102
|
-
# Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. By default, the response includes all attributes.
|
96
|
+
# Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
|
103
97
|
attr_accessor :attributes_to_retrieve
|
104
98
|
|
105
|
-
# Determines the order in which Algolia
|
99
|
+
# Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list. **Modifiers** <dl> <dt><code>asc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in ascending order.</dd> <dt><code>desc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in descending order.</dd> </dl> Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
|
106
100
|
attr_accessor :ranking
|
107
101
|
|
108
|
-
#
|
102
|
+
# Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** <dl> <dt><code>asc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in ascending order.</dd> <dt><code>desc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in descending order.</dd> </dl> If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
|
109
103
|
attr_accessor :custom_ranking
|
110
104
|
|
111
|
-
# Relevancy threshold below which less relevant results aren't included in the results.
|
105
|
+
# 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.
|
112
106
|
attr_accessor :relevancy_strictness
|
113
107
|
|
114
|
-
# Attributes to highlight.
|
108
|
+
# Attributes to highlight. By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI. For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).
|
115
109
|
attr_accessor :attributes_to_highlight
|
116
110
|
|
117
|
-
# Attributes to
|
111
|
+
# Attributes for which to enable snippets. Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted.
|
118
112
|
attr_accessor :attributes_to_snippet
|
119
113
|
|
120
|
-
# HTML
|
114
|
+
# HTML tag to insert before the highlighted parts in all highlighted results and snippets.
|
121
115
|
attr_accessor :highlight_pre_tag
|
122
116
|
|
123
|
-
# HTML
|
117
|
+
# HTML tag to insert after the highlighted parts in all highlighted results and snippets.
|
124
118
|
attr_accessor :highlight_post_tag
|
125
119
|
|
126
120
|
# String used as an ellipsis indicator when a snippet is truncated.
|
127
121
|
attr_accessor :snippet_ellipsis_text
|
128
122
|
|
129
|
-
#
|
123
|
+
# Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted.
|
130
124
|
attr_accessor :restrict_highlight_and_snippet_arrays
|
131
125
|
|
132
126
|
# Number of hits per page.
|
133
127
|
attr_accessor :hits_per_page
|
134
128
|
|
135
|
-
# Minimum number of characters a word in the query
|
129
|
+
# Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
|
136
130
|
attr_accessor :min_word_sizefor1_typo
|
137
131
|
|
138
|
-
# Minimum number of characters a word in the query
|
132
|
+
# Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
|
139
133
|
attr_accessor :min_word_sizefor2_typos
|
140
134
|
|
141
135
|
attr_accessor :typo_tolerance
|
142
136
|
|
143
|
-
# Whether to allow typos on numbers
|
137
|
+
# 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.
|
144
138
|
attr_accessor :allow_typos_on_numeric_tokens
|
145
139
|
|
146
|
-
# Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).
|
140
|
+
# Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Returning only exact matches can help when: - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/). - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions. Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
|
147
141
|
attr_accessor :disable_typo_tolerance_on_attributes
|
148
142
|
|
149
143
|
attr_accessor :ignore_plurals
|
150
144
|
|
151
145
|
attr_accessor :remove_stop_words
|
152
146
|
|
153
|
-
# Characters
|
147
|
+
# Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics.
|
154
148
|
attr_accessor :keep_diacritics_on_characters
|
155
149
|
|
156
|
-
#
|
150
|
+
# [ISO code](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) for language-specific settings such as plurals, stop words, and word-detection dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**. **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
|
157
151
|
attr_accessor :query_languages
|
158
152
|
|
159
|
-
#
|
153
|
+
# Whether to split compound words into their building blocks. For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian.
|
160
154
|
attr_accessor :decompound_query
|
161
155
|
|
162
|
-
#
|
156
|
+
# Whether to enable rules.
|
163
157
|
attr_accessor :enable_rules
|
164
158
|
|
165
|
-
#
|
159
|
+
# Whether to enable Personalization.
|
166
160
|
attr_accessor :enable_personalization
|
167
161
|
|
168
162
|
attr_accessor :query_type
|
@@ -173,49 +167,49 @@ module Algolia
|
|
173
167
|
|
174
168
|
attr_accessor :semantic_search
|
175
169
|
|
176
|
-
#
|
170
|
+
# Whether to support phrase matching and excluding words from search queries. Use the `advancedSyntaxFeatures` parameter to control which feature is supported.
|
177
171
|
attr_accessor :advanced_syntax
|
178
172
|
|
179
|
-
# Words
|
173
|
+
# Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words dividied by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
|
180
174
|
attr_accessor :optional_words
|
181
175
|
|
182
|
-
#
|
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). This can be useful for attributes with long values, where the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
|
183
177
|
attr_accessor :disable_exact_on_attributes
|
184
178
|
|
185
179
|
attr_accessor :exact_on_single_word_query
|
186
180
|
|
187
|
-
# Alternatives that should be considered
|
181
|
+
# Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. <dl> <dt><code>ignorePlurals</code></dt> <dd> Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches. </dd> <dt><code>singleWordSynonym</code></dt> <dd> Single-word synonyms, such as \"NY/NYC\" are considered exact matches. </dd> <dt><code>multiWordsSynonym</code></dt> <dd> Multi-word synonyms, such as \"NY/New York\" are considered exact matches. </dd> </dl>.
|
188
182
|
attr_accessor :alternatives_as_exact
|
189
183
|
|
190
|
-
#
|
184
|
+
# Advanced search syntax features you want to support. <dl> <dt><code>exactPhrase</code></dt> <dd> Phrases in quotes must match exactly. For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". </dd> <dt><code>excludeWords</code></dt> <dd> Query words prefixed with a `-` must not occur in a record. For example, `search -engine` matches records that contain \"search\" but not \"engine\". </dd> </dl> This setting only has an effect if `advancedSyntax` is true.
|
191
185
|
attr_accessor :advanced_syntax_features
|
192
186
|
|
193
187
|
attr_accessor :distinct
|
194
188
|
|
195
|
-
# Whether to
|
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 occurences of \"house\" are replaced by \"home\" in the highlighted response.
|
196
190
|
attr_accessor :replace_synonyms_in_highlight
|
197
191
|
|
198
|
-
#
|
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.
|
199
193
|
attr_accessor :min_proximity
|
200
194
|
|
201
|
-
#
|
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 attributes should be included. You can't exclude these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your search UI.
|
202
196
|
attr_accessor :response_fields
|
203
197
|
|
204
|
-
# Maximum number of facet
|
198
|
+
# Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
|
205
199
|
attr_accessor :max_facet_hits
|
206
200
|
|
207
201
|
# Maximum number of facet values to return for each facet.
|
208
202
|
attr_accessor :max_values_per_facet
|
209
203
|
|
210
|
-
#
|
204
|
+
# Order in which to retrieve facet values. <dl> <dt><code>count</code></dt> <dd> Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value. </dd> <dt><code>alpha</code></dt> <dd>Retrieve facet values alphabetically.</dd> </dl> This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
|
211
205
|
attr_accessor :sort_facet_values_by
|
212
206
|
|
213
|
-
#
|
207
|
+
# 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.
|
214
208
|
attr_accessor :attribute_criteria_computed_by_min_proximity
|
215
209
|
|
216
210
|
attr_accessor :rendering_content
|
217
211
|
|
218
|
-
#
|
212
|
+
# 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.
|
219
213
|
attr_accessor :enable_re_ranking
|
220
214
|
|
221
215
|
attr_accessor :re_ranking_apply_filter
|
@@ -276,14 +270,12 @@ module Algolia
|
|
276
270
|
:personalization_impact => :personalizationImpact,
|
277
271
|
:user_token => :userToken,
|
278
272
|
:get_ranking_info => :getRankingInfo,
|
279
|
-
:explain => :explain,
|
280
273
|
:synonyms => :synonyms,
|
281
274
|
:click_analytics => :clickAnalytics,
|
282
275
|
:analytics => :analytics,
|
283
276
|
:analytics_tags => :analyticsTags,
|
284
277
|
:percentile_computation => :percentileComputation,
|
285
278
|
:enable_ab_test => :enableABTest,
|
286
|
-
:attributes_for_faceting => :attributesForFaceting,
|
287
279
|
:attributes_to_retrieve => :attributesToRetrieve,
|
288
280
|
:ranking => :ranking,
|
289
281
|
:custom_ranking => :customRanking,
|
@@ -367,14 +359,12 @@ module Algolia
|
|
367
359
|
:personalization_impact => :Integer,
|
368
360
|
:user_token => :String,
|
369
361
|
:get_ranking_info => :Boolean,
|
370
|
-
:explain => :'Array<String>',
|
371
362
|
:synonyms => :Boolean,
|
372
363
|
:click_analytics => :Boolean,
|
373
364
|
:analytics => :Boolean,
|
374
365
|
:analytics_tags => :'Array<String>',
|
375
366
|
:percentile_computation => :Boolean,
|
376
367
|
:enable_ab_test => :Boolean,
|
377
|
-
:attributes_for_faceting => :'Array<String>',
|
378
368
|
:attributes_to_retrieve => :'Array<String>',
|
379
369
|
:ranking => :'Array<String>',
|
380
370
|
:custom_ranking => :'Array<String>',
|
@@ -570,12 +560,6 @@ module Algolia
|
|
570
560
|
self.get_ranking_info = attributes[:get_ranking_info]
|
571
561
|
end
|
572
562
|
|
573
|
-
if attributes.key?(:explain)
|
574
|
-
if (value = attributes[:explain]).is_a?(Array)
|
575
|
-
self.explain = value
|
576
|
-
end
|
577
|
-
end
|
578
|
-
|
579
563
|
if attributes.key?(:synonyms)
|
580
564
|
self.synonyms = attributes[:synonyms]
|
581
565
|
end
|
@@ -602,12 +586,6 @@ module Algolia
|
|
602
586
|
self.enable_ab_test = attributes[:enable_ab_test]
|
603
587
|
end
|
604
588
|
|
605
|
-
if attributes.key?(:attributes_for_faceting)
|
606
|
-
if (value = attributes[:attributes_for_faceting]).is_a?(Array)
|
607
|
-
self.attributes_for_faceting = value
|
608
|
-
end
|
609
|
-
end
|
610
|
-
|
611
589
|
if attributes.key?(:attributes_to_retrieve)
|
612
590
|
if (value = attributes[:attributes_to_retrieve]).is_a?(Array)
|
613
591
|
self.attributes_to_retrieve = value
|
@@ -821,6 +799,20 @@ module Algolia
|
|
821
799
|
end
|
822
800
|
end
|
823
801
|
|
802
|
+
# Custom attribute writer method with validation
|
803
|
+
# @param [Object] page Value to be assigned
|
804
|
+
def page=(page)
|
805
|
+
if page.nil?
|
806
|
+
raise ArgumentError, 'page cannot be nil'
|
807
|
+
end
|
808
|
+
|
809
|
+
if page < 0
|
810
|
+
raise ArgumentError, 'invalid value for "page", must be greater than or equal to 0.'
|
811
|
+
end
|
812
|
+
|
813
|
+
@page = page
|
814
|
+
end
|
815
|
+
|
824
816
|
# Custom attribute writer method with validation
|
825
817
|
# @param [Object] length Value to be assigned
|
826
818
|
def length=(length)
|
@@ -853,6 +845,24 @@ module Algolia
|
|
853
845
|
@minimum_around_radius = minimum_around_radius
|
854
846
|
end
|
855
847
|
|
848
|
+
# Custom attribute writer method with validation
|
849
|
+
# @param [Object] personalization_impact Value to be assigned
|
850
|
+
def personalization_impact=(personalization_impact)
|
851
|
+
if personalization_impact.nil?
|
852
|
+
raise ArgumentError, 'personalization_impact cannot be nil'
|
853
|
+
end
|
854
|
+
|
855
|
+
if personalization_impact > 100
|
856
|
+
raise ArgumentError, 'invalid value for "personalization_impact", must be smaller than or equal to 100.'
|
857
|
+
end
|
858
|
+
|
859
|
+
if personalization_impact < 0
|
860
|
+
raise ArgumentError, 'invalid value for "personalization_impact", must be greater than or equal to 0.'
|
861
|
+
end
|
862
|
+
|
863
|
+
@personalization_impact = personalization_impact
|
864
|
+
end
|
865
|
+
|
856
866
|
# Custom attribute writer method with validation
|
857
867
|
# @param [Object] hits_per_page Value to be assigned
|
858
868
|
def hits_per_page=(hits_per_page)
|
@@ -903,6 +913,20 @@ module Algolia
|
|
903
913
|
@max_facet_hits = max_facet_hits
|
904
914
|
end
|
905
915
|
|
916
|
+
# Custom attribute writer method with validation
|
917
|
+
# @param [Object] max_values_per_facet Value to be assigned
|
918
|
+
def max_values_per_facet=(max_values_per_facet)
|
919
|
+
if max_values_per_facet.nil?
|
920
|
+
raise ArgumentError, 'max_values_per_facet cannot be nil'
|
921
|
+
end
|
922
|
+
|
923
|
+
if max_values_per_facet > 1000
|
924
|
+
raise ArgumentError, 'invalid value for "max_values_per_facet", must be smaller than or equal to 1000.'
|
925
|
+
end
|
926
|
+
|
927
|
+
@max_values_per_facet = max_values_per_facet
|
928
|
+
end
|
929
|
+
|
906
930
|
# Checks equality by comparing each attribute.
|
907
931
|
# @param [Object] Object to be compared
|
908
932
|
def ==(other)
|
@@ -934,14 +958,12 @@ module Algolia
|
|
934
958
|
personalization_impact == other.personalization_impact &&
|
935
959
|
user_token == other.user_token &&
|
936
960
|
get_ranking_info == other.get_ranking_info &&
|
937
|
-
explain == other.explain &&
|
938
961
|
synonyms == other.synonyms &&
|
939
962
|
click_analytics == other.click_analytics &&
|
940
963
|
analytics == other.analytics &&
|
941
964
|
analytics_tags == other.analytics_tags &&
|
942
965
|
percentile_computation == other.percentile_computation &&
|
943
966
|
enable_ab_test == other.enable_ab_test &&
|
944
|
-
attributes_for_faceting == other.attributes_for_faceting &&
|
945
967
|
attributes_to_retrieve == other.attributes_to_retrieve &&
|
946
968
|
ranking == other.ranking &&
|
947
969
|
custom_ranking == other.custom_ranking &&
|
@@ -1001,7 +1023,7 @@ module Algolia
|
|
1001
1023
|
# @return [Integer] Hash code
|
1002
1024
|
def hash
|
1003
1025
|
[similar_query, filters, facet_filters, optional_filters, numeric_filters, tag_filters, sum_or_filters_scores, restrict_searchable_attributes, facets,
|
1004
|
-
faceting_after_distinct, page, offset, length, around_lat_lng, around_lat_lng_via_ip, around_radius, around_precision, minimum_around_radius, inside_bounding_box, inside_polygon, natural_languages, rule_contexts, personalization_impact, user_token, get_ranking_info,
|
1026
|
+
faceting_after_distinct, page, offset, length, around_lat_lng, around_lat_lng_via_ip, around_radius, around_precision, minimum_around_radius, inside_bounding_box, inside_polygon, natural_languages, rule_contexts, personalization_impact, user_token, get_ranking_info, synonyms, click_analytics, analytics, analytics_tags, percentile_computation, enable_ab_test, attributes_to_retrieve, ranking, custom_ranking, relevancy_strictness, attributes_to_highlight, attributes_to_snippet, highlight_pre_tag, highlight_post_tag, snippet_ellipsis_text, restrict_highlight_and_snippet_arrays, hits_per_page, min_word_sizefor1_typo, min_word_sizefor2_typos, typo_tolerance, allow_typos_on_numeric_tokens, disable_typo_tolerance_on_attributes, ignore_plurals, remove_stop_words, keep_diacritics_on_characters, query_languages, decompound_query, enable_rules, enable_personalization, query_type, remove_words_if_no_results, mode, semantic_search, advanced_syntax, optional_words, disable_exact_on_attributes, exact_on_single_word_query, alternatives_as_exact, advanced_syntax_features, distinct, replace_synonyms_in_highlight, min_proximity, response_fields, max_facet_hits, max_values_per_facet, sort_facet_values_by, attribute_criteria_computed_by_min_proximity, rendering_content, enable_re_ranking, re_ranking_apply_filter, query, automatic_facet_filters, automatic_optional_facet_filters].hash
|
1005
1027
|
end
|
1006
1028
|
|
1007
1029
|
# Builds the object from hash
|
@@ -5,7 +5,7 @@ require 'time'
|
|
5
5
|
|
6
6
|
module Algolia
|
7
7
|
module Recommend
|
8
|
-
#
|
8
|
+
# Replace or edit the search query. If `consequenceQuery` is a string, the entire search query is replaced with that string. If `consequenceQuery` is an object, it describes incremental edits made to the query.
|
9
9
|
module ConsequenceQuery
|
10
10
|
class << self
|
11
11
|
# List of class defined in oneOf (OpenAPI v3)
|
@@ -6,10 +6,10 @@ require 'time'
|
|
6
6
|
module Algolia
|
7
7
|
module Recommend
|
8
8
|
class ConsequenceQueryObject
|
9
|
-
# Words to remove.
|
9
|
+
# Words to remove from the search query.
|
10
10
|
attr_accessor :remove
|
11
11
|
|
12
|
-
#
|
12
|
+
# Changes to make to the search query.
|
13
13
|
attr_accessor :edits
|
14
14
|
|
15
15
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -7,7 +7,7 @@ module Algolia
|
|
7
7
|
module Recommend
|
8
8
|
# Response, taskID, and deletion timestamp.
|
9
9
|
class DeletedAtResponse
|
10
|
-
# Unique identifier of a task.
|
10
|
+
# Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
|
11
11
|
attr_accessor :task_id
|
12
12
|
|
13
13
|
# Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
|
@@ -5,7 +5,7 @@ require 'time'
|
|
5
5
|
|
6
6
|
module Algolia
|
7
7
|
module Recommend
|
8
|
-
#
|
8
|
+
# Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set.
|
9
9
|
module Distinct
|
10
10
|
class << self
|
11
11
|
# List of class defined in oneOf (OpenAPI v3)
|
@@ -11,7 +11,7 @@ module Algolia
|
|
11
11
|
# Text or patterns to remove from the query string.
|
12
12
|
attr_accessor :delete
|
13
13
|
|
14
|
-
# Text
|
14
|
+
# Text to be added in place of the deleted text inside the query string.
|
15
15
|
attr_accessor :insert
|
16
16
|
|
17
17
|
class EnumAttributeValidator
|
@@ -5,7 +5,7 @@ require 'time'
|
|
5
5
|
|
6
6
|
module Algolia
|
7
7
|
module Recommend
|
8
|
-
#
|
8
|
+
# Filter the search by facet values, so that only records with the same facet values are retrieved. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it's best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.
|
9
9
|
module FacetFilters
|
10
10
|
class << self
|
11
11
|
# List of class defined in oneOf (OpenAPI v3)
|
@@ -5,11 +5,11 @@ require 'time'
|
|
5
5
|
|
6
6
|
module Algolia
|
7
7
|
module Recommend
|
8
|
-
#
|
8
|
+
# Order of facet names and facet values in your UI.
|
9
9
|
class FacetOrdering
|
10
10
|
attr_accessor :facets
|
11
11
|
|
12
|
-
#
|
12
|
+
# Order of facet values. One object for each facet.
|
13
13
|
attr_accessor :values
|
14
14
|
|
15
15
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -5,9 +5,9 @@ require 'time'
|
|
5
5
|
|
6
6
|
module Algolia
|
7
7
|
module Recommend
|
8
|
-
#
|
8
|
+
# Order of facet names.
|
9
9
|
class Facets
|
10
|
-
#
|
10
|
+
# Explicit order of facets or facet values. This setting lets you always show specific facets or facet values at the top of the list.
|
11
11
|
attr_accessor :order
|
12
12
|
|
13
13
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -5,14 +5,14 @@ require 'time'
|
|
5
5
|
|
6
6
|
module Algolia
|
7
7
|
module Recommend
|
8
|
-
#
|
8
|
+
# Surround words that match the query with HTML tags for highlighting.
|
9
9
|
class HighlightResultOption
|
10
|
-
#
|
10
|
+
# Highlighted attribute value, including HTML tags.
|
11
11
|
attr_accessor :value
|
12
12
|
|
13
13
|
attr_accessor :match_level
|
14
14
|
|
15
|
-
# List of words from the query
|
15
|
+
# List of matched words from the search query.
|
16
16
|
attr_accessor :matched_words
|
17
17
|
|
18
18
|
# Whether the entire attribute value is highlighted.
|
@@ -5,7 +5,7 @@ require 'time'
|
|
5
5
|
|
6
6
|
module Algolia
|
7
7
|
module Recommend
|
8
|
-
#
|
8
|
+
# Treat singular, plurals, and other forms of declensions as equivalent. You should only use this feature for the languages used in your index.
|
9
9
|
module IgnorePlurals
|
10
10
|
class << self
|
11
11
|
# List of class defined in oneOf (OpenAPI v3)
|