algolia 3.27.0 → 3.28.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (582) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/do-not-edit-this-repository.yml +1 -1
  3. data/.github/workflows/release.yml +2 -2
  4. data/CHANGELOG.md +7 -0
  5. data/Gemfile.lock +11 -11
  6. data/lib/algolia/api/abtesting_client.rb +13 -13
  7. data/lib/algolia/api/abtesting_v3_client.rb +13 -13
  8. data/lib/algolia/api/analytics_client.rb +69 -69
  9. data/lib/algolia/api/composition_client.rb +17 -17
  10. data/lib/algolia/api/ingestion_client.rb +15 -15
  11. data/lib/algolia/api/insights_client.rb +13 -13
  12. data/lib/algolia/api/monitoring_client.rb +12 -12
  13. data/lib/algolia/api/personalization_client.rb +13 -13
  14. data/lib/algolia/api/query_suggestions_client.rb +13 -13
  15. data/lib/algolia/api/recommend_client.rb +13 -13
  16. data/lib/algolia/api/search_client.rb +41 -41
  17. data/lib/algolia/models/abtesting/ab_test.rb +0 -2
  18. data/lib/algolia/models/abtesting/ab_test_configuration.rb +0 -2
  19. data/lib/algolia/models/abtesting/ab_test_response.rb +1 -3
  20. data/lib/algolia/models/abtesting/ab_tests_variant.rb +0 -2
  21. data/lib/algolia/models/abtesting/ab_tests_variant_search_params.rb +0 -2
  22. data/lib/algolia/models/abtesting/add_ab_tests_request.rb +0 -2
  23. data/lib/algolia/models/abtesting/add_ab_tests_variant.rb +0 -1
  24. data/lib/algolia/models/abtesting/currency.rb +0 -2
  25. data/lib/algolia/models/abtesting/empty_search.rb +0 -2
  26. data/lib/algolia/models/abtesting/empty_search_filter.rb +0 -2
  27. data/lib/algolia/models/abtesting/error_base.rb +0 -2
  28. data/lib/algolia/models/abtesting/estimate_ab_test_request.rb +0 -2
  29. data/lib/algolia/models/abtesting/estimate_ab_test_response.rb +0 -2
  30. data/lib/algolia/models/abtesting/estimate_configuration.rb +0 -2
  31. data/lib/algolia/models/abtesting/filter_effects.rb +0 -2
  32. data/lib/algolia/models/abtesting/list_ab_tests_response.rb +0 -2
  33. data/lib/algolia/models/abtesting/minimum_detectable_effect.rb +0 -2
  34. data/lib/algolia/models/abtesting/outliers.rb +0 -2
  35. data/lib/algolia/models/abtesting/outliers_filter.rb +0 -2
  36. data/lib/algolia/models/abtesting/schedule_ab_test_response.rb +0 -2
  37. data/lib/algolia/models/abtesting/schedule_ab_tests_request.rb +0 -2
  38. data/lib/algolia/models/abtesting/variant.rb +0 -2
  39. data/lib/algolia/models/abtesting-v3/ab_test.rb +0 -2
  40. data/lib/algolia/models/abtesting-v3/ab_test_configuration.rb +0 -2
  41. data/lib/algolia/models/abtesting-v3/ab_test_response.rb +1 -3
  42. data/lib/algolia/models/abtesting-v3/ab_tests_variant.rb +0 -2
  43. data/lib/algolia/models/abtesting-v3/ab_tests_variant_search_params.rb +0 -2
  44. data/lib/algolia/models/abtesting-v3/add_ab_tests_request.rb +0 -2
  45. data/lib/algolia/models/abtesting-v3/add_ab_tests_variant.rb +0 -1
  46. data/lib/algolia/models/abtesting-v3/create_metric.rb +0 -2
  47. data/lib/algolia/models/abtesting-v3/empty_search_filter.rb +0 -2
  48. data/lib/algolia/models/abtesting-v3/error_base.rb +0 -2
  49. data/lib/algolia/models/abtesting-v3/estimate_ab_test_request.rb +0 -2
  50. data/lib/algolia/models/abtesting-v3/estimate_ab_test_response.rb +0 -2
  51. data/lib/algolia/models/abtesting-v3/estimate_configuration.rb +0 -2
  52. data/lib/algolia/models/abtesting-v3/filter_effects.rb +0 -2
  53. data/lib/algolia/models/abtesting-v3/list_ab_tests_response.rb +0 -2
  54. data/lib/algolia/models/abtesting-v3/metric_date.rb +0 -2
  55. data/lib/algolia/models/abtesting-v3/metric_metadata.rb +0 -2
  56. data/lib/algolia/models/abtesting-v3/metric_result.rb +0 -2
  57. data/lib/algolia/models/abtesting-v3/metrics_filter.rb +0 -2
  58. data/lib/algolia/models/abtesting-v3/minimum_detectable_effect.rb +0 -2
  59. data/lib/algolia/models/abtesting-v3/outliers_filter.rb +0 -2
  60. data/lib/algolia/models/abtesting-v3/schedule_ab_test_response.rb +0 -2
  61. data/lib/algolia/models/abtesting-v3/schedule_ab_tests_request.rb +0 -2
  62. data/lib/algolia/models/abtesting-v3/timeseries.rb +0 -2
  63. data/lib/algolia/models/abtesting-v3/timeseries_variant.rb +0 -2
  64. data/lib/algolia/models/abtesting-v3/variant.rb +0 -2
  65. data/lib/algolia/models/abtesting-v3/variant_metadata.rb +0 -2
  66. data/lib/algolia/models/analytics/click_position.rb +0 -2
  67. data/lib/algolia/models/analytics/currency_code.rb +0 -2
  68. data/lib/algolia/models/analytics/daily_add_to_cart_rates.rb +0 -2
  69. data/lib/algolia/models/analytics/daily_average_clicks.rb +0 -2
  70. data/lib/algolia/models/analytics/daily_click_through_rates.rb +0 -2
  71. data/lib/algolia/models/analytics/daily_conversion_rates.rb +0 -2
  72. data/lib/algolia/models/analytics/daily_no_click_rates.rb +0 -2
  73. data/lib/algolia/models/analytics/daily_no_results_rates.rb +0 -2
  74. data/lib/algolia/models/analytics/daily_purchase_rates.rb +0 -2
  75. data/lib/algolia/models/analytics/daily_revenue.rb +0 -2
  76. data/lib/algolia/models/analytics/daily_searches.rb +0 -2
  77. data/lib/algolia/models/analytics/daily_searches_no_clicks.rb +0 -2
  78. data/lib/algolia/models/analytics/daily_searches_no_results.rb +0 -2
  79. data/lib/algolia/models/analytics/daily_users.rb +0 -2
  80. data/lib/algolia/models/analytics/error_base.rb +0 -2
  81. data/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb +0 -2
  82. data/lib/algolia/models/analytics/get_average_click_position_response.rb +0 -2
  83. data/lib/algolia/models/analytics/get_click_positions_response.rb +0 -2
  84. data/lib/algolia/models/analytics/get_click_through_rate_response.rb +0 -2
  85. data/lib/algolia/models/analytics/get_conversion_rate_response.rb +0 -2
  86. data/lib/algolia/models/analytics/get_no_click_rate_response.rb +0 -2
  87. data/lib/algolia/models/analytics/get_no_results_rate_response.rb +0 -2
  88. data/lib/algolia/models/analytics/get_purchase_rate_response.rb +0 -2
  89. data/lib/algolia/models/analytics/get_revenue.rb +0 -2
  90. data/lib/algolia/models/analytics/get_searches_count_response.rb +0 -2
  91. data/lib/algolia/models/analytics/get_searches_no_clicks_response.rb +0 -2
  92. data/lib/algolia/models/analytics/get_searches_no_results_response.rb +0 -2
  93. data/lib/algolia/models/analytics/get_status_response.rb +0 -2
  94. data/lib/algolia/models/analytics/get_top_countries_response.rb +0 -2
  95. data/lib/algolia/models/analytics/get_top_filter_attribute.rb +0 -2
  96. data/lib/algolia/models/analytics/get_top_filter_attributes_response.rb +0 -2
  97. data/lib/algolia/models/analytics/get_top_filter_for_attribute.rb +0 -2
  98. data/lib/algolia/models/analytics/get_top_filter_for_attribute_response.rb +0 -2
  99. data/lib/algolia/models/analytics/get_top_filters_no_results_response.rb +0 -2
  100. data/lib/algolia/models/analytics/get_top_filters_no_results_value.rb +0 -2
  101. data/lib/algolia/models/analytics/get_top_filters_no_results_values.rb +0 -2
  102. data/lib/algolia/models/analytics/get_top_hits_response.rb +0 -1
  103. data/lib/algolia/models/analytics/get_top_searches_response.rb +0 -1
  104. data/lib/algolia/models/analytics/get_users_count_response.rb +0 -2
  105. data/lib/algolia/models/analytics/top_country.rb +0 -2
  106. data/lib/algolia/models/analytics/top_hit.rb +0 -2
  107. data/lib/algolia/models/analytics/top_hit_with_analytics.rb +0 -2
  108. data/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb +0 -2
  109. data/lib/algolia/models/analytics/top_hits_response.rb +0 -2
  110. data/lib/algolia/models/analytics/top_hits_response_with_analytics.rb +0 -2
  111. data/lib/algolia/models/analytics/top_hits_response_with_revenue_analytics.rb +0 -2
  112. data/lib/algolia/models/analytics/top_search.rb +0 -2
  113. data/lib/algolia/models/analytics/top_search_with_analytics.rb +0 -2
  114. data/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb +0 -2
  115. data/lib/algolia/models/analytics/top_searches_response.rb +0 -2
  116. data/lib/algolia/models/analytics/top_searches_response_with_analytics.rb +0 -2
  117. data/lib/algolia/models/analytics/top_searches_response_with_revenue_analytics.rb +0 -2
  118. data/lib/algolia/models/composition/around_precision.rb +0 -1
  119. data/lib/algolia/models/composition/around_radius.rb +0 -1
  120. data/lib/algolia/models/composition/banner.rb +0 -2
  121. data/lib/algolia/models/composition/banner_image.rb +0 -2
  122. data/lib/algolia/models/composition/banner_image_url.rb +0 -2
  123. data/lib/algolia/models/composition/banner_link.rb +0 -2
  124. data/lib/algolia/models/composition/base_injection_query_parameters.rb +6 -8
  125. data/lib/algolia/models/composition/batch_composition_action.rb +0 -1
  126. data/lib/algolia/models/composition/batch_params.rb +0 -2
  127. data/lib/algolia/models/composition/composition.rb +0 -2
  128. data/lib/algolia/models/composition/composition_behavior.rb +0 -2
  129. data/lib/algolia/models/composition/composition_id_ranking_info.rb +0 -2
  130. data/lib/algolia/models/composition/composition_rule.rb +0 -2
  131. data/lib/algolia/models/composition/composition_rule_consequence.rb +0 -2
  132. data/lib/algolia/models/composition/composition_rules_batch_params.rb +0 -2
  133. data/lib/algolia/models/composition/composition_run_applied_rules.rb +0 -2
  134. data/lib/algolia/models/composition/composition_run_search_response.rb +0 -2
  135. data/lib/algolia/models/composition/composition_source.rb +0 -2
  136. data/lib/algolia/models/composition/composition_source_search.rb +0 -2
  137. data/lib/algolia/models/composition/compositions_search_response.rb +0 -2
  138. data/lib/algolia/models/composition/condition.rb +0 -2
  139. data/lib/algolia/models/composition/dedup_positioning.rb +34 -0
  140. data/lib/algolia/models/composition/deduplication.rb +209 -0
  141. data/lib/algolia/models/composition/delete_composition_action.rb +0 -2
  142. data/lib/algolia/models/composition/delete_composition_rule_action.rb +0 -2
  143. data/lib/algolia/models/composition/distinct.rb +0 -1
  144. data/lib/algolia/models/composition/error_base.rb +0 -2
  145. data/lib/algolia/models/composition/exhaustive.rb +0 -2
  146. data/lib/algolia/models/composition/external.rb +0 -2
  147. data/lib/algolia/models/composition/external_injected_item.rb +0 -2
  148. data/lib/algolia/models/composition/external_injection.rb +0 -2
  149. data/lib/algolia/models/composition/external_source.rb +0 -2
  150. data/lib/algolia/models/composition/facet_filters.rb +0 -1
  151. data/lib/algolia/models/composition/facet_hits.rb +0 -2
  152. data/lib/algolia/models/composition/facet_ordering.rb +0 -2
  153. data/lib/algolia/models/composition/facet_stats.rb +0 -2
  154. data/lib/algolia/models/composition/facets.rb +0 -2
  155. data/lib/algolia/models/composition/get_task_response.rb +0 -2
  156. data/lib/algolia/models/composition/highlight_result.rb +0 -1
  157. data/lib/algolia/models/composition/highlight_result_option.rb +0 -2
  158. data/lib/algolia/models/composition/hit.rb +0 -2
  159. data/lib/algolia/models/composition/hit_metadata.rb +0 -2
  160. data/lib/algolia/models/composition/hit_ranking_info.rb +0 -2
  161. data/lib/algolia/models/composition/ignore_plurals.rb +0 -1
  162. data/lib/algolia/models/composition/injected_item.rb +0 -2
  163. data/lib/algolia/models/composition/injected_item_hits_metadata.rb +0 -2
  164. data/lib/algolia/models/composition/injected_item_metadata.rb +0 -2
  165. data/lib/algolia/models/composition/injected_item_source.rb +0 -1
  166. data/lib/algolia/models/composition/injection.rb +13 -6
  167. data/lib/algolia/models/composition/inside_bounding_box.rb +0 -1
  168. data/lib/algolia/models/composition/list_compositions_response.rb +0 -2
  169. data/lib/algolia/models/composition/main.rb +0 -2
  170. data/lib/algolia/models/composition/main_injection_query_parameters.rb +7 -9
  171. data/lib/algolia/models/composition/matched_geo_location.rb +0 -2
  172. data/lib/algolia/models/composition/multiple_batch_request.rb +0 -2
  173. data/lib/algolia/models/composition/multiple_batch_response.rb +0 -2
  174. data/lib/algolia/models/composition/numeric_filters.rb +0 -1
  175. data/lib/algolia/models/composition/optional_filters.rb +1 -2
  176. data/lib/algolia/models/composition/optional_words.rb +0 -1
  177. data/lib/algolia/models/composition/params.rb +6 -8
  178. data/lib/algolia/models/composition/personalization.rb +0 -2
  179. data/lib/algolia/models/composition/range.rb +0 -2
  180. data/lib/algolia/models/composition/redirect.rb +1 -3
  181. data/lib/algolia/models/composition/redirect_rule_index_data.rb +0 -2
  182. data/lib/algolia/models/composition/redirect_rule_index_metadata.rb +0 -2
  183. data/lib/algolia/models/composition/redirect_url.rb +0 -2
  184. data/lib/algolia/models/composition/remove_stop_words.rb +0 -1
  185. data/lib/algolia/models/composition/rendering_content.rb +0 -2
  186. data/lib/algolia/models/composition/request_body.rb +0 -2
  187. data/lib/algolia/models/composition/results_composition_info_response.rb +0 -2
  188. data/lib/algolia/models/composition/results_injected_item_applied_rules_info_response.rb +0 -2
  189. data/lib/algolia/models/composition/results_injected_item_info_response.rb +0 -2
  190. data/lib/algolia/models/composition/rules_batch_composition_action.rb +0 -1
  191. data/lib/algolia/models/composition/rules_multiple_batch_request.rb +0 -2
  192. data/lib/algolia/models/composition/rules_multiple_batch_response.rb +1 -3
  193. data/lib/algolia/models/composition/search.rb +0 -2
  194. data/lib/algolia/models/composition/search_composition_rules_params.rb +2 -4
  195. data/lib/algolia/models/composition/search_composition_rules_response.rb +0 -2
  196. data/lib/algolia/models/composition/search_for_facet_values_params.rb +0 -2
  197. data/lib/algolia/models/composition/search_for_facet_values_request.rb +0 -2
  198. data/lib/algolia/models/composition/search_for_facet_values_response.rb +0 -2
  199. data/lib/algolia/models/composition/search_for_facet_values_results.rb +0 -2
  200. data/lib/algolia/models/composition/search_response.rb +0 -2
  201. data/lib/algolia/models/composition/search_results_item.rb +1 -3
  202. data/lib/algolia/models/composition/search_source.rb +0 -2
  203. data/lib/algolia/models/composition/snippet_result.rb +0 -1
  204. data/lib/algolia/models/composition/snippet_result_option.rb +0 -2
  205. data/lib/algolia/models/composition/task_id_response.rb +1 -3
  206. data/lib/algolia/models/composition/time_range.rb +0 -2
  207. data/lib/algolia/models/composition/typo_tolerance.rb +1 -2
  208. data/lib/algolia/models/composition/value.rb +0 -2
  209. data/lib/algolia/models/composition/widgets.rb +0 -2
  210. data/lib/algolia/models/ingestion/auth_algolia.rb +0 -2
  211. data/lib/algolia/models/ingestion/auth_algolia_insights.rb +0 -2
  212. data/lib/algolia/models/ingestion/auth_algolia_insights_partial.rb +0 -2
  213. data/lib/algolia/models/ingestion/auth_algolia_partial.rb +0 -2
  214. data/lib/algolia/models/ingestion/auth_api_key.rb +0 -2
  215. data/lib/algolia/models/ingestion/auth_api_key_partial.rb +0 -2
  216. data/lib/algolia/models/ingestion/auth_basic.rb +0 -2
  217. data/lib/algolia/models/ingestion/auth_basic_partial.rb +0 -2
  218. data/lib/algolia/models/ingestion/auth_google_service_account.rb +0 -2
  219. data/lib/algolia/models/ingestion/auth_google_service_account_partial.rb +0 -2
  220. data/lib/algolia/models/ingestion/auth_input.rb +0 -1
  221. data/lib/algolia/models/ingestion/auth_input_partial.rb +0 -1
  222. data/lib/algolia/models/ingestion/auth_o_auth.rb +0 -2
  223. data/lib/algolia/models/ingestion/auth_o_auth_partial.rb +0 -2
  224. data/lib/algolia/models/ingestion/authentication.rb +0 -2
  225. data/lib/algolia/models/ingestion/authentication_create.rb +0 -2
  226. data/lib/algolia/models/ingestion/authentication_create_response.rb +0 -2
  227. data/lib/algolia/models/ingestion/authentication_search.rb +0 -2
  228. data/lib/algolia/models/ingestion/authentication_update.rb +0 -2
  229. data/lib/algolia/models/ingestion/authentication_update_response.rb +0 -2
  230. data/lib/algolia/models/ingestion/big_commerce_channel.rb +0 -2
  231. data/lib/algolia/models/ingestion/big_commerce_metafield.rb +0 -2
  232. data/lib/algolia/models/ingestion/commercetools_custom_fields.rb +0 -2
  233. data/lib/algolia/models/ingestion/delete_response.rb +0 -2
  234. data/lib/algolia/models/ingestion/destination.rb +0 -2
  235. data/lib/algolia/models/ingestion/destination_create.rb +0 -2
  236. data/lib/algolia/models/ingestion/destination_create_response.rb +0 -2
  237. data/lib/algolia/models/ingestion/destination_input.rb +0 -2
  238. data/lib/algolia/models/ingestion/destination_search.rb +0 -2
  239. data/lib/algolia/models/ingestion/destination_update.rb +0 -2
  240. data/lib/algolia/models/ingestion/destination_update_response.rb +0 -2
  241. data/lib/algolia/models/ingestion/docker_streams.rb +0 -2
  242. data/lib/algolia/models/ingestion/docker_streams_input.rb +0 -2
  243. data/lib/algolia/models/ingestion/email_notifications.rb +0 -2
  244. data/lib/algolia/models/ingestion/error_base.rb +0 -2
  245. data/lib/algolia/models/ingestion/event.rb +0 -2
  246. data/lib/algolia/models/ingestion/list_authentications_response.rb +0 -2
  247. data/lib/algolia/models/ingestion/list_destinations_response.rb +0 -2
  248. data/lib/algolia/models/ingestion/list_events_response.rb +0 -2
  249. data/lib/algolia/models/ingestion/list_sources_response.rb +0 -2
  250. data/lib/algolia/models/ingestion/list_tasks_response.rb +0 -2
  251. data/lib/algolia/models/ingestion/list_tasks_response_v1.rb +0 -2
  252. data/lib/algolia/models/ingestion/list_transformations_response.rb +0 -2
  253. data/lib/algolia/models/ingestion/mapping_field_directive.rb +0 -2
  254. data/lib/algolia/models/ingestion/mapping_input.rb +0 -2
  255. data/lib/algolia/models/ingestion/mapping_kit_action.rb +0 -2
  256. data/lib/algolia/models/ingestion/notifications.rb +0 -2
  257. data/lib/algolia/models/ingestion/on_demand_trigger.rb +0 -2
  258. data/lib/algolia/models/ingestion/on_demand_trigger_input.rb +0 -2
  259. data/lib/algolia/models/ingestion/pagination.rb +0 -2
  260. data/lib/algolia/models/ingestion/platform_with_none.rb +0 -1
  261. data/lib/algolia/models/ingestion/policies.rb +0 -2
  262. data/lib/algolia/models/ingestion/push_task_payload.rb +0 -2
  263. data/lib/algolia/models/ingestion/push_task_records.rb +0 -2
  264. data/lib/algolia/models/ingestion/run.rb +0 -2
  265. data/lib/algolia/models/ingestion/run_list_response.rb +0 -2
  266. data/lib/algolia/models/ingestion/run_progress.rb +0 -2
  267. data/lib/algolia/models/ingestion/run_response.rb +0 -2
  268. data/lib/algolia/models/ingestion/run_source_payload.rb +0 -2
  269. data/lib/algolia/models/ingestion/run_source_response.rb +0 -2
  270. data/lib/algolia/models/ingestion/run_task_payload.rb +0 -2
  271. data/lib/algolia/models/ingestion/schedule_trigger.rb +0 -2
  272. data/lib/algolia/models/ingestion/schedule_trigger_input.rb +0 -2
  273. data/lib/algolia/models/ingestion/shopify_input.rb +0 -2
  274. data/lib/algolia/models/ingestion/shopify_market.rb +0 -2
  275. data/lib/algolia/models/ingestion/shopify_metafield.rb +0 -2
  276. data/lib/algolia/models/ingestion/source.rb +0 -2
  277. data/lib/algolia/models/ingestion/source_big_commerce.rb +0 -2
  278. data/lib/algolia/models/ingestion/source_big_query.rb +0 -2
  279. data/lib/algolia/models/ingestion/source_commercetools.rb +0 -2
  280. data/lib/algolia/models/ingestion/source_create.rb +0 -2
  281. data/lib/algolia/models/ingestion/source_create_response.rb +0 -2
  282. data/lib/algolia/models/ingestion/source_csv.rb +0 -2
  283. data/lib/algolia/models/ingestion/source_docker.rb +0 -2
  284. data/lib/algolia/models/ingestion/source_ga4_big_query_export.rb +0 -2
  285. data/lib/algolia/models/ingestion/source_input.rb +0 -1
  286. data/lib/algolia/models/ingestion/source_json.rb +0 -2
  287. data/lib/algolia/models/ingestion/source_search.rb +0 -2
  288. data/lib/algolia/models/ingestion/source_shopify.rb +0 -2
  289. data/lib/algolia/models/ingestion/source_update.rb +0 -2
  290. data/lib/algolia/models/ingestion/source_update_commercetools.rb +0 -2
  291. data/lib/algolia/models/ingestion/source_update_docker.rb +0 -2
  292. data/lib/algolia/models/ingestion/source_update_input.rb +0 -1
  293. data/lib/algolia/models/ingestion/source_update_response.rb +0 -2
  294. data/lib/algolia/models/ingestion/source_update_shopify.rb +0 -2
  295. data/lib/algolia/models/ingestion/streaming_input.rb +0 -2
  296. data/lib/algolia/models/ingestion/streaming_trigger.rb +0 -2
  297. data/lib/algolia/models/ingestion/subscription_trigger.rb +0 -2
  298. data/lib/algolia/models/ingestion/task.rb +0 -2
  299. data/lib/algolia/models/ingestion/task_create.rb +0 -2
  300. data/lib/algolia/models/ingestion/task_create_response.rb +0 -2
  301. data/lib/algolia/models/ingestion/task_create_trigger.rb +0 -1
  302. data/lib/algolia/models/ingestion/task_create_v1.rb +0 -2
  303. data/lib/algolia/models/ingestion/task_input.rb +0 -1
  304. data/lib/algolia/models/ingestion/task_replace.rb +0 -2
  305. data/lib/algolia/models/ingestion/task_search.rb +0 -2
  306. data/lib/algolia/models/ingestion/task_update.rb +0 -2
  307. data/lib/algolia/models/ingestion/task_update_response.rb +0 -2
  308. data/lib/algolia/models/ingestion/task_update_v1.rb +0 -2
  309. data/lib/algolia/models/ingestion/task_v1.rb +0 -2
  310. data/lib/algolia/models/ingestion/transformation.rb +0 -2
  311. data/lib/algolia/models/ingestion/transformation_code.rb +0 -2
  312. data/lib/algolia/models/ingestion/transformation_create.rb +0 -2
  313. data/lib/algolia/models/ingestion/transformation_create_response.rb +0 -2
  314. data/lib/algolia/models/ingestion/transformation_error.rb +0 -2
  315. data/lib/algolia/models/ingestion/transformation_input.rb +0 -1
  316. data/lib/algolia/models/ingestion/transformation_no_code.rb +0 -2
  317. data/lib/algolia/models/ingestion/transformation_search.rb +0 -2
  318. data/lib/algolia/models/ingestion/transformation_try.rb +0 -2
  319. data/lib/algolia/models/ingestion/transformation_try_response.rb +0 -2
  320. data/lib/algolia/models/ingestion/transformation_update_response.rb +0 -2
  321. data/lib/algolia/models/ingestion/trigger.rb +0 -1
  322. data/lib/algolia/models/ingestion/trigger_update_input.rb +0 -2
  323. data/lib/algolia/models/ingestion/watch_response.rb +0 -2
  324. data/lib/algolia/models/ingestion/window.rb +0 -2
  325. data/lib/algolia/models/insights/added_to_cart_object_ids.rb +2 -4
  326. data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb +2 -4
  327. data/lib/algolia/models/insights/clicked_filters.rb +2 -4
  328. data/lib/algolia/models/insights/clicked_object_ids.rb +2 -4
  329. data/lib/algolia/models/insights/clicked_object_ids_after_search.rb +2 -4
  330. data/lib/algolia/models/insights/converted_filters.rb +2 -4
  331. data/lib/algolia/models/insights/converted_object_ids.rb +2 -4
  332. data/lib/algolia/models/insights/converted_object_ids_after_search.rb +2 -4
  333. data/lib/algolia/models/insights/discount.rb +0 -1
  334. data/lib/algolia/models/insights/error_base.rb +0 -2
  335. data/lib/algolia/models/insights/events_items.rb +0 -1
  336. data/lib/algolia/models/insights/events_response.rb +0 -2
  337. data/lib/algolia/models/insights/insights_events.rb +0 -2
  338. data/lib/algolia/models/insights/object_data.rb +0 -2
  339. data/lib/algolia/models/insights/object_data_after_search.rb +0 -2
  340. data/lib/algolia/models/insights/price.rb +0 -1
  341. data/lib/algolia/models/insights/purchased_object_ids.rb +2 -4
  342. data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +2 -4
  343. data/lib/algolia/models/insights/value.rb +0 -1
  344. data/lib/algolia/models/insights/viewed_filters.rb +2 -4
  345. data/lib/algolia/models/insights/viewed_object_ids.rb +2 -4
  346. data/lib/algolia/models/monitoring/error_base.rb +0 -2
  347. data/lib/algolia/models/monitoring/incident.rb +0 -2
  348. data/lib/algolia/models/monitoring/incident_entry.rb +0 -2
  349. data/lib/algolia/models/monitoring/incidents_response.rb +0 -2
  350. data/lib/algolia/models/monitoring/indexing_metric.rb +0 -2
  351. data/lib/algolia/models/monitoring/indexing_time_response.rb +0 -2
  352. data/lib/algolia/models/monitoring/infrastructure_response.rb +0 -2
  353. data/lib/algolia/models/monitoring/inventory_response.rb +0 -2
  354. data/lib/algolia/models/monitoring/latency_metric.rb +0 -2
  355. data/lib/algolia/models/monitoring/latency_response.rb +0 -2
  356. data/lib/algolia/models/monitoring/metrics.rb +0 -2
  357. data/lib/algolia/models/monitoring/probes_metric.rb +0 -2
  358. data/lib/algolia/models/monitoring/server.rb +0 -2
  359. data/lib/algolia/models/monitoring/status_response.rb +0 -2
  360. data/lib/algolia/models/monitoring/time_entry.rb +0 -2
  361. data/lib/algolia/models/personalization/delete_user_profile_response.rb +1 -3
  362. data/lib/algolia/models/personalization/error_base.rb +0 -2
  363. data/lib/algolia/models/personalization/events_scoring.rb +0 -2
  364. data/lib/algolia/models/personalization/facets_scoring.rb +0 -2
  365. data/lib/algolia/models/personalization/get_user_token_response.rb +1 -3
  366. data/lib/algolia/models/personalization/personalization_strategy_params.rb +0 -2
  367. data/lib/algolia/models/personalization/set_personalization_strategy_response.rb +0 -2
  368. data/lib/algolia/models/query-suggestions/base_response.rb +0 -2
  369. data/lib/algolia/models/query-suggestions/config_status.rb +0 -2
  370. data/lib/algolia/models/query-suggestions/configuration.rb +0 -2
  371. data/lib/algolia/models/query-suggestions/configuration_response.rb +0 -2
  372. data/lib/algolia/models/query-suggestions/configuration_with_index.rb +0 -2
  373. data/lib/algolia/models/query-suggestions/error_base.rb +0 -2
  374. data/lib/algolia/models/query-suggestions/facet.rb +0 -2
  375. data/lib/algolia/models/query-suggestions/languages.rb +0 -1
  376. data/lib/algolia/models/query-suggestions/log_file.rb +0 -2
  377. data/lib/algolia/models/query-suggestions/source_index.rb +0 -2
  378. data/lib/algolia/models/recommend/around_precision.rb +0 -1
  379. data/lib/algolia/models/recommend/around_radius.rb +0 -1
  380. data/lib/algolia/models/recommend/auto_facet_filter.rb +0 -2
  381. data/lib/algolia/models/recommend/banner.rb +0 -2
  382. data/lib/algolia/models/recommend/banner_image.rb +0 -2
  383. data/lib/algolia/models/recommend/banner_image_url.rb +0 -2
  384. data/lib/algolia/models/recommend/banner_link.rb +0 -2
  385. data/lib/algolia/models/recommend/bought_together_query.rb +0 -2
  386. data/lib/algolia/models/recommend/condition.rb +1 -3
  387. data/lib/algolia/models/recommend/consequence.rb +0 -2
  388. data/lib/algolia/models/recommend/deleted_at_response.rb +1 -3
  389. data/lib/algolia/models/recommend/distinct.rb +0 -1
  390. data/lib/algolia/models/recommend/error_base.rb +0 -2
  391. data/lib/algolia/models/recommend/exhaustive.rb +0 -2
  392. data/lib/algolia/models/recommend/facet_filters.rb +0 -1
  393. data/lib/algolia/models/recommend/facet_ordering.rb +0 -2
  394. data/lib/algolia/models/recommend/facet_stats.rb +0 -2
  395. data/lib/algolia/models/recommend/fallback_params.rb +19 -21
  396. data/lib/algolia/models/recommend/get_recommend_task_response.rb +0 -2
  397. data/lib/algolia/models/recommend/get_recommendations_params.rb +0 -2
  398. data/lib/algolia/models/recommend/get_recommendations_response.rb +0 -2
  399. data/lib/algolia/models/recommend/hide_consequence_object.rb +0 -2
  400. data/lib/algolia/models/recommend/highlight_result.rb +0 -1
  401. data/lib/algolia/models/recommend/highlight_result_option.rb +0 -2
  402. data/lib/algolia/models/recommend/ignore_plurals.rb +0 -1
  403. data/lib/algolia/models/recommend/index_settings_facets.rb +0 -2
  404. data/lib/algolia/models/recommend/inside_bounding_box.rb +0 -1
  405. data/lib/algolia/models/recommend/looking_similar_query.rb +0 -2
  406. data/lib/algolia/models/recommend/matched_geo_location.rb +0 -2
  407. data/lib/algolia/models/recommend/numeric_filters.rb +0 -1
  408. data/lib/algolia/models/recommend/optional_filters.rb +1 -2
  409. data/lib/algolia/models/recommend/optional_words.rb +0 -1
  410. data/lib/algolia/models/recommend/params_consequence.rb +1 -3
  411. data/lib/algolia/models/recommend/personalization.rb +0 -2
  412. data/lib/algolia/models/recommend/promote_consequence_object.rb +0 -2
  413. data/lib/algolia/models/recommend/range.rb +0 -2
  414. data/lib/algolia/models/recommend/ranking_info.rb +0 -2
  415. data/lib/algolia/models/recommend/re_ranking_apply_filter.rb +1 -2
  416. data/lib/algolia/models/recommend/recommend_hit.rb +0 -2
  417. data/lib/algolia/models/recommend/recommend_rule.rb +0 -2
  418. data/lib/algolia/models/recommend/recommend_search_params.rb +19 -21
  419. data/lib/algolia/models/recommend/recommend_updated_at_response.rb +1 -3
  420. data/lib/algolia/models/recommend/recommendations_hit.rb +0 -1
  421. data/lib/algolia/models/recommend/recommendations_request.rb +0 -1
  422. data/lib/algolia/models/recommend/recommendations_results.rb +1 -3
  423. data/lib/algolia/models/recommend/redirect.rb +1 -3
  424. data/lib/algolia/models/recommend/redirect_rule_index_data.rb +0 -2
  425. data/lib/algolia/models/recommend/redirect_rule_index_metadata.rb +0 -2
  426. data/lib/algolia/models/recommend/redirect_url.rb +0 -2
  427. data/lib/algolia/models/recommend/related_query.rb +0 -2
  428. data/lib/algolia/models/recommend/remove_stop_words.rb +0 -1
  429. data/lib/algolia/models/recommend/rendering_content.rb +0 -2
  430. data/lib/algolia/models/recommend/rule_metadata.rb +0 -2
  431. data/lib/algolia/models/recommend/search_recommend_rules_params.rb +2 -4
  432. data/lib/algolia/models/recommend/search_recommend_rules_response.rb +0 -2
  433. data/lib/algolia/models/recommend/snippet_result.rb +0 -1
  434. data/lib/algolia/models/recommend/snippet_result_option.rb +0 -2
  435. data/lib/algolia/models/recommend/tag_filters.rb +0 -1
  436. data/lib/algolia/models/recommend/time_range.rb +0 -2
  437. data/lib/algolia/models/recommend/trending_facet_hit.rb +0 -2
  438. data/lib/algolia/models/recommend/trending_facets_query.rb +0 -2
  439. data/lib/algolia/models/recommend/trending_items_query.rb +0 -2
  440. data/lib/algolia/models/recommend/typo_tolerance.rb +1 -2
  441. data/lib/algolia/models/recommend/value.rb +0 -2
  442. data/lib/algolia/models/recommend/widgets.rb +0 -2
  443. data/lib/algolia/models/search/add_api_key_response.rb +0 -2
  444. data/lib/algolia/models/search/api_key.rb +1 -3
  445. data/lib/algolia/models/search/around_precision.rb +0 -1
  446. data/lib/algolia/models/search/around_radius.rb +0 -1
  447. data/lib/algolia/models/search/assign_user_id_params.rb +0 -2
  448. data/lib/algolia/models/search/attribute_to_update.rb +0 -1
  449. data/lib/algolia/models/search/automatic_facet_filter.rb +0 -2
  450. data/lib/algolia/models/search/automatic_facet_filters.rb +0 -1
  451. data/lib/algolia/models/search/banner.rb +0 -2
  452. data/lib/algolia/models/search/banner_image.rb +0 -2
  453. data/lib/algolia/models/search/banner_image_url.rb +0 -2
  454. data/lib/algolia/models/search/banner_link.rb +0 -2
  455. data/lib/algolia/models/search/batch_assign_user_ids_params.rb +0 -2
  456. data/lib/algolia/models/search/batch_dictionary_entries_params.rb +0 -2
  457. data/lib/algolia/models/search/batch_dictionary_entries_request.rb +0 -2
  458. data/lib/algolia/models/search/batch_params.rb +0 -2
  459. data/lib/algolia/models/search/batch_request.rb +0 -2
  460. data/lib/algolia/models/search/batch_response.rb +1 -3
  461. data/lib/algolia/models/search/batch_write_params.rb +0 -2
  462. data/lib/algolia/models/search/browse_params.rb +0 -1
  463. data/lib/algolia/models/search/browse_params_object.rb +10 -12
  464. data/lib/algolia/models/search/browse_response.rb +1 -3
  465. data/lib/algolia/models/search/built_in_operation.rb +0 -2
  466. data/lib/algolia/models/search/built_in_operation_value.rb +0 -1
  467. data/lib/algolia/models/search/condition.rb +0 -2
  468. data/lib/algolia/models/search/consequence.rb +0 -2
  469. data/lib/algolia/models/search/consequence_hide.rb +0 -2
  470. data/lib/algolia/models/search/consequence_params.rb +10 -12
  471. data/lib/algolia/models/search/consequence_query.rb +0 -1
  472. data/lib/algolia/models/search/consequence_query_object.rb +0 -2
  473. data/lib/algolia/models/search/created_at_response.rb +0 -2
  474. data/lib/algolia/models/search/delete_api_key_response.rb +0 -2
  475. data/lib/algolia/models/search/delete_by_params.rb +1 -3
  476. data/lib/algolia/models/search/delete_source_response.rb +0 -2
  477. data/lib/algolia/models/search/deleted_at_response.rb +1 -3
  478. data/lib/algolia/models/search/dictionary_entry.rb +0 -2
  479. data/lib/algolia/models/search/dictionary_language.rb +0 -2
  480. data/lib/algolia/models/search/dictionary_settings_params.rb +0 -2
  481. data/lib/algolia/models/search/distinct.rb +0 -1
  482. data/lib/algolia/models/search/edit.rb +0 -2
  483. data/lib/algolia/models/search/error_base.rb +0 -2
  484. data/lib/algolia/models/search/event.rb +0 -2
  485. data/lib/algolia/models/search/exhaustive.rb +0 -2
  486. data/lib/algolia/models/search/facet_filters.rb +0 -1
  487. data/lib/algolia/models/search/facet_hits.rb +0 -2
  488. data/lib/algolia/models/search/facet_ordering.rb +0 -2
  489. data/lib/algolia/models/search/facet_stats.rb +0 -2
  490. data/lib/algolia/models/search/facets.rb +0 -2
  491. data/lib/algolia/models/search/fetched_index.rb +0 -2
  492. data/lib/algolia/models/search/get_api_key_response.rb +1 -3
  493. data/lib/algolia/models/search/get_dictionary_settings_response.rb +0 -2
  494. data/lib/algolia/models/search/get_logs_response.rb +0 -2
  495. data/lib/algolia/models/search/get_objects_params.rb +0 -2
  496. data/lib/algolia/models/search/get_objects_request.rb +0 -2
  497. data/lib/algolia/models/search/get_objects_response.rb +0 -2
  498. data/lib/algolia/models/search/get_task_response.rb +0 -2
  499. data/lib/algolia/models/search/get_top_user_ids_response.rb +0 -2
  500. data/lib/algolia/models/search/has_pending_mappings_response.rb +0 -2
  501. data/lib/algolia/models/search/highlight_result.rb +0 -1
  502. data/lib/algolia/models/search/highlight_result_option.rb +0 -2
  503. data/lib/algolia/models/search/hit.rb +0 -2
  504. data/lib/algolia/models/search/ignore_plurals.rb +0 -1
  505. data/lib/algolia/models/search/index_settings.rb +15 -17
  506. data/lib/algolia/models/search/inside_bounding_box.rb +0 -1
  507. data/lib/algolia/models/search/languages.rb +0 -2
  508. data/lib/algolia/models/search/list_api_keys_response.rb +0 -2
  509. data/lib/algolia/models/search/list_clusters_response.rb +0 -2
  510. data/lib/algolia/models/search/list_indices_response.rb +0 -2
  511. data/lib/algolia/models/search/list_user_ids_response.rb +0 -2
  512. data/lib/algolia/models/search/log.rb +0 -2
  513. data/lib/algolia/models/search/log_query.rb +0 -2
  514. data/lib/algolia/models/search/matched_geo_location.rb +0 -2
  515. data/lib/algolia/models/search/multiple_batch_request.rb +0 -2
  516. data/lib/algolia/models/search/multiple_batch_response.rb +0 -2
  517. data/lib/algolia/models/search/numeric_filters.rb +0 -1
  518. data/lib/algolia/models/search/operation_index_params.rb +0 -2
  519. data/lib/algolia/models/search/optional_filters.rb +1 -2
  520. data/lib/algolia/models/search/optional_words.rb +0 -1
  521. data/lib/algolia/models/search/personalization.rb +0 -2
  522. data/lib/algolia/models/search/promote.rb +0 -1
  523. data/lib/algolia/models/search/promote_object_id.rb +0 -2
  524. data/lib/algolia/models/search/promote_object_ids.rb +0 -2
  525. data/lib/algolia/models/search/range.rb +0 -2
  526. data/lib/algolia/models/search/ranking_info.rb +0 -2
  527. data/lib/algolia/models/search/re_ranking_apply_filter.rb +1 -2
  528. data/lib/algolia/models/search/redirect.rb +1 -3
  529. data/lib/algolia/models/search/redirect_rule_index_data.rb +0 -2
  530. data/lib/algolia/models/search/redirect_rule_index_metadata.rb +0 -2
  531. data/lib/algolia/models/search/redirect_url.rb +0 -2
  532. data/lib/algolia/models/search/remove_stop_words.rb +0 -1
  533. data/lib/algolia/models/search/remove_user_id_response.rb +0 -2
  534. data/lib/algolia/models/search/rendering_content.rb +0 -2
  535. data/lib/algolia/models/search/replace_all_objects_response.rb +0 -2
  536. data/lib/algolia/models/search/replace_all_objects_with_transformation_response.rb +0 -2
  537. data/lib/algolia/models/search/replace_source_response.rb +0 -2
  538. data/lib/algolia/models/search/rule.rb +0 -2
  539. data/lib/algolia/models/search/save_object_response.rb +1 -3
  540. data/lib/algolia/models/search/save_synonym_response.rb +1 -3
  541. data/lib/algolia/models/search/search_dictionary_entries_params.rb +0 -2
  542. data/lib/algolia/models/search/search_dictionary_entries_response.rb +1 -3
  543. data/lib/algolia/models/search/search_for_facet_values_request.rb +0 -2
  544. data/lib/algolia/models/search/search_for_facet_values_response.rb +0 -2
  545. data/lib/algolia/models/search/search_for_facets.rb +10 -12
  546. data/lib/algolia/models/search/search_for_hits.rb +10 -12
  547. data/lib/algolia/models/search/search_method_params.rb +0 -2
  548. data/lib/algolia/models/search/search_params.rb +0 -1
  549. data/lib/algolia/models/search/search_params_object.rb +10 -12
  550. data/lib/algolia/models/search/search_params_string.rb +0 -2
  551. data/lib/algolia/models/search/search_query.rb +0 -1
  552. data/lib/algolia/models/search/search_response.rb +1 -3
  553. data/lib/algolia/models/search/search_responses.rb +0 -2
  554. data/lib/algolia/models/search/search_result.rb +0 -1
  555. data/lib/algolia/models/search/search_rules_params.rb +2 -4
  556. data/lib/algolia/models/search/search_rules_response.rb +0 -2
  557. data/lib/algolia/models/search/search_synonyms_params.rb +0 -2
  558. data/lib/algolia/models/search/search_synonyms_response.rb +0 -2
  559. data/lib/algolia/models/search/search_user_ids_params.rb +0 -3
  560. data/lib/algolia/models/search/search_user_ids_response.rb +1 -3
  561. data/lib/algolia/models/search/secured_api_key_restrictions.rb +0 -2
  562. data/lib/algolia/models/search/semantic_search.rb +0 -2
  563. data/lib/algolia/models/search/settings_response.rb +15 -17
  564. data/lib/algolia/models/search/snippet_result.rb +0 -1
  565. data/lib/algolia/models/search/snippet_result_option.rb +0 -2
  566. data/lib/algolia/models/search/source.rb +0 -2
  567. data/lib/algolia/models/search/standard_entries.rb +1 -3
  568. data/lib/algolia/models/search/synonym_hit.rb +4 -6
  569. data/lib/algolia/models/search/tag_filters.rb +0 -1
  570. data/lib/algolia/models/search/time_range.rb +0 -2
  571. data/lib/algolia/models/search/typo_tolerance.rb +1 -2
  572. data/lib/algolia/models/search/update_api_key_response.rb +0 -2
  573. data/lib/algolia/models/search/updated_at_response.rb +1 -3
  574. data/lib/algolia/models/search/updated_at_with_object_id_response.rb +1 -3
  575. data/lib/algolia/models/search/user_highlight_result.rb +0 -2
  576. data/lib/algolia/models/search/user_hit.rb +0 -2
  577. data/lib/algolia/models/search/user_id.rb +0 -2
  578. data/lib/algolia/models/search/value.rb +0 -2
  579. data/lib/algolia/models/search/watch_response.rb +0 -2
  580. data/lib/algolia/models/search/widgets.rb +0 -2
  581. data/lib/algolia/version.rb +1 -1
  582. metadata +3 -1
@@ -289,8 +289,6 @@ module Algolia
289
289
  value
290
290
  end
291
291
  end
292
-
293
292
  end
294
-
295
293
  end
296
294
  end
@@ -268,8 +268,6 @@ module Algolia
268
268
  value
269
269
  end
270
270
  end
271
-
272
271
  end
273
-
274
272
  end
275
273
  end
@@ -202,8 +202,6 @@ module Algolia
202
202
  value
203
203
  end
204
204
  end
205
-
206
205
  end
207
-
208
206
  end
209
207
  end
@@ -210,8 +210,6 @@ module Algolia
210
210
  value
211
211
  end
212
212
  end
213
-
214
213
  end
215
-
216
214
  end
217
215
  end
@@ -105,6 +105,5 @@ module Algolia
105
105
  end
106
106
  end
107
107
  end
108
-
109
108
  end
110
109
  end
@@ -228,8 +228,6 @@ module Algolia
228
228
  value
229
229
  end
230
230
  end
231
-
232
231
  end
233
-
234
232
  end
235
233
  end
@@ -284,8 +284,6 @@ module Algolia
284
284
  value
285
285
  end
286
286
  end
287
-
288
287
  end
289
-
290
288
  end
291
289
  end
@@ -105,6 +105,5 @@ module Algolia
105
105
  end
106
106
  end
107
107
  end
108
-
109
108
  end
110
109
  end
@@ -105,6 +105,5 @@ module Algolia
105
105
  end
106
106
  end
107
107
  end
108
-
109
108
  end
110
109
  end
@@ -213,8 +213,6 @@ module Algolia
213
213
  value
214
214
  end
215
215
  end
216
-
217
216
  end
218
-
219
217
  end
220
218
  end
@@ -208,8 +208,6 @@ module Algolia
208
208
  value
209
209
  end
210
210
  end
211
-
212
211
  end
213
-
214
212
  end
215
213
  end
@@ -213,8 +213,6 @@ module Algolia
213
213
  value
214
214
  end
215
215
  end
216
-
217
216
  end
218
-
219
217
  end
220
218
  end
@@ -202,8 +202,6 @@ module Algolia
202
202
  value
203
203
  end
204
204
  end
205
-
206
205
  end
207
-
208
206
  end
209
207
  end
@@ -202,8 +202,6 @@ module Algolia
202
202
  value
203
203
  end
204
204
  end
205
-
206
205
  end
207
-
208
206
  end
209
207
  end
@@ -266,8 +266,6 @@ module Algolia
266
266
  value
267
267
  end
268
268
  end
269
-
270
269
  end
271
-
272
270
  end
273
271
  end
@@ -9,7 +9,7 @@ module Algolia
9
9
  module Recommend
10
10
  # Condition that triggers the rule. If not specified, the rule is triggered for all recommendations.
11
11
  class Condition
12
- # Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
12
+ # Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).
13
13
  attr_accessor :filters
14
14
 
15
15
  # An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters.
@@ -213,8 +213,6 @@ module Algolia
213
213
  value
214
214
  end
215
215
  end
216
-
217
216
  end
218
-
219
217
  end
220
218
  end
@@ -226,8 +226,6 @@ module Algolia
226
226
  value
227
227
  end
228
228
  end
229
-
230
229
  end
231
-
232
230
  end
233
231
  end
@@ -9,7 +9,7 @@ module Algolia
9
9
  module Recommend
10
10
  # Response, taskID, and deletion timestamp.
11
11
  class DeletedAtResponse
12
- # 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`.
12
+ # 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](https://www.algolia.com/doc/rest-api/search/get-task) and this task ID.
13
13
  attr_accessor :task_id
14
14
 
15
15
  # Date and time when the object was deleted, in RFC 3339 format.
@@ -217,8 +217,6 @@ module Algolia
217
217
  value
218
218
  end
219
219
  end
220
-
221
220
  end
222
-
223
221
  end
224
222
  end
@@ -105,6 +105,5 @@ module Algolia
105
105
  end
106
106
  end
107
107
  end
108
-
109
108
  end
110
109
  end
@@ -202,8 +202,6 @@ module Algolia
202
202
  value
203
203
  end
204
204
  end
205
-
206
205
  end
207
-
208
206
  end
209
207
  end
@@ -243,8 +243,6 @@ module Algolia
243
243
  value
244
244
  end
245
245
  end
246
-
247
246
  end
248
-
249
247
  end
250
248
  end
@@ -105,6 +105,5 @@ module Algolia
105
105
  end
106
106
  end
107
107
  end
108
-
109
108
  end
110
109
  end
@@ -214,8 +214,6 @@ module Algolia
214
214
  value
215
215
  end
216
216
  end
217
-
218
217
  end
219
-
220
218
  end
221
219
  end
@@ -232,8 +232,6 @@ module Algolia
232
232
  value
233
233
  end
234
234
  end
235
-
236
235
  end
237
-
238
236
  end
239
237
  end
@@ -11,7 +11,7 @@ module Algolia
11
11
  # Keywords to be used instead of the search query to conduct a more broader search Using the `similarQuery` parameter changes other settings - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords` Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results.
12
12
  attr_accessor :similar_query
13
13
 
14
- # Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` 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/).
14
+ # Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes 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).
15
15
  attr_accessor :filters
16
16
 
17
17
  attr_accessor :facet_filters
@@ -61,7 +61,7 @@ module Algolia
61
61
  # 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).
62
62
  attr_accessor :personalization_impact
63
63
 
64
- # 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/).
64
+ # 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).
65
65
  attr_accessor :user_token
66
66
 
67
67
  # Whether the search response should include detailed ranking information.
@@ -70,13 +70,13 @@ module Algolia
70
70
  # Whether to take into account an index's synonyms for this search.
71
71
  attr_accessor :synonyms
72
72
 
73
- # 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/).
73
+ # 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).
74
74
  attr_accessor :click_analytics
75
75
 
76
76
  # Whether this search will be included in Analytics.
77
77
  attr_accessor :analytics
78
78
 
79
- # Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
79
+ # Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments).
80
80
  attr_accessor :analytics_tags
81
81
 
82
82
  # Whether to include this search when calculating processing-time percentiles.
@@ -88,19 +88,19 @@ module Algolia
88
88
  # Search query.
89
89
  attr_accessor :query
90
90
 
91
- # Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/). Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows the attribute to be used as a filter but doesn't evaluate the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching for facet values. - `afterDistinct(\"ATTRIBUTE\")`. Evaluates the facet count _after_ deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
91
+ # Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting). Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows the attribute to be used as a filter but doesn't evaluate the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching for facet values. - `afterDistinct(\"ATTRIBUTE\")`. Evaluates the facet count _after_ deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
92
92
  attr_accessor :attributes_for_faceting
93
93
 
94
- # Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/). Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you'll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer be synced with the primary index. **Modifier** - `virtual(\"REPLICA\")`. Create a virtual replica, Virtual replicas don't increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/).
94
+ # Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas). Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you'll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer be synced with the primary index. **Modifier** - `virtual(\"REPLICA\")`. Create a virtual replica, Virtual replicas don't increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort).
95
95
  attr_accessor :replicas
96
96
 
97
97
  # Maximum number of search results that can be obtained through pagination. Higher pagination limits might slow down your search. For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed.
98
98
  attr_accessor :pagination_limited_to
99
99
 
100
- # Attributes that can't be retrieved at query time. This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), but don't want to include it in the search results. Attribute names are case-sensitive.
100
+ # Attributes that can't be retrieved at query time. This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data), but don't want to include it in the search results. Attribute names are case-sensitive.
101
101
  attr_accessor :unretrievable_attributes
102
102
 
103
- # Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
103
+ # Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation) for the specified words.
104
104
  attr_accessor :disable_typo_tolerance_on_words
105
105
 
106
106
  # Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead). Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive.
@@ -109,10 +109,10 @@ module Algolia
109
109
  # Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive.
110
110
  attr_accessor :camel_case_attributes
111
111
 
112
- # Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`). Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
112
+ # Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation) (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`). Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
113
113
  attr_accessor :decompounded_attributes
114
114
 
115
- # Languages for language-specific processing steps, such as word detection and dictionary settings. **You should always specify an indexing language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
115
+ # Languages for language-specific processing steps, such as word detection and dictionary settings. **You should always specify an indexing language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations).
116
116
  attr_accessor :index_languages
117
117
 
118
118
  # Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). Attribute names are case-sensitive.
@@ -127,13 +127,13 @@ module Algolia
127
127
  # Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
128
128
  attr_accessor :separators_to_index
129
129
 
130
- # Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered. For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/). **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. Without a modifier, matches at the beginning of an attribute rank higher than matches at the end.
130
+ # Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered. For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes). **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. Without a modifier, matches at the beginning of an attribute rank higher than matches at the end.
131
131
  attr_accessor :searchable_attributes
132
132
 
133
133
  # An object with custom data. You can store up to 32kB as custom data.
134
134
  attr_accessor :user_data
135
135
 
136
- # Characters and their normalized replacements. This overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
136
+ # Characters and their normalized replacements. This overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization).
137
137
  attr_accessor :custom_normalization
138
138
 
139
139
  # Attribute that should be used to establish groups of results. Attribute names are case-sensitive. All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results. If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting _after_ deduplication, which will result in accurate facet counts.
@@ -145,19 +145,19 @@ module Algolia
145
145
  # 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.
146
146
  attr_accessor :keep_diacritics_on_characters
147
147
 
148
- # Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive. 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** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. 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.
148
+ # Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking). Attribute names are case-sensitive. 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** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. 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.
149
149
  attr_accessor :custom_ranking
150
150
 
151
151
  # Attributes to include in the API response To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
152
152
  attr_accessor :attributes_to_retrieve
153
153
 
154
- # Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, 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/).
154
+ # Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, 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).
155
155
  attr_accessor :ranking
156
156
 
157
157
  # Relevancy threshold below which less relevant results aren't included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
158
158
  attr_accessor :relevancy_strictness
159
159
 
160
- # Attributes to highlight By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).
160
+ # Attributes to highlight By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js).
161
161
  attr_accessor :attributes_to_highlight
162
162
 
163
163
  # Attributes for which to enable snippets. Attribute names are case-sensitive Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted.
@@ -186,14 +186,14 @@ module Algolia
186
186
  # 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.
187
187
  attr_accessor :allow_typos_on_numeric_tokens
188
188
 
189
- # Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive Returning only exact matches can help when - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/). - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
189
+ # Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance). Attribute names are case-sensitive Returning only exact matches can help when - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes). - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
190
190
  attr_accessor :disable_typo_tolerance_on_attributes
191
191
 
192
192
  attr_accessor :ignore_plurals
193
193
 
194
194
  attr_accessor :remove_stop_words
195
195
 
196
- # Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries 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/).
196
+ # Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, 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).
197
197
  attr_accessor :query_languages
198
198
 
199
199
  # Whether to split compound words in the query into their building blocks For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
@@ -239,7 +239,7 @@ module Algolia
239
239
  # Maximum number of facet values to return for each facet.
240
240
  attr_accessor :max_values_per_facet
241
241
 
242
- # Order in which to retrieve facet values - `count`. Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value - `alpha`. Retrieve facet values alphabetically This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
242
+ # Order in which to retrieve facet values - `count`. Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value - `alpha`. Retrieve facet values alphabetically This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js).
243
243
  attr_accessor :sort_facet_values_by
244
244
 
245
245
  # 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.
@@ -247,7 +247,7 @@ module Algolia
247
247
 
248
248
  attr_accessor :rendering_content
249
249
 
250
- # 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.
250
+ # 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.
251
251
  attr_accessor :enable_re_ranking
252
252
 
253
253
  attr_accessor :re_ranking_apply_filter
@@ -1200,8 +1200,6 @@ module Algolia
1200
1200
  value
1201
1201
  end
1202
1202
  end
1203
-
1204
1203
  end
1205
-
1206
1204
  end
1207
1205
  end
@@ -203,8 +203,6 @@ module Algolia
203
203
  value
204
204
  end
205
205
  end
206
-
207
206
  end
208
-
209
207
  end
210
208
  end
@@ -207,8 +207,6 @@ module Algolia
207
207
  value
208
208
  end
209
209
  end
210
-
211
210
  end
212
-
213
211
  end
214
212
  end
@@ -205,8 +205,6 @@ module Algolia
205
205
  value
206
206
  end
207
207
  end
208
-
209
208
  end
210
-
211
209
  end
212
210
  end
@@ -203,8 +203,6 @@ module Algolia
203
203
  value
204
204
  end
205
205
  end
206
-
207
206
  end
208
-
209
207
  end
210
208
  end
@@ -105,6 +105,5 @@ module Algolia
105
105
  end
106
106
  end
107
107
  end
108
-
109
108
  end
110
109
  end
@@ -248,8 +248,6 @@ module Algolia
248
248
  value
249
249
  end
250
250
  end
251
-
252
251
  end
253
-
254
252
  end
255
253
  end
@@ -106,6 +106,5 @@ module Algolia
106
106
  end
107
107
  end
108
108
  end
109
-
110
109
  end
111
110
  end
@@ -205,8 +205,6 @@ module Algolia
205
205
  value
206
206
  end
207
207
  end
208
-
209
208
  end
210
-
211
209
  end
212
210
  end
@@ -104,6 +104,5 @@ module Algolia
104
104
  end
105
105
  end
106
106
  end
107
-
108
107
  end
109
108
  end
@@ -275,8 +275,6 @@ module Algolia
275
275
  value
276
276
  end
277
277
  end
278
-
279
278
  end
280
-
281
279
  end
282
280
  end
@@ -222,8 +222,6 @@ module Algolia
222
222
  value
223
223
  end
224
224
  end
225
-
226
225
  end
227
-
228
226
  end
229
227
  end
@@ -105,6 +105,5 @@ module Algolia
105
105
  end
106
106
  end
107
107
  end
108
-
109
108
  end
110
109
  end
@@ -7,7 +7,7 @@ require "time"
7
7
 
8
8
  module Algolia
9
9
  module Recommend
10
- # Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. - Optional filters don't work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters are applied _before_ custom ranking attributes (in the default [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/)). - Optional filters don't work with numeric attributes.
10
+ # Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. - Optional filters don't work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters are applied _before_ custom ranking attributes (in the default [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria)). - Optional filters don't work with numeric attributes.
11
11
  module OptionalFilters
12
12
  class << self
13
13
  # List of class defined in oneOf (OpenAPI v3)
@@ -105,6 +105,5 @@ module Algolia
105
105
  end
106
106
  end
107
107
  end
108
-
109
108
  end
110
109
  end
@@ -105,6 +105,5 @@ module Algolia
105
105
  end
106
106
  end
107
107
  end
108
-
109
108
  end
110
109
  end
@@ -12,7 +12,7 @@ module Algolia
12
12
  # Filter recommendations that match or don't match the same `facet:facet_value` combination as the viewed item.
13
13
  attr_accessor :automatic_facet_filters
14
14
 
15
- # Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` 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/).
15
+ # Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes 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).
16
16
  attr_accessor :filters
17
17
 
18
18
  # Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. Matches with higher weights (`<score=N>`) rank before matches with lower weights. If you're using a negative filter `facet:-value`, matching records rank after records that don't match.
@@ -227,8 +227,6 @@ module Algolia
227
227
  value
228
228
  end
229
229
  end
230
-
231
230
  end
232
-
233
231
  end
234
232
  end
@@ -222,8 +222,6 @@ module Algolia
222
222
  value
223
223
  end
224
224
  end
225
-
226
225
  end
227
-
228
226
  end
229
227
  end