algolia 3.27.0 → 3.28.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/workflows/do-not-edit-this-repository.yml +1 -1
- data/.github/workflows/release.yml +2 -2
- data/CHANGELOG.md +7 -0
- data/Gemfile.lock +11 -11
- data/lib/algolia/api/abtesting_client.rb +13 -13
- data/lib/algolia/api/abtesting_v3_client.rb +13 -13
- data/lib/algolia/api/analytics_client.rb +69 -69
- data/lib/algolia/api/composition_client.rb +17 -17
- data/lib/algolia/api/ingestion_client.rb +15 -15
- data/lib/algolia/api/insights_client.rb +13 -13
- data/lib/algolia/api/monitoring_client.rb +12 -12
- data/lib/algolia/api/personalization_client.rb +13 -13
- data/lib/algolia/api/query_suggestions_client.rb +13 -13
- data/lib/algolia/api/recommend_client.rb +13 -13
- data/lib/algolia/api/search_client.rb +41 -41
- data/lib/algolia/models/abtesting/ab_test.rb +0 -2
- data/lib/algolia/models/abtesting/ab_test_configuration.rb +0 -2
- data/lib/algolia/models/abtesting/ab_test_response.rb +1 -3
- data/lib/algolia/models/abtesting/ab_tests_variant.rb +0 -2
- data/lib/algolia/models/abtesting/ab_tests_variant_search_params.rb +0 -2
- data/lib/algolia/models/abtesting/add_ab_tests_request.rb +0 -2
- data/lib/algolia/models/abtesting/add_ab_tests_variant.rb +0 -1
- data/lib/algolia/models/abtesting/currency.rb +0 -2
- data/lib/algolia/models/abtesting/empty_search.rb +0 -2
- data/lib/algolia/models/abtesting/empty_search_filter.rb +0 -2
- data/lib/algolia/models/abtesting/error_base.rb +0 -2
- data/lib/algolia/models/abtesting/estimate_ab_test_request.rb +0 -2
- data/lib/algolia/models/abtesting/estimate_ab_test_response.rb +0 -2
- data/lib/algolia/models/abtesting/estimate_configuration.rb +0 -2
- data/lib/algolia/models/abtesting/filter_effects.rb +0 -2
- data/lib/algolia/models/abtesting/list_ab_tests_response.rb +0 -2
- data/lib/algolia/models/abtesting/minimum_detectable_effect.rb +0 -2
- data/lib/algolia/models/abtesting/outliers.rb +0 -2
- data/lib/algolia/models/abtesting/outliers_filter.rb +0 -2
- data/lib/algolia/models/abtesting/schedule_ab_test_response.rb +0 -2
- data/lib/algolia/models/abtesting/schedule_ab_tests_request.rb +0 -2
- data/lib/algolia/models/abtesting/variant.rb +0 -2
- data/lib/algolia/models/abtesting-v3/ab_test.rb +0 -2
- data/lib/algolia/models/abtesting-v3/ab_test_configuration.rb +0 -2
- data/lib/algolia/models/abtesting-v3/ab_test_response.rb +1 -3
- data/lib/algolia/models/abtesting-v3/ab_tests_variant.rb +0 -2
- data/lib/algolia/models/abtesting-v3/ab_tests_variant_search_params.rb +0 -2
- data/lib/algolia/models/abtesting-v3/add_ab_tests_request.rb +0 -2
- data/lib/algolia/models/abtesting-v3/add_ab_tests_variant.rb +0 -1
- data/lib/algolia/models/abtesting-v3/create_metric.rb +0 -2
- data/lib/algolia/models/abtesting-v3/empty_search_filter.rb +0 -2
- data/lib/algolia/models/abtesting-v3/error_base.rb +0 -2
- data/lib/algolia/models/abtesting-v3/estimate_ab_test_request.rb +0 -2
- data/lib/algolia/models/abtesting-v3/estimate_ab_test_response.rb +0 -2
- data/lib/algolia/models/abtesting-v3/estimate_configuration.rb +0 -2
- data/lib/algolia/models/abtesting-v3/filter_effects.rb +0 -2
- data/lib/algolia/models/abtesting-v3/list_ab_tests_response.rb +0 -2
- data/lib/algolia/models/abtesting-v3/metric_date.rb +0 -2
- data/lib/algolia/models/abtesting-v3/metric_metadata.rb +0 -2
- data/lib/algolia/models/abtesting-v3/metric_result.rb +0 -2
- data/lib/algolia/models/abtesting-v3/metrics_filter.rb +0 -2
- data/lib/algolia/models/abtesting-v3/minimum_detectable_effect.rb +0 -2
- data/lib/algolia/models/abtesting-v3/outliers_filter.rb +0 -2
- data/lib/algolia/models/abtesting-v3/schedule_ab_test_response.rb +0 -2
- data/lib/algolia/models/abtesting-v3/schedule_ab_tests_request.rb +0 -2
- data/lib/algolia/models/abtesting-v3/timeseries.rb +0 -2
- data/lib/algolia/models/abtesting-v3/timeseries_variant.rb +0 -2
- data/lib/algolia/models/abtesting-v3/variant.rb +0 -2
- data/lib/algolia/models/abtesting-v3/variant_metadata.rb +0 -2
- data/lib/algolia/models/analytics/click_position.rb +0 -2
- data/lib/algolia/models/analytics/currency_code.rb +0 -2
- data/lib/algolia/models/analytics/daily_add_to_cart_rates.rb +0 -2
- data/lib/algolia/models/analytics/daily_average_clicks.rb +0 -2
- data/lib/algolia/models/analytics/daily_click_through_rates.rb +0 -2
- data/lib/algolia/models/analytics/daily_conversion_rates.rb +0 -2
- data/lib/algolia/models/analytics/daily_no_click_rates.rb +0 -2
- data/lib/algolia/models/analytics/daily_no_results_rates.rb +0 -2
- data/lib/algolia/models/analytics/daily_purchase_rates.rb +0 -2
- data/lib/algolia/models/analytics/daily_revenue.rb +0 -2
- data/lib/algolia/models/analytics/daily_searches.rb +0 -2
- data/lib/algolia/models/analytics/daily_searches_no_clicks.rb +0 -2
- data/lib/algolia/models/analytics/daily_searches_no_results.rb +0 -2
- data/lib/algolia/models/analytics/daily_users.rb +0 -2
- data/lib/algolia/models/analytics/error_base.rb +0 -2
- data/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb +0 -2
- data/lib/algolia/models/analytics/get_average_click_position_response.rb +0 -2
- data/lib/algolia/models/analytics/get_click_positions_response.rb +0 -2
- data/lib/algolia/models/analytics/get_click_through_rate_response.rb +0 -2
- data/lib/algolia/models/analytics/get_conversion_rate_response.rb +0 -2
- data/lib/algolia/models/analytics/get_no_click_rate_response.rb +0 -2
- data/lib/algolia/models/analytics/get_no_results_rate_response.rb +0 -2
- data/lib/algolia/models/analytics/get_purchase_rate_response.rb +0 -2
- data/lib/algolia/models/analytics/get_revenue.rb +0 -2
- data/lib/algolia/models/analytics/get_searches_count_response.rb +0 -2
- data/lib/algolia/models/analytics/get_searches_no_clicks_response.rb +0 -2
- data/lib/algolia/models/analytics/get_searches_no_results_response.rb +0 -2
- data/lib/algolia/models/analytics/get_status_response.rb +0 -2
- data/lib/algolia/models/analytics/get_top_countries_response.rb +0 -2
- data/lib/algolia/models/analytics/get_top_filter_attribute.rb +0 -2
- data/lib/algolia/models/analytics/get_top_filter_attributes_response.rb +0 -2
- data/lib/algolia/models/analytics/get_top_filter_for_attribute.rb +0 -2
- data/lib/algolia/models/analytics/get_top_filter_for_attribute_response.rb +0 -2
- data/lib/algolia/models/analytics/get_top_filters_no_results_response.rb +0 -2
- data/lib/algolia/models/analytics/get_top_filters_no_results_value.rb +0 -2
- data/lib/algolia/models/analytics/get_top_filters_no_results_values.rb +0 -2
- data/lib/algolia/models/analytics/get_top_hits_response.rb +0 -1
- data/lib/algolia/models/analytics/get_top_searches_response.rb +0 -1
- data/lib/algolia/models/analytics/get_users_count_response.rb +0 -2
- data/lib/algolia/models/analytics/top_country.rb +0 -2
- data/lib/algolia/models/analytics/top_hit.rb +0 -2
- data/lib/algolia/models/analytics/top_hit_with_analytics.rb +0 -2
- data/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb +0 -2
- data/lib/algolia/models/analytics/top_hits_response.rb +0 -2
- data/lib/algolia/models/analytics/top_hits_response_with_analytics.rb +0 -2
- data/lib/algolia/models/analytics/top_hits_response_with_revenue_analytics.rb +0 -2
- data/lib/algolia/models/analytics/top_search.rb +0 -2
- data/lib/algolia/models/analytics/top_search_with_analytics.rb +0 -2
- data/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb +0 -2
- data/lib/algolia/models/analytics/top_searches_response.rb +0 -2
- data/lib/algolia/models/analytics/top_searches_response_with_analytics.rb +0 -2
- data/lib/algolia/models/analytics/top_searches_response_with_revenue_analytics.rb +0 -2
- data/lib/algolia/models/composition/around_precision.rb +0 -1
- data/lib/algolia/models/composition/around_radius.rb +0 -1
- data/lib/algolia/models/composition/banner.rb +0 -2
- data/lib/algolia/models/composition/banner_image.rb +0 -2
- data/lib/algolia/models/composition/banner_image_url.rb +0 -2
- data/lib/algolia/models/composition/banner_link.rb +0 -2
- data/lib/algolia/models/composition/base_injection_query_parameters.rb +6 -8
- data/lib/algolia/models/composition/batch_composition_action.rb +0 -1
- data/lib/algolia/models/composition/batch_params.rb +0 -2
- data/lib/algolia/models/composition/composition.rb +0 -2
- data/lib/algolia/models/composition/composition_behavior.rb +0 -2
- data/lib/algolia/models/composition/composition_id_ranking_info.rb +0 -2
- data/lib/algolia/models/composition/composition_rule.rb +0 -2
- data/lib/algolia/models/composition/composition_rule_consequence.rb +0 -2
- data/lib/algolia/models/composition/composition_rules_batch_params.rb +0 -2
- data/lib/algolia/models/composition/composition_run_applied_rules.rb +0 -2
- data/lib/algolia/models/composition/composition_run_search_response.rb +0 -2
- data/lib/algolia/models/composition/composition_source.rb +0 -2
- data/lib/algolia/models/composition/composition_source_search.rb +0 -2
- data/lib/algolia/models/composition/compositions_search_response.rb +0 -2
- data/lib/algolia/models/composition/condition.rb +0 -2
- data/lib/algolia/models/composition/dedup_positioning.rb +34 -0
- data/lib/algolia/models/composition/deduplication.rb +209 -0
- data/lib/algolia/models/composition/delete_composition_action.rb +0 -2
- data/lib/algolia/models/composition/delete_composition_rule_action.rb +0 -2
- data/lib/algolia/models/composition/distinct.rb +0 -1
- data/lib/algolia/models/composition/error_base.rb +0 -2
- data/lib/algolia/models/composition/exhaustive.rb +0 -2
- data/lib/algolia/models/composition/external.rb +0 -2
- data/lib/algolia/models/composition/external_injected_item.rb +0 -2
- data/lib/algolia/models/composition/external_injection.rb +0 -2
- data/lib/algolia/models/composition/external_source.rb +0 -2
- data/lib/algolia/models/composition/facet_filters.rb +0 -1
- data/lib/algolia/models/composition/facet_hits.rb +0 -2
- data/lib/algolia/models/composition/facet_ordering.rb +0 -2
- data/lib/algolia/models/composition/facet_stats.rb +0 -2
- data/lib/algolia/models/composition/facets.rb +0 -2
- data/lib/algolia/models/composition/get_task_response.rb +0 -2
- data/lib/algolia/models/composition/highlight_result.rb +0 -1
- data/lib/algolia/models/composition/highlight_result_option.rb +0 -2
- data/lib/algolia/models/composition/hit.rb +0 -2
- data/lib/algolia/models/composition/hit_metadata.rb +0 -2
- data/lib/algolia/models/composition/hit_ranking_info.rb +0 -2
- data/lib/algolia/models/composition/ignore_plurals.rb +0 -1
- data/lib/algolia/models/composition/injected_item.rb +0 -2
- data/lib/algolia/models/composition/injected_item_hits_metadata.rb +0 -2
- data/lib/algolia/models/composition/injected_item_metadata.rb +0 -2
- data/lib/algolia/models/composition/injected_item_source.rb +0 -1
- data/lib/algolia/models/composition/injection.rb +13 -6
- data/lib/algolia/models/composition/inside_bounding_box.rb +0 -1
- data/lib/algolia/models/composition/list_compositions_response.rb +0 -2
- data/lib/algolia/models/composition/main.rb +0 -2
- data/lib/algolia/models/composition/main_injection_query_parameters.rb +7 -9
- data/lib/algolia/models/composition/matched_geo_location.rb +0 -2
- data/lib/algolia/models/composition/multiple_batch_request.rb +0 -2
- data/lib/algolia/models/composition/multiple_batch_response.rb +0 -2
- data/lib/algolia/models/composition/numeric_filters.rb +0 -1
- data/lib/algolia/models/composition/optional_filters.rb +1 -2
- data/lib/algolia/models/composition/optional_words.rb +0 -1
- data/lib/algolia/models/composition/params.rb +6 -8
- data/lib/algolia/models/composition/personalization.rb +0 -2
- data/lib/algolia/models/composition/range.rb +0 -2
- data/lib/algolia/models/composition/redirect.rb +1 -3
- data/lib/algolia/models/composition/redirect_rule_index_data.rb +0 -2
- data/lib/algolia/models/composition/redirect_rule_index_metadata.rb +0 -2
- data/lib/algolia/models/composition/redirect_url.rb +0 -2
- data/lib/algolia/models/composition/remove_stop_words.rb +0 -1
- data/lib/algolia/models/composition/rendering_content.rb +0 -2
- data/lib/algolia/models/composition/request_body.rb +0 -2
- data/lib/algolia/models/composition/results_composition_info_response.rb +0 -2
- data/lib/algolia/models/composition/results_injected_item_applied_rules_info_response.rb +0 -2
- data/lib/algolia/models/composition/results_injected_item_info_response.rb +0 -2
- data/lib/algolia/models/composition/rules_batch_composition_action.rb +0 -1
- data/lib/algolia/models/composition/rules_multiple_batch_request.rb +0 -2
- data/lib/algolia/models/composition/rules_multiple_batch_response.rb +1 -3
- data/lib/algolia/models/composition/search.rb +0 -2
- data/lib/algolia/models/composition/search_composition_rules_params.rb +2 -4
- data/lib/algolia/models/composition/search_composition_rules_response.rb +0 -2
- data/lib/algolia/models/composition/search_for_facet_values_params.rb +0 -2
- data/lib/algolia/models/composition/search_for_facet_values_request.rb +0 -2
- data/lib/algolia/models/composition/search_for_facet_values_response.rb +0 -2
- data/lib/algolia/models/composition/search_for_facet_values_results.rb +0 -2
- data/lib/algolia/models/composition/search_response.rb +0 -2
- data/lib/algolia/models/composition/search_results_item.rb +1 -3
- data/lib/algolia/models/composition/search_source.rb +0 -2
- data/lib/algolia/models/composition/snippet_result.rb +0 -1
- data/lib/algolia/models/composition/snippet_result_option.rb +0 -2
- data/lib/algolia/models/composition/task_id_response.rb +1 -3
- data/lib/algolia/models/composition/time_range.rb +0 -2
- data/lib/algolia/models/composition/typo_tolerance.rb +1 -2
- data/lib/algolia/models/composition/value.rb +0 -2
- data/lib/algolia/models/composition/widgets.rb +0 -2
- data/lib/algolia/models/ingestion/auth_algolia.rb +0 -2
- data/lib/algolia/models/ingestion/auth_algolia_insights.rb +0 -2
- data/lib/algolia/models/ingestion/auth_algolia_insights_partial.rb +0 -2
- data/lib/algolia/models/ingestion/auth_algolia_partial.rb +0 -2
- data/lib/algolia/models/ingestion/auth_api_key.rb +0 -2
- data/lib/algolia/models/ingestion/auth_api_key_partial.rb +0 -2
- data/lib/algolia/models/ingestion/auth_basic.rb +0 -2
- data/lib/algolia/models/ingestion/auth_basic_partial.rb +0 -2
- data/lib/algolia/models/ingestion/auth_google_service_account.rb +0 -2
- data/lib/algolia/models/ingestion/auth_google_service_account_partial.rb +0 -2
- data/lib/algolia/models/ingestion/auth_input.rb +0 -1
- data/lib/algolia/models/ingestion/auth_input_partial.rb +0 -1
- data/lib/algolia/models/ingestion/auth_o_auth.rb +0 -2
- data/lib/algolia/models/ingestion/auth_o_auth_partial.rb +0 -2
- data/lib/algolia/models/ingestion/authentication.rb +0 -2
- data/lib/algolia/models/ingestion/authentication_create.rb +0 -2
- data/lib/algolia/models/ingestion/authentication_create_response.rb +0 -2
- data/lib/algolia/models/ingestion/authentication_search.rb +0 -2
- data/lib/algolia/models/ingestion/authentication_update.rb +0 -2
- data/lib/algolia/models/ingestion/authentication_update_response.rb +0 -2
- data/lib/algolia/models/ingestion/big_commerce_channel.rb +0 -2
- data/lib/algolia/models/ingestion/big_commerce_metafield.rb +0 -2
- data/lib/algolia/models/ingestion/commercetools_custom_fields.rb +0 -2
- data/lib/algolia/models/ingestion/delete_response.rb +0 -2
- data/lib/algolia/models/ingestion/destination.rb +0 -2
- data/lib/algolia/models/ingestion/destination_create.rb +0 -2
- data/lib/algolia/models/ingestion/destination_create_response.rb +0 -2
- data/lib/algolia/models/ingestion/destination_input.rb +0 -2
- data/lib/algolia/models/ingestion/destination_search.rb +0 -2
- data/lib/algolia/models/ingestion/destination_update.rb +0 -2
- data/lib/algolia/models/ingestion/destination_update_response.rb +0 -2
- data/lib/algolia/models/ingestion/docker_streams.rb +0 -2
- data/lib/algolia/models/ingestion/docker_streams_input.rb +0 -2
- data/lib/algolia/models/ingestion/email_notifications.rb +0 -2
- data/lib/algolia/models/ingestion/error_base.rb +0 -2
- data/lib/algolia/models/ingestion/event.rb +0 -2
- data/lib/algolia/models/ingestion/list_authentications_response.rb +0 -2
- data/lib/algolia/models/ingestion/list_destinations_response.rb +0 -2
- data/lib/algolia/models/ingestion/list_events_response.rb +0 -2
- data/lib/algolia/models/ingestion/list_sources_response.rb +0 -2
- data/lib/algolia/models/ingestion/list_tasks_response.rb +0 -2
- data/lib/algolia/models/ingestion/list_tasks_response_v1.rb +0 -2
- data/lib/algolia/models/ingestion/list_transformations_response.rb +0 -2
- data/lib/algolia/models/ingestion/mapping_field_directive.rb +0 -2
- data/lib/algolia/models/ingestion/mapping_input.rb +0 -2
- data/lib/algolia/models/ingestion/mapping_kit_action.rb +0 -2
- data/lib/algolia/models/ingestion/notifications.rb +0 -2
- data/lib/algolia/models/ingestion/on_demand_trigger.rb +0 -2
- data/lib/algolia/models/ingestion/on_demand_trigger_input.rb +0 -2
- data/lib/algolia/models/ingestion/pagination.rb +0 -2
- data/lib/algolia/models/ingestion/platform_with_none.rb +0 -1
- data/lib/algolia/models/ingestion/policies.rb +0 -2
- data/lib/algolia/models/ingestion/push_task_payload.rb +0 -2
- data/lib/algolia/models/ingestion/push_task_records.rb +0 -2
- data/lib/algolia/models/ingestion/run.rb +0 -2
- data/lib/algolia/models/ingestion/run_list_response.rb +0 -2
- data/lib/algolia/models/ingestion/run_progress.rb +0 -2
- data/lib/algolia/models/ingestion/run_response.rb +0 -2
- data/lib/algolia/models/ingestion/run_source_payload.rb +0 -2
- data/lib/algolia/models/ingestion/run_source_response.rb +0 -2
- data/lib/algolia/models/ingestion/run_task_payload.rb +0 -2
- data/lib/algolia/models/ingestion/schedule_trigger.rb +0 -2
- data/lib/algolia/models/ingestion/schedule_trigger_input.rb +0 -2
- data/lib/algolia/models/ingestion/shopify_input.rb +0 -2
- data/lib/algolia/models/ingestion/shopify_market.rb +0 -2
- data/lib/algolia/models/ingestion/shopify_metafield.rb +0 -2
- data/lib/algolia/models/ingestion/source.rb +0 -2
- data/lib/algolia/models/ingestion/source_big_commerce.rb +0 -2
- data/lib/algolia/models/ingestion/source_big_query.rb +0 -2
- data/lib/algolia/models/ingestion/source_commercetools.rb +0 -2
- data/lib/algolia/models/ingestion/source_create.rb +0 -2
- data/lib/algolia/models/ingestion/source_create_response.rb +0 -2
- data/lib/algolia/models/ingestion/source_csv.rb +0 -2
- data/lib/algolia/models/ingestion/source_docker.rb +0 -2
- data/lib/algolia/models/ingestion/source_ga4_big_query_export.rb +0 -2
- data/lib/algolia/models/ingestion/source_input.rb +0 -1
- data/lib/algolia/models/ingestion/source_json.rb +0 -2
- data/lib/algolia/models/ingestion/source_search.rb +0 -2
- data/lib/algolia/models/ingestion/source_shopify.rb +0 -2
- data/lib/algolia/models/ingestion/source_update.rb +0 -2
- data/lib/algolia/models/ingestion/source_update_commercetools.rb +0 -2
- data/lib/algolia/models/ingestion/source_update_docker.rb +0 -2
- data/lib/algolia/models/ingestion/source_update_input.rb +0 -1
- data/lib/algolia/models/ingestion/source_update_response.rb +0 -2
- data/lib/algolia/models/ingestion/source_update_shopify.rb +0 -2
- data/lib/algolia/models/ingestion/streaming_input.rb +0 -2
- data/lib/algolia/models/ingestion/streaming_trigger.rb +0 -2
- data/lib/algolia/models/ingestion/subscription_trigger.rb +0 -2
- data/lib/algolia/models/ingestion/task.rb +0 -2
- data/lib/algolia/models/ingestion/task_create.rb +0 -2
- data/lib/algolia/models/ingestion/task_create_response.rb +0 -2
- data/lib/algolia/models/ingestion/task_create_trigger.rb +0 -1
- data/lib/algolia/models/ingestion/task_create_v1.rb +0 -2
- data/lib/algolia/models/ingestion/task_input.rb +0 -1
- data/lib/algolia/models/ingestion/task_replace.rb +0 -2
- data/lib/algolia/models/ingestion/task_search.rb +0 -2
- data/lib/algolia/models/ingestion/task_update.rb +0 -2
- data/lib/algolia/models/ingestion/task_update_response.rb +0 -2
- data/lib/algolia/models/ingestion/task_update_v1.rb +0 -2
- data/lib/algolia/models/ingestion/task_v1.rb +0 -2
- data/lib/algolia/models/ingestion/transformation.rb +0 -2
- data/lib/algolia/models/ingestion/transformation_code.rb +0 -2
- data/lib/algolia/models/ingestion/transformation_create.rb +0 -2
- data/lib/algolia/models/ingestion/transformation_create_response.rb +0 -2
- data/lib/algolia/models/ingestion/transformation_error.rb +0 -2
- data/lib/algolia/models/ingestion/transformation_input.rb +0 -1
- data/lib/algolia/models/ingestion/transformation_no_code.rb +0 -2
- data/lib/algolia/models/ingestion/transformation_search.rb +0 -2
- data/lib/algolia/models/ingestion/transformation_try.rb +0 -2
- data/lib/algolia/models/ingestion/transformation_try_response.rb +0 -2
- data/lib/algolia/models/ingestion/transformation_update_response.rb +0 -2
- data/lib/algolia/models/ingestion/trigger.rb +0 -1
- data/lib/algolia/models/ingestion/trigger_update_input.rb +0 -2
- data/lib/algolia/models/ingestion/watch_response.rb +0 -2
- data/lib/algolia/models/ingestion/window.rb +0 -2
- data/lib/algolia/models/insights/added_to_cart_object_ids.rb +2 -4
- data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb +2 -4
- data/lib/algolia/models/insights/clicked_filters.rb +2 -4
- data/lib/algolia/models/insights/clicked_object_ids.rb +2 -4
- data/lib/algolia/models/insights/clicked_object_ids_after_search.rb +2 -4
- data/lib/algolia/models/insights/converted_filters.rb +2 -4
- data/lib/algolia/models/insights/converted_object_ids.rb +2 -4
- data/lib/algolia/models/insights/converted_object_ids_after_search.rb +2 -4
- data/lib/algolia/models/insights/discount.rb +0 -1
- data/lib/algolia/models/insights/error_base.rb +0 -2
- data/lib/algolia/models/insights/events_items.rb +0 -1
- data/lib/algolia/models/insights/events_response.rb +0 -2
- data/lib/algolia/models/insights/insights_events.rb +0 -2
- data/lib/algolia/models/insights/object_data.rb +0 -2
- data/lib/algolia/models/insights/object_data_after_search.rb +0 -2
- data/lib/algolia/models/insights/price.rb +0 -1
- data/lib/algolia/models/insights/purchased_object_ids.rb +2 -4
- data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +2 -4
- data/lib/algolia/models/insights/value.rb +0 -1
- data/lib/algolia/models/insights/viewed_filters.rb +2 -4
- data/lib/algolia/models/insights/viewed_object_ids.rb +2 -4
- data/lib/algolia/models/monitoring/error_base.rb +0 -2
- data/lib/algolia/models/monitoring/incident.rb +0 -2
- data/lib/algolia/models/monitoring/incident_entry.rb +0 -2
- data/lib/algolia/models/monitoring/incidents_response.rb +0 -2
- data/lib/algolia/models/monitoring/indexing_metric.rb +0 -2
- data/lib/algolia/models/monitoring/indexing_time_response.rb +0 -2
- data/lib/algolia/models/monitoring/infrastructure_response.rb +0 -2
- data/lib/algolia/models/monitoring/inventory_response.rb +0 -2
- data/lib/algolia/models/monitoring/latency_metric.rb +0 -2
- data/lib/algolia/models/monitoring/latency_response.rb +0 -2
- data/lib/algolia/models/monitoring/metrics.rb +0 -2
- data/lib/algolia/models/monitoring/probes_metric.rb +0 -2
- data/lib/algolia/models/monitoring/server.rb +0 -2
- data/lib/algolia/models/monitoring/status_response.rb +0 -2
- data/lib/algolia/models/monitoring/time_entry.rb +0 -2
- data/lib/algolia/models/personalization/delete_user_profile_response.rb +1 -3
- data/lib/algolia/models/personalization/error_base.rb +0 -2
- data/lib/algolia/models/personalization/events_scoring.rb +0 -2
- data/lib/algolia/models/personalization/facets_scoring.rb +0 -2
- data/lib/algolia/models/personalization/get_user_token_response.rb +1 -3
- data/lib/algolia/models/personalization/personalization_strategy_params.rb +0 -2
- data/lib/algolia/models/personalization/set_personalization_strategy_response.rb +0 -2
- data/lib/algolia/models/query-suggestions/base_response.rb +0 -2
- data/lib/algolia/models/query-suggestions/config_status.rb +0 -2
- data/lib/algolia/models/query-suggestions/configuration.rb +0 -2
- data/lib/algolia/models/query-suggestions/configuration_response.rb +0 -2
- data/lib/algolia/models/query-suggestions/configuration_with_index.rb +0 -2
- data/lib/algolia/models/query-suggestions/error_base.rb +0 -2
- data/lib/algolia/models/query-suggestions/facet.rb +0 -2
- data/lib/algolia/models/query-suggestions/languages.rb +0 -1
- data/lib/algolia/models/query-suggestions/log_file.rb +0 -2
- data/lib/algolia/models/query-suggestions/source_index.rb +0 -2
- data/lib/algolia/models/recommend/around_precision.rb +0 -1
- data/lib/algolia/models/recommend/around_radius.rb +0 -1
- data/lib/algolia/models/recommend/auto_facet_filter.rb +0 -2
- data/lib/algolia/models/recommend/banner.rb +0 -2
- data/lib/algolia/models/recommend/banner_image.rb +0 -2
- data/lib/algolia/models/recommend/banner_image_url.rb +0 -2
- data/lib/algolia/models/recommend/banner_link.rb +0 -2
- data/lib/algolia/models/recommend/bought_together_query.rb +0 -2
- data/lib/algolia/models/recommend/condition.rb +1 -3
- data/lib/algolia/models/recommend/consequence.rb +0 -2
- data/lib/algolia/models/recommend/deleted_at_response.rb +1 -3
- data/lib/algolia/models/recommend/distinct.rb +0 -1
- data/lib/algolia/models/recommend/error_base.rb +0 -2
- data/lib/algolia/models/recommend/exhaustive.rb +0 -2
- data/lib/algolia/models/recommend/facet_filters.rb +0 -1
- data/lib/algolia/models/recommend/facet_ordering.rb +0 -2
- data/lib/algolia/models/recommend/facet_stats.rb +0 -2
- data/lib/algolia/models/recommend/fallback_params.rb +19 -21
- data/lib/algolia/models/recommend/get_recommend_task_response.rb +0 -2
- data/lib/algolia/models/recommend/get_recommendations_params.rb +0 -2
- data/lib/algolia/models/recommend/get_recommendations_response.rb +0 -2
- data/lib/algolia/models/recommend/hide_consequence_object.rb +0 -2
- data/lib/algolia/models/recommend/highlight_result.rb +0 -1
- data/lib/algolia/models/recommend/highlight_result_option.rb +0 -2
- data/lib/algolia/models/recommend/ignore_plurals.rb +0 -1
- data/lib/algolia/models/recommend/index_settings_facets.rb +0 -2
- data/lib/algolia/models/recommend/inside_bounding_box.rb +0 -1
- data/lib/algolia/models/recommend/looking_similar_query.rb +0 -2
- data/lib/algolia/models/recommend/matched_geo_location.rb +0 -2
- data/lib/algolia/models/recommend/numeric_filters.rb +0 -1
- data/lib/algolia/models/recommend/optional_filters.rb +1 -2
- data/lib/algolia/models/recommend/optional_words.rb +0 -1
- data/lib/algolia/models/recommend/params_consequence.rb +1 -3
- data/lib/algolia/models/recommend/personalization.rb +0 -2
- data/lib/algolia/models/recommend/promote_consequence_object.rb +0 -2
- data/lib/algolia/models/recommend/range.rb +0 -2
- data/lib/algolia/models/recommend/ranking_info.rb +0 -2
- data/lib/algolia/models/recommend/re_ranking_apply_filter.rb +1 -2
- data/lib/algolia/models/recommend/recommend_hit.rb +0 -2
- data/lib/algolia/models/recommend/recommend_rule.rb +0 -2
- data/lib/algolia/models/recommend/recommend_search_params.rb +19 -21
- data/lib/algolia/models/recommend/recommend_updated_at_response.rb +1 -3
- data/lib/algolia/models/recommend/recommendations_hit.rb +0 -1
- data/lib/algolia/models/recommend/recommendations_request.rb +0 -1
- data/lib/algolia/models/recommend/recommendations_results.rb +1 -3
- data/lib/algolia/models/recommend/redirect.rb +1 -3
- data/lib/algolia/models/recommend/redirect_rule_index_data.rb +0 -2
- data/lib/algolia/models/recommend/redirect_rule_index_metadata.rb +0 -2
- data/lib/algolia/models/recommend/redirect_url.rb +0 -2
- data/lib/algolia/models/recommend/related_query.rb +0 -2
- data/lib/algolia/models/recommend/remove_stop_words.rb +0 -1
- data/lib/algolia/models/recommend/rendering_content.rb +0 -2
- data/lib/algolia/models/recommend/rule_metadata.rb +0 -2
- data/lib/algolia/models/recommend/search_recommend_rules_params.rb +2 -4
- data/lib/algolia/models/recommend/search_recommend_rules_response.rb +0 -2
- data/lib/algolia/models/recommend/snippet_result.rb +0 -1
- data/lib/algolia/models/recommend/snippet_result_option.rb +0 -2
- data/lib/algolia/models/recommend/tag_filters.rb +0 -1
- data/lib/algolia/models/recommend/time_range.rb +0 -2
- data/lib/algolia/models/recommend/trending_facet_hit.rb +0 -2
- data/lib/algolia/models/recommend/trending_facets_query.rb +0 -2
- data/lib/algolia/models/recommend/trending_items_query.rb +0 -2
- data/lib/algolia/models/recommend/typo_tolerance.rb +1 -2
- data/lib/algolia/models/recommend/value.rb +0 -2
- data/lib/algolia/models/recommend/widgets.rb +0 -2
- data/lib/algolia/models/search/add_api_key_response.rb +0 -2
- data/lib/algolia/models/search/api_key.rb +1 -3
- data/lib/algolia/models/search/around_precision.rb +0 -1
- data/lib/algolia/models/search/around_radius.rb +0 -1
- data/lib/algolia/models/search/assign_user_id_params.rb +0 -2
- data/lib/algolia/models/search/attribute_to_update.rb +0 -1
- data/lib/algolia/models/search/automatic_facet_filter.rb +0 -2
- data/lib/algolia/models/search/automatic_facet_filters.rb +0 -1
- data/lib/algolia/models/search/banner.rb +0 -2
- data/lib/algolia/models/search/banner_image.rb +0 -2
- data/lib/algolia/models/search/banner_image_url.rb +0 -2
- data/lib/algolia/models/search/banner_link.rb +0 -2
- data/lib/algolia/models/search/batch_assign_user_ids_params.rb +0 -2
- data/lib/algolia/models/search/batch_dictionary_entries_params.rb +0 -2
- data/lib/algolia/models/search/batch_dictionary_entries_request.rb +0 -2
- data/lib/algolia/models/search/batch_params.rb +0 -2
- data/lib/algolia/models/search/batch_request.rb +0 -2
- data/lib/algolia/models/search/batch_response.rb +1 -3
- data/lib/algolia/models/search/batch_write_params.rb +0 -2
- data/lib/algolia/models/search/browse_params.rb +0 -1
- data/lib/algolia/models/search/browse_params_object.rb +10 -12
- data/lib/algolia/models/search/browse_response.rb +1 -3
- data/lib/algolia/models/search/built_in_operation.rb +0 -2
- data/lib/algolia/models/search/built_in_operation_value.rb +0 -1
- data/lib/algolia/models/search/condition.rb +0 -2
- data/lib/algolia/models/search/consequence.rb +0 -2
- data/lib/algolia/models/search/consequence_hide.rb +0 -2
- data/lib/algolia/models/search/consequence_params.rb +10 -12
- data/lib/algolia/models/search/consequence_query.rb +0 -1
- data/lib/algolia/models/search/consequence_query_object.rb +0 -2
- data/lib/algolia/models/search/created_at_response.rb +0 -2
- data/lib/algolia/models/search/delete_api_key_response.rb +0 -2
- data/lib/algolia/models/search/delete_by_params.rb +1 -3
- data/lib/algolia/models/search/delete_source_response.rb +0 -2
- data/lib/algolia/models/search/deleted_at_response.rb +1 -3
- data/lib/algolia/models/search/dictionary_entry.rb +0 -2
- data/lib/algolia/models/search/dictionary_language.rb +0 -2
- data/lib/algolia/models/search/dictionary_settings_params.rb +0 -2
- data/lib/algolia/models/search/distinct.rb +0 -1
- data/lib/algolia/models/search/edit.rb +0 -2
- data/lib/algolia/models/search/error_base.rb +0 -2
- data/lib/algolia/models/search/event.rb +0 -2
- data/lib/algolia/models/search/exhaustive.rb +0 -2
- data/lib/algolia/models/search/facet_filters.rb +0 -1
- data/lib/algolia/models/search/facet_hits.rb +0 -2
- data/lib/algolia/models/search/facet_ordering.rb +0 -2
- data/lib/algolia/models/search/facet_stats.rb +0 -2
- data/lib/algolia/models/search/facets.rb +0 -2
- data/lib/algolia/models/search/fetched_index.rb +0 -2
- data/lib/algolia/models/search/get_api_key_response.rb +1 -3
- data/lib/algolia/models/search/get_dictionary_settings_response.rb +0 -2
- data/lib/algolia/models/search/get_logs_response.rb +0 -2
- data/lib/algolia/models/search/get_objects_params.rb +0 -2
- data/lib/algolia/models/search/get_objects_request.rb +0 -2
- data/lib/algolia/models/search/get_objects_response.rb +0 -2
- data/lib/algolia/models/search/get_task_response.rb +0 -2
- data/lib/algolia/models/search/get_top_user_ids_response.rb +0 -2
- data/lib/algolia/models/search/has_pending_mappings_response.rb +0 -2
- data/lib/algolia/models/search/highlight_result.rb +0 -1
- data/lib/algolia/models/search/highlight_result_option.rb +0 -2
- data/lib/algolia/models/search/hit.rb +0 -2
- data/lib/algolia/models/search/ignore_plurals.rb +0 -1
- data/lib/algolia/models/search/index_settings.rb +15 -17
- data/lib/algolia/models/search/inside_bounding_box.rb +0 -1
- data/lib/algolia/models/search/languages.rb +0 -2
- data/lib/algolia/models/search/list_api_keys_response.rb +0 -2
- data/lib/algolia/models/search/list_clusters_response.rb +0 -2
- data/lib/algolia/models/search/list_indices_response.rb +0 -2
- data/lib/algolia/models/search/list_user_ids_response.rb +0 -2
- data/lib/algolia/models/search/log.rb +0 -2
- data/lib/algolia/models/search/log_query.rb +0 -2
- data/lib/algolia/models/search/matched_geo_location.rb +0 -2
- data/lib/algolia/models/search/multiple_batch_request.rb +0 -2
- data/lib/algolia/models/search/multiple_batch_response.rb +0 -2
- data/lib/algolia/models/search/numeric_filters.rb +0 -1
- data/lib/algolia/models/search/operation_index_params.rb +0 -2
- data/lib/algolia/models/search/optional_filters.rb +1 -2
- data/lib/algolia/models/search/optional_words.rb +0 -1
- data/lib/algolia/models/search/personalization.rb +0 -2
- data/lib/algolia/models/search/promote.rb +0 -1
- data/lib/algolia/models/search/promote_object_id.rb +0 -2
- data/lib/algolia/models/search/promote_object_ids.rb +0 -2
- data/lib/algolia/models/search/range.rb +0 -2
- data/lib/algolia/models/search/ranking_info.rb +0 -2
- data/lib/algolia/models/search/re_ranking_apply_filter.rb +1 -2
- data/lib/algolia/models/search/redirect.rb +1 -3
- data/lib/algolia/models/search/redirect_rule_index_data.rb +0 -2
- data/lib/algolia/models/search/redirect_rule_index_metadata.rb +0 -2
- data/lib/algolia/models/search/redirect_url.rb +0 -2
- data/lib/algolia/models/search/remove_stop_words.rb +0 -1
- data/lib/algolia/models/search/remove_user_id_response.rb +0 -2
- data/lib/algolia/models/search/rendering_content.rb +0 -2
- data/lib/algolia/models/search/replace_all_objects_response.rb +0 -2
- data/lib/algolia/models/search/replace_all_objects_with_transformation_response.rb +0 -2
- data/lib/algolia/models/search/replace_source_response.rb +0 -2
- data/lib/algolia/models/search/rule.rb +0 -2
- data/lib/algolia/models/search/save_object_response.rb +1 -3
- data/lib/algolia/models/search/save_synonym_response.rb +1 -3
- data/lib/algolia/models/search/search_dictionary_entries_params.rb +0 -2
- data/lib/algolia/models/search/search_dictionary_entries_response.rb +1 -3
- data/lib/algolia/models/search/search_for_facet_values_request.rb +0 -2
- data/lib/algolia/models/search/search_for_facet_values_response.rb +0 -2
- data/lib/algolia/models/search/search_for_facets.rb +10 -12
- data/lib/algolia/models/search/search_for_hits.rb +10 -12
- data/lib/algolia/models/search/search_method_params.rb +0 -2
- data/lib/algolia/models/search/search_params.rb +0 -1
- data/lib/algolia/models/search/search_params_object.rb +10 -12
- data/lib/algolia/models/search/search_params_string.rb +0 -2
- data/lib/algolia/models/search/search_query.rb +0 -1
- data/lib/algolia/models/search/search_response.rb +1 -3
- data/lib/algolia/models/search/search_responses.rb +0 -2
- data/lib/algolia/models/search/search_result.rb +0 -1
- data/lib/algolia/models/search/search_rules_params.rb +2 -4
- data/lib/algolia/models/search/search_rules_response.rb +0 -2
- data/lib/algolia/models/search/search_synonyms_params.rb +0 -2
- data/lib/algolia/models/search/search_synonyms_response.rb +0 -2
- data/lib/algolia/models/search/search_user_ids_params.rb +0 -3
- data/lib/algolia/models/search/search_user_ids_response.rb +1 -3
- data/lib/algolia/models/search/secured_api_key_restrictions.rb +0 -2
- data/lib/algolia/models/search/semantic_search.rb +0 -2
- data/lib/algolia/models/search/settings_response.rb +15 -17
- data/lib/algolia/models/search/snippet_result.rb +0 -1
- data/lib/algolia/models/search/snippet_result_option.rb +0 -2
- data/lib/algolia/models/search/source.rb +0 -2
- data/lib/algolia/models/search/standard_entries.rb +1 -3
- data/lib/algolia/models/search/synonym_hit.rb +4 -6
- data/lib/algolia/models/search/tag_filters.rb +0 -1
- data/lib/algolia/models/search/time_range.rb +0 -2
- data/lib/algolia/models/search/typo_tolerance.rb +1 -2
- data/lib/algolia/models/search/update_api_key_response.rb +0 -2
- data/lib/algolia/models/search/updated_at_response.rb +1 -3
- data/lib/algolia/models/search/updated_at_with_object_id_response.rb +1 -3
- data/lib/algolia/models/search/user_highlight_result.rb +0 -2
- data/lib/algolia/models/search/user_hit.rb +0 -2
- data/lib/algolia/models/search/user_id.rb +0 -2
- data/lib/algolia/models/search/value.rb +0 -2
- data/lib/algolia/models/search/watch_response.rb +0 -2
- data/lib/algolia/models/search/widgets.rb +0 -2
- data/lib/algolia/version.rb +1 -1
- metadata +3 -1
@@ -26,7 +26,7 @@ module Algolia
|
|
26
26
|
# Maximum number of results this API key can retrieve in one query. By default, there's no limit.
|
27
27
|
attr_accessor :max_hits_per_query
|
28
28
|
|
29
|
-
# Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken
|
29
|
+
# Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken) per hour. If this limit is reached, the API returns an error with status code `429`. By default, there's no limit.
|
30
30
|
attr_accessor :max_queries_per_ip_per_hour
|
31
31
|
|
32
32
|
# Query parameters to add when making API requests with this API key. To restrict this API key to specific IP addresses, add the `restrictSources` parameter. You can only add a single source, but you can provide a range of IP addresses. Creating an API key fails if the request is made from an IP address outside the restricted range.
|
@@ -323,8 +323,6 @@ module Algolia
|
|
323
323
|
value
|
324
324
|
end
|
325
325
|
end
|
326
|
-
|
327
326
|
end
|
328
|
-
|
329
327
|
end
|
330
328
|
end
|
@@ -9,19 +9,19 @@ module Algolia
|
|
9
9
|
module Search
|
10
10
|
# Index settings.
|
11
11
|
class IndexSettings
|
12
|
-
# Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting
|
12
|
+
# Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting). Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows the attribute to be used as a filter but doesn't evaluate the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching for facet values. - `afterDistinct(\"ATTRIBUTE\")`. Evaluates the facet count _after_ deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
|
13
13
|
attr_accessor :attributes_for_faceting
|
14
14
|
|
15
|
-
# Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas
|
15
|
+
# Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas). Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you'll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer be synced with the primary index. **Modifier** - `virtual(\"REPLICA\")`. Create a virtual replica, Virtual replicas don't increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort).
|
16
16
|
attr_accessor :replicas
|
17
17
|
|
18
18
|
# Maximum number of search results that can be obtained through pagination. Higher pagination limits might slow down your search. For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed.
|
19
19
|
attr_accessor :pagination_limited_to
|
20
20
|
|
21
|
-
# Attributes that can't be retrieved at query time. This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data
|
21
|
+
# Attributes that can't be retrieved at query time. This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data), but don't want to include it in the search results. Attribute names are case-sensitive.
|
22
22
|
attr_accessor :unretrievable_attributes
|
23
23
|
|
24
|
-
# Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation
|
24
|
+
# Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation) for the specified words.
|
25
25
|
attr_accessor :disable_typo_tolerance_on_words
|
26
26
|
|
27
27
|
# Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead). Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive.
|
@@ -30,10 +30,10 @@ module Algolia
|
|
30
30
|
# Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive.
|
31
31
|
attr_accessor :camel_case_attributes
|
32
32
|
|
33
|
-
# Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation
|
33
|
+
# Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation) (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`). Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
|
34
34
|
attr_accessor :decompounded_attributes
|
35
35
|
|
36
|
-
# Languages for language-specific processing steps, such as word detection and dictionary settings. **You should always specify an indexing language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages
|
36
|
+
# Languages for language-specific processing steps, such as word detection and dictionary settings. **You should always specify an indexing language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations).
|
37
37
|
attr_accessor :index_languages
|
38
38
|
|
39
39
|
# Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). Attribute names are case-sensitive.
|
@@ -48,13 +48,13 @@ module Algolia
|
|
48
48
|
# Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
|
49
49
|
attr_accessor :separators_to_index
|
50
50
|
|
51
|
-
# Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered. For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes
|
51
|
+
# Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered. For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes). **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. Without a modifier, matches at the beginning of an attribute rank higher than matches at the end.
|
52
52
|
attr_accessor :searchable_attributes
|
53
53
|
|
54
54
|
# An object with custom data. You can store up to 32kB as custom data.
|
55
55
|
attr_accessor :user_data
|
56
56
|
|
57
|
-
# Characters and their normalized replacements. This overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization
|
57
|
+
# Characters and their normalized replacements. This overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization).
|
58
58
|
attr_accessor :custom_normalization
|
59
59
|
|
60
60
|
# Attribute that should be used to establish groups of results. Attribute names are case-sensitive. All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results. If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting _after_ deduplication, which will result in accurate facet counts.
|
@@ -66,19 +66,19 @@ module Algolia
|
|
66
66
|
# 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.
|
67
67
|
attr_accessor :keep_diacritics_on_characters
|
68
68
|
|
69
|
-
# Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking
|
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
70
|
attr_accessor :custom_ranking
|
71
71
|
|
72
72
|
# 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.
|
73
73
|
attr_accessor :attributes_to_retrieve
|
74
74
|
|
75
|
-
# 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
|
75
|
+
# 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).
|
76
76
|
attr_accessor :ranking
|
77
77
|
|
78
78
|
# 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.
|
79
79
|
attr_accessor :relevancy_strictness
|
80
80
|
|
81
|
-
# Attributes to highlight By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js
|
81
|
+
# Attributes to highlight By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js).
|
82
82
|
attr_accessor :attributes_to_highlight
|
83
83
|
|
84
84
|
# Attributes for which to enable snippets. Attribute names are case-sensitive Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted.
|
@@ -110,14 +110,14 @@ module Algolia
|
|
110
110
|
# Whether to allow typos on numbers in the search query Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers.
|
111
111
|
attr_accessor :allow_typos_on_numeric_tokens
|
112
112
|
|
113
|
-
# Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance
|
113
|
+
# Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance). Attribute names are case-sensitive Returning only exact matches can help when - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes). - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
|
114
114
|
attr_accessor :disable_typo_tolerance_on_attributes
|
115
115
|
|
116
116
|
attr_accessor :ignore_plurals
|
117
117
|
|
118
118
|
attr_accessor :remove_stop_words
|
119
119
|
|
120
|
-
# 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
|
120
|
+
# 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).
|
121
121
|
attr_accessor :query_languages
|
122
122
|
|
123
123
|
# Whether to split compound words in the query into their building blocks For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
|
@@ -167,7 +167,7 @@ module Algolia
|
|
167
167
|
# Maximum number of facet values to return for each facet.
|
168
168
|
attr_accessor :max_values_per_facet
|
169
169
|
|
170
|
-
# Order in which to retrieve facet values - `count`. Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value - `alpha`. Retrieve facet values alphabetically This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js
|
170
|
+
# Order in which to retrieve facet values - `count`. Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value - `alpha`. Retrieve facet values alphabetically This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js).
|
171
171
|
attr_accessor :sort_facet_values_by
|
172
172
|
|
173
173
|
# Whether the best matching attribute should be determined by minimum proximity This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.
|
@@ -175,7 +175,7 @@ module Algolia
|
|
175
175
|
|
176
176
|
attr_accessor :rendering_content
|
177
177
|
|
178
|
-
# Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking
|
178
|
+
# Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
|
179
179
|
attr_accessor :enable_re_ranking
|
180
180
|
|
181
181
|
attr_accessor :re_ranking_apply_filter
|
@@ -908,8 +908,6 @@ module Algolia
|
|
908
908
|
value
|
909
909
|
end
|
910
910
|
end
|
911
|
-
|
912
911
|
end
|
913
|
-
|
914
912
|
end
|
915
913
|
end
|
@@ -7,7 +7,7 @@ require "time"
|
|
7
7
|
|
8
8
|
module Algolia
|
9
9
|
module Search
|
10
|
-
# Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. - Optional filters don't work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters are applied _before_ custom ranking attributes (in the default [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria
|
10
|
+
# Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. - Optional filters don't work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters are applied _before_ custom ranking attributes (in the default [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria)). - Optional filters don't work with numeric attributes.
|
11
11
|
module OptionalFilters
|
12
12
|
class << self
|
13
13
|
# List of class defined in oneOf (OpenAPI v3)
|
@@ -105,6 +105,5 @@ module Algolia
|
|
105
105
|
end
|
106
106
|
end
|
107
107
|
end
|
108
|
-
|
109
108
|
end
|
110
109
|
end
|
@@ -7,7 +7,7 @@ require "time"
|
|
7
7
|
|
8
8
|
module Algolia
|
9
9
|
module Search
|
10
|
-
# Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking
|
10
|
+
# Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) to records that match these filters.
|
11
11
|
module ReRankingApplyFilter
|
12
12
|
class << self
|
13
13
|
# List of class defined in oneOf (OpenAPI v3)
|
@@ -105,6 +105,5 @@ module Algolia
|
|
105
105
|
end
|
106
106
|
end
|
107
107
|
end
|
108
|
-
|
109
108
|
end
|
110
109
|
end
|
@@ -7,7 +7,7 @@ require "time"
|
|
7
7
|
|
8
8
|
module Algolia
|
9
9
|
module Search
|
10
|
-
# [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects
|
10
|
+
# [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects), this this parameter is for internal use only.
|
11
11
|
class Redirect
|
12
12
|
attr_accessor :index
|
13
13
|
|
@@ -201,8 +201,6 @@ module Algolia
|
|
201
201
|
value
|
202
202
|
end
|
203
203
|
end
|
204
|
-
|
205
204
|
end
|
206
|
-
|
207
205
|
end
|
208
206
|
end
|