@elastic/schemas 0.4.4 → 0.4.5
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.
- package/lib/cjs/es/json/async_search.submit.request.json +1 -1
- package/lib/cjs/es/json/bulk.request.json +1 -1
- package/lib/cjs/es/json/cat.circuit_breaker.request.json +1 -1
- package/lib/cjs/es/json/ccr.follow.request.json +1 -1
- package/lib/cjs/es/json/ccr.forget_follower.request.json +1 -1
- package/lib/cjs/es/json/ccr.put_auto_follow_pattern.request.json +1 -1
- package/lib/cjs/es/json/ccr.resume_follow.request.json +1 -1
- package/lib/cjs/es/json/cluster.allocation_explain.request.json +1 -1
- package/lib/cjs/es/json/cluster.get_component_template.request.json +1 -1
- package/lib/cjs/es/json/cluster.put_component_template.request.json +1 -1
- package/lib/cjs/es/json/cluster.put_settings.request.json +1 -1
- package/lib/cjs/es/json/cluster.reroute.request.json +1 -1
- package/lib/cjs/es/json/connector.sync_job_list.request.json +1 -1
- package/lib/cjs/es/json/count.request.json +1 -1
- package/lib/cjs/es/json/create.request.json +1 -1
- package/lib/cjs/es/json/delete_by_query.request.json +1 -1
- package/lib/cjs/es/json/enrich.put_policy.request.json +1 -1
- package/lib/cjs/es/json/eql.search.request.json +1 -1
- package/lib/cjs/es/json/esql.async_query.request.json +1 -1
- package/lib/cjs/es/json/esql.query.request.json +1 -1
- package/lib/cjs/es/json/explain.request.json +1 -1
- package/lib/cjs/es/json/field_caps.request.json +1 -1
- package/lib/cjs/es/json/fleet.global_checkpoints.request.json +1 -1
- package/lib/cjs/es/json/fleet.msearch.request.json +1 -1
- package/lib/cjs/es/json/fleet.search.request.json +1 -1
- package/lib/cjs/es/json/graph.explore.request.json +1 -1
- package/lib/cjs/es/json/health_report.request.json +1 -1
- package/lib/cjs/es/json/ilm.migrate_to_data_tiers.request.json +1 -1
- package/lib/cjs/es/json/ilm.put_lifecycle.request.json +1 -1
- package/lib/cjs/es/json/index.request.json +1 -1
- package/lib/cjs/es/json/indices.analyze.request.json +1 -1
- package/lib/cjs/es/json/indices.clone.request.json +1 -1
- package/lib/cjs/es/json/indices.create.request.json +1 -1
- package/lib/cjs/es/json/indices.create_from.request.json +1 -1
- package/lib/cjs/es/json/indices.downsample.request.json +1 -1
- package/lib/cjs/es/json/indices.forcemerge.request.json +1 -1
- package/lib/cjs/es/json/indices.migrate_reindex.request.json +1 -1
- package/lib/cjs/es/json/indices.put_alias.request.json +1 -1
- package/lib/cjs/es/json/indices.put_data_lifecycle.request.json +1 -1
- package/lib/cjs/es/json/indices.put_data_stream_mappings.request.json +1 -1
- package/lib/cjs/es/json/indices.put_data_stream_options.request.json +1 -1
- package/lib/cjs/es/json/indices.put_data_stream_settings.request.json +1 -1
- package/lib/cjs/es/json/indices.put_index_template.request.json +1 -1
- package/lib/cjs/es/json/indices.put_mapping.request.json +1 -1
- package/lib/cjs/es/json/indices.put_settings.request.json +1 -1
- package/lib/cjs/es/json/indices.put_template.request.json +1 -1
- package/lib/cjs/es/json/indices.resolve_index.request.json +1 -1
- package/lib/cjs/es/json/indices.rollover.request.json +1 -1
- package/lib/cjs/es/json/indices.shard_stores.request.json +1 -1
- package/lib/cjs/es/json/indices.shrink.request.json +1 -1
- package/lib/cjs/es/json/indices.simulate_index_template.request.json +1 -1
- package/lib/cjs/es/json/indices.simulate_template.request.json +1 -1
- package/lib/cjs/es/json/indices.split.request.json +1 -1
- package/lib/cjs/es/json/indices.stats.request.json +1 -1
- package/lib/cjs/es/json/indices.update_aliases.request.json +1 -1
- package/lib/cjs/es/json/indices.validate_query.request.json +1 -1
- package/lib/cjs/es/json/inference.chat_completion_unified.request.json +1 -1
- package/lib/cjs/es/json/inference.completion.request.json +1 -1
- package/lib/cjs/es/json/inference.embedding.request.json +1 -1
- package/lib/cjs/es/json/inference.inference.request.json +1 -1
- package/lib/cjs/es/json/inference.put.request.json +1 -1
- package/lib/cjs/es/json/inference.put_ai21.request.json +1 -1
- package/lib/cjs/es/json/inference.put_alibabacloud.request.json +1 -1
- package/lib/cjs/es/json/inference.put_amazonbedrock.request.json +1 -1
- package/lib/cjs/es/json/inference.put_amazonsagemaker.request.json +1 -1
- package/lib/cjs/es/json/inference.put_anthropic.request.json +1 -1
- package/lib/cjs/es/json/inference.put_azureaistudio.request.json +1 -1
- package/lib/cjs/es/json/inference.put_azureopenai.request.json +1 -1
- package/lib/cjs/es/json/inference.put_cohere.request.json +1 -1
- package/lib/cjs/es/json/inference.put_contextualai.request.json +1 -1
- package/lib/cjs/es/json/inference.put_deepseek.request.json +1 -1
- package/lib/cjs/es/json/inference.put_elasticsearch.request.json +1 -1
- package/lib/cjs/es/json/inference.put_elser.request.json +1 -1
- package/lib/cjs/es/json/inference.put_fireworksai.request.json +1 -1
- package/lib/cjs/es/json/inference.put_googleaistudio.request.json +1 -1
- package/lib/cjs/es/json/inference.put_googlevertexai.request.json +1 -1
- package/lib/cjs/es/json/inference.put_groq.request.json +1 -1
- package/lib/cjs/es/json/inference.put_hugging_face.request.json +1 -1
- package/lib/cjs/es/json/inference.put_jinaai.request.json +1 -1
- package/lib/cjs/es/json/inference.put_llama.request.json +1 -1
- package/lib/cjs/es/json/inference.put_mistral.request.json +1 -1
- package/lib/cjs/es/json/inference.put_nvidia.request.json +1 -1
- package/lib/cjs/es/json/inference.put_openai.request.json +1 -1
- package/lib/cjs/es/json/inference.put_openshift_ai.request.json +1 -1
- package/lib/cjs/es/json/inference.put_region_policy.request.json +1 -1
- package/lib/cjs/es/json/inference.put_voyageai.request.json +1 -1
- package/lib/cjs/es/json/inference.put_watsonx.request.json +1 -1
- package/lib/cjs/es/json/inference.rerank.request.json +1 -1
- package/lib/cjs/es/json/inference.sparse_embedding.request.json +1 -1
- package/lib/cjs/es/json/inference.stream_completion.request.json +1 -1
- package/lib/cjs/es/json/inference.text_embedding.request.json +1 -1
- package/lib/cjs/es/json/inference.update.request.json +1 -1
- package/lib/cjs/es/json/ingest.put_geoip_database.request.json +1 -1
- package/lib/cjs/es/json/ingest.put_ip_location_database.request.json +1 -1
- package/lib/cjs/es/json/ingest.put_pipeline.request.json +1 -1
- package/lib/cjs/es/json/ingest.simulate.request.json +1 -1
- package/lib/cjs/es/json/license.post.request.json +1 -1
- package/lib/cjs/es/json/logstash.put_pipeline.request.json +1 -1
- package/lib/cjs/es/json/mget.request.json +1 -1
- package/lib/cjs/es/json/ml.close_job.request.json +1 -1
- package/lib/cjs/es/json/ml.delete_expired_data.request.json +1 -1
- package/lib/cjs/es/json/ml.flush_job.request.json +1 -1
- package/lib/cjs/es/json/ml.forecast.request.json +1 -1
- package/lib/cjs/es/json/ml.get_buckets.request.json +1 -1
- package/lib/cjs/es/json/ml.get_calendars.request.json +1 -1
- package/lib/cjs/es/json/ml.get_categories.request.json +1 -1
- package/lib/cjs/es/json/ml.get_influencers.request.json +1 -1
- package/lib/cjs/es/json/ml.get_model_snapshots.request.json +1 -1
- package/lib/cjs/es/json/ml.get_overall_buckets.request.json +1 -1
- package/lib/cjs/es/json/ml.get_records.request.json +1 -1
- package/lib/cjs/es/json/ml.get_trained_models.request.json +1 -1
- package/lib/cjs/es/json/ml.infer_trained_model.request.json +1 -1
- package/lib/cjs/es/json/ml.open_job.request.json +1 -1
- package/lib/cjs/es/json/ml.post_data.request.json +1 -1
- package/lib/cjs/es/json/ml.preview_datafeed.request.json +1 -1
- package/lib/cjs/es/json/ml.put_datafeed.request.json +1 -1
- package/lib/cjs/es/json/ml.put_job.request.json +1 -1
- package/lib/cjs/es/json/ml.put_trained_model.request.json +1 -1
- package/lib/cjs/es/json/ml.revert_model_snapshot.request.json +1 -1
- package/lib/cjs/es/json/ml.start_data_frame_analytics.request.json +1 -1
- package/lib/cjs/es/json/ml.start_datafeed.request.json +1 -1
- package/lib/cjs/es/json/ml.start_trained_model_deployment.request.json +1 -1
- package/lib/cjs/es/json/ml.stop_data_frame_analytics.request.json +1 -1
- package/lib/cjs/es/json/ml.stop_datafeed.request.json +1 -1
- package/lib/cjs/es/json/ml.stop_trained_model_deployment.request.json +1 -1
- package/lib/cjs/es/json/ml.update_datafeed.request.json +1 -1
- package/lib/cjs/es/json/ml.update_trained_model_deployment.request.json +1 -1
- package/lib/cjs/es/json/msearch.request.json +1 -1
- package/lib/cjs/es/json/msearch_template.request.json +1 -1
- package/lib/cjs/es/json/mtermvectors.request.json +1 -1
- package/lib/cjs/es/json/nodes.reload_secure_settings.request.json +1 -1
- package/lib/cjs/es/json/open_point_in_time.request.json +1 -1
- package/lib/cjs/es/json/project.create_many_routing.request.json +1 -1
- package/lib/cjs/es/json/project.create_routing.request.json +1 -1
- package/lib/cjs/es/json/put_script.request.json +1 -1
- package/lib/cjs/es/json/query_rules.put_rule.request.json +1 -1
- package/lib/cjs/es/json/query_rules.put_ruleset.request.json +1 -1
- package/lib/cjs/es/json/rank_eval.request.json +1 -1
- package/lib/cjs/es/json/reindex.request.json +1 -1
- package/lib/cjs/es/json/rollup.rollup_search.request.json +1 -1
- package/lib/cjs/es/json/scroll.request.json +1 -1
- package/lib/cjs/es/json/search.request.json +1 -1
- package/lib/cjs/es/json/search_application.post_behavioral_analytics_event.request.json +1 -1
- package/lib/cjs/es/json/search_application.put.request.json +1 -1
- package/lib/cjs/es/json/search_application.search.request.json +1 -1
- package/lib/cjs/es/json/search_mvt.request.json +1 -1
- package/lib/cjs/es/json/search_template.request.json +1 -1
- package/lib/cjs/es/json/searchable_snapshots.mount.request.json +1 -1
- package/lib/cjs/es/json/security.bulk_delete_role.request.json +1 -1
- package/lib/cjs/es/json/security.bulk_put_role.request.json +1 -1
- package/lib/cjs/es/json/security.bulk_update_api_keys.request.json +1 -1
- package/lib/cjs/es/json/security.change_password.request.json +1 -1
- package/lib/cjs/es/json/security.clone_api_key.request.json +1 -1
- package/lib/cjs/es/json/security.create_api_key.request.json +1 -1
- package/lib/cjs/es/json/security.get_user.request.json +1 -1
- package/lib/cjs/es/json/security.get_user_profile.request.json +1 -1
- package/lib/cjs/es/json/security.grant_api_key.request.json +1 -1
- package/lib/cjs/es/json/security.put_privileges.request.json +1 -1
- package/lib/cjs/es/json/security.put_role.request.json +1 -1
- package/lib/cjs/es/json/security.put_role_mapping.request.json +1 -1
- package/lib/cjs/es/json/security.put_user.request.json +1 -1
- package/lib/cjs/es/json/security.query_api_keys.request.json +1 -1
- package/lib/cjs/es/json/security.query_user.request.json +1 -1
- package/lib/cjs/es/json/security.suggest_user_profiles.request.json +1 -1
- package/lib/cjs/es/json/security.update_settings.request.json +1 -1
- package/lib/cjs/es/json/security.update_user_profile_data.request.json +1 -1
- package/lib/cjs/es/json/simulate.ingest.request.json +1 -1
- package/lib/cjs/es/json/slm.put_lifecycle.request.json +1 -1
- package/lib/cjs/es/json/snapshot.clone.request.json +1 -1
- package/lib/cjs/es/json/snapshot.create.request.json +1 -1
- package/lib/cjs/es/json/snapshot.get.request.json +1 -1
- package/lib/cjs/es/json/snapshot.restore.request.json +1 -1
- package/lib/cjs/es/json/sql.query.request.json +1 -1
- package/lib/cjs/es/json/synonyms.put_synonym.request.json +1 -1
- package/lib/cjs/es/json/synonyms.put_synonym_rule.request.json +1 -1
- package/lib/cjs/es/json/tasks.cancel.request.json +1 -1
- package/lib/cjs/es/json/tasks.list.request.json +1 -1
- package/lib/cjs/es/json/termvectors.request.json +1 -1
- package/lib/cjs/es/json/text_structure.find_field_structure.request.json +1 -1
- package/lib/cjs/es/json/text_structure.find_message_structure.request.json +1 -1
- package/lib/cjs/es/json/text_structure.find_structure.request.json +1 -1
- package/lib/cjs/es/json/text_structure.test_grok_pattern.request.json +1 -1
- package/lib/cjs/es/json/transform.preview_transform.request.json +1 -1
- package/lib/cjs/es/json/transform.put_transform.request.json +1 -1
- package/lib/cjs/es/json/transform.update_transform.request.json +1 -1
- package/lib/cjs/es/json/update.request.json +1 -1
- package/lib/cjs/es/json/update_by_query.request.json +1 -1
- package/lib/cjs/es/json/watcher.execute_watch.request.json +1 -1
- package/lib/cjs/es/json/watcher.put_watch.request.json +1 -1
- package/lib/cjs/es/json/watcher.stats.request.json +1 -1
- package/lib/cjs/es/json/watcher.update_settings.request.json +1 -1
- package/lib/cjs/es/schemas/indices.forcemerge.d.ts +3 -4
- package/lib/cjs/es/schemas/indices.forcemerge.d.ts.map +1 -1
- package/lib/cjs/es/schemas/indices.forcemerge.js +3 -4
- package/lib/cjs/es/schemas/indices.forcemerge.js.map +1 -1
- package/lib/cjs/serverless/schemas/get_traffic_filter_metadata.d.ts +7 -3
- package/lib/cjs/serverless/schemas/get_traffic_filter_metadata.d.ts.map +1 -1
- package/lib/cjs/serverless/schemas/get_traffic_filter_metadata.js +3 -3
- package/lib/cjs/serverless/schemas/get_traffic_filter_metadata.js.map +1 -1
- package/lib/es/json/async_search.submit.request.json +1 -1
- package/lib/es/json/bulk.request.json +1 -1
- package/lib/es/json/cat.circuit_breaker.request.json +1 -1
- package/lib/es/json/ccr.follow.request.json +1 -1
- package/lib/es/json/ccr.forget_follower.request.json +1 -1
- package/lib/es/json/ccr.put_auto_follow_pattern.request.json +1 -1
- package/lib/es/json/ccr.resume_follow.request.json +1 -1
- package/lib/es/json/cluster.allocation_explain.request.json +1 -1
- package/lib/es/json/cluster.get_component_template.request.json +1 -1
- package/lib/es/json/cluster.put_component_template.request.json +1 -1
- package/lib/es/json/cluster.put_settings.request.json +1 -1
- package/lib/es/json/cluster.reroute.request.json +1 -1
- package/lib/es/json/connector.sync_job_list.request.json +1 -1
- package/lib/es/json/count.request.json +1 -1
- package/lib/es/json/create.request.json +1 -1
- package/lib/es/json/delete_by_query.request.json +1 -1
- package/lib/es/json/enrich.put_policy.request.json +1 -1
- package/lib/es/json/eql.search.request.json +1 -1
- package/lib/es/json/esql.async_query.request.json +1 -1
- package/lib/es/json/esql.query.request.json +1 -1
- package/lib/es/json/explain.request.json +1 -1
- package/lib/es/json/field_caps.request.json +1 -1
- package/lib/es/json/fleet.global_checkpoints.request.json +1 -1
- package/lib/es/json/fleet.msearch.request.json +1 -1
- package/lib/es/json/fleet.search.request.json +1 -1
- package/lib/es/json/graph.explore.request.json +1 -1
- package/lib/es/json/health_report.request.json +1 -1
- package/lib/es/json/ilm.migrate_to_data_tiers.request.json +1 -1
- package/lib/es/json/ilm.put_lifecycle.request.json +1 -1
- package/lib/es/json/index.request.json +1 -1
- package/lib/es/json/indices.analyze.request.json +1 -1
- package/lib/es/json/indices.clone.request.json +1 -1
- package/lib/es/json/indices.create.request.json +1 -1
- package/lib/es/json/indices.create_from.request.json +1 -1
- package/lib/es/json/indices.downsample.request.json +1 -1
- package/lib/es/json/indices.forcemerge.request.json +1 -1
- package/lib/es/json/indices.migrate_reindex.request.json +1 -1
- package/lib/es/json/indices.put_alias.request.json +1 -1
- package/lib/es/json/indices.put_data_lifecycle.request.json +1 -1
- package/lib/es/json/indices.put_data_stream_mappings.request.json +1 -1
- package/lib/es/json/indices.put_data_stream_options.request.json +1 -1
- package/lib/es/json/indices.put_data_stream_settings.request.json +1 -1
- package/lib/es/json/indices.put_index_template.request.json +1 -1
- package/lib/es/json/indices.put_mapping.request.json +1 -1
- package/lib/es/json/indices.put_settings.request.json +1 -1
- package/lib/es/json/indices.put_template.request.json +1 -1
- package/lib/es/json/indices.resolve_index.request.json +1 -1
- package/lib/es/json/indices.rollover.request.json +1 -1
- package/lib/es/json/indices.shard_stores.request.json +1 -1
- package/lib/es/json/indices.shrink.request.json +1 -1
- package/lib/es/json/indices.simulate_index_template.request.json +1 -1
- package/lib/es/json/indices.simulate_template.request.json +1 -1
- package/lib/es/json/indices.split.request.json +1 -1
- package/lib/es/json/indices.stats.request.json +1 -1
- package/lib/es/json/indices.update_aliases.request.json +1 -1
- package/lib/es/json/indices.validate_query.request.json +1 -1
- package/lib/es/json/inference.chat_completion_unified.request.json +1 -1
- package/lib/es/json/inference.completion.request.json +1 -1
- package/lib/es/json/inference.embedding.request.json +1 -1
- package/lib/es/json/inference.inference.request.json +1 -1
- package/lib/es/json/inference.put.request.json +1 -1
- package/lib/es/json/inference.put_ai21.request.json +1 -1
- package/lib/es/json/inference.put_alibabacloud.request.json +1 -1
- package/lib/es/json/inference.put_amazonbedrock.request.json +1 -1
- package/lib/es/json/inference.put_amazonsagemaker.request.json +1 -1
- package/lib/es/json/inference.put_anthropic.request.json +1 -1
- package/lib/es/json/inference.put_azureaistudio.request.json +1 -1
- package/lib/es/json/inference.put_azureopenai.request.json +1 -1
- package/lib/es/json/inference.put_cohere.request.json +1 -1
- package/lib/es/json/inference.put_contextualai.request.json +1 -1
- package/lib/es/json/inference.put_deepseek.request.json +1 -1
- package/lib/es/json/inference.put_elasticsearch.request.json +1 -1
- package/lib/es/json/inference.put_elser.request.json +1 -1
- package/lib/es/json/inference.put_fireworksai.request.json +1 -1
- package/lib/es/json/inference.put_googleaistudio.request.json +1 -1
- package/lib/es/json/inference.put_googlevertexai.request.json +1 -1
- package/lib/es/json/inference.put_groq.request.json +1 -1
- package/lib/es/json/inference.put_hugging_face.request.json +1 -1
- package/lib/es/json/inference.put_jinaai.request.json +1 -1
- package/lib/es/json/inference.put_llama.request.json +1 -1
- package/lib/es/json/inference.put_mistral.request.json +1 -1
- package/lib/es/json/inference.put_nvidia.request.json +1 -1
- package/lib/es/json/inference.put_openai.request.json +1 -1
- package/lib/es/json/inference.put_openshift_ai.request.json +1 -1
- package/lib/es/json/inference.put_region_policy.request.json +1 -1
- package/lib/es/json/inference.put_voyageai.request.json +1 -1
- package/lib/es/json/inference.put_watsonx.request.json +1 -1
- package/lib/es/json/inference.rerank.request.json +1 -1
- package/lib/es/json/inference.sparse_embedding.request.json +1 -1
- package/lib/es/json/inference.stream_completion.request.json +1 -1
- package/lib/es/json/inference.text_embedding.request.json +1 -1
- package/lib/es/json/inference.update.request.json +1 -1
- package/lib/es/json/ingest.put_geoip_database.request.json +1 -1
- package/lib/es/json/ingest.put_ip_location_database.request.json +1 -1
- package/lib/es/json/ingest.put_pipeline.request.json +1 -1
- package/lib/es/json/ingest.simulate.request.json +1 -1
- package/lib/es/json/license.post.request.json +1 -1
- package/lib/es/json/logstash.put_pipeline.request.json +1 -1
- package/lib/es/json/mget.request.json +1 -1
- package/lib/es/json/ml.close_job.request.json +1 -1
- package/lib/es/json/ml.delete_expired_data.request.json +1 -1
- package/lib/es/json/ml.flush_job.request.json +1 -1
- package/lib/es/json/ml.forecast.request.json +1 -1
- package/lib/es/json/ml.get_buckets.request.json +1 -1
- package/lib/es/json/ml.get_calendars.request.json +1 -1
- package/lib/es/json/ml.get_categories.request.json +1 -1
- package/lib/es/json/ml.get_influencers.request.json +1 -1
- package/lib/es/json/ml.get_model_snapshots.request.json +1 -1
- package/lib/es/json/ml.get_overall_buckets.request.json +1 -1
- package/lib/es/json/ml.get_records.request.json +1 -1
- package/lib/es/json/ml.get_trained_models.request.json +1 -1
- package/lib/es/json/ml.infer_trained_model.request.json +1 -1
- package/lib/es/json/ml.open_job.request.json +1 -1
- package/lib/es/json/ml.post_data.request.json +1 -1
- package/lib/es/json/ml.preview_datafeed.request.json +1 -1
- package/lib/es/json/ml.put_datafeed.request.json +1 -1
- package/lib/es/json/ml.put_job.request.json +1 -1
- package/lib/es/json/ml.put_trained_model.request.json +1 -1
- package/lib/es/json/ml.revert_model_snapshot.request.json +1 -1
- package/lib/es/json/ml.start_data_frame_analytics.request.json +1 -1
- package/lib/es/json/ml.start_datafeed.request.json +1 -1
- package/lib/es/json/ml.start_trained_model_deployment.request.json +1 -1
- package/lib/es/json/ml.stop_data_frame_analytics.request.json +1 -1
- package/lib/es/json/ml.stop_datafeed.request.json +1 -1
- package/lib/es/json/ml.stop_trained_model_deployment.request.json +1 -1
- package/lib/es/json/ml.update_datafeed.request.json +1 -1
- package/lib/es/json/ml.update_trained_model_deployment.request.json +1 -1
- package/lib/es/json/msearch.request.json +1 -1
- package/lib/es/json/msearch_template.request.json +1 -1
- package/lib/es/json/mtermvectors.request.json +1 -1
- package/lib/es/json/nodes.reload_secure_settings.request.json +1 -1
- package/lib/es/json/open_point_in_time.request.json +1 -1
- package/lib/es/json/project.create_many_routing.request.json +1 -1
- package/lib/es/json/project.create_routing.request.json +1 -1
- package/lib/es/json/put_script.request.json +1 -1
- package/lib/es/json/query_rules.put_rule.request.json +1 -1
- package/lib/es/json/query_rules.put_ruleset.request.json +1 -1
- package/lib/es/json/rank_eval.request.json +1 -1
- package/lib/es/json/reindex.request.json +1 -1
- package/lib/es/json/rollup.rollup_search.request.json +1 -1
- package/lib/es/json/scroll.request.json +1 -1
- package/lib/es/json/search.request.json +1 -1
- package/lib/es/json/search_application.post_behavioral_analytics_event.request.json +1 -1
- package/lib/es/json/search_application.put.request.json +1 -1
- package/lib/es/json/search_application.search.request.json +1 -1
- package/lib/es/json/search_mvt.request.json +1 -1
- package/lib/es/json/search_template.request.json +1 -1
- package/lib/es/json/searchable_snapshots.mount.request.json +1 -1
- package/lib/es/json/security.bulk_delete_role.request.json +1 -1
- package/lib/es/json/security.bulk_put_role.request.json +1 -1
- package/lib/es/json/security.bulk_update_api_keys.request.json +1 -1
- package/lib/es/json/security.change_password.request.json +1 -1
- package/lib/es/json/security.clone_api_key.request.json +1 -1
- package/lib/es/json/security.create_api_key.request.json +1 -1
- package/lib/es/json/security.get_user.request.json +1 -1
- package/lib/es/json/security.get_user_profile.request.json +1 -1
- package/lib/es/json/security.grant_api_key.request.json +1 -1
- package/lib/es/json/security.put_privileges.request.json +1 -1
- package/lib/es/json/security.put_role.request.json +1 -1
- package/lib/es/json/security.put_role_mapping.request.json +1 -1
- package/lib/es/json/security.put_user.request.json +1 -1
- package/lib/es/json/security.query_api_keys.request.json +1 -1
- package/lib/es/json/security.query_user.request.json +1 -1
- package/lib/es/json/security.suggest_user_profiles.request.json +1 -1
- package/lib/es/json/security.update_settings.request.json +1 -1
- package/lib/es/json/security.update_user_profile_data.request.json +1 -1
- package/lib/es/json/simulate.ingest.request.json +1 -1
- package/lib/es/json/slm.put_lifecycle.request.json +1 -1
- package/lib/es/json/snapshot.clone.request.json +1 -1
- package/lib/es/json/snapshot.create.request.json +1 -1
- package/lib/es/json/snapshot.get.request.json +1 -1
- package/lib/es/json/snapshot.restore.request.json +1 -1
- package/lib/es/json/sql.query.request.json +1 -1
- package/lib/es/json/synonyms.put_synonym.request.json +1 -1
- package/lib/es/json/synonyms.put_synonym_rule.request.json +1 -1
- package/lib/es/json/tasks.cancel.request.json +1 -1
- package/lib/es/json/tasks.list.request.json +1 -1
- package/lib/es/json/termvectors.request.json +1 -1
- package/lib/es/json/text_structure.find_field_structure.request.json +1 -1
- package/lib/es/json/text_structure.find_message_structure.request.json +1 -1
- package/lib/es/json/text_structure.find_structure.request.json +1 -1
- package/lib/es/json/text_structure.test_grok_pattern.request.json +1 -1
- package/lib/es/json/transform.preview_transform.request.json +1 -1
- package/lib/es/json/transform.put_transform.request.json +1 -1
- package/lib/es/json/transform.update_transform.request.json +1 -1
- package/lib/es/json/update.request.json +1 -1
- package/lib/es/json/update_by_query.request.json +1 -1
- package/lib/es/json/watcher.execute_watch.request.json +1 -1
- package/lib/es/json/watcher.put_watch.request.json +1 -1
- package/lib/es/json/watcher.stats.request.json +1 -1
- package/lib/es/json/watcher.update_settings.request.json +1 -1
- package/lib/es/schemas/indices.forcemerge.d.ts +3 -4
- package/lib/es/schemas/indices.forcemerge.d.ts.map +1 -1
- package/lib/es/schemas/indices.forcemerge.js +3 -4
- package/lib/es/schemas/indices.forcemerge.js.map +1 -1
- package/lib/serverless/schemas/get_traffic_filter_metadata.d.ts +7 -3
- package/lib/serverless/schemas/get_traffic_filter_metadata.d.ts.map +1 -1
- package/lib/serverless/schemas/get_traffic_filter_metadata.js +3 -3
- package/lib/serverless/schemas/get_traffic_filter_metadata.js.map +1 -1
- package/package.json +1 -1
- package/src/es/json/_global.bulk.json +1 -1
- package/src/es/json/_global.health_report.json +1 -1
- package/src/es/json/_global.mget.json +1 -1
- package/src/es/json/_global.msearch.json +1 -1
- package/src/es/json/_global.msearch_template.json +1 -0
- package/src/es/json/_global.rank_eval.json +1 -1
- package/src/es/json/_global.reindex_rethrottle.json +1 -1
- package/src/es/json/_global.search._types.json +1 -1
- package/src/es/json/_spec_utils.json +1 -1
- package/src/es/json/_types.aggregations.json +1 -1
- package/src/es/json/_types.analysis.json +1 -1
- package/src/es/json/_types.json +1 -1
- package/src/es/json/_types.mapping.json +1 -1
- package/src/es/json/_types.query_dsl.json +1 -1
- package/src/es/json/async_search.submit.request.json +1 -1
- package/src/es/json/bulk.request.json +1 -1
- package/src/es/json/cat._types.json +1 -1
- package/src/es/json/cat.allocation.json +1 -1
- package/src/es/json/cat.circuit_breaker.request.json +1 -1
- package/src/es/json/cat.component_templates.json +1 -1
- package/src/es/json/cat.indices.json +1 -1
- package/src/es/json/cat.shards.json +1 -1
- package/src/es/json/cat.templates.json +1 -1
- package/src/es/json/cat.thread_pool.json +1 -1
- package/src/es/json/cat.transforms.json +1 -1
- package/src/es/json/ccr.follow.request.json +1 -1
- package/src/es/json/ccr.forget_follower.request.json +1 -1
- package/src/es/json/ccr.put_auto_follow_pattern.request.json +1 -1
- package/src/es/json/ccr.resume_follow.request.json +1 -1
- package/src/es/json/cluster.allocation_explain.request.json +1 -1
- package/src/es/json/cluster.get_component_template.request.json +1 -1
- package/src/es/json/cluster.health.json +1 -1
- package/src/es/json/cluster.put_component_template.request.json +1 -1
- package/src/es/json/cluster.put_settings.request.json +1 -1
- package/src/es/json/cluster.remote_info.json +1 -1
- package/src/es/json/cluster.reroute.request.json +1 -1
- package/src/es/json/cluster.state.json +1 -1
- package/src/es/json/connector._types.json +1 -1
- package/src/es/json/connector.sync_job_list.request.json +1 -1
- package/src/es/json/count.request.json +1 -1
- package/src/es/json/create.request.json +1 -1
- package/src/es/json/delete_by_query.request.json +1 -1
- package/src/es/json/enrich.put_policy.request.json +1 -1
- package/src/es/json/eql.search.request.json +1 -1
- package/src/es/json/esql._types.json +1 -1
- package/src/es/json/esql.async_query.request.json +1 -1
- package/src/es/json/esql.query.request.json +1 -1
- package/src/es/json/explain.request.json +1 -1
- package/src/es/json/field_caps.request.json +1 -1
- package/src/es/json/fleet.global_checkpoints.request.json +1 -1
- package/src/es/json/fleet.msearch.request.json +1 -1
- package/src/es/json/fleet.search.request.json +1 -1
- package/src/es/json/graph.explore.request.json +1 -1
- package/src/es/json/health_report.request.json +1 -1
- package/src/es/json/ilm.explain_lifecycle.json +1 -1
- package/src/es/json/ilm.migrate_to_data_tiers.request.json +1 -1
- package/src/es/json/ilm.put_lifecycle.request.json +1 -1
- package/src/es/json/index.request.json +1 -1
- package/src/es/json/indices._types.json +1 -1
- package/src/es/json/indices.analyze.json +1 -1
- package/src/es/json/indices.analyze.request.json +1 -1
- package/src/es/json/indices.clone.request.json +1 -1
- package/src/es/json/indices.create.request.json +1 -1
- package/src/es/json/indices.create_from.json +1 -0
- package/src/es/json/indices.create_from.request.json +1 -1
- package/src/es/json/indices.downsample.request.json +1 -1
- package/src/es/json/indices.forcemerge.request.json +1 -1
- package/src/es/json/indices.get.json +1 -1
- package/src/es/json/indices.migrate_reindex.json +1 -0
- package/src/es/json/indices.migrate_reindex.request.json +1 -1
- package/src/es/json/indices.put_alias.request.json +1 -1
- package/src/es/json/indices.put_data_lifecycle.request.json +1 -1
- package/src/es/json/indices.put_data_stream_mappings.request.json +1 -1
- package/src/es/json/indices.put_data_stream_options.request.json +1 -1
- package/src/es/json/indices.put_data_stream_settings.request.json +1 -1
- package/src/es/json/indices.put_index_template.json +1 -1
- package/src/es/json/indices.put_index_template.request.json +1 -1
- package/src/es/json/indices.put_mapping.request.json +1 -1
- package/src/es/json/indices.put_settings.request.json +1 -1
- package/src/es/json/indices.put_template.request.json +1 -1
- package/src/es/json/indices.resolve_index.request.json +1 -1
- package/src/es/json/indices.rollover.request.json +1 -1
- package/src/es/json/indices.segments.json +1 -1
- package/src/es/json/indices.shard_stores.request.json +1 -1
- package/src/es/json/indices.shrink.request.json +1 -1
- package/src/es/json/indices.simulate_index_template.request.json +1 -1
- package/src/es/json/indices.simulate_template.request.json +1 -1
- package/src/es/json/indices.split.request.json +1 -1
- package/src/es/json/indices.stats.json +1 -1
- package/src/es/json/indices.stats.request.json +1 -1
- package/src/es/json/indices.update_aliases.json +1 -1
- package/src/es/json/indices.update_aliases.request.json +1 -1
- package/src/es/json/indices.validate_query.request.json +1 -1
- package/src/es/json/inference._types.json +1 -1
- package/src/es/json/inference.chat_completion_unified.request.json +1 -1
- package/src/es/json/inference.completion.request.json +1 -1
- package/src/es/json/inference.embedding.request.json +1 -1
- package/src/es/json/inference.inference.request.json +1 -1
- package/src/es/json/inference.put.request.json +1 -1
- package/src/es/json/inference.put_ai21.request.json +1 -1
- package/src/es/json/inference.put_alibabacloud.request.json +1 -1
- package/src/es/json/inference.put_amazonbedrock.request.json +1 -1
- package/src/es/json/inference.put_amazonsagemaker.request.json +1 -1
- package/src/es/json/inference.put_anthropic.request.json +1 -1
- package/src/es/json/inference.put_azureaistudio.request.json +1 -1
- package/src/es/json/inference.put_azureopenai.request.json +1 -1
- package/src/es/json/inference.put_cohere.request.json +1 -1
- package/src/es/json/inference.put_contextualai.request.json +1 -1
- package/src/es/json/inference.put_deepseek.request.json +1 -1
- package/src/es/json/inference.put_elasticsearch.request.json +1 -1
- package/src/es/json/inference.put_elser.request.json +1 -1
- package/src/es/json/inference.put_fireworksai.request.json +1 -1
- package/src/es/json/inference.put_googleaistudio.request.json +1 -1
- package/src/es/json/inference.put_googlevertexai.request.json +1 -1
- package/src/es/json/inference.put_groq.request.json +1 -1
- package/src/es/json/inference.put_hugging_face.request.json +1 -1
- package/src/es/json/inference.put_jinaai.request.json +1 -1
- package/src/es/json/inference.put_llama.request.json +1 -1
- package/src/es/json/inference.put_mistral.request.json +1 -1
- package/src/es/json/inference.put_nvidia.request.json +1 -1
- package/src/es/json/inference.put_openai.request.json +1 -1
- package/src/es/json/inference.put_openshift_ai.request.json +1 -1
- package/src/es/json/inference.put_region_policy.request.json +1 -1
- package/src/es/json/inference.put_voyageai.request.json +1 -1
- package/src/es/json/inference.put_watsonx.request.json +1 -1
- package/src/es/json/inference.rerank.json +1 -1
- package/src/es/json/inference.rerank.request.json +1 -1
- package/src/es/json/inference.sparse_embedding.request.json +1 -1
- package/src/es/json/inference.stream_completion.request.json +1 -1
- package/src/es/json/inference.text_embedding.request.json +1 -1
- package/src/es/json/inference.update.request.json +1 -1
- package/src/es/json/ingest._types.json +1 -1
- package/src/es/json/ingest.put_geoip_database.request.json +1 -1
- package/src/es/json/ingest.put_ip_location_database.request.json +1 -1
- package/src/es/json/ingest.put_pipeline.request.json +1 -1
- package/src/es/json/ingest.simulate.request.json +1 -1
- package/src/es/json/license._types.json +1 -1
- package/src/es/json/license.get.json +1 -1
- package/src/es/json/license.post.request.json +1 -1
- package/src/es/json/license.post_start_basic.response.json +1 -1
- package/src/es/json/logstash.put_pipeline.request.json +1 -1
- package/src/es/json/mget.request.json +1 -1
- package/src/es/json/ml._types.json +1 -1
- package/src/es/json/ml.close_job.request.json +1 -1
- package/src/es/json/ml.delete_expired_data.request.json +1 -1
- package/src/es/json/ml.flush_job.request.json +1 -1
- package/src/es/json/ml.forecast.request.json +1 -1
- package/src/es/json/ml.get_buckets.request.json +1 -1
- package/src/es/json/ml.get_calendars.request.json +1 -1
- package/src/es/json/ml.get_categories.request.json +1 -1
- package/src/es/json/ml.get_influencers.request.json +1 -1
- package/src/es/json/ml.get_model_snapshots.request.json +1 -1
- package/src/es/json/ml.get_overall_buckets.request.json +1 -1
- package/src/es/json/ml.get_records.request.json +1 -1
- package/src/es/json/ml.get_trained_models.request.json +1 -1
- package/src/es/json/ml.infer_trained_model.request.json +1 -1
- package/src/es/json/ml.open_job.request.json +1 -1
- package/src/es/json/ml.post_data.request.json +1 -1
- package/src/es/json/ml.preview_datafeed.request.json +1 -1
- package/src/es/json/ml.put_datafeed.request.json +1 -1
- package/src/es/json/ml.put_job.request.json +1 -1
- package/src/es/json/ml.put_trained_model.request.json +1 -1
- package/src/es/json/ml.revert_model_snapshot.request.json +1 -1
- package/src/es/json/ml.start_data_frame_analytics.request.json +1 -1
- package/src/es/json/ml.start_datafeed.request.json +1 -1
- package/src/es/json/ml.start_trained_model_deployment.request.json +1 -1
- package/src/es/json/ml.stop_data_frame_analytics.request.json +1 -1
- package/src/es/json/ml.stop_datafeed.request.json +1 -1
- package/src/es/json/ml.stop_trained_model_deployment.request.json +1 -1
- package/src/es/json/ml.update_datafeed.request.json +1 -1
- package/src/es/json/ml.update_trained_model_deployment.request.json +1 -1
- package/src/es/json/msearch.request.json +1 -1
- package/src/es/json/msearch_template.request.json +1 -1
- package/src/es/json/mtermvectors.request.json +1 -1
- package/src/es/json/nodes._types.json +1 -1
- package/src/es/json/nodes.info.json +1 -1
- package/src/es/json/nodes.reload_secure_settings.request.json +1 -1
- package/src/es/json/nodes.stats.json +1 -1
- package/src/es/json/nodes.usage.json +1 -1
- package/src/es/json/open_point_in_time.request.json +1 -1
- package/src/es/json/project.create_many_routing.request.json +1 -1
- package/src/es/json/project.create_routing.request.json +1 -1
- package/src/es/json/put_script.request.json +1 -1
- package/src/es/json/query_rules._types.json +1 -1
- package/src/es/json/query_rules.put_rule.request.json +1 -1
- package/src/es/json/query_rules.put_ruleset.request.json +1 -1
- package/src/es/json/rank_eval.request.json +1 -1
- package/src/es/json/reindex.request.json +1 -1
- package/src/es/json/rollup.rollup_search.request.json +1 -1
- package/src/es/json/scroll.request.json +1 -1
- package/src/es/json/search.request.json +1 -1
- package/src/es/json/search_application._types.json +1 -1
- package/src/es/json/search_application.post_behavioral_analytics_event.request.json +1 -1
- package/src/es/json/search_application.put.request.json +1 -1
- package/src/es/json/search_application.search.request.json +1 -1
- package/src/es/json/search_mvt.request.json +1 -1
- package/src/es/json/search_template.request.json +1 -1
- package/src/es/json/searchable_snapshots.mount.request.json +1 -1
- package/src/es/json/security._types.json +1 -1
- package/src/es/json/security.authenticate.response.json +1 -1
- package/src/es/json/security.bulk_delete_role.request.json +1 -1
- package/src/es/json/security.bulk_put_role.request.json +1 -1
- package/src/es/json/security.bulk_update_api_keys.request.json +1 -1
- package/src/es/json/security.change_password.request.json +1 -1
- package/src/es/json/security.clone_api_key.request.json +1 -1
- package/src/es/json/security.create_api_key.request.json +1 -1
- package/src/es/json/security.delegate_pki.json +1 -1
- package/src/es/json/security.get_role.json +1 -1
- package/src/es/json/security.get_token.json +1 -1
- package/src/es/json/security.get_user.request.json +1 -1
- package/src/es/json/security.get_user_profile.request.json +1 -1
- package/src/es/json/security.grant_api_key.json +1 -1
- package/src/es/json/security.grant_api_key.request.json +1 -1
- package/src/es/json/security.put_privileges.request.json +1 -1
- package/src/es/json/security.put_role.request.json +1 -1
- package/src/es/json/security.put_role_mapping.request.json +1 -1
- package/src/es/json/security.put_user.request.json +1 -1
- package/src/es/json/security.query_api_keys.json +1 -1
- package/src/es/json/security.query_api_keys.request.json +1 -1
- package/src/es/json/security.query_role.json +1 -1
- package/src/es/json/security.query_user.json +1 -1
- package/src/es/json/security.query_user.request.json +1 -1
- package/src/es/json/security.suggest_user_profiles.json +1 -1
- package/src/es/json/security.suggest_user_profiles.request.json +1 -1
- package/src/es/json/security.update_settings.request.json +1 -1
- package/src/es/json/security.update_user_profile_data.request.json +1 -1
- package/src/es/json/simulate.ingest.request.json +1 -1
- package/src/es/json/slm.put_lifecycle.request.json +1 -1
- package/src/es/json/snapshot._types.json +1 -1
- package/src/es/json/snapshot.clone.request.json +1 -1
- package/src/es/json/snapshot.create.request.json +1 -1
- package/src/es/json/snapshot.get.request.json +1 -1
- package/src/es/json/snapshot.restore.request.json +1 -1
- package/src/es/json/sql.query.request.json +1 -1
- package/src/es/json/ssl.certificates.json +1 -1
- package/src/es/json/synonyms.put_synonym.request.json +1 -1
- package/src/es/json/synonyms.put_synonym_rule.request.json +1 -1
- package/src/es/json/tasks._types.json +1 -1
- package/src/es/json/tasks.cancel.request.json +1 -1
- package/src/es/json/tasks.list.request.json +1 -1
- package/src/es/json/termvectors.request.json +1 -1
- package/src/es/json/text_structure.find_field_structure.request.json +1 -1
- package/src/es/json/text_structure.find_message_structure.request.json +1 -1
- package/src/es/json/text_structure.find_structure.request.json +1 -1
- package/src/es/json/text_structure.test_grok_pattern.request.json +1 -1
- package/src/es/json/transform.preview_transform.request.json +1 -1
- package/src/es/json/transform.put_transform.request.json +1 -1
- package/src/es/json/transform.update_transform.request.json +1 -1
- package/src/es/json/update.request.json +1 -1
- package/src/es/json/update_by_query.request.json +1 -1
- package/src/es/json/watcher._types.json +1 -1
- package/src/es/json/watcher.execute_watch.request.json +1 -1
- package/src/es/json/watcher.put_watch.request.json +1 -1
- package/src/es/json/watcher.stats.request.json +1 -1
- package/src/es/json/watcher.update_settings.request.json +1 -1
- package/src/serverless/json/get_traffic_filter_metadata.response.json +7 -2
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.chat_completion_unified","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference request to complete.","x-found-in":"query"},"inference_id":{"type":"string","description":"The inference Id","x-found-in":"path"}},"required":["inference_id"],"description":"Perform chat completion inference on the service.\n\nThe chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation.\nIt only works with the `chat_completion` task type.\n\nNOTE: The `chat_completion` task type is only available within the _stream API and only supports streaming.\nThe Chat completion inference API and the Stream inference API differ in their response structure and capabilities.\nThe Chat completion inference API provides more comprehensive customization options through more fields and function calling support.\nTo determine whether a given inference service supports this task type, please see the page for that service."}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.chat_completion_unified","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference request to complete.","x-found-in":"query"},"chat_completion_request":{"$ref":"./inference._types.json#/$defs/inference._types__RequestChatCompletion","x-found-in":"body"},"inference_id":{"type":"string","description":"The inference Id","x-found-in":"path"}},"required":["inference_id"],"description":"Perform chat completion inference on the service.\n\nThe chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation.\nIt only works with the `chat_completion` task type.\n\nNOTE: The `chat_completion` task type is only available within the _stream API and only supports streaming.\nThe Chat completion inference API and the Stream inference API differ in their response structure and capabilities.\nThe Chat completion inference API provides more comprehensive customization options through more fields and function calling support.\nTo determine whether a given inference service supports this task type, please see the page for that service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.completion","type":"object","properties":{"input":{"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.completion","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference request to complete.","x-found-in":"query"},"input":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Inference input.\nEither a string or an array of strings.","x-found-in":"body"},"task_settings":{"description":"Task settings for the individual inference request. These settings are specific to the <task_type> you specified and override the task settings specified when initializing the service.","x-found-in":"body"},"inference_id":{"type":"string","description":"The inference Id","x-found-in":"path"}},"required":["inference_id","input"],"description":"Perform completion inference on the service.\n\nGet responses for completion tasks.\nThis API works only with the completion task type.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.\n\nThis API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege)."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.embedding","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference request to complete.","x-found-in":"query"},"inference_id":{"type":"string","description":"The inference Id","x-found-in":"path"}},"required":["inference_id"],"description":"Perform dense embedding inference on the service."}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.embedding","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference request to complete.","x-found-in":"query"},"embedding":{"$ref":"./inference._types.json#/$defs/inference._types__RequestEmbedding","x-found-in":"body"},"inference_id":{"type":"string","description":"The inference Id","x-found-in":"path"}},"required":["inference_id"],"description":"Perform dense embedding inference on the service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.inference","type":"object","properties":{"query":{"type":"string","description":"The query input, which is required only for the `rerank` task.\nIt is not required for other tasks.","x-found-in":"body"},"input":{"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.inference","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The amount of time to wait for the inference request to complete.","x-found-in":"query"},"query":{"type":"string","description":"The query input, which is required only for the `rerank` task.\nIt is not required for other tasks.","x-found-in":"body"},"input":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"The text on which you want to perform the inference task.\nIt can be a single string or an array.\n\n> info\n> Inference endpoints for the `completion` task type currently only support a single string as input.","x-found-in":"body"},"input_type":{"type":"string","description":"Specifies the input data type for the embedding model. The `input_type` parameter only applies to Inference Endpoints with the `embedding` or `text_embedding` task type. Possible values include:\n* `SEARCH`\n* `INGEST`\n* `CLASSIFICATION`\n* `CLUSTERING`\nNot all services support all values. Unsupported values will trigger a validation exception.\nAccepted values depend on the configured inference service, refer to the relevant service-specific documentation for more info.\n\n> info\n> The `input_type` parameter specified on the root level of the request body will take precedence over the `input_type` parameter specified in `task_settings`.","x-found-in":"body"},"task_settings":{"description":"Task settings for the individual inference request.\nThese settings are specific to the task type you specified and override the task settings specified when initializing the service.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__TaskType","description":"The type of inference task that the model performs.","x-found-in":"path"},"inference_id":{"type":"string","description":"The unique identifier for the inference endpoint.","x-found-in":"path"}},"required":["inference_id","input"],"description":"Perform inference on the service.\n\nThis API enables you to use machine learning models to perform specific tasks on data that you provide as an input.\nIt returns a response with the results of the tasks.\nThe inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.\n\nFor details about using this API with a service, such as Amazon Bedrock, Anthropic, or HuggingFace, refer to the service-specific documentation.\n\n> info\n> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.\nThe default depends on the task type: 120s for `completion` and `chat_completion`, and 30s for all other task types.","x-found-in":"query"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__TaskType","description":"The task type. Refer to the integration list in the API description for the available task types.","x-found-in":"path"},"inference_id":{"type":"string","description":"The inference Id","x-found-in":"path"}},"required":["inference_id"],"description":"Create an inference endpoint.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.\n\nThe following integrations are available through the inference API. You can find the available task types next to the integration name:\n* AI21 (`chat_completion`, `completion`)\n* AlibabaCloud AI Search (`completion`, `rerank`, `sparse_embedding`, `text_embedding`)\n* Amazon Bedrock (`chat_completion`, `completion`, `text_embedding`)\n* Amazon SageMaker (`chat_completion`, `completion`, `rerank`, `sparse_embedding`, `text_embedding`)\n* Anthropic (`chat_completion`, `completion`)\n* Azure AI Studio (`completion`, `rerank`, `text_embedding`)\n* Azure OpenAI (`chat_completion`, `completion`, `text_embedding`)\n* Cohere (`completion`, `rerank`, `text_embedding`)\n* DeepSeek (`chat_completion`, `completion`)\n* Elasticsearch (`rerank`, `sparse_embedding`, `text_embedding` - this service is for built-in models and models uploaded through Eland)\n* ELSER (`sparse_embedding`)\n* Fireworks AI (`chat_completion`, `completion`, `text_embedding`)\n* Google AI Studio (`completion`, `text_embedding`)\n* Google Vertex AI (`chat_completion`, `completion`, `rerank`, `text_embedding`)\n* Groq (`chat_completion`)\n* Hugging Face (`chat_completion`, `completion`, `rerank`, `text_embedding`)\n* JinaAI (`embedding`, `rerank`, `text_embedding`)\n* Llama (`chat_completion`, `completion`, `text_embedding`)\n* Mistral (`chat_completion`, `completion`, `text_embedding`)\n* Nvidia (`chat_completion`, `completion`, `text_embedding`, `rerank`)\n* OpenAI (`chat_completion`, `completion`, `text_embedding`)\n* OpenShift AI (`chat_completion`, `completion`, `rerank`, `text_embedding`)\n* VoyageAI (`rerank`, `text_embedding`)\n* Watsonx (`chat_completion`, `completion`, `rerank`, `text_embedding`)"}
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.\nThe default depends on the task type: 120s for `completion` and `chat_completion`, and 30s for all other task types.","x-found-in":"query"},"inference_config":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceEndpoint","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__TaskType","description":"The task type. Refer to the integration list in the API description for the available task types.","x-found-in":"path"},"inference_id":{"type":"string","description":"The inference Id","x-found-in":"path"}},"required":["inference_id"],"description":"Create an inference endpoint.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.\n\nThe following integrations are available through the inference API. You can find the available task types next to the integration name:\n* AI21 (`chat_completion`, `completion`)\n* AlibabaCloud AI Search (`completion`, `rerank`, `sparse_embedding`, `text_embedding`)\n* Amazon Bedrock (`chat_completion`, `completion`, `text_embedding`)\n* Amazon SageMaker (`chat_completion`, `completion`, `rerank`, `sparse_embedding`, `text_embedding`)\n* Anthropic (`chat_completion`, `completion`)\n* Azure AI Studio (`completion`, `rerank`, `text_embedding`)\n* Azure OpenAI (`chat_completion`, `completion`, `text_embedding`)\n* Cohere (`completion`, `rerank`, `text_embedding`)\n* DeepSeek (`chat_completion`, `completion`)\n* Elasticsearch (`rerank`, `sparse_embedding`, `text_embedding` - this service is for built-in models and models uploaded through Eland)\n* ELSER (`sparse_embedding`)\n* Fireworks AI (`chat_completion`, `completion`, `text_embedding`)\n* Google AI Studio (`completion`, `text_embedding`)\n* Google Vertex AI (`chat_completion`, `completion`, `rerank`, `text_embedding`)\n* Groq (`chat_completion`)\n* Hugging Face (`chat_completion`, `completion`, `rerank`, `text_embedding`)\n* JinaAI (`embedding`, `rerank`, `text_embedding`)\n* Llama (`chat_completion`, `completion`, `text_embedding`)\n* Mistral (`chat_completion`, `completion`, `text_embedding`)\n* Nvidia (`chat_completion`, `completion`, `text_embedding`, `rerank`)\n* OpenAI (`chat_completion`, `completion`, `text_embedding`)\n* OpenShift AI (`chat_completion`, `completion`, `rerank`, `text_embedding`)\n* VoyageAI (`rerank`, `text_embedding`)\n* Watsonx (`chat_completion`, `completion`, `rerank`, `text_embedding`)"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_ai21","type":"object","properties":{"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_ai21","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__Ai21ServiceType","description":"The type of service supported for the specified task type. In this case, `ai21`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__Ai21ServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `ai21` service.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__Ai21TaskType","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"ai21_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","ai21_inference_id","service","service_settings"],"description":"Create a AI21 inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `ai21` service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_alibabacloud","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `sparse_embedding` or `text_embedding` task types.\nNot applicable to the `rerank` or `completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__AlibabaCloudServiceType","description":"The type of service supported for the specified task type. In this case, `alibabacloud-ai-search`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AlibabaCloudServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `alibabacloud-ai-search` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AlibabaCloudTaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_alibabacloud","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `sparse_embedding` or `text_embedding` task types.\nNot applicable to the `rerank` or `completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__AlibabaCloudServiceType","description":"The type of service supported for the specified task type. In this case, `alibabacloud-ai-search`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AlibabaCloudServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `alibabacloud-ai-search` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AlibabaCloudTaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__AlibabaCloudTaskType","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"alibabacloud_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","alibabacloud_inference_id","service","service_settings"],"description":"Create an AlibabaCloud AI Search inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_amazonbedrock","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `chat_completion` and `completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__AmazonBedrockServiceType","description":"The type of service supported for the specified task type. In this case, `amazonbedrock`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AmazonBedrockServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `amazonbedrock` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AmazonBedrockTaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_amazonbedrock","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `chat_completion` and `completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__AmazonBedrockServiceType","description":"The type of service supported for the specified task type. In this case, `amazonbedrock`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AmazonBedrockServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `amazonbedrock` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AmazonBedrockTaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__AmazonBedrockTaskType","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"amazonbedrock_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","amazonbedrock_inference_id","service","service_settings"],"description":"Create an Amazon Bedrock inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `amazonbedrock` service.\n\n>info\n> You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys. After creating the inference model, you cannot change the associated key pairs. If you want to use a different access and secret key pair, delete the inference model and recreate it with the same name and the updated keys."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_amazonsagemaker","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `sparse_embedding` or `text_embedding` task types.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__AmazonSageMakerServiceType","description":"The type of service supported for the specified task type. In this case, `amazon_sagemaker`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AmazonSageMakerServiceSettings","description":"Settings used to install the inference model.\nThese settings are specific to the `amazon_sagemaker` service and `service_settings.api` you specified.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AmazonSageMakerTaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type and `service_settings.api` you specified.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_amazonsagemaker","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `sparse_embedding` or `text_embedding` task types.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__AmazonSageMakerServiceType","description":"The type of service supported for the specified task type. In this case, `amazon_sagemaker`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AmazonSageMakerServiceSettings","description":"Settings used to install the inference model.\nThese settings are specific to the `amazon_sagemaker` service and `service_settings.api` you specified.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AmazonSageMakerTaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type and `service_settings.api` you specified.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__TaskTypeAmazonSageMaker","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"amazonsagemaker_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","amazonsagemaker_inference_id","service","service_settings"],"description":"Create an Amazon SageMaker inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `amazon_sagemaker` service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_anthropic","type":"object","properties":{"service":{"$ref":"./inference._types.json#/$defs/inference._types__AnthropicServiceType","description":"The type of service supported for the specified task type. In this case, `anthropic`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AnthropicServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `anthropic` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AnthropicTaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_anthropic","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__AnthropicServiceType","description":"The type of service supported for the specified task type. In this case, `anthropic`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AnthropicServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `anthropic` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AnthropicTaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__AnthropicTaskType","description":"The task type.\nThe valid task types for the model to perform are `completion` and `chat_completion`.\nNOTE: The `chat_completion` task type only supports streaming and only through the _stream API.","x-found-in":"path"},"anthropic_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","anthropic_inference_id","service","service_settings"],"description":"Create an Anthropic inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `anthropic` service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_azureaistudio","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank` or `completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__AzureAiStudioServiceType","description":"The type of service supported for the specified task type. In this case, `azureaistudio`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AzureAiStudioServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `azureaistudio` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AzureAiStudioTaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_azureaistudio","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank` or `completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__AzureAiStudioServiceType","description":"The type of service supported for the specified task type. In this case, `azureaistudio`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AzureAiStudioServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `azureaistudio` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AzureAiStudioTaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__AzureAiStudioTaskType","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"azureaistudio_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","azureaistudio_inference_id","service","service_settings"],"description":"Create an Azure AI studio inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `azureaistudio` service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_azureopenai","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` and `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__AzureOpenAIServiceType","description":"The type of service supported for the specified task type. In this case, `azureopenai`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AzureOpenAIServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `azureopenai` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AzureOpenAITaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_azureopenai","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` and `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__AzureOpenAIServiceType","description":"The type of service supported for the specified task type. In this case, `azureopenai`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AzureOpenAIServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `azureopenai` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__AzureOpenAITaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__AzureOpenAITaskType","description":"The type of the inference task that the model will perform.\nNOTE: The `chat_completion` task type only supports streaming and only through the _stream API.","x-found-in":"path"},"azureopenai_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","azureopenai_inference_id","service","service_settings"],"description":"Create an Azure OpenAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `azureopenai` service.\n\nThe list of chat completion models that you can choose from in your Azure OpenAI deployment include:\n\n* [GPT-4 and GPT-4 Turbo models](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)\n* [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-35)\n\nThe list of embeddings models that you can choose from in your deployment can be found in the [Azure models documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#embeddings)."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_cohere","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank` or `completion` task type.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__CohereServiceType","description":"The type of service supported for the specified task type. In this case, `cohere`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__CohereServiceSettings","description":"Settings used to install the inference model.\nThese settings are specific to the `cohere` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__CohereTaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_cohere","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank` or `completion` task type.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__CohereServiceType","description":"The type of service supported for the specified task type. In this case, `cohere`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__CohereServiceSettings","description":"Settings used to install the inference model.\nThese settings are specific to the `cohere` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__CohereTaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__CohereTaskType","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"cohere_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","cohere_inference_id","service","service_settings"],"description":"Create a Cohere inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `cohere` service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_contextualai","type":"object","properties":{"service":{"$ref":"./inference._types.json#/$defs/inference._types__ContextualAIServiceType","description":"The type of service supported for the specified task type. In this case, `contextualai`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__ContextualAIServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `contextualai` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__ContextualAITaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_contextualai","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__ContextualAIServiceType","description":"The type of service supported for the specified task type. In this case, `contextualai`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__ContextualAIServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `contextualai` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__ContextualAITaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__TaskTypeContextualAI","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"contextualai_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","contextualai_inference_id","service","service_settings"],"description":"Create an Contextual AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `contexualai` service.\n\nTo review the available `rerank` models, refer to <https://docs.contextual.ai/api-reference/rerank/rerank#body-model>."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_deepseek","type":"object","properties":{"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_deepseek","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__DeepSeekServiceType","description":"The type of service supported for the specified task type. In this case, `deepseek`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__DeepSeekServiceSettings","description":"Settings used to install the inference model.\nThese settings are specific to the `deepseek` service.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__TaskTypeDeepSeek","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"deepseek_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","deepseek_inference_id","service","service_settings"],"description":"Create a DeepSeek inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `deepseek` service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_elasticsearch","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `sparse_embedding` and `text_embedding` task types.\nNot applicable to the `rerank` task type.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__ElasticsearchServiceType","description":"The type of service supported for the specified task type. In this case, `elasticsearch`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__ElasticsearchServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `elasticsearch` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__ElasticsearchTaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_elasticsearch","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `sparse_embedding` and `text_embedding` task types.\nNot applicable to the `rerank` task type.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__ElasticsearchServiceType","description":"The type of service supported for the specified task type. In this case, `elasticsearch`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__ElasticsearchServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `elasticsearch` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__ElasticsearchTaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__ElasticsearchTaskType","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"elasticsearch_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.\nThe must not match the `model_id`.","x-found-in":"path"}},"required":["task_type","elasticsearch_inference_id","service","service_settings"],"description":"Create an Elasticsearch inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `elasticsearch` service.\n\n> info\n> Your Elasticsearch deployment contains preconfigured ELSER and E5 inference endpoints, you only need to create the enpoints using the API if you want to customize the settings.\n\nIf you use the ELSER or the E5 model through the `elasticsearch` service, the API request will automatically download and deploy the model if it isn't downloaded yet.\n\n> info\n> You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value.\n\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_elser","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nNote that for ELSER endpoints, the max_chunk_size may not exceed `300`.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__ElserServiceType","description":"The type of service supported for the specified task type. In this case, `elser`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__ElserServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `elser` service.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_elser","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nNote that for ELSER endpoints, the max_chunk_size may not exceed `300`.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__ElserServiceType","description":"The type of service supported for the specified task type. In this case, `elser`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__ElserServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `elser` service.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__ElserTaskType","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"elser_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","elser_inference_id","service","service_settings"],"description":"Create an ELSER inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `elser` service.\nYou can also deploy ELSER by using the Elasticsearch inference integration.\n\n> info\n> Your Elasticsearch deployment contains a preconfigured ELSER inference endpoint, you only need to create the enpoint using the API if you want to customize the settings.\n\nThe API request will automatically download and deploy the ELSER model if it isn't already downloaded.\n\n> info\n> You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value.\n\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_fireworksai","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__FireworksAIServiceType","description":"The type of service supported for the specified task type. In this case, `fireworksai`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__FireworksAIServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `fireworksai` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__FireworksAITaskSettings","description":"Settings to configure the inference task.\nApplies only to the `completion` or `chat_completion` task types.\nNot applicable to the `text_embedding` task type.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_fireworksai","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__FireworksAIServiceType","description":"The type of service supported for the specified task type. In this case, `fireworksai`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__FireworksAIServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `fireworksai` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__FireworksAITaskSettings","description":"Settings to configure the inference task.\nApplies only to the `completion` or `chat_completion` task types.\nNot applicable to the `text_embedding` task type.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__FireworksAITaskType","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"fireworksai_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","fireworksai_inference_id","service","service_settings"],"description":"Create a Fireworks AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `fireworksai` service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_googleaistudio","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` task type.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__GoogleAiServiceType","description":"The type of service supported for the specified task type. In this case, `googleaistudio`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__GoogleAiStudioServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `googleaistudio` service.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_googleaistudio","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` task type.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__GoogleAiServiceType","description":"The type of service supported for the specified task type. In this case, `googleaistudio`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__GoogleAiStudioServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `googleaistudio` service.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__GoogleAiStudioTaskType","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"googleaistudio_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","googleaistudio_inference_id","service","service_settings"],"description":"Create an Google AI Studio inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `googleaistudio` service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_googlevertexai","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__GoogleVertexAIServiceType","description":"The type of service supported for the specified task type. In this case, `googlevertexai`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__GoogleVertexAIServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `googlevertexai` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__GoogleVertexAITaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_googlevertexai","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__GoogleVertexAIServiceType","description":"The type of service supported for the specified task type. In this case, `googlevertexai`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__GoogleVertexAIServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `googlevertexai` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__GoogleVertexAITaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__GoogleVertexAITaskType","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"googlevertexai_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","googlevertexai_inference_id","service","service_settings"],"description":"Create a Google Vertex AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `googlevertexai` service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_groq","type":"object","properties":{"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_groq","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__GroqServiceType","description":"The type of service supported for the specified task type. In this case, `groq`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__GroqServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `groq` service.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__GroqTaskType","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"groq_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","groq_inference_id","service","service_settings"],"description":"Create a Groq inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `groq` service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_hugging_face","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__HuggingFaceServiceType","description":"The type of service supported for the specified task type. In this case, `hugging_face`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__HuggingFaceServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `hugging_face` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__HuggingFaceTaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_hugging_face","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__HuggingFaceServiceType","description":"The type of service supported for the specified task type. In this case, `hugging_face`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__HuggingFaceServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `hugging_face` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__HuggingFaceTaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__HuggingFaceTaskType","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"huggingface_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","huggingface_inference_id","service","service_settings"],"description":"Create a Hugging Face inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `hugging_face` service.\nSupported tasks include: `text_embedding`, `completion`, and `chat_completion`.\n\nTo configure the endpoint, first visit the Hugging Face Inference Endpoints page and create a new endpoint.\nSelect a model that supports the task you intend to use.\n\nFor Elastic's `text_embedding` task:\nThe selected model must support the `Sentence Embeddings` task. On the new endpoint creation page, select the `Sentence Embeddings` task under the `Advanced Configuration` section.\nAfter the endpoint has initialized, copy the generated endpoint URL.\nRecommended models for `text_embedding` task:\n\n* `all-MiniLM-L6-v2`\n* `all-MiniLM-L12-v2`\n* `all-mpnet-base-v2`\n* `e5-base-v2`\n* `e5-small-v2`\n* `multilingual-e5-base`\n* `multilingual-e5-small`\n\nFor Elastic's `chat_completion` and `completion` tasks:\nThe 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.\nAfter 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.\nRecommended models for `chat_completion` and `completion` tasks:\n\n* `Mistral-7B-Instruct-v0.2`\n* `QwQ-32B`\n* `Phi-3-mini-128k-instruct`\n\nFor Elastic's `rerank` task:\nThe selected model must support the `sentence-ranking` task and expose OpenAI API.\nHuggingFace supports only dedicated (not serverless) endpoints for `Rerank` so far.\nAfter the endpoint is initialized, copy the full endpoint URL for use.\nTested models for `rerank` task:\n\n* `bge-reranker-base`\n* `jina-reranker-v1-turbo-en-GGUF`"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_jinaai","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `embedding` and text_embedding` task types.\nNot applicable to the `rerank` task type.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__JinaAIServiceType","description":"The type of service supported for the specified task type. In this case, `jinaai`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__JinaAIServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `jinaai` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__JinaAITaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_jinaai","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `embedding` and text_embedding` task types.\nNot applicable to the `rerank` task type.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__JinaAIServiceType","description":"The type of service supported for the specified task type. In this case, `jinaai`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__JinaAIServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `jinaai` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__JinaAITaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__JinaAITaskType","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"jinaai_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","jinaai_inference_id","service","service_settings"],"description":"Create an JinaAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `jinaai` service.\n\nTo review the available `rerank` models, refer to <https://jina.ai/reranker>.\nTo review the available `embedding` and `text_embedding` models, refer to <https://jina.ai/embeddings/>."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_llama","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__LlamaServiceType","description":"The type of service supported for the specified task type. In this case, `llama`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__LlamaServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `llama` service.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_llama","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__LlamaServiceType","description":"The type of service supported for the specified task type. In this case, `llama`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__LlamaServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `llama` service.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__LlamaTaskType","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"llama_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","llama_inference_id","service","service_settings"],"description":"Create a Llama inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `llama` service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_mistral","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__MistralServiceType","description":"The type of service supported for the specified task type. In this case, `mistral`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__MistralServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `mistral` service.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_mistral","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__MistralServiceType","description":"The type of service supported for the specified task type. In this case, `mistral`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__MistralServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `mistral` service.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__MistralTaskType","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"mistral_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","mistral_inference_id","service","service_settings"],"description":"Create a Mistral inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `mistral` service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_nvidia","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__NvidiaServiceType","description":"The type of service supported for the specified task type. In this case, `nvidia`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__NvidiaServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `nvidia` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__NvidiaTaskSettings","description":"Settings to configure the inference task.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_nvidia","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__NvidiaServiceType","description":"The type of service supported for the specified task type. In this case, `nvidia`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__NvidiaServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `nvidia` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__NvidiaTaskSettings","description":"Settings to configure the inference task.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__NvidiaTaskType","description":"The type of the inference task that the model will perform.\nNOTE: The `chat_completion` task type only supports streaming and only through the _stream API.","x-found-in":"path"},"nvidia_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","nvidia_inference_id","service","service_settings"],"description":"Create an Nvidia inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `nvidia` service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_openai","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__OpenAIServiceType","description":"The type of service supported for the specified task type. In this case, `openai`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__OpenAIServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `openai` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__OpenAITaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_openai","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `completion` or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__OpenAIServiceType","description":"The type of service supported for the specified task type. In this case, `openai`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__OpenAIServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `openai` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__OpenAITaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__OpenAITaskType","description":"The type of the inference task that the model will perform.\nNOTE: The `chat_completion` task type only supports streaming and only through the _stream API.","x-found-in":"path"},"openai_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","openai_inference_id","service","service_settings"],"description":"Create an OpenAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `openai` service or `openai` compatible APIs."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_openshift_ai","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__OpenShiftAiServiceType","description":"The type of service supported for the specified task type. In this case, `openshift_ai`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__OpenShiftAiServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `openshift_ai` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__OpenShiftAiTaskSettings","description":"Settings to configure the inference task.\nApplies only to the `rerank` task type.\nNot applicable to the `text_embedding`, `completion`, or `chat_completion` task types.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_openshift_ai","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion`, or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__OpenShiftAiServiceType","description":"The type of service supported for the specified task type. In this case, `openshift_ai`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__OpenShiftAiServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `openshift_ai` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__OpenShiftAiTaskSettings","description":"Settings to configure the inference task.\nApplies only to the `rerank` task type.\nNot applicable to the `text_embedding`, `completion`, or `chat_completion` task types.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__OpenShiftAiTaskType","description":"The type of the inference task that the model will perform.\nNOTE: The `chat_completion` task type only supports streaming and only through the _stream API.","x-found-in":"path"},"openshiftai_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","openshiftai_inference_id","service","service_settings"],"description":"Create an OpenShift AI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `openshift_ai` service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_region_policy","type":"object","properties":{"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_region_policy","type":"object","properties":{"force":{"type":"boolean","description":"If `true`, the region policy is applied even if it would deny access to inference endpoints that are currently in use by ingest pipeline or indices.","x-found-in":"query"},"region_policy":{"$ref":"./inference._types.json#/$defs/inference._types__RegionPolicy","description":"The region policy configuration.","x-found-in":"body"}},"required":["region_policy"],"description":"Create or update the inference region policy.\n\nThe region policy restricts inference to a set of allowed geographic areas or cloud service provider regions."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_voyageai","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank` task type.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__VoyageAIServiceType","description":"The type of service supported for the specified task type. In this case, `voyageai`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__VoyageAIServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `voyageai` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__VoyageAITaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_voyageai","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank` task type.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__VoyageAIServiceType","description":"The type of service supported for the specified task type. In this case, `voyageai`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__VoyageAIServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `voyageai` service.","x-found-in":"body"},"task_settings":{"$ref":"./inference._types.json#/$defs/inference._types__VoyageAITaskSettings","description":"Settings to configure the inference task.\nThese settings are specific to the task type you specified.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__VoyageAITaskType","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"voyageai_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","voyageai_inference_id","service","service_settings"],"description":"Create a VoyageAI inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `voyageai` service.\n\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_watsonx","type":"object","properties":{"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion` or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__WatsonxServiceType","description":"The type of service supported for the specified task type. In this case, `watsonxai`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__WatsonxServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `watsonxai` service.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.put_watsonx","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference endpoint to be created.","x-found-in":"query"},"chunking_settings":{"$ref":"./inference._types.json#/$defs/inference._types__InferenceChunkingSettings","description":"The chunking configuration object.\nApplies only to the `text_embedding` task type.\nNot applicable to the `rerank`, `completion` or `chat_completion` task types.","x-found-in":"body"},"service":{"$ref":"./inference._types.json#/$defs/inference._types__WatsonxServiceType","description":"The type of service supported for the specified task type. In this case, `watsonxai`.","x-found-in":"body"},"service_settings":{"$ref":"./inference._types.json#/$defs/inference._types__WatsonxServiceSettings","description":"Settings used to install the inference model. These settings are specific to the `watsonxai` service.","x-found-in":"body"},"task_type":{"$ref":"./inference._types.json#/$defs/inference._types__WatsonxTaskType","description":"The type of the inference task that the model will perform.","x-found-in":"path"},"watsonx_inference_id":{"type":"string","description":"The unique identifier of the inference endpoint.","x-found-in":"path"}},"required":["task_type","watsonx_inference_id","service","service_settings"],"description":"Create a Watsonx inference endpoint.\n\nCreate an inference endpoint to perform an inference task with the `watsonxai` service.\nYou need an IBM Cloud Databases for Elasticsearch deployment to use the `watsonxai` inference service.\nYou can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"inference.rerank__RerankQuery":{"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"inference.rerank__RerankQuery":{"anyOf":[{"type":"string"},{"$ref":"./inference.rerank.json#/$defs/inference.rerank__RerankInputObject"}],"description":"Query input for the `rerank` task.\nEither a string, or an object. The object form additionally allows specifying non-text inputs, such as images.\n\n> info\n> Only the `elastic` service currently supports non-text queries for the `rerank` task."},"inference.rerank__RerankInputObject":{"type":"object","properties":{"type":{"$ref":"./inference.rerank.json#/$defs/inference.rerank__RerankInputType","description":"The type of input. Not all services and models support all input types."},"format":{"$ref":"./inference.rerank.json#/$defs/inference.rerank__RerankInputFormat","description":"The format of the input. For the `text` type this must be `text`. For the `image` type this must be `base64`.\nIf not specified, this defaults to `text` for the `text` type and `base64` for the `image` type."},"value":{"type":"string","description":"The value of the input. For images, this must be a base64-encoded data URI, that is, \"data:content/type;base64,...\"."}},"required":["type","value"],"description":"An object describing a single input for the `rerank` task, which additionally allows specifying non-text inputs, such as images."},"inference.rerank__RerankInputType":{"enum":["text","image"]},"inference.rerank__RerankInputFormat":{"enum":["text","base64"]},"inference.rerank__RerankInput":{"anyOf":[{"$ref":"./inference.rerank.json#/$defs/inference.rerank__RerankStringInput"},{"$ref":"./inference.rerank.json#/$defs/inference.rerank__RerankObjectInput"}],"description":"The documents to rank for the `rerank` task.\nEither a string, an array of strings, an object, or an array of objects.\nThe object form additionally allows specifying non-text inputs, such as images.\n\n> info\n> Only the `elastic` service currently supports non-text inputs for the `rerank` task."},"inference.rerank__RerankStringInput":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Allows specifying text-only documents to rank for the `rerank` task."},"inference.rerank__RerankObjectInput":{"anyOf":[{"$ref":"./inference.rerank.json#/$defs/inference.rerank__RerankInputObject"},{"type":"array","items":{"$ref":"./inference.rerank.json#/$defs/inference.rerank__RerankInputObject"}}],"description":"Allows specifying documents to rank as objects, which additionally supports non-text inputs, such as images."}}}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.rerank","type":"object","properties":{"query":{"$ref":"./inference.rerank.json#/$defs/inference.rerank__RerankQuery","description":"Query input.\nThe query can be specified as a single string, or as an object.\nThe object form additionally allows specifying non-text inputs, such as images.\n\n> info\n> Only the `elastic` service currently supports non-text queries for the `rerank` task. For all other services, the query must be a string.\n\nstring example:\n```\n\"query\": \"some query text\"\n```\nobject example:\n```\n\"query\": {\n \"type\": \"image\",\n \"format\": \"base64\",\n \"value\": \"data:image/jpeg;base64,...\"\n}\n```","x-found-in":"body"},"input":{"$ref":"./inference.rerank.json#/$defs/inference.rerank__RerankInput","description":"The documents to rank.\nThe input can be specified as a single string or an array of strings, or as an object or an array of objects.\nThe object form additionally allows specifying non-text inputs, such as images.\n\n> info\n> Only the `elastic` service currently supports non-text inputs for the `rerank` task. For all other services, the input must be a string or an array of strings.\n\nstring example:\n```\n\"input\": \"some document text\"\n```\nstring array example:\n```\n\"input\": [\"some document text\", \"some more document text\"]\n```\nobject example:\n```\n\"input\": {\n \"type\": \"image\",\n \"format\": \"base64\",\n \"value\": \"data:image/jpeg;base64,...\"\n}\n```\nobject array example:\n```\n\"input\": [\n {\n \"type\": \"text\",\n \"format\": \"text\",\n \"value\": \"some document text\"\n },\n {\n \"type\": \"image\",\n \"format\": \"base64\",\n \"value\": \"data:image/jpeg;base64,...\"\n }\n]\n```","x-found-in":"body"},"return_documents":{"type":"boolean","description":"Include the document text in the response.","x-found-in":"body"},"top_n":{"type":"number","description":"Limit the response to the top N documents.","x-found-in":"body"},"task_settings":{"description":"Task settings for the individual inference request.\nThese settings are specific to the task type you specified and override the task settings specified when initializing the service.","x-found-in":"body"},"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.rerank","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The amount of time to wait for the inference request to complete.","x-found-in":"query"},"query":{"$ref":"./inference.rerank.json#/$defs/inference.rerank__RerankQuery","description":"Query input.\nThe query can be specified as a single string, or as an object.\nThe object form additionally allows specifying non-text inputs, such as images.\n\n> info\n> Only the `elastic` service currently supports non-text queries for the `rerank` task. For all other services, the query must be a string.\n\nstring example:\n```\n\"query\": \"some query text\"\n```\nobject example:\n```\n\"query\": {\n \"type\": \"image\",\n \"format\": \"base64\",\n \"value\": \"data:image/jpeg;base64,...\"\n}\n```","x-found-in":"body"},"input":{"$ref":"./inference.rerank.json#/$defs/inference.rerank__RerankInput","description":"The documents to rank.\nThe input can be specified as a single string or an array of strings, or as an object or an array of objects.\nThe object form additionally allows specifying non-text inputs, such as images.\n\n> info\n> Only the `elastic` service currently supports non-text inputs for the `rerank` task. For all other services, the input must be a string or an array of strings.\n\nstring example:\n```\n\"input\": \"some document text\"\n```\nstring array example:\n```\n\"input\": [\"some document text\", \"some more document text\"]\n```\nobject example:\n```\n\"input\": {\n \"type\": \"image\",\n \"format\": \"base64\",\n \"value\": \"data:image/jpeg;base64,...\"\n}\n```\nobject array example:\n```\n\"input\": [\n {\n \"type\": \"text\",\n \"format\": \"text\",\n \"value\": \"some document text\"\n },\n {\n \"type\": \"image\",\n \"format\": \"base64\",\n \"value\": \"data:image/jpeg;base64,...\"\n }\n]\n```","x-found-in":"body"},"return_documents":{"type":"boolean","description":"Include the document text in the response.","x-found-in":"body"},"top_n":{"type":"number","description":"Limit the response to the top N documents.","x-found-in":"body"},"task_settings":{"description":"Task settings for the individual inference request.\nThese settings are specific to the task type you specified and override the task settings specified when initializing the service.","x-found-in":"body"},"inference_id":{"type":"string","description":"The unique identifier for the inference endpoint.","x-found-in":"path"}},"required":["inference_id","query","input"],"description":"Perform reranking inference on the service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.sparse_embedding","type":"object","properties":{"input":{"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.sparse_embedding","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference request to complete.","x-found-in":"query"},"input":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Inference input.\nEither a string or an array of strings.","x-found-in":"body"},"task_settings":{"description":"Task settings for the individual inference request. These settings are specific to the <task_type> you specified and override the task settings specified when initializing the service.","x-found-in":"body"},"inference_id":{"type":"string","description":"The inference Id","x-found-in":"path"}},"required":["inference_id","input"],"description":"Perform sparse embedding inference on the service."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.stream_completion","type":"object","properties":{"input":{"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.stream_completion","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The amount of time to wait for the inference request to complete.","x-found-in":"query"},"input":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"The text on which you want to perform the inference task.\nIt can be a single string or an array.\n\nNOTE: Inference endpoints for the completion task type currently only support a single string as input.","x-found-in":"body"},"task_settings":{"description":"Task settings for the individual inference request. These settings are specific to the <task_type> you specified and override the task settings specified when initializing the service.","x-found-in":"body"},"inference_id":{"type":"string","description":"The unique identifier for the inference endpoint.","x-found-in":"path"}},"required":["inference_id","input"],"description":"Perform streaming completion inference on the service.\n\nGet real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation.\nThis API works only with the completion task type.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.\n\nThis API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege). You must use a client that supports streaming."}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.text_embedding","type":"object","properties":{"input":{"
|
|
1
|
+
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"inference.text_embedding","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Specifies the amount of time to wait for the inference request to complete.","x-found-in":"query"},"input":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Inference input.\nEither a string or an array of strings.","x-found-in":"body"},"input_type":{"type":"string","description":"The input data type for the text embedding model. Possible values include:\n* `SEARCH`\n* `INGEST`\n* `CLASSIFICATION`\n* `CLUSTERING`\nNot all services support all values. Unsupported values will trigger a validation exception.\nAccepted values depend on the configured inference service, refer to the relevant service-specific documentation for more info.\n\n> info\n> The `input_type` parameter specified on the root level of the request body will take precedence over the `input_type` parameter specified in `task_settings`.","x-found-in":"body"},"task_settings":{"description":"Task settings for the individual inference request. These settings are specific to the <task_type> you specified and override the task settings specified when initializing the service.","x-found-in":"body"},"inference_id":{"type":"string","description":"The inference Id","x-found-in":"path"}},"required":["inference_id","input"],"description":"Perform text embedding inference on the service."}
|