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 Search
|
8
8
|
class BaseSearchParamsWithoutQuery
|
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,80 +20,77 @@ 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
96
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -124,7 +121,6 @@ module Algolia
|
|
124
121
|
:personalization_impact => :personalizationImpact,
|
125
122
|
:user_token => :userToken,
|
126
123
|
:get_ranking_info => :getRankingInfo,
|
127
|
-
:explain => :explain,
|
128
124
|
:synonyms => :synonyms,
|
129
125
|
:click_analytics => :clickAnalytics,
|
130
126
|
:analytics => :analytics,
|
@@ -167,7 +163,6 @@ module Algolia
|
|
167
163
|
:personalization_impact => :Integer,
|
168
164
|
:user_token => :String,
|
169
165
|
:get_ranking_info => :Boolean,
|
170
|
-
:explain => :'Array<String>',
|
171
166
|
:synonyms => :Boolean,
|
172
167
|
:click_analytics => :Boolean,
|
173
168
|
:analytics => :Boolean,
|
@@ -311,12 +306,6 @@ module Algolia
|
|
311
306
|
self.get_ranking_info = attributes[:get_ranking_info]
|
312
307
|
end
|
313
308
|
|
314
|
-
if attributes.key?(:explain)
|
315
|
-
if (value = attributes[:explain]).is_a?(Array)
|
316
|
-
self.explain = value
|
317
|
-
end
|
318
|
-
end
|
319
|
-
|
320
309
|
if attributes.key?(:synonyms)
|
321
310
|
self.synonyms = attributes[:synonyms]
|
322
311
|
end
|
@@ -344,6 +333,20 @@ module Algolia
|
|
344
333
|
end
|
345
334
|
end
|
346
335
|
|
336
|
+
# Custom attribute writer method with validation
|
337
|
+
# @param [Object] page Value to be assigned
|
338
|
+
def page=(page)
|
339
|
+
if page.nil?
|
340
|
+
raise ArgumentError, 'page cannot be nil'
|
341
|
+
end
|
342
|
+
|
343
|
+
if page < 0
|
344
|
+
raise ArgumentError, 'invalid value for "page", must be greater than or equal to 0.'
|
345
|
+
end
|
346
|
+
|
347
|
+
@page = page
|
348
|
+
end
|
349
|
+
|
347
350
|
# Custom attribute writer method with validation
|
348
351
|
# @param [Object] length Value to be assigned
|
349
352
|
def length=(length)
|
@@ -376,6 +379,24 @@ module Algolia
|
|
376
379
|
@minimum_around_radius = minimum_around_radius
|
377
380
|
end
|
378
381
|
|
382
|
+
# Custom attribute writer method with validation
|
383
|
+
# @param [Object] personalization_impact Value to be assigned
|
384
|
+
def personalization_impact=(personalization_impact)
|
385
|
+
if personalization_impact.nil?
|
386
|
+
raise ArgumentError, 'personalization_impact cannot be nil'
|
387
|
+
end
|
388
|
+
|
389
|
+
if personalization_impact > 100
|
390
|
+
raise ArgumentError, 'invalid value for "personalization_impact", must be smaller than or equal to 100.'
|
391
|
+
end
|
392
|
+
|
393
|
+
if personalization_impact < 0
|
394
|
+
raise ArgumentError, 'invalid value for "personalization_impact", must be greater than or equal to 0.'
|
395
|
+
end
|
396
|
+
|
397
|
+
@personalization_impact = personalization_impact
|
398
|
+
end
|
399
|
+
|
379
400
|
# Checks equality by comparing each attribute.
|
380
401
|
# @param [Object] Object to be compared
|
381
402
|
def ==(other)
|
@@ -407,7 +428,6 @@ module Algolia
|
|
407
428
|
personalization_impact == other.personalization_impact &&
|
408
429
|
user_token == other.user_token &&
|
409
430
|
get_ranking_info == other.get_ranking_info &&
|
410
|
-
explain == other.explain &&
|
411
431
|
synonyms == other.synonyms &&
|
412
432
|
click_analytics == other.click_analytics &&
|
413
433
|
analytics == other.analytics &&
|
@@ -426,7 +446,7 @@ module Algolia
|
|
426
446
|
# @return [Integer] Hash code
|
427
447
|
def hash
|
428
448
|
[similar_query, filters, facet_filters, optional_filters, numeric_filters, tag_filters, sum_or_filters_scores, restrict_searchable_attributes, facets,
|
429
|
-
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,
|
449
|
+
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].hash
|
430
450
|
end
|
431
451
|
|
432
452
|
# Builds the object from hash
|
@@ -15,7 +15,7 @@ module Algolia
|
|
15
15
|
# Computed geographical location.
|
16
16
|
attr_accessor :around_lat_lng
|
17
17
|
|
18
|
-
#
|
18
|
+
# Distance from a central coordinate provided by `aroundLatLng`.
|
19
19
|
attr_accessor :automatic_radius
|
20
20
|
|
21
21
|
attr_accessor :exhaustive
|
@@ -29,7 +29,7 @@ module Algolia
|
|
29
29
|
# See the `typo` field of the `exhaustive` object in the response.
|
30
30
|
attr_accessor :exhaustive_typo
|
31
31
|
|
32
|
-
#
|
32
|
+
# Facet counts.
|
33
33
|
attr_accessor :facets
|
34
34
|
|
35
35
|
# Statistics for numerical facets.
|
@@ -47,16 +47,16 @@ module Algolia
|
|
47
47
|
# Warnings about the query.
|
48
48
|
attr_accessor :message
|
49
49
|
|
50
|
-
# Number of hits
|
50
|
+
# Number of results (hits).
|
51
51
|
attr_accessor :nb_hits
|
52
52
|
|
53
|
-
# Number of pages of results
|
53
|
+
# Number of pages of results.
|
54
54
|
attr_accessor :nb_pages
|
55
55
|
|
56
56
|
# Number of hits selected and sorted by the relevant sort algorithm.
|
57
57
|
attr_accessor :nb_sorted_hits
|
58
58
|
|
59
|
-
# Page
|
59
|
+
# Page of search results to retrieve.
|
60
60
|
attr_accessor :page
|
61
61
|
|
62
62
|
# Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
|
@@ -81,7 +81,7 @@ module Algolia
|
|
81
81
|
# Host name of the server that processed the request.
|
82
82
|
attr_accessor :server_used
|
83
83
|
|
84
|
-
#
|
84
|
+
# An object with custom data. You can store up to 32 kB as custom data.
|
85
85
|
attr_accessor :user_data
|
86
86
|
|
87
87
|
# Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
|
@@ -354,6 +354,20 @@ module Algolia
|
|
354
354
|
@hits_per_page = hits_per_page
|
355
355
|
end
|
356
356
|
|
357
|
+
# Custom attribute writer method with validation
|
358
|
+
# @param [Object] page Value to be assigned
|
359
|
+
def page=(page)
|
360
|
+
if page.nil?
|
361
|
+
raise ArgumentError, 'page cannot be nil'
|
362
|
+
end
|
363
|
+
|
364
|
+
if page < 0
|
365
|
+
raise ArgumentError, 'invalid value for "page", must be greater than or equal to 0.'
|
366
|
+
end
|
367
|
+
|
368
|
+
@page = page
|
369
|
+
end
|
370
|
+
|
357
371
|
# Checks equality by comparing each attribute.
|
358
372
|
# @param [Object] Object to be compared
|
359
373
|
def ==(other)
|
@@ -5,12 +5,12 @@ require 'time'
|
|
5
5
|
|
6
6
|
module Algolia
|
7
7
|
module Search
|
8
|
-
#
|
8
|
+
# Request body for updating dictionary entries.
|
9
9
|
class BatchDictionaryEntriesParams
|
10
|
-
#
|
10
|
+
# Whether to replace all custom entries in the dictionary with the ones sent with this request.
|
11
11
|
attr_accessor :clear_existing_dictionary_entries
|
12
12
|
|
13
|
-
#
|
13
|
+
# List of additions and deletions to your dictionaries.
|
14
14
|
attr_accessor :requests
|
15
15
|
|
16
16
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -6,10 +6,10 @@ require 'time'
|
|
6
6
|
module Algolia
|
7
7
|
module Search
|
8
8
|
class BatchResponse
|
9
|
-
# Unique identifier of a task.
|
9
|
+
# 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`.
|
10
10
|
attr_accessor :task_id
|
11
11
|
|
12
|
-
# Unique
|
12
|
+
# Unique record identifiers.
|
13
13
|
attr_accessor :object_ids
|
14
14
|
|
15
15
|
# Attribute mapping from ruby-style variable name to JSON key.
|