diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb index eb75f6d18..94464a760 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb @@ -25,8 +25,7 @@ module Actions # Get component templates. # Get information about component templates. # - # @option arguments [String] :name Comma-separated list of component template names used to limit the request. - # Wildcard (`*`) expressions are supported. + # @option arguments [String] :name Name of component template to retrieve. Wildcard (`*`) expressions are supported. # @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format. # @option arguments [String, Array] :settings_filter Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys # @option arguments [Boolean] :include_defaults Return all default configurations for the component template diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb index 88302fd8f..5eaf4caf1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb @@ -31,18 +31,31 @@ module Actions # One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. # The cluster status is controlled by the worst index status. # - # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (`*`) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or `*`. - # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: all. - # @option arguments [String] :level Can be one of cluster, indices or shards. Controls the details level of the health information returned. Server default: cluster. - # @option arguments [Boolean] :local If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. - # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. - # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. - # @option arguments [Integer, String] :wait_for_active_shards A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. Server default: 0. - # @option arguments [String] :wait_for_events Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. - # @option arguments [String, Integer] :wait_for_nodes The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and yellow > red. By default, will not wait for any status. + # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and index aliases that limit the request. + # Wildcard expressions (`*`) are supported. + # To target all data streams and indices in a cluster, omit this parameter or use _all or `*`. + # @option arguments [String, Array] :expand_wildcards Expand wildcard expression to concrete indices that are open, closed or both. Server default: all. + # @option arguments [String] :level Return health information at a specific level of detail. Server default: cluster. + # @option arguments [Boolean] :local If true, retrieve information from the local node only. + # If false, retrieve information from the master node. + # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Time] :timeout The period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Integer, String] :wait_for_active_shards Wait for the specified number of active shards. + # Use `all` to wait for all shards in the cluster to be active. + # Use `0` to not wait. Server default: 0. + # @option arguments [String] :wait_for_events Wait until all currently queued events with the given priority are processed. + # @option arguments [String, Integer] :wait_for_nodes Wait until the specified number (N) of nodes is available. + # It also accepts `>=N`, `<=N`, `>N` and `] :filter_path Comma-separated list of filters in dot notation which reduce the response diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb index f8fc86118..9c6fdf14d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb @@ -69,7 +69,7 @@ module Actions # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open. # @option arguments [Boolean] :flush Specify whether the index should be flushed after performing the operation Server default: true. # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @option arguments [Integer] :max_num_segments The number of segments the index should be merged into (defayult: dynamic) + # @option arguments [Integer] :max_num_segments The number of segments the index should be merged into (default: dynamic) # @option arguments [Boolean] :only_expunge_deletes Specify whether the operation should only expunge deleted documents # @option arguments [Boolean] :wait_for_completion Should the request wait until the force merge is completed Server default: true. # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb index 938012994..1c8114d68 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb @@ -22,13 +22,13 @@ module Elasticsearch module API module Inference module Actions - # Perform chat completion inference. + # Perform chat completion inference on the service. # The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation. - # It only works with the `chat_completion` task type for `openai` and `elastic` inference services. + # It only works with the `chat_completion` task type. # NOTE: The `chat_completion` task type is only available within the _stream API and only supports streaming. # The Chat completion inference API and the Stream inference API differ in their response structure and capabilities. # The Chat completion inference API provides more comprehensive customization options through more fields and function calling support. - # If you use the `openai`, `hugging_face` or the `elastic` service, use the Chat completion inference API. + # To determine whether a given inference service supports this task type, please see the page for that service. # # @option arguments [String] :inference_id The inference Id (*Required*) # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. Server default: 30s. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb index 8d3405557..2110e8fc8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb @@ -23,6 +23,10 @@ module API module Inference module Actions # Perform completion inference on the service. + # Get responses for completion tasks. + # This API works only with the completion task type. + # IMPORTANT: 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. + # This API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege). # # @option arguments [String] :inference_id The inference Id (*Required*) # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. Server default: 30s. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb index 80e55c604..2f77a1627 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb @@ -22,7 +22,7 @@ module Elasticsearch module API module Inference module Actions - # Perform streaming inference. + # Perform streaming inference on the service. # Get real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation. # This API works only with the completion task type. # IMPORTANT: 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. diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/project/tags.rb b/elasticsearch-api/lib/elasticsearch/api/actions/project/tags.rb index a3144bd70..8ffafb3f1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/project/tags.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/project/tags.rb @@ -24,6 +24,10 @@ module Project module Actions # Get tags. # Get the tags that are defined for the project. + # This API is only available in Serverless. + # This functionality is in technical preview and may be changed or removed in a future + # release. Elastic will apply best effort to fix any issues, but features in technical + # preview are not subject to the support SLA of official GA features. # # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors # when they occur. @@ -38,7 +42,7 @@ module Actions # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see + # @see https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-project-tags # def tags(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'project.tags' } diff --git a/elasticsearch-api/lib/elasticsearch/api/version.rb b/elasticsearch-api/lib/elasticsearch/api/version.rb index 2edbd9ed1..6d3d7e3d3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/version.rb +++ b/elasticsearch-api/lib/elasticsearch/api/version.rb @@ -18,6 +18,6 @@ module Elasticsearch module API VERSION = '9.2.0'.freeze - ES_SPECIFICATION_COMMIT = '1d3156ba602ab3e3c15c74e11369391580cf0ad4'.freeze + ES_SPECIFICATION_COMMIT = '7ca0e28be98092be26a11a37118b2ba70e3c5479'.freeze end end