elasticsearch-api 9.0.3 → 9.1.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/.gitignore +1 -0
- data/lib/elasticsearch/api/actions/async_search/delete.rb +14 -3
- data/lib/elasticsearch/api/actions/async_search/get.rb +13 -2
- data/lib/elasticsearch/api/actions/async_search/status.rb +13 -2
- data/lib/elasticsearch/api/actions/async_search/submit.rb +17 -6
- data/lib/elasticsearch/api/actions/bulk.rb +86 -63
- data/lib/elasticsearch/api/actions/cat/aliases.rb +20 -9
- data/lib/elasticsearch/api/actions/cat/allocation.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/component_templates.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/count.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/fielddata.rb +17 -6
- data/lib/elasticsearch/api/actions/cat/health.rb +20 -9
- data/lib/elasticsearch/api/actions/cat/help.rb +1 -1
- data/lib/elasticsearch/api/actions/cat/indices.rb +18 -7
- data/lib/elasticsearch/api/actions/cat/master.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb +16 -5
- data/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/ml_jobs.rb +20 -9
- data/lib/elasticsearch/api/actions/cat/ml_trained_models.rb +18 -7
- data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/nodes.rb +23 -11
- data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/plugins.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/recovery.rb +24 -12
- data/lib/elasticsearch/api/actions/cat/repositories.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/segments.rb +24 -12
- data/lib/elasticsearch/api/actions/cat/shards.rb +22 -11
- data/lib/elasticsearch/api/actions/cat/snapshots.rb +21 -9
- data/lib/elasticsearch/api/actions/cat/tasks.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/templates.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/thread_pool.rb +21 -10
- data/lib/elasticsearch/api/actions/cat/transforms.rb +18 -7
- data/lib/elasticsearch/api/actions/clear_scroll.rb +13 -2
- data/lib/elasticsearch/api/actions/close_point_in_time.rb +15 -4
- data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +13 -1
- data/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +12 -1
- data/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +12 -1
- data/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +12 -1
- data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +17 -5
- data/lib/elasticsearch/api/actions/cluster/get_settings.rb +14 -3
- data/lib/elasticsearch/api/actions/cluster/health.rb +13 -2
- data/lib/elasticsearch/api/actions/cluster/info.rb +13 -2
- data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +14 -3
- data/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +16 -5
- data/lib/elasticsearch/api/actions/cluster/put_component_template.rb +20 -8
- data/lib/elasticsearch/api/actions/cluster/put_settings.rb +17 -6
- data/lib/elasticsearch/api/actions/cluster/remote_info.rb +13 -2
- data/lib/elasticsearch/api/actions/cluster/reroute.rb +16 -5
- data/lib/elasticsearch/api/actions/cluster/state.rb +15 -4
- data/lib/elasticsearch/api/actions/cluster/stats.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/check_in.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/delete.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/get.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/list.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/post.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/put.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/sync_job_claim.rb +15 -4
- data/lib/elasticsearch/api/actions/connector/sync_job_delete.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_error.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/sync_job_get.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_list.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_post.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb +15 -4
- data/lib/elasticsearch/api/actions/connector/update_active_filtering.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_api_key_id.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/update_configuration.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_error.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_features.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_filtering.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_index_name.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/update_name.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_native.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_pipeline.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_scheduling.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_service_type.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_status.rb +13 -2
- data/lib/elasticsearch/api/actions/count.rb +29 -18
- data/lib/elasticsearch/api/actions/create.rb +44 -41
- data/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb +13 -2
- data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +13 -2
- data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +13 -2
- data/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb +14 -3
- data/lib/elasticsearch/api/actions/delete.rb +25 -12
- data/lib/elasticsearch/api/actions/delete_by_query.rb +63 -48
- data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +14 -3
- data/lib/elasticsearch/api/actions/delete_script.rb +14 -3
- data/lib/elasticsearch/api/actions/enrich/delete_policy.rb +12 -1
- data/lib/elasticsearch/api/actions/enrich/execute_policy.rb +13 -2
- data/lib/elasticsearch/api/actions/enrich/get_policy.rb +12 -1
- data/lib/elasticsearch/api/actions/enrich/put_policy.rb +12 -1
- data/lib/elasticsearch/api/actions/enrich/stats.rb +12 -1
- data/lib/elasticsearch/api/actions/eql/delete.rb +14 -3
- data/lib/elasticsearch/api/actions/eql/get.rb +12 -1
- data/lib/elasticsearch/api/actions/eql/get_status.rb +13 -2
- data/lib/elasticsearch/api/actions/eql/search.rb +15 -3
- data/lib/elasticsearch/api/actions/esql/async_query.rb +17 -14
- data/lib/elasticsearch/api/actions/esql/async_query_delete.rb +15 -4
- data/lib/elasticsearch/api/actions/esql/async_query_get.rb +17 -5
- data/lib/elasticsearch/api/actions/esql/async_query_stop.rb +15 -4
- data/lib/elasticsearch/api/actions/esql/get_query.rb +76 -0
- data/lib/elasticsearch/api/actions/esql/list_queries.rb +66 -0
- data/lib/elasticsearch/api/actions/esql/query.rb +15 -2
- data/lib/elasticsearch/api/actions/exists.rb +31 -18
- data/lib/elasticsearch/api/actions/exists_source.rb +21 -8
- data/lib/elasticsearch/api/actions/explain.rb +25 -14
- data/lib/elasticsearch/api/actions/features/get_features.rb +13 -2
- data/lib/elasticsearch/api/actions/features/reset_features.rb +12 -1
- data/lib/elasticsearch/api/actions/field_caps.rb +18 -7
- data/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb +17 -6
- data/lib/elasticsearch/api/actions/fleet/msearch.rb +15 -4
- data/lib/elasticsearch/api/actions/fleet/search.rb +15 -4
- data/lib/elasticsearch/api/actions/get.rb +48 -29
- data/lib/elasticsearch/api/actions/get_script.rb +13 -2
- data/lib/elasticsearch/api/actions/get_script_context.rb +13 -2
- data/lib/elasticsearch/api/actions/get_script_languages.rb +13 -2
- data/lib/elasticsearch/api/actions/get_source.rb +24 -11
- data/lib/elasticsearch/api/actions/graph/explore.rb +13 -2
- data/lib/elasticsearch/api/actions/health_report.rb +13 -2
- data/lib/elasticsearch/api/actions/index.rb +55 -43
- data/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb +14 -3
- data/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb +13 -2
- data/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb +14 -3
- data/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb +14 -3
- data/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb +13 -2
- data/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb +13 -2
- data/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb +12 -1
- data/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/add_block.rb +20 -9
- data/lib/elasticsearch/api/actions/indices/analyze.rb +15 -4
- data/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/clear_cache.rb +24 -14
- data/lib/elasticsearch/api/actions/indices/clone.rb +17 -6
- data/lib/elasticsearch/api/actions/indices/close.rb +19 -9
- data/lib/elasticsearch/api/actions/indices/create.rb +24 -13
- data/lib/elasticsearch/api/actions/indices/create_data_stream.rb +15 -4
- data/lib/elasticsearch/api/actions/indices/create_from.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +15 -4
- data/lib/elasticsearch/api/actions/indices/delete.rb +17 -7
- data/lib/elasticsearch/api/actions/indices/delete_alias.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/delete_data_stream.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb +75 -0
- data/lib/elasticsearch/api/actions/indices/delete_index_template.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/delete_template.rb +14 -2
- data/lib/elasticsearch/api/actions/indices/disk_usage.rb +21 -10
- data/lib/elasticsearch/api/actions/indices/downsample.rb +15 -4
- data/lib/elasticsearch/api/actions/indices/exists.rb +19 -9
- data/lib/elasticsearch/api/actions/indices/exists_alias.rb +18 -8
- data/lib/elasticsearch/api/actions/indices/exists_index_template.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/exists_template.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +16 -5
- data/lib/elasticsearch/api/actions/indices/flush.rb +20 -10
- data/lib/elasticsearch/api/actions/indices/forcemerge.rb +23 -11
- data/lib/elasticsearch/api/actions/indices/get.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/get_alias.rb +19 -9
- data/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb +16 -6
- data/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/get_data_stream.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb +77 -0
- data/lib/elasticsearch/api/actions/indices/get_data_stream_settings.rb +75 -0
- data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +19 -10
- data/lib/elasticsearch/api/actions/indices/get_index_template.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/get_mapping.rb +18 -8
- data/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/get_settings.rb +24 -13
- data/lib/elasticsearch/api/actions/indices/get_template.rb +17 -6
- data/lib/elasticsearch/api/actions/indices/migrate_reindex.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/modify_data_stream.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/open.rb +23 -13
- data/lib/elasticsearch/api/actions/indices/promote_data_stream.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/put_alias.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb +15 -5
- data/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb +82 -0
- data/lib/elasticsearch/api/actions/indices/put_data_stream_settings.rb +85 -0
- data/lib/elasticsearch/api/actions/indices/put_index_template.rb +17 -6
- data/lib/elasticsearch/api/actions/indices/put_mapping.rb +26 -25
- data/lib/elasticsearch/api/actions/indices/put_settings.rb +66 -14
- data/lib/elasticsearch/api/actions/indices/put_template.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/recovery.rb +22 -5
- data/lib/elasticsearch/api/actions/indices/refresh.rb +19 -9
- data/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb +15 -4
- data/lib/elasticsearch/api/actions/indices/remove_block.rb +93 -0
- data/lib/elasticsearch/api/actions/indices/resolve_cluster.rb +35 -25
- data/lib/elasticsearch/api/actions/indices/resolve_index.rb +17 -7
- data/lib/elasticsearch/api/actions/indices/rollover.rb +22 -11
- data/lib/elasticsearch/api/actions/indices/segments.rb +17 -7
- data/lib/elasticsearch/api/actions/indices/shard_stores.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/shrink.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/simulate_template.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/split.rb +19 -6
- data/lib/elasticsearch/api/actions/indices/stats.rb +19 -8
- data/lib/elasticsearch/api/actions/indices/update_aliases.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/validate_query.rb +25 -15
- data/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb +18 -1
- data/lib/elasticsearch/api/actions/inference/completion.rb +12 -1
- data/lib/elasticsearch/api/actions/inference/delete.rb +12 -1
- data/lib/elasticsearch/api/actions/inference/get.rb +13 -2
- data/lib/elasticsearch/api/actions/inference/inference.rb +12 -1
- data/lib/elasticsearch/api/actions/inference/put.rb +33 -8
- data/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb +15 -3
- data/lib/elasticsearch/api/actions/inference/put_anthropic.rb +16 -9
- data/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_azureopenai.rb +16 -9
- data/lib/elasticsearch/api/actions/inference/put_cohere.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_custom.rb +112 -0
- data/lib/elasticsearch/api/actions/inference/put_deepseek.rb +82 -0
- data/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb +16 -4
- data/lib/elasticsearch/api/actions/inference/put_elser.rb +15 -3
- data/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_hugging_face.rb +43 -19
- data/lib/elasticsearch/api/actions/inference/put_jinaai.rb +17 -10
- data/lib/elasticsearch/api/actions/inference/put_mistral.rb +16 -10
- data/lib/elasticsearch/api/actions/inference/put_openai.rb +16 -9
- data/lib/elasticsearch/api/actions/inference/put_voyageai.rb +15 -3
- data/lib/elasticsearch/api/actions/inference/put_watsonx.rb +17 -11
- data/lib/elasticsearch/api/actions/inference/rerank.rb +13 -2
- data/lib/elasticsearch/api/actions/inference/sparse_embedding.rb +12 -1
- data/lib/elasticsearch/api/actions/inference/stream_completion.rb +15 -3
- data/lib/elasticsearch/api/actions/inference/text_embedding.rb +12 -1
- data/lib/elasticsearch/api/actions/inference/update.rb +14 -3
- data/lib/elasticsearch/api/actions/info.rb +14 -2
- data/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb +12 -1
- data/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb +14 -3
- data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +13 -2
- data/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb +12 -1
- data/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb +15 -4
- data/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb +14 -6
- data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +14 -3
- data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +12 -1
- data/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb +12 -1
- data/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb +14 -3
- data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +11 -0
- data/lib/elasticsearch/api/actions/ingest/simulate.rb +14 -3
- data/lib/elasticsearch/api/actions/license/delete.rb +12 -1
- data/lib/elasticsearch/api/actions/license/get.rb +14 -3
- data/lib/elasticsearch/api/actions/license/get_basic_status.rb +13 -2
- data/lib/elasticsearch/api/actions/license/get_trial_status.rb +13 -2
- data/lib/elasticsearch/api/actions/license/post.rb +12 -1
- data/lib/elasticsearch/api/actions/license/post_start_basic.rb +13 -2
- data/lib/elasticsearch/api/actions/license/post_start_trial.rb +13 -2
- data/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb +13 -2
- data/lib/elasticsearch/api/actions/logstash/get_pipeline.rb +13 -2
- data/lib/elasticsearch/api/actions/logstash/put_pipeline.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/close_job.rb +16 -5
- data/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb +15 -4
- data/lib/elasticsearch/api/actions/machine_learning/delete_job.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/flush_job.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/forecast.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb +16 -5
- data/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/get_categories.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb +19 -8
- data/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb +18 -7
- data/lib/elasticsearch/api/actions/machine_learning/get_filters.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb +15 -4
- data/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb +31 -20
- data/lib/elasticsearch/api/actions/machine_learning/get_records.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/info.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/open_job.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/post_data.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb +25 -6
- data/lib/elasticsearch/api/actions/machine_learning/put_filter.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/put_job.rb +19 -13
- data/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/reset_job.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb +19 -8
- data/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb +17 -6
- data/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb +17 -11
- data/lib/elasticsearch/api/actions/machine_learning/update_filter.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/update_job.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb +12 -1
- data/lib/elasticsearch/api/actions/mget.rb +25 -14
- data/lib/elasticsearch/api/actions/migration/deprecations.rb +13 -2
- data/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb +13 -2
- data/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb +13 -2
- data/lib/elasticsearch/api/actions/msearch.rb +28 -11
- data/lib/elasticsearch/api/actions/msearch_template.rb +22 -10
- data/lib/elasticsearch/api/actions/mtermvectors.rb +21 -10
- data/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +14 -3
- data/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb +13 -2
- data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +12 -1
- data/lib/elasticsearch/api/actions/nodes/info.rb +12 -1
- data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +12 -1
- data/lib/elasticsearch/api/actions/nodes/stats.rb +13 -2
- data/lib/elasticsearch/api/actions/nodes/usage.rb +14 -3
- data/lib/elasticsearch/api/actions/open_point_in_time.rb +23 -12
- data/lib/elasticsearch/api/actions/ping.rb +13 -2
- data/lib/elasticsearch/api/actions/put_script.rb +14 -3
- data/lib/elasticsearch/api/actions/query_rules/delete_rule.rb +13 -2
- data/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb +12 -1
- data/lib/elasticsearch/api/actions/query_rules/get_rule.rb +13 -2
- data/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb +13 -2
- data/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb +12 -1
- data/lib/elasticsearch/api/actions/query_rules/put_rule.rb +13 -2
- data/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb +15 -4
- data/lib/elasticsearch/api/actions/query_rules/test.rb +13 -2
- data/lib/elasticsearch/api/actions/rank_eval.rb +16 -5
- data/lib/elasticsearch/api/actions/reindex.rb +35 -123
- data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +17 -4
- data/lib/elasticsearch/api/actions/render_search_template.rb +14 -3
- data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +12 -1
- data/lib/elasticsearch/api/actions/scroll.rb +16 -5
- data/lib/elasticsearch/api/actions/search.rb +71 -60
- data/lib/elasticsearch/api/actions/search_application/delete.rb +13 -2
- data/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/search_application/get.rb +13 -2
- data/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/search_application/list.rb +12 -1
- data/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb +12 -1
- data/lib/elasticsearch/api/actions/search_application/put.rb +13 -2
- data/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/search_application/render_query.rb +15 -4
- data/lib/elasticsearch/api/actions/search_application/search.rb +12 -1
- data/lib/elasticsearch/api/actions/search_mvt.rb +39 -70
- data/lib/elasticsearch/api/actions/search_shards.rb +22 -12
- data/lib/elasticsearch/api/actions/search_template.rb +24 -14
- data/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb +12 -1
- data/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb +14 -3
- data/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb +13 -2
- data/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb +12 -1
- data/lib/elasticsearch/api/actions/security/activate_user_profile.rb +17 -6
- data/lib/elasticsearch/api/actions/security/authenticate.rb +13 -2
- data/lib/elasticsearch/api/actions/security/bulk_delete_role.rb +13 -2
- data/lib/elasticsearch/api/actions/security/bulk_put_role.rb +13 -2
- data/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb +15 -4
- data/lib/elasticsearch/api/actions/security/change_password.rb +13 -2
- data/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb +14 -3
- data/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb +14 -3
- data/lib/elasticsearch/api/actions/security/clear_cached_realms.rb +13 -2
- data/lib/elasticsearch/api/actions/security/clear_cached_roles.rb +14 -3
- data/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb +17 -6
- data/lib/elasticsearch/api/actions/security/create_api_key.rb +13 -2
- data/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb +16 -5
- data/lib/elasticsearch/api/actions/security/create_service_token.rb +15 -4
- data/lib/elasticsearch/api/actions/security/delegate_pki.rb +15 -4
- data/lib/elasticsearch/api/actions/security/delete_privileges.rb +14 -3
- data/lib/elasticsearch/api/actions/security/delete_role.rb +13 -2
- data/lib/elasticsearch/api/actions/security/delete_role_mapping.rb +13 -2
- data/lib/elasticsearch/api/actions/security/delete_service_token.rb +13 -2
- data/lib/elasticsearch/api/actions/security/delete_user.rb +13 -2
- data/lib/elasticsearch/api/actions/security/disable_user.rb +13 -2
- data/lib/elasticsearch/api/actions/security/disable_user_profile.rb +12 -1
- data/lib/elasticsearch/api/actions/security/enable_user.rb +13 -2
- data/lib/elasticsearch/api/actions/security/enable_user_profile.rb +12 -1
- data/lib/elasticsearch/api/actions/security/enroll_kibana.rb +13 -2
- data/lib/elasticsearch/api/actions/security/enroll_node.rb +13 -2
- data/lib/elasticsearch/api/actions/security/get_api_key.rb +20 -9
- data/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb +13 -2
- data/lib/elasticsearch/api/actions/security/get_privileges.rb +14 -3
- data/lib/elasticsearch/api/actions/security/get_role.rb +12 -1
- data/lib/elasticsearch/api/actions/security/get_role_mapping.rb +13 -2
- data/lib/elasticsearch/api/actions/security/get_service_accounts.rb +16 -5
- data/lib/elasticsearch/api/actions/security/get_service_credentials.rb +15 -4
- data/lib/elasticsearch/api/actions/security/get_settings.rb +15 -4
- data/lib/elasticsearch/api/actions/security/get_token.rb +15 -4
- data/lib/elasticsearch/api/actions/security/get_user.rb +13 -2
- data/lib/elasticsearch/api/actions/security/get_user_privileges.rb +12 -4
- data/lib/elasticsearch/api/actions/security/get_user_profile.rb +17 -6
- data/lib/elasticsearch/api/actions/security/grant_api_key.rb +17 -2
- data/lib/elasticsearch/api/actions/security/has_privileges.rb +13 -2
- data/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb +13 -2
- data/lib/elasticsearch/api/actions/security/invalidate_api_key.rb +21 -10
- data/lib/elasticsearch/api/actions/security/invalidate_token.rb +16 -5
- data/lib/elasticsearch/api/actions/security/oidc_authenticate.rb +13 -2
- data/lib/elasticsearch/api/actions/security/oidc_logout.rb +14 -3
- data/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb +13 -2
- data/lib/elasticsearch/api/actions/security/put_privileges.rb +18 -7
- data/lib/elasticsearch/api/actions/security/put_role.rb +13 -2
- data/lib/elasticsearch/api/actions/security/put_role_mapping.rb +16 -5
- data/lib/elasticsearch/api/actions/security/put_user.rb +13 -2
- data/lib/elasticsearch/api/actions/security/query_api_keys.rb +18 -6
- data/lib/elasticsearch/api/actions/security/query_role.rb +13 -2
- data/lib/elasticsearch/api/actions/security/query_user.rb +12 -1
- data/lib/elasticsearch/api/actions/security/saml_authenticate.rb +14 -3
- data/lib/elasticsearch/api/actions/security/saml_complete_logout.rb +13 -2
- data/lib/elasticsearch/api/actions/security/saml_invalidate.rb +14 -3
- data/lib/elasticsearch/api/actions/security/saml_logout.rb +13 -2
- data/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb +16 -5
- data/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb +13 -2
- data/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb +17 -6
- data/lib/elasticsearch/api/actions/security/update_api_key.rb +17 -6
- data/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb +17 -5
- data/lib/elasticsearch/api/actions/security/update_settings.rb +14 -3
- data/lib/elasticsearch/api/actions/security/update_user_profile_data.rb +16 -5
- data/lib/elasticsearch/api/actions/simulate/ingest.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot/clone.rb +13 -2
- data/lib/elasticsearch/api/actions/snapshot/create.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +17 -6
- data/lib/elasticsearch/api/actions/snapshot/delete.rb +16 -3
- data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +15 -4
- data/lib/elasticsearch/api/actions/snapshot/get.rb +32 -19
- data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +16 -5
- data/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +38 -16
- data/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb +113 -0
- data/lib/elasticsearch/api/actions/snapshot/restore.rb +19 -6
- data/lib/elasticsearch/api/actions/snapshot/status.rb +19 -8
- data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb +14 -3
- data/lib/elasticsearch/api/actions/sql/clear_cursor.rb +13 -2
- data/lib/elasticsearch/api/actions/sql/delete_async.rb +14 -3
- data/lib/elasticsearch/api/actions/sql/get_async.rb +14 -3
- data/lib/elasticsearch/api/actions/sql/get_async_status.rb +13 -2
- data/lib/elasticsearch/api/actions/sql/query.rb +14 -3
- data/lib/elasticsearch/api/actions/sql/translate.rb +14 -3
- data/lib/elasticsearch/api/actions/ssl/certificates.rb +15 -4
- data/lib/elasticsearch/api/actions/streams/logs_disable.rb +50 -0
- data/lib/elasticsearch/api/actions/streams/logs_enable.rb +50 -0
- data/lib/elasticsearch/api/actions/streams/status.rb +50 -0
- data/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb +13 -2
- data/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb +15 -2
- data/lib/elasticsearch/api/actions/synonyms/get_synonym.rb +12 -1
- data/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb +13 -2
- data/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb +12 -1
- data/lib/elasticsearch/api/actions/synonyms/put_synonym.rb +16 -2
- data/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb +15 -2
- data/lib/elasticsearch/api/actions/tasks/cancel.rb +15 -4
- data/lib/elasticsearch/api/actions/tasks/get.rb +13 -2
- data/lib/elasticsearch/api/actions/tasks/list.rb +30 -15
- data/lib/elasticsearch/api/actions/terms_enum.rb +15 -4
- data/lib/elasticsearch/api/actions/termvectors.rb +28 -15
- data/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb +53 -42
- data/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb +53 -42
- data/lib/elasticsearch/api/actions/text_structure/find_structure.rb +45 -45
- data/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb +13 -2
- data/lib/elasticsearch/api/actions/transform/delete_transform.rb +12 -1
- data/lib/elasticsearch/api/actions/transform/get_node_stats.rb +2 -7
- data/lib/elasticsearch/api/actions/transform/get_transform.rb +14 -3
- data/lib/elasticsearch/api/actions/transform/get_transform_stats.rb +14 -3
- data/lib/elasticsearch/api/actions/transform/preview_transform.rb +12 -1
- data/lib/elasticsearch/api/actions/transform/put_transform.rb +19 -8
- data/lib/elasticsearch/api/actions/transform/reset_transform.rb +14 -3
- data/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb +13 -2
- data/lib/elasticsearch/api/actions/transform/start_transform.rb +15 -4
- data/lib/elasticsearch/api/actions/transform/stop_transform.rb +15 -4
- data/lib/elasticsearch/api/actions/transform/update_transform.rb +15 -4
- data/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb +12 -1
- data/lib/elasticsearch/api/actions/update.rb +20 -8
- data/lib/elasticsearch/api/actions/update_by_query.rb +76 -56
- data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/ack_watch.rb +16 -4
- data/lib/elasticsearch/api/actions/watcher/activate_watch.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/delete_watch.rb +15 -4
- data/lib/elasticsearch/api/actions/watcher/execute_watch.rb +14 -2
- data/lib/elasticsearch/api/actions/watcher/get_settings.rb +14 -3
- data/lib/elasticsearch/api/actions/watcher/get_watch.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/put_watch.rb +18 -7
- data/lib/elasticsearch/api/actions/watcher/query_watches.rb +14 -3
- data/lib/elasticsearch/api/actions/watcher/start.rb +12 -1
- data/lib/elasticsearch/api/actions/watcher/stats.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/stop.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/update_settings.rb +17 -6
- data/lib/elasticsearch/api/actions/xpack/info.rb +13 -2
- data/lib/elasticsearch/api/actions/xpack/usage.rb +13 -2
- data/lib/elasticsearch/api/version.rb +2 -2
- data/lib/elasticsearch/api.rb +1 -0
- metadata +18 -4
@@ -23,24 +23,31 @@ module Elasticsearch
|
|
23
23
|
module Inference
|
24
24
|
module Actions
|
25
25
|
# Create an Azure OpenAI inference endpoint.
|
26
|
-
# Create an inference endpoint to perform an inference task with the
|
26
|
+
# Create an inference endpoint to perform an inference task with the `azureopenai` service.
|
27
27
|
# The list of chat completion models that you can choose from in your Azure OpenAI deployment include:
|
28
28
|
# * {https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-4-and-gpt-4-turbo-models GPT-4 and GPT-4 Turbo models}
|
29
29
|
# * {https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-35 GPT-3.5}
|
30
30
|
# The list of embeddings models that you can choose from in your deployment can be found in the {https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#embeddings Azure models documentation}.
|
31
|
-
# When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
|
32
|
-
# After creating the endpoint, wait for the model deployment to complete before using it.
|
33
|
-
# To verify the deployment status, use the get trained model statistics API.
|
34
|
-
# Look for +"state": "fully_allocated"+ in the response and ensure that the +"allocation_count"+ matches the +"target_allocation_count"+.
|
35
|
-
# Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
|
36
31
|
#
|
37
32
|
# @option arguments [String] :task_type The type of the inference task that the model will perform.
|
38
|
-
# NOTE: The
|
33
|
+
# NOTE: The `chat_completion` task type only supports streaming and only through the _stream API. (*Required*)
|
39
34
|
# @option arguments [String] :azureopenai_inference_id The unique identifier of the inference endpoint. (*Required*)
|
35
|
+
# @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
|
36
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
37
|
+
# when they occur.
|
38
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
39
|
+
# returned by Elasticsearch.
|
40
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
41
|
+
# For example `"exists_time": "1h"` for humans and
|
42
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
43
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
44
|
+
# only by machines.
|
45
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
46
|
+
# this option for debugging only.
|
40
47
|
# @option arguments [Hash] :headers Custom HTTP headers
|
41
48
|
# @option arguments [Hash] :body request body
|
42
49
|
#
|
43
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
50
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-azureopenai
|
44
51
|
#
|
45
52
|
def put_azureopenai(arguments = {})
|
46
53
|
request_opts = { endpoint: arguments[:endpoint] || 'inference.put_azureopenai' }
|
@@ -68,7 +75,7 @@ module Elasticsearch
|
|
68
75
|
|
69
76
|
method = Elasticsearch::API::HTTP_PUT
|
70
77
|
path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_azureopenai_inference_id)}"
|
71
|
-
params =
|
78
|
+
params = Utils.process_params(arguments)
|
72
79
|
|
73
80
|
Elasticsearch::API::Response.new(
|
74
81
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -23,19 +23,26 @@ module Elasticsearch
|
|
23
23
|
module Inference
|
24
24
|
module Actions
|
25
25
|
# Create a Cohere inference endpoint.
|
26
|
-
# Create an inference endpoint to perform an inference task with the
|
27
|
-
# When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
|
28
|
-
# After creating the endpoint, wait for the model deployment to complete before using it.
|
29
|
-
# To verify the deployment status, use the get trained model statistics API.
|
30
|
-
# Look for +"state": "fully_allocated"+ in the response and ensure that the +"allocation_count"+ matches the +"target_allocation_count"+.
|
31
|
-
# Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
|
26
|
+
# Create an inference endpoint to perform an inference task with the `cohere` service.
|
32
27
|
#
|
33
28
|
# @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
|
34
29
|
# @option arguments [String] :cohere_inference_id The unique identifier of the inference endpoint. (*Required*)
|
30
|
+
# @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
|
31
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
32
|
+
# when they occur.
|
33
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
34
|
+
# returned by Elasticsearch.
|
35
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
36
|
+
# For example `"exists_time": "1h"` for humans and
|
37
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
38
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
39
|
+
# only by machines.
|
40
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
41
|
+
# this option for debugging only.
|
35
42
|
# @option arguments [Hash] :headers Custom HTTP headers
|
36
43
|
# @option arguments [Hash] :body request body
|
37
44
|
#
|
38
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
45
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-cohere
|
39
46
|
#
|
40
47
|
def put_cohere(arguments = {})
|
41
48
|
request_opts = { endpoint: arguments[:endpoint] || 'inference.put_cohere' }
|
@@ -63,7 +70,7 @@ module Elasticsearch
|
|
63
70
|
|
64
71
|
method = Elasticsearch::API::HTTP_PUT
|
65
72
|
path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_cohere_inference_id)}"
|
66
|
-
params =
|
73
|
+
params = Utils.process_params(arguments)
|
67
74
|
|
68
75
|
Elasticsearch::API::Response.new(
|
69
76
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -0,0 +1,112 @@
|
|
1
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
2
|
+
# license agreements. See the NOTICE file distributed with
|
3
|
+
# this work for additional information regarding copyright
|
4
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
5
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
6
|
+
# not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing,
|
12
|
+
# software distributed under the License is distributed on an
|
13
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
14
|
+
# KIND, either express or implied. See the License for the
|
15
|
+
# specific language governing permissions and limitations
|
16
|
+
# under the License.
|
17
|
+
#
|
18
|
+
# This code was automatically generated from the Elasticsearch Specification
|
19
|
+
# See https://github.com/elastic/elasticsearch-specification
|
20
|
+
# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
|
21
|
+
module Elasticsearch
|
22
|
+
module API
|
23
|
+
module Inference
|
24
|
+
module Actions
|
25
|
+
# Create a custom inference endpoint.
|
26
|
+
# The custom service gives more control over how to interact with external inference services that aren't explicitly supported through dedicated integrations.
|
27
|
+
# The custom service gives you the ability to define the headers, url, query parameters, request body, and secrets.
|
28
|
+
# The custom service supports the template replacement functionality, which enables you to define a template that can be replaced with the value associated with that key.
|
29
|
+
# Templates are portions of a string that start with `${` and end with `}`.
|
30
|
+
# The parameters `secret_parameters` and `task_settings` are checked for keys for template replacement. Template replacement is supported in the `request`, `headers`, `url`, and `query_parameters`.
|
31
|
+
# If the definition (key) is not found for a template, an error message is returned.
|
32
|
+
# In case of an endpoint definition like the following:
|
33
|
+
#
|
34
|
+
# ```
|
35
|
+
# PUT _inference/text_embedding/test-text-embedding
|
36
|
+
# {
|
37
|
+
# "service": "custom",
|
38
|
+
# "service_settings": {
|
39
|
+
# "secret_parameters": {
|
40
|
+
# "api_key": "<some api key>"
|
41
|
+
# },
|
42
|
+
# "url": "...endpoints.huggingface.cloud/v1/embeddings",
|
43
|
+
# "headers": {
|
44
|
+
# "Authorization": "Bearer ${api_key}",
|
45
|
+
# "Content-Type": "application/json"
|
46
|
+
# },
|
47
|
+
# "request": "{\"input\": ${input}}",
|
48
|
+
# "response": {
|
49
|
+
# "json_parser": {
|
50
|
+
# "text_embeddings":"$.data[*].embedding[*]"
|
51
|
+
# }
|
52
|
+
# }
|
53
|
+
# }
|
54
|
+
# }
|
55
|
+
# ```
|
56
|
+
#
|
57
|
+
# To replace `${api_key}` the `secret_parameters` and `task_settings` are checked for a key named `api_key`.
|
58
|
+
#
|
59
|
+
# @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
|
60
|
+
# @option arguments [String] :custom_inference_id The unique identifier of the inference endpoint. (*Required*)
|
61
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
62
|
+
# when they occur.
|
63
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
64
|
+
# returned by Elasticsearch.
|
65
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
66
|
+
# For example `"exists_time": "1h"` for humans and
|
67
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
68
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
69
|
+
# only by machines.
|
70
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
71
|
+
# this option for debugging only.
|
72
|
+
# @option arguments [Hash] :headers Custom HTTP headers
|
73
|
+
# @option arguments [Hash] :body request body
|
74
|
+
#
|
75
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-custom
|
76
|
+
#
|
77
|
+
def put_custom(arguments = {})
|
78
|
+
request_opts = { endpoint: arguments[:endpoint] || 'inference.put_custom' }
|
79
|
+
|
80
|
+
defined_params = [:task_type, :custom_inference_id].each_with_object({}) do |variable, set_variables|
|
81
|
+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
|
82
|
+
end
|
83
|
+
request_opts[:defined_params] = defined_params unless defined_params.empty?
|
84
|
+
|
85
|
+
raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
|
86
|
+
|
87
|
+
unless arguments[:custom_inference_id]
|
88
|
+
raise ArgumentError,
|
89
|
+
"Required argument 'custom_inference_id' missing"
|
90
|
+
end
|
91
|
+
|
92
|
+
arguments = arguments.clone
|
93
|
+
headers = arguments.delete(:headers) || {}
|
94
|
+
|
95
|
+
body = arguments.delete(:body)
|
96
|
+
|
97
|
+
_task_type = arguments.delete(:task_type)
|
98
|
+
|
99
|
+
_custom_inference_id = arguments.delete(:custom_inference_id)
|
100
|
+
|
101
|
+
method = Elasticsearch::API::HTTP_PUT
|
102
|
+
path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_custom_inference_id)}"
|
103
|
+
params = Utils.process_params(arguments)
|
104
|
+
|
105
|
+
Elasticsearch::API::Response.new(
|
106
|
+
perform_request(method, path, params, body, headers, request_opts)
|
107
|
+
)
|
108
|
+
end
|
109
|
+
end
|
110
|
+
end
|
111
|
+
end
|
112
|
+
end
|
@@ -0,0 +1,82 @@
|
|
1
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
2
|
+
# license agreements. See the NOTICE file distributed with
|
3
|
+
# this work for additional information regarding copyright
|
4
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
5
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
6
|
+
# not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing,
|
12
|
+
# software distributed under the License is distributed on an
|
13
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
14
|
+
# KIND, either express or implied. See the License for the
|
15
|
+
# specific language governing permissions and limitations
|
16
|
+
# under the License.
|
17
|
+
#
|
18
|
+
# This code was automatically generated from the Elasticsearch Specification
|
19
|
+
# See https://github.com/elastic/elasticsearch-specification
|
20
|
+
# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
|
21
|
+
module Elasticsearch
|
22
|
+
module API
|
23
|
+
module Inference
|
24
|
+
module Actions
|
25
|
+
# Create a DeepSeek inference endpoint.
|
26
|
+
# Create an inference endpoint to perform an inference task with the `deepseek` service.
|
27
|
+
#
|
28
|
+
# @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
|
29
|
+
# @option arguments [String] :deepseek_inference_id The unique identifier of the inference endpoint. (*Required*)
|
30
|
+
# @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
|
31
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
32
|
+
# when they occur.
|
33
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
34
|
+
# returned by Elasticsearch.
|
35
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
36
|
+
# For example `"exists_time": "1h"` for humans and
|
37
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
38
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
39
|
+
# only by machines.
|
40
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
41
|
+
# this option for debugging only.
|
42
|
+
# @option arguments [Hash] :headers Custom HTTP headers
|
43
|
+
# @option arguments [Hash] :body request body
|
44
|
+
#
|
45
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-deepseek
|
46
|
+
#
|
47
|
+
def put_deepseek(arguments = {})
|
48
|
+
request_opts = { endpoint: arguments[:endpoint] || 'inference.put_deepseek' }
|
49
|
+
|
50
|
+
defined_params = [:task_type, :deepseek_inference_id].each_with_object({}) do |variable, set_variables|
|
51
|
+
set_variables[variable] = arguments[variable] if arguments.key?(variable)
|
52
|
+
end
|
53
|
+
request_opts[:defined_params] = defined_params unless defined_params.empty?
|
54
|
+
|
55
|
+
raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
|
56
|
+
|
57
|
+
unless arguments[:deepseek_inference_id]
|
58
|
+
raise ArgumentError,
|
59
|
+
"Required argument 'deepseek_inference_id' missing"
|
60
|
+
end
|
61
|
+
|
62
|
+
arguments = arguments.clone
|
63
|
+
headers = arguments.delete(:headers) || {}
|
64
|
+
|
65
|
+
body = arguments.delete(:body)
|
66
|
+
|
67
|
+
_task_type = arguments.delete(:task_type)
|
68
|
+
|
69
|
+
_deepseek_inference_id = arguments.delete(:deepseek_inference_id)
|
70
|
+
|
71
|
+
method = Elasticsearch::API::HTTP_PUT
|
72
|
+
path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_deepseek_inference_id)}"
|
73
|
+
params = Utils.process_params(arguments)
|
74
|
+
|
75
|
+
Elasticsearch::API::Response.new(
|
76
|
+
perform_request(method, path, params, body, headers, request_opts)
|
77
|
+
)
|
78
|
+
end
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|
82
|
+
end
|
@@ -23,15 +23,27 @@ module Elasticsearch
|
|
23
23
|
module Inference
|
24
24
|
module Actions
|
25
25
|
# Create an Elasticsearch inference endpoint.
|
26
|
-
# Create an inference endpoint to perform an inference task with the
|
26
|
+
# Create an inference endpoint to perform an inference task with the `elasticsearch` service.
|
27
27
|
#
|
28
28
|
# @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
|
29
29
|
# @option arguments [String] :elasticsearch_inference_id The unique identifier of the inference endpoint.
|
30
|
-
# The must not match the
|
30
|
+
# The must not match the `model_id`. (*Required*)
|
31
|
+
# @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
|
32
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
33
|
+
# when they occur.
|
34
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
35
|
+
# returned by Elasticsearch.
|
36
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
37
|
+
# For example `"exists_time": "1h"` for humans and
|
38
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
39
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
40
|
+
# only by machines.
|
41
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
42
|
+
# this option for debugging only.
|
31
43
|
# @option arguments [Hash] :headers Custom HTTP headers
|
32
44
|
# @option arguments [Hash] :body request body
|
33
45
|
#
|
34
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
46
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-elasticsearch
|
35
47
|
#
|
36
48
|
def put_elasticsearch(arguments = {})
|
37
49
|
request_opts = { endpoint: arguments[:endpoint] || 'inference.put_elasticsearch' }
|
@@ -59,7 +71,7 @@ module Elasticsearch
|
|
59
71
|
|
60
72
|
method = Elasticsearch::API::HTTP_PUT
|
61
73
|
path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_elasticsearch_inference_id)}"
|
62
|
-
params =
|
74
|
+
params = Utils.process_params(arguments)
|
63
75
|
|
64
76
|
Elasticsearch::API::Response.new(
|
65
77
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -23,15 +23,27 @@ module Elasticsearch
|
|
23
23
|
module Inference
|
24
24
|
module Actions
|
25
25
|
# Create an ELSER inference endpoint.
|
26
|
-
# Create an inference endpoint to perform an inference task with the
|
26
|
+
# Create an inference endpoint to perform an inference task with the `elser` service.
|
27
27
|
# You can also deploy ELSER by using the Elasticsearch inference integration.
|
28
28
|
#
|
29
29
|
# @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
|
30
30
|
# @option arguments [String] :elser_inference_id The unique identifier of the inference endpoint. (*Required*)
|
31
|
+
# @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
|
32
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
33
|
+
# when they occur.
|
34
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
35
|
+
# returned by Elasticsearch.
|
36
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
37
|
+
# For example `"exists_time": "1h"` for humans and
|
38
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
39
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
40
|
+
# only by machines.
|
41
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
42
|
+
# this option for debugging only.
|
31
43
|
# @option arguments [Hash] :headers Custom HTTP headers
|
32
44
|
# @option arguments [Hash] :body request body
|
33
45
|
#
|
34
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
46
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-elser
|
35
47
|
#
|
36
48
|
def put_elser(arguments = {})
|
37
49
|
request_opts = { endpoint: arguments[:endpoint] || 'inference.put_elser' }
|
@@ -55,7 +67,7 @@ module Elasticsearch
|
|
55
67
|
|
56
68
|
method = Elasticsearch::API::HTTP_PUT
|
57
69
|
path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_elser_inference_id)}"
|
58
|
-
params =
|
70
|
+
params = Utils.process_params(arguments)
|
59
71
|
|
60
72
|
Elasticsearch::API::Response.new(
|
61
73
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -23,19 +23,26 @@ module Elasticsearch
|
|
23
23
|
module Inference
|
24
24
|
module Actions
|
25
25
|
# Create an Google AI Studio inference endpoint.
|
26
|
-
# Create an inference endpoint to perform an inference task with the
|
27
|
-
# When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
|
28
|
-
# After creating the endpoint, wait for the model deployment to complete before using it.
|
29
|
-
# To verify the deployment status, use the get trained model statistics API.
|
30
|
-
# Look for +"state": "fully_allocated"+ in the response and ensure that the +"allocation_count"+ matches the +"target_allocation_count"+.
|
31
|
-
# Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
|
26
|
+
# Create an inference endpoint to perform an inference task with the `googleaistudio` service.
|
32
27
|
#
|
33
28
|
# @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
|
34
29
|
# @option arguments [String] :googleaistudio_inference_id The unique identifier of the inference endpoint. (*Required*)
|
30
|
+
# @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
|
31
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
32
|
+
# when they occur.
|
33
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
34
|
+
# returned by Elasticsearch.
|
35
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
36
|
+
# For example `"exists_time": "1h"` for humans and
|
37
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
38
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
39
|
+
# only by machines.
|
40
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
41
|
+
# this option for debugging only.
|
35
42
|
# @option arguments [Hash] :headers Custom HTTP headers
|
36
43
|
# @option arguments [Hash] :body request body
|
37
44
|
#
|
38
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
45
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-googleaistudio
|
39
46
|
#
|
40
47
|
def put_googleaistudio(arguments = {})
|
41
48
|
request_opts = { endpoint: arguments[:endpoint] || 'inference.put_googleaistudio' }
|
@@ -63,7 +70,7 @@ module Elasticsearch
|
|
63
70
|
|
64
71
|
method = Elasticsearch::API::HTTP_PUT
|
65
72
|
path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_googleaistudio_inference_id)}"
|
66
|
-
params =
|
73
|
+
params = Utils.process_params(arguments)
|
67
74
|
|
68
75
|
Elasticsearch::API::Response.new(
|
69
76
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -23,19 +23,26 @@ module Elasticsearch
|
|
23
23
|
module Inference
|
24
24
|
module Actions
|
25
25
|
# Create a Google Vertex AI inference endpoint.
|
26
|
-
# Create an inference endpoint to perform an inference task with the
|
27
|
-
# When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
|
28
|
-
# After creating the endpoint, wait for the model deployment to complete before using it.
|
29
|
-
# To verify the deployment status, use the get trained model statistics API.
|
30
|
-
# Look for +"state": "fully_allocated"+ in the response and ensure that the +"allocation_count"+ matches the +"target_allocation_count"+.
|
31
|
-
# Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
|
26
|
+
# Create an inference endpoint to perform an inference task with the `googlevertexai` service.
|
32
27
|
#
|
33
28
|
# @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
|
34
29
|
# @option arguments [String] :googlevertexai_inference_id The unique identifier of the inference endpoint. (*Required*)
|
30
|
+
# @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
|
31
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
32
|
+
# when they occur.
|
33
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
34
|
+
# returned by Elasticsearch.
|
35
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
36
|
+
# For example `"exists_time": "1h"` for humans and
|
37
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
38
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
39
|
+
# only by machines.
|
40
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
41
|
+
# this option for debugging only.
|
35
42
|
# @option arguments [Hash] :headers Custom HTTP headers
|
36
43
|
# @option arguments [Hash] :body request body
|
37
44
|
#
|
38
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
45
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-googlevertexai
|
39
46
|
#
|
40
47
|
def put_googlevertexai(arguments = {})
|
41
48
|
request_opts = { endpoint: arguments[:endpoint] || 'inference.put_googlevertexai' }
|
@@ -63,7 +70,7 @@ module Elasticsearch
|
|
63
70
|
|
64
71
|
method = Elasticsearch::API::HTTP_PUT
|
65
72
|
path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_googlevertexai_inference_id)}"
|
66
|
-
params =
|
73
|
+
params = Utils.process_params(arguments)
|
67
74
|
|
68
75
|
Elasticsearch::API::Response.new(
|
69
76
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -23,30 +23,54 @@ module Elasticsearch
|
|
23
23
|
module Inference
|
24
24
|
module Actions
|
25
25
|
# Create a Hugging Face inference endpoint.
|
26
|
-
# Create an inference endpoint to perform an inference task with the
|
27
|
-
#
|
28
|
-
#
|
29
|
-
#
|
30
|
-
#
|
31
|
-
#
|
32
|
-
#
|
33
|
-
#
|
34
|
-
# *
|
35
|
-
# *
|
36
|
-
# *
|
37
|
-
# *
|
38
|
-
#
|
39
|
-
#
|
40
|
-
#
|
41
|
-
#
|
42
|
-
#
|
26
|
+
# Create an inference endpoint to perform an inference task with the `hugging_face` service.
|
27
|
+
# Supported tasks include: `text_embedding`, `completion`, and `chat_completion`.
|
28
|
+
# To configure the endpoint, first visit the Hugging Face Inference Endpoints page and create a new endpoint.
|
29
|
+
# Select a model that supports the task you intend to use.
|
30
|
+
# For Elastic's `text_embedding` task:
|
31
|
+
# The selected model must support the `Sentence Embeddings` task. On the new endpoint creation page, select the `Sentence Embeddings` task under the `Advanced Configuration` section.
|
32
|
+
# After the endpoint has initialized, copy the generated endpoint URL.
|
33
|
+
# Recommended models for `text_embedding` task:
|
34
|
+
# * `all-MiniLM-L6-v2`
|
35
|
+
# * `all-MiniLM-L12-v2`
|
36
|
+
# * `all-mpnet-base-v2`
|
37
|
+
# * `e5-base-v2`
|
38
|
+
# * `e5-small-v2`
|
39
|
+
# * `multilingual-e5-base`
|
40
|
+
# * `multilingual-e5-small`
|
41
|
+
# For Elastic's `chat_completion` and `completion` tasks:
|
42
|
+
# The selected model must support the `Text Generation` task and expose OpenAI API. HuggingFace supports both serverless and dedicated endpoints for `Text Generation`. When creating dedicated endpoint select the `Text Generation` task.
|
43
|
+
# After the endpoint is initialized (for dedicated) or ready (for serverless), ensure it supports the OpenAI API and includes `/v1/chat/completions` part in URL. Then, copy the full endpoint URL for use.
|
44
|
+
# Recommended models for `chat_completion` and `completion` tasks:
|
45
|
+
# * `Mistral-7B-Instruct-v0.2`
|
46
|
+
# * `QwQ-32B`
|
47
|
+
# * `Phi-3-mini-128k-instruct`
|
48
|
+
# For Elastic's `rerank` task:
|
49
|
+
# The selected model must support the `sentence-ranking` task and expose OpenAI API.
|
50
|
+
# HuggingFace supports only dedicated (not serverless) endpoints for `Rerank` so far.
|
51
|
+
# After the endpoint is initialized, copy the full endpoint URL for use.
|
52
|
+
# Tested models for `rerank` task:
|
53
|
+
# * `bge-reranker-base`
|
54
|
+
# * `jina-reranker-v1-turbo-en-GGUF`
|
43
55
|
#
|
44
56
|
# @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
|
45
57
|
# @option arguments [String] :huggingface_inference_id The unique identifier of the inference endpoint. (*Required*)
|
58
|
+
# @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
|
59
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
60
|
+
# when they occur.
|
61
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
62
|
+
# returned by Elasticsearch.
|
63
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
64
|
+
# For example `"exists_time": "1h"` for humans and
|
65
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
66
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
67
|
+
# only by machines.
|
68
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
69
|
+
# this option for debugging only.
|
46
70
|
# @option arguments [Hash] :headers Custom HTTP headers
|
47
71
|
# @option arguments [Hash] :body request body
|
48
72
|
#
|
49
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
73
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-hugging-face
|
50
74
|
#
|
51
75
|
def put_hugging_face(arguments = {})
|
52
76
|
request_opts = { endpoint: arguments[:endpoint] || 'inference.put_hugging_face' }
|
@@ -74,7 +98,7 @@ module Elasticsearch
|
|
74
98
|
|
75
99
|
method = Elasticsearch::API::HTTP_PUT
|
76
100
|
path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_huggingface_inference_id)}"
|
77
|
-
params =
|
101
|
+
params = Utils.process_params(arguments)
|
78
102
|
|
79
103
|
Elasticsearch::API::Response.new(
|
80
104
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -23,21 +23,28 @@ module Elasticsearch
|
|
23
23
|
module Inference
|
24
24
|
module Actions
|
25
25
|
# Create an JinaAI inference endpoint.
|
26
|
-
# Create an inference endpoint to perform an inference task with the
|
27
|
-
# To review the available
|
28
|
-
# To review the available
|
29
|
-
# When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
|
30
|
-
# After creating the endpoint, wait for the model deployment to complete before using it.
|
31
|
-
# To verify the deployment status, use the get trained model statistics API.
|
32
|
-
# Look for +"state": "fully_allocated"+ in the response and ensure that the +"allocation_count"+ matches the +"target_allocation_count"+.
|
33
|
-
# Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
|
26
|
+
# Create an inference endpoint to perform an inference task with the `jinaai` service.
|
27
|
+
# To review the available `rerank` models, refer to <https://jina.ai/reranker>.
|
28
|
+
# To review the available `text_embedding` models, refer to the <https://jina.ai/embeddings/>.
|
34
29
|
#
|
35
30
|
# @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
|
36
31
|
# @option arguments [String] :jinaai_inference_id The unique identifier of the inference endpoint. (*Required*)
|
32
|
+
# @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
|
33
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
34
|
+
# when they occur.
|
35
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
36
|
+
# returned by Elasticsearch.
|
37
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
38
|
+
# For example `"exists_time": "1h"` for humans and
|
39
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
40
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
41
|
+
# only by machines.
|
42
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
43
|
+
# this option for debugging only.
|
37
44
|
# @option arguments [Hash] :headers Custom HTTP headers
|
38
45
|
# @option arguments [Hash] :body request body
|
39
46
|
#
|
40
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
47
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-jinaai
|
41
48
|
#
|
42
49
|
def put_jinaai(arguments = {})
|
43
50
|
request_opts = { endpoint: arguments[:endpoint] || 'inference.put_jinaai' }
|
@@ -65,7 +72,7 @@ module Elasticsearch
|
|
65
72
|
|
66
73
|
method = Elasticsearch::API::HTTP_PUT
|
67
74
|
path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_jinaai_inference_id)}"
|
68
|
-
params =
|
75
|
+
params = Utils.process_params(arguments)
|
69
76
|
|
70
77
|
Elasticsearch::API::Response.new(
|
71
78
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -23,20 +23,26 @@ module Elasticsearch
|
|
23
23
|
module Inference
|
24
24
|
module Actions
|
25
25
|
# Create a Mistral inference endpoint.
|
26
|
-
#
|
27
|
-
# When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
|
28
|
-
# After creating the endpoint, wait for the model deployment to complete before using it.
|
29
|
-
# To verify the deployment status, use the get trained model statistics API.
|
30
|
-
# Look for +"state": "fully_allocated"+ in the response and ensure that the +"allocation_count"+ matches the +"target_allocation_count"+.
|
31
|
-
# Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
|
26
|
+
# Create an inference endpoint to perform an inference task with the `mistral` service.
|
32
27
|
#
|
33
|
-
# @option arguments [String] :task_type The task
|
34
|
-
# The only valid task type for the model to perform is +text_embedding+. (*Required*)
|
28
|
+
# @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
|
35
29
|
# @option arguments [String] :mistral_inference_id The unique identifier of the inference endpoint. (*Required*)
|
30
|
+
# @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
|
31
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
32
|
+
# when they occur.
|
33
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
34
|
+
# returned by Elasticsearch.
|
35
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
36
|
+
# For example `"exists_time": "1h"` for humans and
|
37
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
38
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
39
|
+
# only by machines.
|
40
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
41
|
+
# this option for debugging only.
|
36
42
|
# @option arguments [Hash] :headers Custom HTTP headers
|
37
43
|
# @option arguments [Hash] :body request body
|
38
44
|
#
|
39
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
45
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-mistral
|
40
46
|
#
|
41
47
|
def put_mistral(arguments = {})
|
42
48
|
request_opts = { endpoint: arguments[:endpoint] || 'inference.put_mistral' }
|
@@ -64,7 +70,7 @@ module Elasticsearch
|
|
64
70
|
|
65
71
|
method = Elasticsearch::API::HTTP_PUT
|
66
72
|
path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_mistral_inference_id)}"
|
67
|
-
params =
|
73
|
+
params = Utils.process_params(arguments)
|
68
74
|
|
69
75
|
Elasticsearch::API::Response.new(
|
70
76
|
perform_request(method, path, params, body, headers, request_opts)
|