algolia 3.11.0 → 3.12.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +13 -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 +2 -0
- 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 +26 -0
- 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 +26 -0
- 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 +2 -0
- 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 +2 -24
- 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 +2 -0
- data/lib/algolia/models/search/consequence_hide.rb +10 -8
- data/lib/algolia/models/search/consequence_params.rb +2 -24
- 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 +26 -24
- 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 +2 -24
- data/lib/algolia/models/search/search_for_hits.rb +2 -24
- 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 +2 -24
- 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 +26 -24
- 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"
|
|
@@ -8,19 +10,19 @@ module Algolia
|
|
|
8
10
|
# Object ID of the record to hide.
|
|
9
11
|
class ConsequenceHide
|
|
10
12
|
# Unique record identifier.
|
|
11
|
-
attr_accessor :
|
|
13
|
+
attr_accessor :algolia_object_id
|
|
12
14
|
|
|
13
15
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
14
16
|
def self.attribute_map
|
|
15
17
|
{
|
|
16
|
-
:
|
|
18
|
+
:algolia_object_id => :objectID
|
|
17
19
|
}
|
|
18
20
|
end
|
|
19
21
|
|
|
20
22
|
# Attribute type mapping.
|
|
21
23
|
def self.types_mapping
|
|
22
24
|
{
|
|
23
|
-
:
|
|
25
|
+
:algolia_object_id => :"String"
|
|
24
26
|
}
|
|
25
27
|
end
|
|
26
28
|
|
|
@@ -54,10 +56,10 @@ module Algolia
|
|
|
54
56
|
h[k.to_sym] = v
|
|
55
57
|
}
|
|
56
58
|
|
|
57
|
-
if attributes.key?(:
|
|
58
|
-
self.
|
|
59
|
+
if attributes.key?(:algolia_object_id)
|
|
60
|
+
self.algolia_object_id = attributes[:algolia_object_id]
|
|
59
61
|
else
|
|
60
|
-
self.
|
|
62
|
+
self.algolia_object_id = nil
|
|
61
63
|
end
|
|
62
64
|
end
|
|
63
65
|
|
|
@@ -66,7 +68,7 @@ module Algolia
|
|
|
66
68
|
def ==(other)
|
|
67
69
|
return true if self.equal?(other)
|
|
68
70
|
self.class == other.class &&
|
|
69
|
-
|
|
71
|
+
algolia_object_id == other.algolia_object_id
|
|
70
72
|
end
|
|
71
73
|
|
|
72
74
|
# @see the `==` method
|
|
@@ -78,7 +80,7 @@ module Algolia
|
|
|
78
80
|
# Calculates hash code according to all attributes.
|
|
79
81
|
# @return [Integer] Hash code
|
|
80
82
|
def hash
|
|
81
|
-
[
|
|
83
|
+
[algolia_object_id].hash
|
|
82
84
|
end
|
|
83
85
|
|
|
84
86
|
# 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"
|
|
@@ -98,9 +100,6 @@ module Algolia
|
|
|
98
100
|
# 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/).
|
|
99
101
|
attr_accessor :ranking
|
|
100
102
|
|
|
101
|
-
# 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.
|
|
102
|
-
attr_accessor :custom_ranking
|
|
103
|
-
|
|
104
103
|
# 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.
|
|
105
104
|
attr_accessor :relevancy_strictness
|
|
106
105
|
|
|
@@ -143,9 +142,6 @@ module Algolia
|
|
|
143
142
|
|
|
144
143
|
attr_accessor :remove_stop_words
|
|
145
144
|
|
|
146
|
-
# 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.
|
|
147
|
-
attr_accessor :keep_diacritics_on_characters
|
|
148
|
-
|
|
149
145
|
# 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/).
|
|
150
146
|
attr_accessor :query_languages
|
|
151
147
|
|
|
@@ -251,7 +247,6 @@ module Algolia
|
|
|
251
247
|
:enable_ab_test => :enableABTest,
|
|
252
248
|
:attributes_to_retrieve => :attributesToRetrieve,
|
|
253
249
|
:ranking => :ranking,
|
|
254
|
-
:custom_ranking => :customRanking,
|
|
255
250
|
:relevancy_strictness => :relevancyStrictness,
|
|
256
251
|
:attributes_to_highlight => :attributesToHighlight,
|
|
257
252
|
:attributes_to_snippet => :attributesToSnippet,
|
|
@@ -267,7 +262,6 @@ module Algolia
|
|
|
267
262
|
:disable_typo_tolerance_on_attributes => :disableTypoToleranceOnAttributes,
|
|
268
263
|
:ignore_plurals => :ignorePlurals,
|
|
269
264
|
:remove_stop_words => :removeStopWords,
|
|
270
|
-
:keep_diacritics_on_characters => :keepDiacriticsOnCharacters,
|
|
271
265
|
:query_languages => :queryLanguages,
|
|
272
266
|
:decompound_query => :decompoundQuery,
|
|
273
267
|
:enable_rules => :enableRules,
|
|
@@ -334,7 +328,6 @@ module Algolia
|
|
|
334
328
|
:enable_ab_test => :"Boolean",
|
|
335
329
|
:attributes_to_retrieve => :"Array<String>",
|
|
336
330
|
:ranking => :"Array<String>",
|
|
337
|
-
:custom_ranking => :"Array<String>",
|
|
338
331
|
:relevancy_strictness => :"Integer",
|
|
339
332
|
:attributes_to_highlight => :"Array<String>",
|
|
340
333
|
:attributes_to_snippet => :"Array<String>",
|
|
@@ -350,7 +343,6 @@ module Algolia
|
|
|
350
343
|
:disable_typo_tolerance_on_attributes => :"Array<String>",
|
|
351
344
|
:ignore_plurals => :"IgnorePlurals",
|
|
352
345
|
:remove_stop_words => :"RemoveStopWords",
|
|
353
|
-
:keep_diacritics_on_characters => :"String",
|
|
354
346
|
:query_languages => :"Array<SupportedLanguage>",
|
|
355
347
|
:decompound_query => :"Boolean",
|
|
356
348
|
:enable_rules => :"Boolean",
|
|
@@ -571,12 +563,6 @@ module Algolia
|
|
|
571
563
|
end
|
|
572
564
|
end
|
|
573
565
|
|
|
574
|
-
if attributes.key?(:custom_ranking)
|
|
575
|
-
if (value = attributes[:custom_ranking]).is_a?(Array)
|
|
576
|
-
self.custom_ranking = value
|
|
577
|
-
end
|
|
578
|
-
end
|
|
579
|
-
|
|
580
566
|
if attributes.key?(:relevancy_strictness)
|
|
581
567
|
self.relevancy_strictness = attributes[:relevancy_strictness]
|
|
582
568
|
end
|
|
@@ -643,10 +629,6 @@ module Algolia
|
|
|
643
629
|
self.remove_stop_words = attributes[:remove_stop_words]
|
|
644
630
|
end
|
|
645
631
|
|
|
646
|
-
if attributes.key?(:keep_diacritics_on_characters)
|
|
647
|
-
self.keep_diacritics_on_characters = attributes[:keep_diacritics_on_characters]
|
|
648
|
-
end
|
|
649
|
-
|
|
650
632
|
if attributes.key?(:query_languages)
|
|
651
633
|
if (value = attributes[:query_languages]).is_a?(Array)
|
|
652
634
|
self.query_languages = value
|
|
@@ -804,7 +786,6 @@ module Algolia
|
|
|
804
786
|
enable_ab_test == other.enable_ab_test &&
|
|
805
787
|
attributes_to_retrieve == other.attributes_to_retrieve &&
|
|
806
788
|
ranking == other.ranking &&
|
|
807
|
-
custom_ranking == other.custom_ranking &&
|
|
808
789
|
relevancy_strictness == other.relevancy_strictness &&
|
|
809
790
|
attributes_to_highlight == other.attributes_to_highlight &&
|
|
810
791
|
attributes_to_snippet == other.attributes_to_snippet &&
|
|
@@ -820,7 +801,6 @@ module Algolia
|
|
|
820
801
|
disable_typo_tolerance_on_attributes == other.disable_typo_tolerance_on_attributes &&
|
|
821
802
|
ignore_plurals == other.ignore_plurals &&
|
|
822
803
|
remove_stop_words == other.remove_stop_words &&
|
|
823
|
-
keep_diacritics_on_characters == other.keep_diacritics_on_characters &&
|
|
824
804
|
query_languages == other.query_languages &&
|
|
825
805
|
decompound_query == other.decompound_query &&
|
|
826
806
|
enable_rules == other.enable_rules &&
|
|
@@ -893,7 +873,6 @@ module Algolia
|
|
|
893
873
|
enable_ab_test,
|
|
894
874
|
attributes_to_retrieve,
|
|
895
875
|
ranking,
|
|
896
|
-
custom_ranking,
|
|
897
876
|
relevancy_strictness,
|
|
898
877
|
attributes_to_highlight,
|
|
899
878
|
attributes_to_snippet,
|
|
@@ -909,7 +888,6 @@ module Algolia
|
|
|
909
888
|
disable_typo_tolerance_on_attributes,
|
|
910
889
|
ignore_plurals,
|
|
911
890
|
remove_stop_words,
|
|
912
|
-
keep_diacritics_on_characters,
|
|
913
891
|
query_languages,
|
|
914
892
|
decompound_query,
|
|
915
893
|
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
|
# Dictionary entry.
|
|
9
11
|
class DictionaryEntry
|
|
10
12
|
# Unique identifier for the dictionary entry.
|
|
11
|
-
attr_accessor :
|
|
13
|
+
attr_accessor :algolia_object_id
|
|
12
14
|
|
|
13
15
|
attr_accessor :language
|
|
14
16
|
|
|
@@ -30,7 +32,7 @@ module Algolia
|
|
|
30
32
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
31
33
|
def self.attribute_map
|
|
32
34
|
{
|
|
33
|
-
:
|
|
35
|
+
:algolia_object_id => :objectID,
|
|
34
36
|
:language => :language,
|
|
35
37
|
:word => :word,
|
|
36
38
|
:words => :words,
|
|
@@ -43,7 +45,7 @@ module Algolia
|
|
|
43
45
|
# Attribute type mapping.
|
|
44
46
|
def self.types_mapping
|
|
45
47
|
{
|
|
46
|
-
:
|
|
48
|
+
:algolia_object_id => :"String",
|
|
47
49
|
:language => :"SupportedLanguage",
|
|
48
50
|
:word => :"String",
|
|
49
51
|
:words => :"Array<String>",
|
|
@@ -70,10 +72,10 @@ module Algolia
|
|
|
70
72
|
)
|
|
71
73
|
end
|
|
72
74
|
|
|
73
|
-
if attributes.key?(:
|
|
74
|
-
self.
|
|
75
|
+
if attributes.key?(:algolia_object_id)
|
|
76
|
+
self.algolia_object_id = attributes[:algolia_object_id]
|
|
75
77
|
else
|
|
76
|
-
self.
|
|
78
|
+
self.algolia_object_id = nil
|
|
77
79
|
end
|
|
78
80
|
|
|
79
81
|
if attributes.key?(:language)
|
|
@@ -114,7 +116,7 @@ module Algolia
|
|
|
114
116
|
def ==(other)
|
|
115
117
|
return true if self.equal?(other)
|
|
116
118
|
self.class == other.class &&
|
|
117
|
-
|
|
119
|
+
algolia_object_id == other.algolia_object_id &&
|
|
118
120
|
language == other.language &&
|
|
119
121
|
word == other.word &&
|
|
120
122
|
words == other.words &&
|
|
@@ -132,7 +134,7 @@ module Algolia
|
|
|
132
134
|
# Calculates hash code according to all attributes.
|
|
133
135
|
# @return [Integer] Hash code
|
|
134
136
|
def hash
|
|
135
|
-
[
|
|
137
|
+
[algolia_object_id, language, word, words, decomposition, state, type].hash
|
|
136
138
|
end
|
|
137
139
|
|
|
138
140
|
# 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"
|
|
@@ -11,7 +13,7 @@ module Algolia
|
|
|
11
13
|
attr_accessor :attributes_to_retrieve
|
|
12
14
|
|
|
13
15
|
# Object ID for the record to retrieve.
|
|
14
|
-
attr_accessor :
|
|
16
|
+
attr_accessor :algolia_object_id
|
|
15
17
|
|
|
16
18
|
# Index from which to retrieve the records.
|
|
17
19
|
attr_accessor :index_name
|
|
@@ -20,7 +22,7 @@ module Algolia
|
|
|
20
22
|
def self.attribute_map
|
|
21
23
|
{
|
|
22
24
|
:attributes_to_retrieve => :attributesToRetrieve,
|
|
23
|
-
:
|
|
25
|
+
:algolia_object_id => :objectID,
|
|
24
26
|
:index_name => :indexName
|
|
25
27
|
}
|
|
26
28
|
end
|
|
@@ -29,7 +31,7 @@ module Algolia
|
|
|
29
31
|
def self.types_mapping
|
|
30
32
|
{
|
|
31
33
|
:attributes_to_retrieve => :"Array<String>",
|
|
32
|
-
:
|
|
34
|
+
:algolia_object_id => :"String",
|
|
33
35
|
:index_name => :"String"
|
|
34
36
|
}
|
|
35
37
|
end
|
|
@@ -70,10 +72,10 @@ module Algolia
|
|
|
70
72
|
end
|
|
71
73
|
end
|
|
72
74
|
|
|
73
|
-
if attributes.key?(:
|
|
74
|
-
self.
|
|
75
|
+
if attributes.key?(:algolia_object_id)
|
|
76
|
+
self.algolia_object_id = attributes[:algolia_object_id]
|
|
75
77
|
else
|
|
76
|
-
self.
|
|
78
|
+
self.algolia_object_id = nil
|
|
77
79
|
end
|
|
78
80
|
|
|
79
81
|
if attributes.key?(:index_name)
|
|
@@ -89,7 +91,7 @@ module Algolia
|
|
|
89
91
|
return true if self.equal?(other)
|
|
90
92
|
self.class == other.class &&
|
|
91
93
|
attributes_to_retrieve == other.attributes_to_retrieve &&
|
|
92
|
-
|
|
94
|
+
algolia_object_id == other.algolia_object_id &&
|
|
93
95
|
index_name == other.index_name
|
|
94
96
|
end
|
|
95
97
|
|
|
@@ -102,7 +104,7 @@ module Algolia
|
|
|
102
104
|
# Calculates hash code according to all attributes.
|
|
103
105
|
# @return [Integer] Hash code
|
|
104
106
|
def hash
|
|
105
|
-
[attributes_to_retrieve,
|
|
107
|
+
[attributes_to_retrieve, algolia_object_id, index_name].hash
|
|
106
108
|
end
|
|
107
109
|
|
|
108
110
|
# 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"
|
|
@@ -8,7 +10,7 @@ module Algolia
|
|
|
8
10
|
# Search result. A hit is a record from your index, augmented with special attributes for highlighting, snippeting, and ranking.
|
|
9
11
|
class Hit
|
|
10
12
|
# Unique record identifier.
|
|
11
|
-
attr_accessor :
|
|
13
|
+
attr_accessor :algolia_object_id
|
|
12
14
|
|
|
13
15
|
# Surround words that match the query with HTML tags for highlighting.
|
|
14
16
|
attr_accessor :_highlight_result
|
|
@@ -25,7 +27,7 @@ module Algolia
|
|
|
25
27
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
26
28
|
def self.attribute_map
|
|
27
29
|
{
|
|
28
|
-
:
|
|
30
|
+
:algolia_object_id => :objectID,
|
|
29
31
|
:_highlight_result => :_highlightResult,
|
|
30
32
|
:_snippet_result => :_snippetResult,
|
|
31
33
|
:_ranking_info => :_rankingInfo,
|
|
@@ -36,7 +38,7 @@ module Algolia
|
|
|
36
38
|
# Attribute type mapping.
|
|
37
39
|
def self.types_mapping
|
|
38
40
|
{
|
|
39
|
-
:
|
|
41
|
+
:algolia_object_id => :"String",
|
|
40
42
|
:_highlight_result => :"Hash<String, HighlightResult>",
|
|
41
43
|
:_snippet_result => :"Hash<String, SnippetResult>",
|
|
42
44
|
:_ranking_info => :"RankingInfo",
|
|
@@ -58,10 +60,10 @@ module Algolia
|
|
|
58
60
|
raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::Hit` initialize method"
|
|
59
61
|
end
|
|
60
62
|
|
|
61
|
-
if attributes.key?(:
|
|
62
|
-
self.
|
|
63
|
+
if attributes.key?(:algolia_object_id)
|
|
64
|
+
self.algolia_object_id = attributes[:algolia_object_id]
|
|
63
65
|
else
|
|
64
|
-
self.
|
|
66
|
+
self.algolia_object_id = nil
|
|
65
67
|
end
|
|
66
68
|
|
|
67
69
|
if attributes.key?(:_highlight_result)
|
|
@@ -94,7 +96,7 @@ module Algolia
|
|
|
94
96
|
def ==(other)
|
|
95
97
|
return true if self.equal?(other)
|
|
96
98
|
self.class == other.class &&
|
|
97
|
-
|
|
99
|
+
algolia_object_id == other.algolia_object_id &&
|
|
98
100
|
_highlight_result == other._highlight_result &&
|
|
99
101
|
_snippet_result == other._snippet_result &&
|
|
100
102
|
_ranking_info == other._ranking_info &&
|
|
@@ -110,7 +112,7 @@ module Algolia
|
|
|
110
112
|
# Calculates hash code according to all attributes.
|
|
111
113
|
# @return [Integer] Hash code
|
|
112
114
|
def hash
|
|
113
|
-
[
|
|
115
|
+
[algolia_object_id, _highlight_result, _snippet_result, _ranking_info, _distinct_seq_id].hash
|
|
114
116
|
end
|
|
115
117
|
|
|
116
118
|
# Builds the object from hash
|