algolia 3.11.0 → 3.12.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +18 -0
- data/Gemfile.lock +1 -1
- data/lib/algolia/api/abtesting_client.rb +3 -1
- data/lib/algolia/api/analytics_client.rb +45 -43
- data/lib/algolia/api/composition_client.rb +174 -0
- data/lib/algolia/api/ingestion_client.rb +7 -1
- data/lib/algolia/api/insights_client.rb +3 -1
- data/lib/algolia/api/monitoring_client.rb +2 -0
- data/lib/algolia/api/personalization_client.rb +3 -1
- data/lib/algolia/api/query_suggestions_client.rb +3 -1
- data/lib/algolia/api/recommend_client.rb +20 -18
- data/lib/algolia/api/search_client.rb +104 -90
- data/lib/algolia/models/abtesting/ab_test.rb +2 -0
- data/lib/algolia/models/abtesting/ab_test_configuration.rb +2 -0
- data/lib/algolia/models/abtesting/ab_test_response.rb +2 -0
- data/lib/algolia/models/abtesting/ab_tests_variant.rb +2 -0
- data/lib/algolia/models/abtesting/ab_tests_variant_search_params.rb +2 -0
- data/lib/algolia/models/abtesting/add_ab_tests_request.rb +2 -0
- data/lib/algolia/models/abtesting/add_ab_tests_variant.rb +2 -0
- data/lib/algolia/models/abtesting/currency.rb +2 -0
- data/lib/algolia/models/abtesting/effect_metric.rb +2 -0
- data/lib/algolia/models/abtesting/empty_search.rb +2 -0
- data/lib/algolia/models/abtesting/empty_search_filter.rb +2 -0
- data/lib/algolia/models/abtesting/error_base.rb +2 -0
- data/lib/algolia/models/abtesting/estimate_ab_test_request.rb +2 -0
- data/lib/algolia/models/abtesting/estimate_ab_test_response.rb +2 -0
- data/lib/algolia/models/abtesting/estimate_configuration.rb +2 -0
- data/lib/algolia/models/abtesting/filter_effects.rb +2 -0
- data/lib/algolia/models/abtesting/list_ab_tests_response.rb +3 -1
- data/lib/algolia/models/abtesting/minimum_detectable_effect.rb +2 -0
- data/lib/algolia/models/abtesting/outliers.rb +2 -0
- data/lib/algolia/models/abtesting/outliers_filter.rb +2 -0
- data/lib/algolia/models/abtesting/schedule_ab_test_response.rb +2 -0
- data/lib/algolia/models/abtesting/schedule_ab_tests_request.rb +2 -0
- data/lib/algolia/models/abtesting/status.rb +2 -0
- data/lib/algolia/models/abtesting/variant.rb +2 -0
- data/lib/algolia/models/analytics/click_position.rb +2 -0
- data/lib/algolia/models/analytics/currency_code.rb +2 -0
- data/lib/algolia/models/analytics/daily_add_to_cart_rates.rb +3 -1
- data/lib/algolia/models/analytics/daily_average_clicks.rb +2 -0
- data/lib/algolia/models/analytics/daily_click_through_rates.rb +3 -1
- data/lib/algolia/models/analytics/daily_conversion_rates.rb +3 -1
- data/lib/algolia/models/analytics/daily_no_click_rates.rb +3 -1
- data/lib/algolia/models/analytics/daily_no_results_rates.rb +3 -1
- data/lib/algolia/models/analytics/daily_purchase_rates.rb +3 -1
- data/lib/algolia/models/analytics/daily_revenue.rb +3 -1
- data/lib/algolia/models/analytics/daily_searches.rb +2 -0
- data/lib/algolia/models/analytics/daily_searches_no_clicks.rb +2 -0
- data/lib/algolia/models/analytics/daily_searches_no_results.rb +2 -0
- data/lib/algolia/models/analytics/daily_users.rb +2 -0
- data/lib/algolia/models/analytics/direction.rb +2 -0
- data/lib/algolia/models/analytics/error_base.rb +2 -0
- data/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb +3 -1
- data/lib/algolia/models/analytics/get_average_click_position_response.rb +2 -0
- data/lib/algolia/models/analytics/get_click_positions_response.rb +2 -0
- data/lib/algolia/models/analytics/get_click_through_rate_response.rb +3 -1
- data/lib/algolia/models/analytics/get_conversion_rate_response.rb +3 -1
- data/lib/algolia/models/analytics/get_no_click_rate_response.rb +3 -1
- data/lib/algolia/models/analytics/get_no_results_rate_response.rb +3 -1
- data/lib/algolia/models/analytics/get_purchase_rate_response.rb +3 -1
- data/lib/algolia/models/analytics/get_revenue.rb +3 -1
- data/lib/algolia/models/analytics/get_searches_count_response.rb +2 -0
- data/lib/algolia/models/analytics/get_searches_no_clicks_response.rb +2 -0
- data/lib/algolia/models/analytics/get_searches_no_results_response.rb +2 -0
- data/lib/algolia/models/analytics/get_status_response.rb +2 -0
- data/lib/algolia/models/analytics/get_top_countries_response.rb +2 -0
- data/lib/algolia/models/analytics/get_top_filter_attribute.rb +2 -0
- data/lib/algolia/models/analytics/get_top_filter_attributes_response.rb +2 -0
- data/lib/algolia/models/analytics/get_top_filter_for_attribute.rb +2 -0
- data/lib/algolia/models/analytics/get_top_filter_for_attribute_response.rb +2 -0
- data/lib/algolia/models/analytics/get_top_filters_no_results_response.rb +3 -1
- data/lib/algolia/models/analytics/get_top_filters_no_results_value.rb +2 -0
- data/lib/algolia/models/analytics/get_top_filters_no_results_values.rb +2 -0
- data/lib/algolia/models/analytics/get_top_hits_response.rb +2 -0
- data/lib/algolia/models/analytics/get_top_searches_response.rb +2 -0
- data/lib/algolia/models/analytics/get_users_count_response.rb +2 -0
- data/lib/algolia/models/analytics/operator.rb +2 -0
- data/lib/algolia/models/analytics/order_by.rb +2 -0
- data/lib/algolia/models/analytics/top_country.rb +2 -0
- data/lib/algolia/models/analytics/top_hit.rb +3 -1
- data/lib/algolia/models/analytics/top_hit_with_analytics.rb +5 -3
- data/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb +8 -6
- data/lib/algolia/models/analytics/top_hits_response.rb +2 -0
- data/lib/algolia/models/analytics/top_hits_response_with_analytics.rb +2 -0
- data/lib/algolia/models/analytics/top_hits_response_with_revenue_analytics.rb +2 -0
- data/lib/algolia/models/analytics/top_search.rb +2 -0
- data/lib/algolia/models/analytics/top_search_with_analytics.rb +4 -2
- data/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb +7 -5
- data/lib/algolia/models/analytics/top_searches_response.rb +2 -0
- data/lib/algolia/models/analytics/top_searches_response_with_analytics.rb +2 -0
- data/lib/algolia/models/analytics/top_searches_response_with_revenue_analytics.rb +2 -0
- data/lib/algolia/models/composition/around_precision.rb +110 -0
- data/lib/algolia/models/composition/around_radius.rb +110 -0
- data/lib/algolia/models/{ingestion/docker_registry.rb → composition/around_radius_all.rb} +8 -7
- data/lib/algolia/models/composition/banner.rb +215 -0
- data/lib/algolia/models/composition/banner_image.rb +220 -0
- data/lib/algolia/models/composition/banner_image_url.rb +209 -0
- data/lib/algolia/models/composition/banner_link.rb +209 -0
- data/lib/algolia/models/composition/composition_id_ranking_info.rb +221 -0
- data/lib/algolia/models/composition/composition_run_applied_rules.rb +211 -0
- data/lib/algolia/models/composition/composition_run_search_response.rb +222 -0
- data/lib/algolia/models/composition/compositions_search_response.rb +212 -0
- data/lib/algolia/models/composition/error_base.rb +209 -0
- data/lib/algolia/models/composition/exhaustive.rb +250 -0
- data/lib/algolia/models/composition/facet_filters.rb +110 -0
- data/lib/algolia/models/composition/facet_hits.rb +235 -0
- data/lib/algolia/models/composition/facet_ordering.rb +221 -0
- data/lib/algolia/models/composition/facet_stats.rb +239 -0
- data/lib/algolia/models/composition/facets.rb +209 -0
- data/lib/algolia/models/composition/highlight_result.rb +110 -0
- data/lib/algolia/models/composition/highlight_result_option.rb +255 -0
- data/lib/algolia/models/composition/hit.rb +251 -0
- data/lib/algolia/models/composition/hit_ranking_info.rb +371 -0
- data/lib/algolia/models/composition/inside_bounding_box.rb +109 -0
- data/lib/algolia/models/{ingestion/docker_image_type.rb → composition/match_level.rb} +10 -7
- data/lib/algolia/models/composition/matched_geo_location.rb +229 -0
- data/lib/algolia/models/composition/numeric_filters.rb +110 -0
- data/lib/algolia/models/composition/optional_filters.rb +110 -0
- data/lib/algolia/models/composition/params.rb +488 -0
- data/lib/algolia/models/composition/personalization.rb +229 -0
- data/lib/algolia/models/composition/range.rb +217 -0
- data/lib/algolia/models/composition/redirect.rb +208 -0
- data/lib/algolia/models/composition/redirect_rule_index_data.rb +211 -0
- data/lib/algolia/models/composition/redirect_rule_index_metadata.rb +258 -0
- data/lib/algolia/models/composition/redirect_url.rb +209 -0
- data/lib/algolia/models/composition/rendering_content.rb +227 -0
- data/lib/algolia/models/composition/request_body.rb +208 -0
- data/lib/algolia/models/composition/results_composition_info_response.rb +212 -0
- data/lib/algolia/models/composition/results_injected_item_applied_rules_info_response.rb +211 -0
- data/lib/algolia/models/composition/results_injected_item_info_response.rb +221 -0
- data/lib/algolia/models/composition/search_for_facet_values_params.rb +228 -0
- data/lib/algolia/models/composition/search_for_facet_values_request.rb +208 -0
- data/lib/algolia/models/composition/search_for_facet_values_response.rb +211 -0
- data/lib/algolia/models/composition/search_for_facet_values_results.rb +253 -0
- data/lib/algolia/models/composition/search_response.rb +230 -0
- data/lib/algolia/models/composition/search_results_item.rb +608 -0
- data/lib/algolia/models/composition/snippet_result.rb +110 -0
- data/lib/algolia/models/composition/snippet_result_option.rb +230 -0
- data/lib/algolia/models/composition/sort_remaining_by.rb +35 -0
- data/lib/algolia/models/composition/supported_language.rb +169 -0
- data/lib/algolia/models/composition/value.rb +229 -0
- data/lib/algolia/models/composition/widgets.rb +209 -0
- data/lib/algolia/models/ingestion/action.rb +2 -0
- data/lib/algolia/models/ingestion/action_type.rb +2 -0
- data/lib/algolia/models/ingestion/auth_algolia.rb +2 -0
- data/lib/algolia/models/ingestion/auth_algolia_insights.rb +2 -0
- data/lib/algolia/models/ingestion/auth_algolia_insights_partial.rb +2 -0
- data/lib/algolia/models/ingestion/auth_algolia_partial.rb +2 -0
- data/lib/algolia/models/ingestion/auth_api_key.rb +2 -0
- data/lib/algolia/models/ingestion/auth_api_key_partial.rb +2 -0
- data/lib/algolia/models/ingestion/auth_basic.rb +2 -0
- data/lib/algolia/models/ingestion/auth_basic_partial.rb +2 -0
- data/lib/algolia/models/ingestion/auth_google_service_account.rb +2 -0
- data/lib/algolia/models/ingestion/auth_google_service_account_partial.rb +2 -0
- data/lib/algolia/models/ingestion/auth_input.rb +2 -0
- data/lib/algolia/models/ingestion/auth_input_partial.rb +2 -0
- data/lib/algolia/models/ingestion/auth_o_auth.rb +2 -0
- data/lib/algolia/models/ingestion/auth_o_auth_partial.rb +2 -0
- data/lib/algolia/models/ingestion/authentication.rb +2 -0
- data/lib/algolia/models/ingestion/authentication_create.rb +2 -0
- data/lib/algolia/models/ingestion/authentication_create_response.rb +2 -0
- data/lib/algolia/models/ingestion/authentication_search.rb +2 -0
- data/lib/algolia/models/ingestion/authentication_sort_keys.rb +2 -0
- data/lib/algolia/models/ingestion/authentication_type.rb +2 -0
- data/lib/algolia/models/ingestion/authentication_update.rb +2 -0
- data/lib/algolia/models/ingestion/authentication_update_response.rb +2 -0
- data/lib/algolia/models/ingestion/big_commerce_channel.rb +2 -0
- data/lib/algolia/models/ingestion/big_commerce_metafield.rb +2 -0
- data/lib/algolia/models/ingestion/big_query_data_type.rb +2 -0
- data/lib/algolia/models/ingestion/commercetools_custom_fields.rb +2 -0
- data/lib/algolia/models/ingestion/delete_response.rb +2 -0
- data/lib/algolia/models/ingestion/destination.rb +2 -0
- data/lib/algolia/models/ingestion/destination_create.rb +2 -0
- data/lib/algolia/models/ingestion/destination_create_response.rb +2 -0
- data/lib/algolia/models/ingestion/destination_index_name.rb +2 -0
- data/lib/algolia/models/ingestion/destination_input.rb +2 -0
- data/lib/algolia/models/ingestion/destination_search.rb +2 -0
- data/lib/algolia/models/ingestion/destination_sort_keys.rb +2 -0
- data/lib/algolia/models/ingestion/destination_type.rb +2 -0
- data/lib/algolia/models/ingestion/destination_update.rb +2 -0
- data/lib/algolia/models/ingestion/destination_update_response.rb +2 -0
- data/lib/algolia/models/ingestion/docker_streams.rb +2 -0
- data/lib/algolia/models/ingestion/docker_streams_input.rb +2 -0
- data/lib/algolia/models/ingestion/docker_streams_sync_mode.rb +2 -0
- data/lib/algolia/models/ingestion/email_notifications.rb +2 -0
- data/lib/algolia/models/ingestion/entity_type.rb +2 -0
- data/lib/algolia/models/ingestion/error_base.rb +2 -0
- data/lib/algolia/models/ingestion/event.rb +2 -0
- data/lib/algolia/models/ingestion/event_sort_keys.rb +2 -0
- data/lib/algolia/models/ingestion/event_status.rb +2 -0
- data/lib/algolia/models/ingestion/event_type.rb +2 -0
- data/lib/algolia/models/ingestion/list_authentications_response.rb +2 -0
- data/lib/algolia/models/ingestion/list_destinations_response.rb +2 -0
- data/lib/algolia/models/ingestion/list_events_response.rb +2 -0
- data/lib/algolia/models/ingestion/list_sources_response.rb +2 -0
- data/lib/algolia/models/ingestion/list_tasks_response.rb +2 -0
- data/lib/algolia/models/ingestion/list_tasks_response_v1.rb +2 -0
- data/lib/algolia/models/ingestion/list_transformations_response.rb +2 -0
- data/lib/algolia/models/ingestion/mapping_field_directive.rb +2 -0
- data/lib/algolia/models/ingestion/mapping_format_schema.rb +2 -0
- data/lib/algolia/models/ingestion/mapping_input.rb +2 -0
- data/lib/algolia/models/ingestion/mapping_kit_action.rb +2 -0
- data/lib/algolia/models/ingestion/mapping_type_csv.rb +2 -0
- data/lib/algolia/models/ingestion/method_type.rb +2 -0
- data/lib/algolia/models/ingestion/notifications.rb +2 -0
- data/lib/algolia/models/ingestion/on_demand_trigger.rb +2 -0
- data/lib/algolia/models/ingestion/on_demand_trigger_input.rb +2 -0
- data/lib/algolia/models/ingestion/on_demand_trigger_type.rb +2 -0
- data/lib/algolia/models/ingestion/order_keys.rb +2 -0
- data/lib/algolia/models/ingestion/pagination.rb +2 -0
- data/lib/algolia/models/ingestion/platform.rb +2 -0
- data/lib/algolia/models/ingestion/platform_none.rb +2 -0
- data/lib/algolia/models/ingestion/platform_with_none.rb +2 -0
- data/lib/algolia/models/ingestion/policies.rb +2 -0
- data/lib/algolia/models/ingestion/push_task_payload.rb +2 -0
- data/lib/algolia/models/ingestion/push_task_records.rb +10 -8
- data/lib/algolia/models/ingestion/record_type.rb +2 -0
- data/lib/algolia/models/ingestion/run.rb +2 -0
- data/lib/algolia/models/ingestion/run_list_response.rb +2 -0
- data/lib/algolia/models/ingestion/run_outcome.rb +3 -2
- data/lib/algolia/models/ingestion/run_progress.rb +6 -0
- data/lib/algolia/models/ingestion/run_reason_code.rb +2 -0
- data/lib/algolia/models/ingestion/run_response.rb +2 -0
- data/lib/algolia/models/ingestion/run_sort_keys.rb +2 -0
- data/lib/algolia/models/ingestion/run_source_payload.rb +2 -0
- data/lib/algolia/models/ingestion/run_source_response.rb +2 -0
- data/lib/algolia/models/ingestion/run_status.rb +2 -0
- data/lib/algolia/models/ingestion/run_type.rb +2 -0
- data/lib/algolia/models/ingestion/schedule_trigger.rb +2 -0
- data/lib/algolia/models/ingestion/schedule_trigger_input.rb +2 -0
- data/lib/algolia/models/ingestion/schedule_trigger_type.rb +2 -0
- data/lib/algolia/models/ingestion/shopify_input.rb +2 -0
- data/lib/algolia/models/ingestion/shopify_market.rb +2 -0
- data/lib/algolia/models/ingestion/shopify_metafield.rb +2 -0
- data/lib/algolia/models/ingestion/source.rb +2 -0
- data/lib/algolia/models/ingestion/source_big_commerce.rb +2 -0
- data/lib/algolia/models/ingestion/source_big_query.rb +2 -0
- data/lib/algolia/models/ingestion/source_commercetools.rb +2 -0
- data/lib/algolia/models/ingestion/source_create.rb +2 -0
- data/lib/algolia/models/ingestion/source_create_response.rb +2 -0
- data/lib/algolia/models/ingestion/source_csv.rb +2 -0
- data/lib/algolia/models/ingestion/source_docker.rb +4 -36
- data/lib/algolia/models/ingestion/source_ga4_big_query_export.rb +2 -0
- data/lib/algolia/models/ingestion/source_input.rb +2 -0
- data/lib/algolia/models/ingestion/source_json.rb +2 -0
- data/lib/algolia/models/ingestion/source_search.rb +2 -0
- data/lib/algolia/models/ingestion/source_shopify.rb +2 -0
- data/lib/algolia/models/ingestion/source_sort_keys.rb +2 -0
- data/lib/algolia/models/ingestion/source_type.rb +2 -0
- data/lib/algolia/models/ingestion/source_update.rb +2 -0
- data/lib/algolia/models/ingestion/source_update_commercetools.rb +2 -0
- data/lib/algolia/models/ingestion/source_update_docker.rb +3 -30
- data/lib/algolia/models/ingestion/source_update_input.rb +2 -0
- data/lib/algolia/models/ingestion/source_update_response.rb +2 -0
- data/lib/algolia/models/ingestion/source_update_shopify.rb +2 -0
- data/lib/algolia/models/ingestion/streaming_input.rb +2 -0
- data/lib/algolia/models/ingestion/streaming_trigger.rb +2 -0
- data/lib/algolia/models/ingestion/streaming_trigger_type.rb +2 -0
- data/lib/algolia/models/ingestion/subscription_trigger.rb +2 -0
- data/lib/algolia/models/ingestion/subscription_trigger_type.rb +2 -0
- data/lib/algolia/models/ingestion/task.rb +2 -0
- data/lib/algolia/models/ingestion/task_create.rb +2 -0
- data/lib/algolia/models/ingestion/task_create_response.rb +2 -0
- data/lib/algolia/models/ingestion/task_create_trigger.rb +2 -0
- data/lib/algolia/models/ingestion/task_create_v1.rb +2 -0
- data/lib/algolia/models/ingestion/task_input.rb +2 -0
- data/lib/algolia/models/ingestion/task_search.rb +2 -0
- data/lib/algolia/models/ingestion/task_sort_keys.rb +2 -0
- data/lib/algolia/models/ingestion/task_update.rb +2 -0
- data/lib/algolia/models/ingestion/task_update_response.rb +2 -0
- data/lib/algolia/models/ingestion/task_update_v1.rb +2 -0
- data/lib/algolia/models/ingestion/task_v1.rb +2 -0
- data/lib/algolia/models/ingestion/transformation.rb +2 -0
- data/lib/algolia/models/ingestion/transformation_create.rb +2 -0
- data/lib/algolia/models/ingestion/transformation_create_response.rb +2 -0
- data/lib/algolia/models/ingestion/transformation_error.rb +2 -0
- data/lib/algolia/models/ingestion/transformation_search.rb +2 -0
- data/lib/algolia/models/ingestion/transformation_sort_keys.rb +2 -0
- data/lib/algolia/models/ingestion/transformation_try.rb +2 -0
- data/lib/algolia/models/ingestion/transformation_try_response.rb +2 -0
- data/lib/algolia/models/ingestion/transformation_update_response.rb +2 -0
- data/lib/algolia/models/ingestion/trigger.rb +2 -0
- data/lib/algolia/models/ingestion/trigger_type.rb +2 -0
- data/lib/algolia/models/ingestion/trigger_update_input.rb +2 -0
- data/lib/algolia/models/ingestion/watch_response.rb +2 -0
- data/lib/algolia/models/ingestion/window.rb +2 -0
- data/lib/algolia/models/insights/add_to_cart_event.rb +2 -0
- data/lib/algolia/models/insights/added_to_cart_object_ids.rb +2 -0
- data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb +2 -0
- data/lib/algolia/models/insights/click_event.rb +2 -0
- data/lib/algolia/models/insights/clicked_filters.rb +2 -0
- data/lib/algolia/models/insights/clicked_object_ids.rb +2 -0
- data/lib/algolia/models/insights/clicked_object_ids_after_search.rb +2 -0
- data/lib/algolia/models/insights/conversion_event.rb +2 -0
- data/lib/algolia/models/insights/converted_filters.rb +2 -0
- data/lib/algolia/models/insights/converted_object_ids.rb +2 -0
- data/lib/algolia/models/insights/converted_object_ids_after_search.rb +2 -0
- data/lib/algolia/models/insights/discount.rb +2 -0
- data/lib/algolia/models/insights/error_base.rb +2 -0
- data/lib/algolia/models/insights/events_items.rb +2 -0
- data/lib/algolia/models/insights/events_response.rb +2 -0
- data/lib/algolia/models/insights/insights_events.rb +2 -0
- data/lib/algolia/models/insights/object_data.rb +2 -0
- data/lib/algolia/models/insights/object_data_after_search.rb +2 -0
- data/lib/algolia/models/insights/price.rb +2 -0
- data/lib/algolia/models/insights/purchase_event.rb +2 -0
- data/lib/algolia/models/insights/purchased_object_ids.rb +2 -0
- data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +2 -0
- data/lib/algolia/models/insights/value.rb +2 -0
- data/lib/algolia/models/insights/view_event.rb +2 -0
- data/lib/algolia/models/insights/viewed_filters.rb +2 -0
- data/lib/algolia/models/insights/viewed_object_ids.rb +2 -0
- data/lib/algolia/models/monitoring/error_base.rb +2 -0
- data/lib/algolia/models/monitoring/incident.rb +2 -0
- data/lib/algolia/models/monitoring/incident_entry.rb +2 -0
- data/lib/algolia/models/monitoring/incidents_response.rb +2 -0
- data/lib/algolia/models/monitoring/indexing_metric.rb +2 -0
- data/lib/algolia/models/monitoring/indexing_time_response.rb +2 -0
- data/lib/algolia/models/monitoring/infrastructure_response.rb +2 -0
- data/lib/algolia/models/monitoring/inventory_response.rb +2 -0
- data/lib/algolia/models/monitoring/latency_metric.rb +2 -0
- data/lib/algolia/models/monitoring/latency_response.rb +2 -0
- data/lib/algolia/models/monitoring/metric.rb +2 -0
- data/lib/algolia/models/monitoring/metrics.rb +2 -0
- data/lib/algolia/models/monitoring/period.rb +2 -0
- data/lib/algolia/models/monitoring/probes_metric.rb +2 -0
- data/lib/algolia/models/monitoring/region.rb +2 -0
- data/lib/algolia/models/monitoring/server.rb +2 -0
- data/lib/algolia/models/monitoring/server_status.rb +2 -0
- data/lib/algolia/models/monitoring/status.rb +2 -0
- data/lib/algolia/models/monitoring/status_response.rb +2 -0
- data/lib/algolia/models/monitoring/time_entry.rb +2 -0
- data/lib/algolia/models/monitoring/type.rb +2 -0
- data/lib/algolia/models/personalization/delete_user_profile_response.rb +2 -0
- data/lib/algolia/models/personalization/error_base.rb +2 -0
- data/lib/algolia/models/personalization/event_type.rb +2 -0
- data/lib/algolia/models/personalization/events_scoring.rb +2 -0
- data/lib/algolia/models/personalization/facets_scoring.rb +2 -0
- data/lib/algolia/models/personalization/get_user_token_response.rb +2 -0
- data/lib/algolia/models/personalization/personalization_strategy_params.rb +2 -0
- data/lib/algolia/models/personalization/set_personalization_strategy_response.rb +2 -0
- data/lib/algolia/models/query-suggestions/base_response.rb +2 -0
- data/lib/algolia/models/query-suggestions/config_status.rb +2 -0
- data/lib/algolia/models/query-suggestions/configuration.rb +2 -0
- data/lib/algolia/models/query-suggestions/configuration_response.rb +2 -0
- data/lib/algolia/models/query-suggestions/configuration_with_index.rb +2 -0
- data/lib/algolia/models/query-suggestions/error_base.rb +2 -0
- data/lib/algolia/models/query-suggestions/facet.rb +2 -0
- data/lib/algolia/models/query-suggestions/languages.rb +2 -0
- data/lib/algolia/models/query-suggestions/log_file.rb +2 -0
- data/lib/algolia/models/query-suggestions/log_level.rb +2 -0
- data/lib/algolia/models/query-suggestions/source_index.rb +2 -0
- data/lib/algolia/models/recommend/advanced_syntax_features.rb +2 -0
- data/lib/algolia/models/recommend/alternatives_as_exact.rb +2 -0
- data/lib/algolia/models/recommend/around_precision.rb +2 -0
- data/lib/algolia/models/recommend/around_radius.rb +2 -0
- data/lib/algolia/models/recommend/around_radius_all.rb +2 -0
- data/lib/algolia/models/recommend/auto_facet_filter.rb +2 -0
- data/lib/algolia/models/recommend/banner.rb +3 -1
- data/lib/algolia/models/recommend/banner_image.rb +3 -1
- data/lib/algolia/models/recommend/banner_image_url.rb +3 -1
- data/lib/algolia/models/recommend/banner_link.rb +3 -1
- data/lib/algolia/models/recommend/boolean_string.rb +2 -0
- data/lib/algolia/models/recommend/bought_together_query.rb +10 -8
- data/lib/algolia/models/recommend/condition.rb +2 -0
- data/lib/algolia/models/recommend/consequence.rb +2 -0
- data/lib/algolia/models/recommend/deleted_at_response.rb +2 -0
- data/lib/algolia/models/recommend/distinct.rb +2 -0
- data/lib/algolia/models/recommend/error_base.rb +2 -0
- data/lib/algolia/models/recommend/exact_on_single_word_query.rb +2 -0
- data/lib/algolia/models/recommend/exhaustive.rb +2 -0
- data/lib/algolia/models/recommend/facet_filters.rb +2 -0
- data/lib/algolia/models/recommend/facet_ordering.rb +2 -0
- data/lib/algolia/models/recommend/facet_stats.rb +2 -0
- data/lib/algolia/models/recommend/fallback_params.rb +27 -1
- data/lib/algolia/models/recommend/fbt_model.rb +2 -0
- data/lib/algolia/models/recommend/get_recommend_task_response.rb +2 -0
- data/lib/algolia/models/recommend/get_recommendations_params.rb +2 -0
- data/lib/algolia/models/recommend/get_recommendations_response.rb +2 -0
- data/lib/algolia/models/recommend/hide_consequence_object.rb +9 -7
- data/lib/algolia/models/recommend/highlight_result.rb +2 -0
- data/lib/algolia/models/recommend/highlight_result_option.rb +2 -0
- data/lib/algolia/models/recommend/ignore_plurals.rb +2 -0
- data/lib/algolia/models/recommend/index_settings_facets.rb +2 -0
- data/lib/algolia/models/recommend/inside_bounding_box.rb +2 -0
- data/lib/algolia/models/recommend/looking_similar_model.rb +2 -0
- data/lib/algolia/models/recommend/looking_similar_query.rb +10 -8
- data/lib/algolia/models/recommend/match_level.rb +2 -0
- data/lib/algolia/models/recommend/matched_geo_location.rb +2 -0
- data/lib/algolia/models/recommend/numeric_filters.rb +2 -0
- data/lib/algolia/models/recommend/optional_filters.rb +3 -1
- data/lib/algolia/models/recommend/optional_words.rb +2 -0
- data/lib/algolia/models/recommend/params_consequence.rb +2 -0
- data/lib/algolia/models/recommend/personalization.rb +2 -0
- data/lib/algolia/models/recommend/promote_consequence_object.rb +9 -7
- data/lib/algolia/models/recommend/query_type.rb +2 -0
- data/lib/algolia/models/recommend/range.rb +2 -0
- data/lib/algolia/models/recommend/ranking_info.rb +2 -0
- data/lib/algolia/models/recommend/re_ranking_apply_filter.rb +2 -0
- data/lib/algolia/models/recommend/recommend_hit.rb +10 -8
- data/lib/algolia/models/recommend/recommend_models.rb +2 -0
- data/lib/algolia/models/recommend/recommend_rule.rb +9 -7
- data/lib/algolia/models/recommend/recommend_search_params.rb +27 -1
- data/lib/algolia/models/recommend/recommend_updated_at_response.rb +2 -0
- data/lib/algolia/models/recommend/recommendations_hit.rb +2 -0
- data/lib/algolia/models/recommend/recommendations_request.rb +2 -0
- data/lib/algolia/models/recommend/recommendations_results.rb +2 -0
- data/lib/algolia/models/recommend/redirect.rb +2 -0
- data/lib/algolia/models/recommend/redirect_rule_index_data.rb +2 -0
- data/lib/algolia/models/recommend/redirect_rule_index_metadata.rb +2 -0
- data/lib/algolia/models/recommend/redirect_url.rb +2 -0
- data/lib/algolia/models/recommend/related_model.rb +2 -0
- data/lib/algolia/models/recommend/related_query.rb +10 -8
- data/lib/algolia/models/recommend/remove_stop_words.rb +2 -0
- data/lib/algolia/models/recommend/remove_words_if_no_results.rb +2 -0
- data/lib/algolia/models/recommend/rendering_content.rb +2 -0
- data/lib/algolia/models/recommend/rule_metadata.rb +2 -0
- data/lib/algolia/models/recommend/search_recommend_rules_params.rb +2 -0
- data/lib/algolia/models/recommend/search_recommend_rules_response.rb +2 -0
- data/lib/algolia/models/recommend/snippet_result.rb +2 -0
- data/lib/algolia/models/recommend/snippet_result_option.rb +2 -0
- data/lib/algolia/models/recommend/sort_remaining_by.rb +2 -0
- data/lib/algolia/models/recommend/supported_language.rb +2 -0
- data/lib/algolia/models/recommend/tag_filters.rb +2 -0
- data/lib/algolia/models/recommend/task_status.rb +2 -0
- data/lib/algolia/models/recommend/time_range.rb +2 -0
- data/lib/algolia/models/recommend/trending_facet_hit.rb +2 -0
- data/lib/algolia/models/recommend/trending_facets_model.rb +2 -0
- data/lib/algolia/models/recommend/trending_facets_query.rb +4 -4
- data/lib/algolia/models/recommend/trending_items_model.rb +2 -0
- data/lib/algolia/models/recommend/trending_items_query.rb +2 -0
- data/lib/algolia/models/recommend/typo_tolerance.rb +2 -0
- data/lib/algolia/models/recommend/typo_tolerance_enum.rb +2 -0
- data/lib/algolia/models/recommend/value.rb +2 -0
- data/lib/algolia/models/recommend/widgets.rb +4 -2
- data/lib/algolia/models/search/acl.rb +2 -0
- data/lib/algolia/models/search/action.rb +2 -0
- data/lib/algolia/models/search/add_api_key_response.rb +2 -0
- data/lib/algolia/models/search/advanced_syntax_features.rb +2 -0
- data/lib/algolia/models/search/alternatives_as_exact.rb +2 -0
- data/lib/algolia/models/search/anchoring.rb +2 -0
- data/lib/algolia/models/search/api_key.rb +2 -0
- data/lib/algolia/models/search/api_key_operation.rb +2 -0
- data/lib/algolia/models/search/around_precision.rb +2 -0
- data/lib/algolia/models/search/around_radius.rb +2 -0
- data/lib/algolia/models/search/around_radius_all.rb +2 -0
- data/lib/algolia/models/search/assign_user_id_params.rb +2 -0
- data/lib/algolia/models/search/attribute_to_update.rb +2 -0
- data/lib/algolia/models/search/automatic_facet_filter.rb +2 -0
- data/lib/algolia/models/search/automatic_facet_filters.rb +2 -0
- data/lib/algolia/models/search/banner.rb +3 -1
- data/lib/algolia/models/search/banner_image.rb +3 -1
- data/lib/algolia/models/search/banner_image_url.rb +3 -1
- data/lib/algolia/models/search/banner_link.rb +3 -1
- data/lib/algolia/models/search/batch_assign_user_ids_params.rb +2 -0
- data/lib/algolia/models/search/batch_dictionary_entries_params.rb +2 -0
- data/lib/algolia/models/search/batch_dictionary_entries_request.rb +2 -0
- data/lib/algolia/models/search/batch_params.rb +2 -0
- data/lib/algolia/models/search/batch_request.rb +2 -0
- data/lib/algolia/models/search/batch_response.rb +2 -0
- data/lib/algolia/models/search/batch_write_params.rb +2 -0
- data/lib/algolia/models/search/boolean_string.rb +2 -0
- data/lib/algolia/models/search/browse_params.rb +2 -0
- data/lib/algolia/models/search/browse_params_object.rb +3 -25
- data/lib/algolia/models/search/browse_response.rb +2 -0
- data/lib/algolia/models/search/built_in_operation.rb +2 -0
- data/lib/algolia/models/search/built_in_operation_type.rb +2 -0
- data/lib/algolia/models/search/built_in_operation_value.rb +2 -0
- data/lib/algolia/models/search/condition.rb +2 -0
- data/lib/algolia/models/search/consequence.rb +3 -3
- data/lib/algolia/models/search/consequence_hide.rb +10 -8
- data/lib/algolia/models/search/consequence_params.rb +3 -25
- data/lib/algolia/models/search/consequence_query.rb +2 -0
- data/lib/algolia/models/search/consequence_query_object.rb +2 -0
- data/lib/algolia/models/search/created_at_response.rb +2 -0
- data/lib/algolia/models/search/delete_api_key_response.rb +2 -0
- data/lib/algolia/models/search/delete_by_params.rb +2 -0
- data/lib/algolia/models/search/delete_source_response.rb +2 -0
- data/lib/algolia/models/search/deleted_at_response.rb +2 -0
- data/lib/algolia/models/search/dictionary_action.rb +2 -0
- data/lib/algolia/models/search/dictionary_entry.rb +10 -8
- data/lib/algolia/models/search/dictionary_entry_state.rb +2 -0
- data/lib/algolia/models/search/dictionary_entry_type.rb +2 -0
- data/lib/algolia/models/search/dictionary_language.rb +2 -0
- data/lib/algolia/models/search/dictionary_settings_params.rb +2 -0
- data/lib/algolia/models/search/dictionary_type.rb +2 -0
- data/lib/algolia/models/search/distinct.rb +2 -0
- data/lib/algolia/models/search/edit.rb +2 -0
- data/lib/algolia/models/search/edit_type.rb +2 -0
- data/lib/algolia/models/search/error_base.rb +2 -0
- data/lib/algolia/models/search/exact_on_single_word_query.rb +2 -0
- data/lib/algolia/models/search/exhaustive.rb +2 -0
- data/lib/algolia/models/search/facet_filters.rb +2 -0
- data/lib/algolia/models/search/facet_hits.rb +2 -0
- data/lib/algolia/models/search/facet_ordering.rb +2 -0
- data/lib/algolia/models/search/facet_stats.rb +2 -0
- data/lib/algolia/models/search/facets.rb +2 -0
- data/lib/algolia/models/search/fetched_index.rb +2 -0
- data/lib/algolia/models/search/get_api_key_response.rb +2 -0
- data/lib/algolia/models/search/get_dictionary_settings_response.rb +2 -0
- data/lib/algolia/models/search/get_logs_response.rb +2 -0
- data/lib/algolia/models/search/get_objects_params.rb +2 -0
- data/lib/algolia/models/search/get_objects_request.rb +10 -8
- data/lib/algolia/models/search/get_objects_response.rb +2 -0
- data/lib/algolia/models/search/get_task_response.rb +2 -0
- data/lib/algolia/models/search/get_top_user_ids_response.rb +2 -0
- data/lib/algolia/models/search/has_pending_mappings_response.rb +2 -0
- data/lib/algolia/models/search/highlight_result.rb +2 -0
- data/lib/algolia/models/search/highlight_result_option.rb +2 -0
- data/lib/algolia/models/search/hit.rb +10 -8
- data/lib/algolia/models/search/ignore_plurals.rb +2 -0
- data/lib/algolia/models/search/index_settings.rb +27 -25
- data/lib/algolia/models/search/inside_bounding_box.rb +2 -0
- data/lib/algolia/models/search/languages.rb +2 -0
- data/lib/algolia/models/search/list_api_keys_response.rb +2 -0
- data/lib/algolia/models/search/list_clusters_response.rb +2 -0
- data/lib/algolia/models/search/list_indices_response.rb +2 -0
- data/lib/algolia/models/search/list_user_ids_response.rb +2 -0
- data/lib/algolia/models/search/log.rb +2 -0
- data/lib/algolia/models/search/log_query.rb +2 -0
- data/lib/algolia/models/search/log_type.rb +2 -0
- data/lib/algolia/models/search/match_level.rb +2 -0
- data/lib/algolia/models/search/matched_geo_location.rb +2 -0
- data/lib/algolia/models/search/mode.rb +2 -0
- data/lib/algolia/models/search/multiple_batch_request.rb +2 -0
- data/lib/algolia/models/search/multiple_batch_response.rb +2 -0
- data/lib/algolia/models/search/numeric_filters.rb +2 -0
- data/lib/algolia/models/search/operation_index_params.rb +2 -0
- data/lib/algolia/models/search/operation_type.rb +2 -0
- data/lib/algolia/models/search/optional_filters.rb +3 -1
- data/lib/algolia/models/search/optional_words.rb +2 -0
- data/lib/algolia/models/search/personalization.rb +2 -0
- data/lib/algolia/models/search/promote.rb +2 -0
- data/lib/algolia/models/search/promote_object_id.rb +10 -8
- data/lib/algolia/models/search/promote_object_ids.rb +2 -0
- data/lib/algolia/models/search/query_type.rb +2 -0
- data/lib/algolia/models/search/range.rb +2 -0
- data/lib/algolia/models/search/ranking_info.rb +2 -0
- data/lib/algolia/models/search/re_ranking_apply_filter.rb +2 -0
- data/lib/algolia/models/search/redirect.rb +2 -0
- data/lib/algolia/models/search/redirect_rule_index_data.rb +2 -0
- data/lib/algolia/models/search/redirect_rule_index_metadata.rb +2 -0
- data/lib/algolia/models/search/redirect_url.rb +2 -0
- data/lib/algolia/models/search/remove_stop_words.rb +2 -0
- data/lib/algolia/models/search/remove_user_id_response.rb +2 -0
- data/lib/algolia/models/search/remove_words_if_no_results.rb +2 -0
- data/lib/algolia/models/search/rendering_content.rb +2 -0
- data/lib/algolia/models/search/replace_all_objects_response.rb +2 -0
- data/lib/algolia/models/search/replace_source_response.rb +2 -0
- data/lib/algolia/models/search/rule.rb +10 -8
- data/lib/algolia/models/search/save_object_response.rb +9 -7
- data/lib/algolia/models/search/save_synonym_response.rb +2 -0
- data/lib/algolia/models/search/scope_type.rb +2 -0
- data/lib/algolia/models/search/search_dictionary_entries_params.rb +2 -0
- data/lib/algolia/models/search/search_dictionary_entries_response.rb +2 -0
- data/lib/algolia/models/search/search_for_facet_values_request.rb +2 -0
- data/lib/algolia/models/search/search_for_facet_values_response.rb +2 -0
- data/lib/algolia/models/search/search_for_facets.rb +3 -25
- data/lib/algolia/models/search/search_for_hits.rb +3 -25
- data/lib/algolia/models/search/search_method_params.rb +2 -0
- data/lib/algolia/models/search/search_params.rb +2 -0
- data/lib/algolia/models/search/search_params_object.rb +3 -25
- data/lib/algolia/models/search/search_params_string.rb +2 -0
- data/lib/algolia/models/search/search_query.rb +2 -0
- data/lib/algolia/models/search/search_response.rb +2 -0
- data/lib/algolia/models/search/search_responses.rb +2 -0
- data/lib/algolia/models/search/search_result.rb +2 -0
- data/lib/algolia/models/search/search_rules_params.rb +2 -0
- data/lib/algolia/models/search/search_rules_response.rb +2 -0
- data/lib/algolia/models/search/search_strategy.rb +2 -0
- data/lib/algolia/models/search/search_synonyms_params.rb +2 -0
- data/lib/algolia/models/search/search_synonyms_response.rb +2 -0
- data/lib/algolia/models/search/search_type_default.rb +2 -0
- data/lib/algolia/models/search/search_type_facet.rb +2 -0
- data/lib/algolia/models/search/search_user_ids_params.rb +2 -0
- data/lib/algolia/models/search/search_user_ids_response.rb +2 -0
- data/lib/algolia/models/search/secured_api_key_restrictions.rb +2 -0
- data/lib/algolia/models/search/semantic_search.rb +2 -0
- data/lib/algolia/models/search/settings_response.rb +27 -25
- data/lib/algolia/models/search/snippet_result.rb +2 -0
- data/lib/algolia/models/search/snippet_result_option.rb +2 -0
- data/lib/algolia/models/search/sort_remaining_by.rb +2 -0
- data/lib/algolia/models/search/source.rb +2 -0
- data/lib/algolia/models/search/standard_entries.rb +2 -0
- data/lib/algolia/models/search/supported_language.rb +2 -0
- data/lib/algolia/models/search/synonym_hit.rb +10 -8
- data/lib/algolia/models/search/synonym_type.rb +2 -0
- data/lib/algolia/models/search/tag_filters.rb +2 -0
- data/lib/algolia/models/search/task_status.rb +2 -0
- data/lib/algolia/models/search/time_range.rb +2 -0
- data/lib/algolia/models/search/typo_tolerance.rb +2 -0
- data/lib/algolia/models/search/typo_tolerance_enum.rb +2 -0
- data/lib/algolia/models/search/update_api_key_response.rb +2 -0
- data/lib/algolia/models/search/updated_at_response.rb +2 -0
- data/lib/algolia/models/search/updated_at_with_object_id_response.rb +9 -7
- data/lib/algolia/models/search/user_highlight_result.rb +2 -0
- data/lib/algolia/models/search/user_hit.rb +10 -8
- data/lib/algolia/models/search/user_id.rb +2 -0
- data/lib/algolia/models/search/value.rb +2 -0
- data/lib/algolia/models/search/widgets.rb +4 -2
- data/lib/algolia/version.rb +3 -1
- metadata +54 -4
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
2
4
|
|
3
5
|
require "date"
|
@@ -60,15 +62,18 @@ module Algolia
|
|
60
62
|
# 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).
|
61
63
|
attr_accessor :max_facet_hits
|
62
64
|
|
65
|
+
# 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.
|
66
|
+
attr_accessor :keep_diacritics_on_characters
|
67
|
+
|
68
|
+
# 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.
|
69
|
+
attr_accessor :custom_ranking
|
70
|
+
|
63
71
|
# 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.
|
64
72
|
attr_accessor :attributes_to_retrieve
|
65
73
|
|
66
74
|
# 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/).
|
67
75
|
attr_accessor :ranking
|
68
76
|
|
69
|
-
# 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.
|
70
|
-
attr_accessor :custom_ranking
|
71
|
-
|
72
77
|
# 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.
|
73
78
|
attr_accessor :relevancy_strictness
|
74
79
|
|
@@ -111,9 +116,6 @@ module Algolia
|
|
111
116
|
|
112
117
|
attr_accessor :remove_stop_words
|
113
118
|
|
114
|
-
# 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.
|
115
|
-
attr_accessor :keep_diacritics_on_characters
|
116
|
-
|
117
119
|
# 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/).
|
118
120
|
attr_accessor :query_languages
|
119
121
|
|
@@ -158,7 +160,7 @@ module Algolia
|
|
158
160
|
# 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.
|
159
161
|
attr_accessor :min_proximity
|
160
162
|
|
161
|
-
# Properties to include in the API response of
|
163
|
+
# Properties to include in the API response of search and browse requests. By default, all response properties are included. To reduce the response size, you can select which properties should be included. An empty list may lead to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`, `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend on other properties, for example, for pagination. Before restricting the response size, check the impact on your search experience.
|
162
164
|
attr_accessor :response_fields
|
163
165
|
|
164
166
|
# Maximum number of facet values to return for each facet.
|
@@ -201,9 +203,10 @@ module Algolia
|
|
201
203
|
:custom_normalization => :customNormalization,
|
202
204
|
:attribute_for_distinct => :attributeForDistinct,
|
203
205
|
:max_facet_hits => :maxFacetHits,
|
206
|
+
:keep_diacritics_on_characters => :keepDiacriticsOnCharacters,
|
207
|
+
:custom_ranking => :customRanking,
|
204
208
|
:attributes_to_retrieve => :attributesToRetrieve,
|
205
209
|
:ranking => :ranking,
|
206
|
-
:custom_ranking => :customRanking,
|
207
210
|
:relevancy_strictness => :relevancyStrictness,
|
208
211
|
:attributes_to_highlight => :attributesToHighlight,
|
209
212
|
:attributes_to_snippet => :attributesToSnippet,
|
@@ -219,7 +222,6 @@ module Algolia
|
|
219
222
|
:disable_typo_tolerance_on_attributes => :disableTypoToleranceOnAttributes,
|
220
223
|
:ignore_plurals => :ignorePlurals,
|
221
224
|
:remove_stop_words => :removeStopWords,
|
222
|
-
:keep_diacritics_on_characters => :keepDiacriticsOnCharacters,
|
223
225
|
:query_languages => :queryLanguages,
|
224
226
|
:decompound_query => :decompoundQuery,
|
225
227
|
:enable_rules => :enableRules,
|
@@ -269,9 +271,10 @@ module Algolia
|
|
269
271
|
:custom_normalization => :"Hash<String, Hash<String, String>>",
|
270
272
|
:attribute_for_distinct => :"String",
|
271
273
|
:max_facet_hits => :"Integer",
|
274
|
+
:keep_diacritics_on_characters => :"String",
|
275
|
+
:custom_ranking => :"Array<String>",
|
272
276
|
:attributes_to_retrieve => :"Array<String>",
|
273
277
|
:ranking => :"Array<String>",
|
274
|
-
:custom_ranking => :"Array<String>",
|
275
278
|
:relevancy_strictness => :"Integer",
|
276
279
|
:attributes_to_highlight => :"Array<String>",
|
277
280
|
:attributes_to_snippet => :"Array<String>",
|
@@ -287,7 +290,6 @@ module Algolia
|
|
287
290
|
:disable_typo_tolerance_on_attributes => :"Array<String>",
|
288
291
|
:ignore_plurals => :"IgnorePlurals",
|
289
292
|
:remove_stop_words => :"RemoveStopWords",
|
290
|
-
:keep_diacritics_on_characters => :"String",
|
291
293
|
:query_languages => :"Array<SupportedLanguage>",
|
292
294
|
:decompound_query => :"Boolean",
|
293
295
|
:enable_rules => :"Boolean",
|
@@ -450,6 +452,16 @@ module Algolia
|
|
450
452
|
self.max_facet_hits = attributes[:max_facet_hits]
|
451
453
|
end
|
452
454
|
|
455
|
+
if attributes.key?(:keep_diacritics_on_characters)
|
456
|
+
self.keep_diacritics_on_characters = attributes[:keep_diacritics_on_characters]
|
457
|
+
end
|
458
|
+
|
459
|
+
if attributes.key?(:custom_ranking)
|
460
|
+
if (value = attributes[:custom_ranking]).is_a?(Array)
|
461
|
+
self.custom_ranking = value
|
462
|
+
end
|
463
|
+
end
|
464
|
+
|
453
465
|
if attributes.key?(:attributes_to_retrieve)
|
454
466
|
if (value = attributes[:attributes_to_retrieve]).is_a?(Array)
|
455
467
|
self.attributes_to_retrieve = value
|
@@ -462,12 +474,6 @@ module Algolia
|
|
462
474
|
end
|
463
475
|
end
|
464
476
|
|
465
|
-
if attributes.key?(:custom_ranking)
|
466
|
-
if (value = attributes[:custom_ranking]).is_a?(Array)
|
467
|
-
self.custom_ranking = value
|
468
|
-
end
|
469
|
-
end
|
470
|
-
|
471
477
|
if attributes.key?(:relevancy_strictness)
|
472
478
|
self.relevancy_strictness = attributes[:relevancy_strictness]
|
473
479
|
end
|
@@ -534,10 +540,6 @@ module Algolia
|
|
534
540
|
self.remove_stop_words = attributes[:remove_stop_words]
|
535
541
|
end
|
536
542
|
|
537
|
-
if attributes.key?(:keep_diacritics_on_characters)
|
538
|
-
self.keep_diacritics_on_characters = attributes[:keep_diacritics_on_characters]
|
539
|
-
end
|
540
|
-
|
541
543
|
if attributes.key?(:query_languages)
|
542
544
|
if (value = attributes[:query_languages]).is_a?(Array)
|
543
545
|
self.query_languages = value
|
@@ -672,9 +674,10 @@ module Algolia
|
|
672
674
|
custom_normalization == other.custom_normalization &&
|
673
675
|
attribute_for_distinct == other.attribute_for_distinct &&
|
674
676
|
max_facet_hits == other.max_facet_hits &&
|
677
|
+
keep_diacritics_on_characters == other.keep_diacritics_on_characters &&
|
678
|
+
custom_ranking == other.custom_ranking &&
|
675
679
|
attributes_to_retrieve == other.attributes_to_retrieve &&
|
676
680
|
ranking == other.ranking &&
|
677
|
-
custom_ranking == other.custom_ranking &&
|
678
681
|
relevancy_strictness == other.relevancy_strictness &&
|
679
682
|
attributes_to_highlight == other.attributes_to_highlight &&
|
680
683
|
attributes_to_snippet == other.attributes_to_snippet &&
|
@@ -690,7 +693,6 @@ module Algolia
|
|
690
693
|
disable_typo_tolerance_on_attributes == other.disable_typo_tolerance_on_attributes &&
|
691
694
|
ignore_plurals == other.ignore_plurals &&
|
692
695
|
remove_stop_words == other.remove_stop_words &&
|
693
|
-
keep_diacritics_on_characters == other.keep_diacritics_on_characters &&
|
694
696
|
query_languages == other.query_languages &&
|
695
697
|
decompound_query == other.decompound_query &&
|
696
698
|
enable_rules == other.enable_rules &&
|
@@ -746,9 +748,10 @@ module Algolia
|
|
746
748
|
custom_normalization,
|
747
749
|
attribute_for_distinct,
|
748
750
|
max_facet_hits,
|
751
|
+
keep_diacritics_on_characters,
|
752
|
+
custom_ranking,
|
749
753
|
attributes_to_retrieve,
|
750
754
|
ranking,
|
751
|
-
custom_ranking,
|
752
755
|
relevancy_strictness,
|
753
756
|
attributes_to_highlight,
|
754
757
|
attributes_to_snippet,
|
@@ -764,7 +767,6 @@ module Algolia
|
|
764
767
|
disable_typo_tolerance_on_attributes,
|
765
768
|
ignore_plurals,
|
766
769
|
remove_stop_words,
|
767
|
-
keep_diacritics_on_characters,
|
768
770
|
query_languages,
|
769
771
|
decompound_query,
|
770
772
|
enable_rules,
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
2
4
|
|
3
5
|
require "date"
|
@@ -8,7 +10,7 @@ module Algolia
|
|
8
10
|
# Synonym object.
|
9
11
|
class SynonymHit
|
10
12
|
# Unique identifier of a synonym object.
|
11
|
-
attr_accessor :
|
13
|
+
attr_accessor :algolia_object_id
|
12
14
|
|
13
15
|
attr_accessor :type
|
14
16
|
|
@@ -33,7 +35,7 @@ module Algolia
|
|
33
35
|
# Attribute mapping from ruby-style variable name to JSON key.
|
34
36
|
def self.attribute_map
|
35
37
|
{
|
36
|
-
:
|
38
|
+
:algolia_object_id => :objectID,
|
37
39
|
:type => :type,
|
38
40
|
:synonyms => :synonyms,
|
39
41
|
:input => :input,
|
@@ -47,7 +49,7 @@ module Algolia
|
|
47
49
|
# Attribute type mapping.
|
48
50
|
def self.types_mapping
|
49
51
|
{
|
50
|
-
:
|
52
|
+
:algolia_object_id => :"String",
|
51
53
|
:type => :"SynonymType",
|
52
54
|
:synonyms => :"Array<String>",
|
53
55
|
:input => :"String",
|
@@ -88,10 +90,10 @@ module Algolia
|
|
88
90
|
h[k.to_sym] = v
|
89
91
|
}
|
90
92
|
|
91
|
-
if attributes.key?(:
|
92
|
-
self.
|
93
|
+
if attributes.key?(:algolia_object_id)
|
94
|
+
self.algolia_object_id = attributes[:algolia_object_id]
|
93
95
|
else
|
94
|
-
self.
|
96
|
+
self.algolia_object_id = nil
|
95
97
|
end
|
96
98
|
|
97
99
|
if attributes.key?(:type)
|
@@ -136,7 +138,7 @@ module Algolia
|
|
136
138
|
def ==(other)
|
137
139
|
return true if self.equal?(other)
|
138
140
|
self.class == other.class &&
|
139
|
-
|
141
|
+
algolia_object_id == other.algolia_object_id &&
|
140
142
|
type == other.type &&
|
141
143
|
synonyms == other.synonyms &&
|
142
144
|
input == other.input &&
|
@@ -155,7 +157,7 @@ module Algolia
|
|
155
157
|
# Calculates hash code according to all attributes.
|
156
158
|
# @return [Integer] Hash code
|
157
159
|
def hash
|
158
|
-
[
|
160
|
+
[algolia_object_id, type, synonyms, input, word, corrections, placeholder, replacements].hash
|
159
161
|
end
|
160
162
|
|
161
163
|
# Builds the object from hash
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
2
4
|
|
3
5
|
require "date"
|
@@ -14,14 +16,14 @@ module Algolia
|
|
14
16
|
attr_accessor :updated_at
|
15
17
|
|
16
18
|
# Unique record identifier.
|
17
|
-
attr_accessor :
|
19
|
+
attr_accessor :algolia_object_id
|
18
20
|
|
19
21
|
# Attribute mapping from ruby-style variable name to JSON key.
|
20
22
|
def self.attribute_map
|
21
23
|
{
|
22
24
|
:task_id => :taskID,
|
23
25
|
:updated_at => :updatedAt,
|
24
|
-
:
|
26
|
+
:algolia_object_id => :objectID
|
25
27
|
}
|
26
28
|
end
|
27
29
|
|
@@ -30,7 +32,7 @@ module Algolia
|
|
30
32
|
{
|
31
33
|
:task_id => :"Integer",
|
32
34
|
:updated_at => :"String",
|
33
|
-
:
|
35
|
+
:algolia_object_id => :"String"
|
34
36
|
}
|
35
37
|
end
|
36
38
|
|
@@ -72,8 +74,8 @@ module Algolia
|
|
72
74
|
self.updated_at = attributes[:updated_at]
|
73
75
|
end
|
74
76
|
|
75
|
-
if attributes.key?(:
|
76
|
-
self.
|
77
|
+
if attributes.key?(:algolia_object_id)
|
78
|
+
self.algolia_object_id = attributes[:algolia_object_id]
|
77
79
|
end
|
78
80
|
end
|
79
81
|
|
@@ -84,7 +86,7 @@ module Algolia
|
|
84
86
|
self.class == other.class &&
|
85
87
|
task_id == other.task_id &&
|
86
88
|
updated_at == other.updated_at &&
|
87
|
-
|
89
|
+
algolia_object_id == other.algolia_object_id
|
88
90
|
end
|
89
91
|
|
90
92
|
# @see the `==` method
|
@@ -96,7 +98,7 @@ module Algolia
|
|
96
98
|
# Calculates hash code according to all attributes.
|
97
99
|
# @return [Integer] Hash code
|
98
100
|
def hash
|
99
|
-
[task_id, updated_at,
|
101
|
+
[task_id, updated_at, algolia_object_id].hash
|
100
102
|
end
|
101
103
|
|
102
104
|
# Builds the object from hash
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
2
4
|
|
3
5
|
require "date"
|
@@ -19,7 +21,7 @@ module Algolia
|
|
19
21
|
attr_accessor :data_size
|
20
22
|
|
21
23
|
# userID of the requested user. Same as userID.
|
22
|
-
attr_accessor :
|
24
|
+
attr_accessor :algolia_object_id
|
23
25
|
|
24
26
|
attr_accessor :_highlight_result
|
25
27
|
|
@@ -30,7 +32,7 @@ module Algolia
|
|
30
32
|
:cluster_name => :clusterName,
|
31
33
|
:nb_records => :nbRecords,
|
32
34
|
:data_size => :dataSize,
|
33
|
-
:
|
35
|
+
:algolia_object_id => :objectID,
|
34
36
|
:_highlight_result => :_highlightResult
|
35
37
|
}
|
36
38
|
end
|
@@ -42,7 +44,7 @@ module Algolia
|
|
42
44
|
:cluster_name => :"String",
|
43
45
|
:nb_records => :"Integer",
|
44
46
|
:data_size => :"Integer",
|
45
|
-
:
|
47
|
+
:algolia_object_id => :"String",
|
46
48
|
:_highlight_result => :"UserHighlightResult"
|
47
49
|
}
|
48
50
|
end
|
@@ -98,10 +100,10 @@ module Algolia
|
|
98
100
|
self.data_size = nil
|
99
101
|
end
|
100
102
|
|
101
|
-
if attributes.key?(:
|
102
|
-
self.
|
103
|
+
if attributes.key?(:algolia_object_id)
|
104
|
+
self.algolia_object_id = attributes[:algolia_object_id]
|
103
105
|
else
|
104
|
-
self.
|
106
|
+
self.algolia_object_id = nil
|
105
107
|
end
|
106
108
|
|
107
109
|
if attributes.key?(:_highlight_result)
|
@@ -120,7 +122,7 @@ module Algolia
|
|
120
122
|
cluster_name == other.cluster_name &&
|
121
123
|
nb_records == other.nb_records &&
|
122
124
|
data_size == other.data_size &&
|
123
|
-
|
125
|
+
algolia_object_id == other.algolia_object_id &&
|
124
126
|
_highlight_result == other._highlight_result
|
125
127
|
end
|
126
128
|
|
@@ -133,7 +135,7 @@ module Algolia
|
|
133
135
|
# Calculates hash code according to all attributes.
|
134
136
|
# @return [Integer] Hash code
|
135
137
|
def hash
|
136
|
-
[user_id, cluster_name, nb_records, data_size,
|
138
|
+
[user_id, cluster_name, nb_records, data_size, algolia_object_id, _highlight_result].hash
|
137
139
|
end
|
138
140
|
|
139
141
|
# Builds the object from hash
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
2
4
|
|
3
5
|
require "date"
|
@@ -5,9 +7,9 @@ require "time"
|
|
5
7
|
|
6
8
|
module Algolia
|
7
9
|
module Search
|
8
|
-
#
|
10
|
+
# Widgets returned from any rules that are applied to the current search.
|
9
11
|
class Widgets
|
10
|
-
#
|
12
|
+
# Banners defined in the Merchandising Studio for a given search.
|
11
13
|
attr_accessor :banners
|
12
14
|
|
13
15
|
# Attribute mapping from ruby-style variable name to JSON key.
|
data/lib/algolia/version.rb
CHANGED
@@ -1,5 +1,7 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
2
4
|
|
3
5
|
module Algolia
|
4
|
-
VERSION = "3.
|
6
|
+
VERSION = "3.12.1"
|
5
7
|
end
|