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
@@ -9,13 +9,13 @@ module Algolia
|
|
9
9
|
# Search parameters as a URL-encoded query string.
|
10
10
|
attr_accessor :params
|
11
11
|
|
12
|
-
#
|
12
|
+
# Search query.
|
13
13
|
attr_accessor :query
|
14
14
|
|
15
|
-
#
|
15
|
+
# 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.
|
16
16
|
attr_accessor :similar_query
|
17
17
|
|
18
|
-
# [
|
18
|
+
# 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/).
|
19
19
|
attr_accessor :filters
|
20
20
|
|
21
21
|
attr_accessor :facet_filters
|
@@ -26,149 +26,143 @@ module Algolia
|
|
26
26
|
|
27
27
|
attr_accessor :tag_filters
|
28
28
|
|
29
|
-
#
|
29
|
+
# 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).
|
30
30
|
attr_accessor :sum_or_filters_scores
|
31
31
|
|
32
|
-
# Restricts a
|
32
|
+
# Restricts a search to a subset of your searchable attributes.
|
33
33
|
attr_accessor :restrict_searchable_attributes
|
34
34
|
|
35
|
-
#
|
35
|
+
# 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).
|
36
36
|
attr_accessor :facets
|
37
37
|
|
38
|
-
#
|
38
|
+
# 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`.
|
39
39
|
attr_accessor :faceting_after_distinct
|
40
40
|
|
41
|
-
# Page
|
41
|
+
# Page of search results to retrieve.
|
42
42
|
attr_accessor :page
|
43
43
|
|
44
|
-
#
|
44
|
+
# Position of the first hit to retrieve.
|
45
45
|
attr_accessor :offset
|
46
46
|
|
47
|
-
#
|
47
|
+
# Number of hits to retrieve (used in combination with `offset`).
|
48
48
|
attr_accessor :length
|
49
49
|
|
50
|
-
#
|
50
|
+
# 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`.
|
51
51
|
attr_accessor :around_lat_lng
|
52
52
|
|
53
|
-
#
|
53
|
+
# Whether to obtain the coordinates from the request's IP address.
|
54
54
|
attr_accessor :around_lat_lng_via_ip
|
55
55
|
|
56
56
|
attr_accessor :around_radius
|
57
57
|
|
58
58
|
attr_accessor :around_precision
|
59
59
|
|
60
|
-
# Minimum radius (in meters)
|
60
|
+
# Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.
|
61
61
|
attr_accessor :minimum_around_radius
|
62
62
|
|
63
|
-
#
|
63
|
+
# 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).
|
64
64
|
attr_accessor :inside_bounding_box
|
65
65
|
|
66
|
-
#
|
66
|
+
# 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`.
|
67
67
|
attr_accessor :inside_polygon
|
68
68
|
|
69
|
-
#
|
69
|
+
# 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`.
|
70
70
|
attr_accessor :natural_languages
|
71
71
|
|
72
|
-
# Assigns
|
72
|
+
# 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.
|
73
73
|
attr_accessor :rule_contexts
|
74
74
|
|
75
|
-
#
|
75
|
+
# 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).
|
76
76
|
attr_accessor :personalization_impact
|
77
77
|
|
78
|
-
#
|
78
|
+
# 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/).
|
79
79
|
attr_accessor :user_token
|
80
80
|
|
81
|
-
#
|
81
|
+
# Whether the search response should include detailed ranking information.
|
82
82
|
attr_accessor :get_ranking_info
|
83
83
|
|
84
|
-
#
|
85
|
-
attr_accessor :explain
|
86
|
-
|
87
|
-
# Whether to take into account an index's synonyms for a particular search.
|
84
|
+
# Whether to take into account an index's synonyms for this search.
|
88
85
|
attr_accessor :synonyms
|
89
86
|
|
90
|
-
#
|
87
|
+
# 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/).
|
91
88
|
attr_accessor :click_analytics
|
92
89
|
|
93
|
-
#
|
90
|
+
# Whether this search will be included in Analytics.
|
94
91
|
attr_accessor :analytics
|
95
92
|
|
96
93
|
# Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
97
94
|
attr_accessor :analytics_tags
|
98
95
|
|
99
|
-
# Whether to include
|
96
|
+
# Whether to include this search when calculating processing-time percentiles.
|
100
97
|
attr_accessor :percentile_computation
|
101
98
|
|
102
|
-
#
|
99
|
+
# Whether to enable A/B testing for this search.
|
103
100
|
attr_accessor :enable_ab_test
|
104
101
|
|
105
|
-
# Attributes
|
106
|
-
attr_accessor :attributes_for_faceting
|
107
|
-
|
108
|
-
# 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.
|
102
|
+
# 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.
|
109
103
|
attr_accessor :attributes_to_retrieve
|
110
104
|
|
111
|
-
# Determines the order in which Algolia
|
105
|
+
# 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/).
|
112
106
|
attr_accessor :ranking
|
113
107
|
|
114
|
-
#
|
108
|
+
# 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.
|
115
109
|
attr_accessor :custom_ranking
|
116
110
|
|
117
|
-
# Relevancy threshold below which less relevant results aren't included in the results.
|
111
|
+
# 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.
|
118
112
|
attr_accessor :relevancy_strictness
|
119
113
|
|
120
|
-
# Attributes to highlight.
|
114
|
+
# 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/).
|
121
115
|
attr_accessor :attributes_to_highlight
|
122
116
|
|
123
|
-
# Attributes to
|
117
|
+
# 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.
|
124
118
|
attr_accessor :attributes_to_snippet
|
125
119
|
|
126
|
-
# HTML
|
120
|
+
# HTML tag to insert before the highlighted parts in all highlighted results and snippets.
|
127
121
|
attr_accessor :highlight_pre_tag
|
128
122
|
|
129
|
-
# HTML
|
123
|
+
# HTML tag to insert after the highlighted parts in all highlighted results and snippets.
|
130
124
|
attr_accessor :highlight_post_tag
|
131
125
|
|
132
126
|
# String used as an ellipsis indicator when a snippet is truncated.
|
133
127
|
attr_accessor :snippet_ellipsis_text
|
134
128
|
|
135
|
-
#
|
129
|
+
# Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted.
|
136
130
|
attr_accessor :restrict_highlight_and_snippet_arrays
|
137
131
|
|
138
132
|
# Number of hits per page.
|
139
133
|
attr_accessor :hits_per_page
|
140
134
|
|
141
|
-
# Minimum number of characters a word in the query
|
135
|
+
# 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).
|
142
136
|
attr_accessor :min_word_sizefor1_typo
|
143
137
|
|
144
|
-
# Minimum number of characters a word in the query
|
138
|
+
# 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).
|
145
139
|
attr_accessor :min_word_sizefor2_typos
|
146
140
|
|
147
141
|
attr_accessor :typo_tolerance
|
148
142
|
|
149
|
-
# Whether to allow typos on numbers
|
143
|
+
# 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.
|
150
144
|
attr_accessor :allow_typos_on_numeric_tokens
|
151
145
|
|
152
|
-
# Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).
|
146
|
+
# 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.
|
153
147
|
attr_accessor :disable_typo_tolerance_on_attributes
|
154
148
|
|
155
149
|
attr_accessor :ignore_plurals
|
156
150
|
|
157
151
|
attr_accessor :remove_stop_words
|
158
152
|
|
159
|
-
# Characters
|
153
|
+
# 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.
|
160
154
|
attr_accessor :keep_diacritics_on_characters
|
161
155
|
|
162
|
-
#
|
156
|
+
# [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/).
|
163
157
|
attr_accessor :query_languages
|
164
158
|
|
165
|
-
#
|
159
|
+
# 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.
|
166
160
|
attr_accessor :decompound_query
|
167
161
|
|
168
|
-
#
|
162
|
+
# Whether to enable rules.
|
169
163
|
attr_accessor :enable_rules
|
170
164
|
|
171
|
-
#
|
165
|
+
# Whether to enable Personalization.
|
172
166
|
attr_accessor :enable_personalization
|
173
167
|
|
174
168
|
attr_accessor :query_type
|
@@ -179,49 +173,49 @@ module Algolia
|
|
179
173
|
|
180
174
|
attr_accessor :semantic_search
|
181
175
|
|
182
|
-
#
|
176
|
+
# Whether to support phrase matching and excluding words from search queries. Use the `advancedSyntaxFeatures` parameter to control which feature is supported.
|
183
177
|
attr_accessor :advanced_syntax
|
184
178
|
|
185
|
-
# Words
|
179
|
+
# 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).
|
186
180
|
attr_accessor :optional_words
|
187
181
|
|
188
|
-
#
|
182
|
+
# 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.
|
189
183
|
attr_accessor :disable_exact_on_attributes
|
190
184
|
|
191
185
|
attr_accessor :exact_on_single_word_query
|
192
186
|
|
193
|
-
# Alternatives that should be considered
|
187
|
+
# 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>.
|
194
188
|
attr_accessor :alternatives_as_exact
|
195
189
|
|
196
|
-
#
|
190
|
+
# 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.
|
197
191
|
attr_accessor :advanced_syntax_features
|
198
192
|
|
199
193
|
attr_accessor :distinct
|
200
194
|
|
201
|
-
# Whether to
|
195
|
+
# 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.
|
202
196
|
attr_accessor :replace_synonyms_in_highlight
|
203
197
|
|
204
|
-
#
|
198
|
+
# 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.
|
205
199
|
attr_accessor :min_proximity
|
206
200
|
|
207
|
-
#
|
201
|
+
# 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.
|
208
202
|
attr_accessor :response_fields
|
209
203
|
|
210
|
-
# Maximum number of facet
|
204
|
+
# 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).
|
211
205
|
attr_accessor :max_facet_hits
|
212
206
|
|
213
207
|
# Maximum number of facet values to return for each facet.
|
214
208
|
attr_accessor :max_values_per_facet
|
215
209
|
|
216
|
-
#
|
210
|
+
# 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/).
|
217
211
|
attr_accessor :sort_facet_values_by
|
218
212
|
|
219
|
-
#
|
213
|
+
# 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.
|
220
214
|
attr_accessor :attribute_criteria_computed_by_min_proximity
|
221
215
|
|
222
216
|
attr_accessor :rendering_content
|
223
217
|
|
224
|
-
#
|
218
|
+
# 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.
|
225
219
|
attr_accessor :enable_re_ranking
|
226
220
|
|
227
221
|
attr_accessor :re_ranking_apply_filter
|
@@ -229,7 +223,7 @@ module Algolia
|
|
229
223
|
# Facet name.
|
230
224
|
attr_accessor :facet
|
231
225
|
|
232
|
-
#
|
226
|
+
# Index name.
|
233
227
|
attr_accessor :index_name
|
234
228
|
|
235
229
|
# Text to search inside the facet's values.
|
@@ -289,14 +283,12 @@ module Algolia
|
|
289
283
|
:personalization_impact => :personalizationImpact,
|
290
284
|
:user_token => :userToken,
|
291
285
|
:get_ranking_info => :getRankingInfo,
|
292
|
-
:explain => :explain,
|
293
286
|
:synonyms => :synonyms,
|
294
287
|
:click_analytics => :clickAnalytics,
|
295
288
|
:analytics => :analytics,
|
296
289
|
:analytics_tags => :analyticsTags,
|
297
290
|
:percentile_computation => :percentileComputation,
|
298
291
|
:enable_ab_test => :enableABTest,
|
299
|
-
:attributes_for_faceting => :attributesForFaceting,
|
300
292
|
:attributes_to_retrieve => :attributesToRetrieve,
|
301
293
|
:ranking => :ranking,
|
302
294
|
:custom_ranking => :customRanking,
|
@@ -383,14 +375,12 @@ module Algolia
|
|
383
375
|
:personalization_impact => :Integer,
|
384
376
|
:user_token => :String,
|
385
377
|
:get_ranking_info => :Boolean,
|
386
|
-
:explain => :'Array<String>',
|
387
378
|
:synonyms => :Boolean,
|
388
379
|
:click_analytics => :Boolean,
|
389
380
|
:analytics => :Boolean,
|
390
381
|
:analytics_tags => :'Array<String>',
|
391
382
|
:percentile_computation => :Boolean,
|
392
383
|
:enable_ab_test => :Boolean,
|
393
|
-
:attributes_for_faceting => :'Array<String>',
|
394
384
|
:attributes_to_retrieve => :'Array<String>',
|
395
385
|
:ranking => :'Array<String>',
|
396
386
|
:custom_ranking => :'Array<String>',
|
@@ -594,12 +584,6 @@ module Algolia
|
|
594
584
|
self.get_ranking_info = attributes[:get_ranking_info]
|
595
585
|
end
|
596
586
|
|
597
|
-
if attributes.key?(:explain)
|
598
|
-
if (value = attributes[:explain]).is_a?(Array)
|
599
|
-
self.explain = value
|
600
|
-
end
|
601
|
-
end
|
602
|
-
|
603
587
|
if attributes.key?(:synonyms)
|
604
588
|
self.synonyms = attributes[:synonyms]
|
605
589
|
end
|
@@ -626,12 +610,6 @@ module Algolia
|
|
626
610
|
self.enable_ab_test = attributes[:enable_ab_test]
|
627
611
|
end
|
628
612
|
|
629
|
-
if attributes.key?(:attributes_for_faceting)
|
630
|
-
if (value = attributes[:attributes_for_faceting]).is_a?(Array)
|
631
|
-
self.attributes_for_faceting = value
|
632
|
-
end
|
633
|
-
end
|
634
|
-
|
635
613
|
if attributes.key?(:attributes_to_retrieve)
|
636
614
|
if (value = attributes[:attributes_to_retrieve]).is_a?(Array)
|
637
615
|
self.attributes_to_retrieve = value
|
@@ -855,6 +833,20 @@ module Algolia
|
|
855
833
|
end
|
856
834
|
end
|
857
835
|
|
836
|
+
# Custom attribute writer method with validation
|
837
|
+
# @param [Object] page Value to be assigned
|
838
|
+
def page=(page)
|
839
|
+
if page.nil?
|
840
|
+
raise ArgumentError, 'page cannot be nil'
|
841
|
+
end
|
842
|
+
|
843
|
+
if page < 0
|
844
|
+
raise ArgumentError, 'invalid value for "page", must be greater than or equal to 0.'
|
845
|
+
end
|
846
|
+
|
847
|
+
@page = page
|
848
|
+
end
|
849
|
+
|
858
850
|
# Custom attribute writer method with validation
|
859
851
|
# @param [Object] length Value to be assigned
|
860
852
|
def length=(length)
|
@@ -887,6 +879,24 @@ module Algolia
|
|
887
879
|
@minimum_around_radius = minimum_around_radius
|
888
880
|
end
|
889
881
|
|
882
|
+
# Custom attribute writer method with validation
|
883
|
+
# @param [Object] personalization_impact Value to be assigned
|
884
|
+
def personalization_impact=(personalization_impact)
|
885
|
+
if personalization_impact.nil?
|
886
|
+
raise ArgumentError, 'personalization_impact cannot be nil'
|
887
|
+
end
|
888
|
+
|
889
|
+
if personalization_impact > 100
|
890
|
+
raise ArgumentError, 'invalid value for "personalization_impact", must be smaller than or equal to 100.'
|
891
|
+
end
|
892
|
+
|
893
|
+
if personalization_impact < 0
|
894
|
+
raise ArgumentError, 'invalid value for "personalization_impact", must be greater than or equal to 0.'
|
895
|
+
end
|
896
|
+
|
897
|
+
@personalization_impact = personalization_impact
|
898
|
+
end
|
899
|
+
|
890
900
|
# Custom attribute writer method with validation
|
891
901
|
# @param [Object] hits_per_page Value to be assigned
|
892
902
|
def hits_per_page=(hits_per_page)
|
@@ -937,6 +947,20 @@ module Algolia
|
|
937
947
|
@max_facet_hits = max_facet_hits
|
938
948
|
end
|
939
949
|
|
950
|
+
# Custom attribute writer method with validation
|
951
|
+
# @param [Object] max_values_per_facet Value to be assigned
|
952
|
+
def max_values_per_facet=(max_values_per_facet)
|
953
|
+
if max_values_per_facet.nil?
|
954
|
+
raise ArgumentError, 'max_values_per_facet cannot be nil'
|
955
|
+
end
|
956
|
+
|
957
|
+
if max_values_per_facet > 1000
|
958
|
+
raise ArgumentError, 'invalid value for "max_values_per_facet", must be smaller than or equal to 1000.'
|
959
|
+
end
|
960
|
+
|
961
|
+
@max_values_per_facet = max_values_per_facet
|
962
|
+
end
|
963
|
+
|
940
964
|
# Checks equality by comparing each attribute.
|
941
965
|
# @param [Object] Object to be compared
|
942
966
|
def ==(other)
|
@@ -970,14 +994,12 @@ module Algolia
|
|
970
994
|
personalization_impact == other.personalization_impact &&
|
971
995
|
user_token == other.user_token &&
|
972
996
|
get_ranking_info == other.get_ranking_info &&
|
973
|
-
explain == other.explain &&
|
974
997
|
synonyms == other.synonyms &&
|
975
998
|
click_analytics == other.click_analytics &&
|
976
999
|
analytics == other.analytics &&
|
977
1000
|
analytics_tags == other.analytics_tags &&
|
978
1001
|
percentile_computation == other.percentile_computation &&
|
979
1002
|
enable_ab_test == other.enable_ab_test &&
|
980
|
-
attributes_for_faceting == other.attributes_for_faceting &&
|
981
1003
|
attributes_to_retrieve == other.attributes_to_retrieve &&
|
982
1004
|
ranking == other.ranking &&
|
983
1005
|
custom_ranking == other.custom_ranking &&
|
@@ -1038,7 +1060,7 @@ module Algolia
|
|
1038
1060
|
# @return [Integer] Hash code
|
1039
1061
|
def hash
|
1040
1062
|
[params, query, similar_query, filters, facet_filters, optional_filters, numeric_filters, tag_filters, sum_or_filters_scores, restrict_searchable_attributes, facets,
|
1041
|
-
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,
|
1063
|
+
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, facet, index_name, facet_query, type].hash
|
1042
1064
|
end
|
1043
1065
|
|
1044
1066
|
# Builds the object from hash
|
@@ -9,13 +9,13 @@ module Algolia
|
|
9
9
|
# Facet name.
|
10
10
|
attr_accessor :facet
|
11
11
|
|
12
|
-
#
|
12
|
+
# Index name.
|
13
13
|
attr_accessor :index_name
|
14
14
|
|
15
15
|
# Text to search inside the facet's values.
|
16
16
|
attr_accessor :facet_query
|
17
17
|
|
18
|
-
# Maximum number of facet
|
18
|
+
# 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).
|
19
19
|
attr_accessor :max_facet_hits
|
20
20
|
|
21
21
|
attr_accessor :type
|