elasticsearch-serverless 0.6.0 → 0.7.0

data/lib/elasticsearch-serverless/api/machine_learning/reset_job.rb

@@ -36,14 +36,13 @@ module ElasticsearchServerless
         #  reset.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-reset-job
         #
         def reset_job(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "ml.reset_job" }
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.reset_job' }
 
-          defined_params = [:job_id].inject({}) do |set_variables, variable|
+          defined_params = [:job_id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/machine_learning/start_data_frame_analytics.rb

@@ -42,14 +42,13 @@ module ElasticsearchServerless
         #  starts. Server default: 20s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-data-frame-analytics
         #
         def start_data_frame_analytics(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "ml.start_data_frame_analytics" }
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.start_data_frame_analytics' }
 
-          defined_params = [:id].inject({}) do |set_variables, variable|
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/machine_learning/start_datafeed.rb

@@ -54,14 +54,13 @@ module ElasticsearchServerless
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-datafeed
         #
         def start_datafeed(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "ml.start_datafeed" }
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.start_datafeed' }
 
-          defined_params = [:datafeed_id].inject({}) do |set_variables, variable|
+          defined_params = [:datafeed_id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/machine_learning/start_trained_model_deployment.rb

@@ -35,7 +35,8 @@ module ElasticsearchServerless
         #  a separate set of threads to evaluate the model.
         #  Increasing this value generally increases the throughput.
         #  If this setting is greater than the number of hardware threads
-        #  it will automatically be changed to a value less than the number of hardware threads. Server default: 1.
+        #  it will automatically be changed to a value less than the number of hardware threads.
+        #  If adaptive_allocations is enabled, do not set this value, because it’s automatically set. Server default: 1.
         # @option arguments [String] :priority The deployment priority.
         # @option arguments [Integer] :queue_capacity Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds
         #  this value, new requests are rejected with a 429 error. Server default: 1024.
@@ -47,15 +48,15 @@ module ElasticsearchServerless
         # @option arguments [Time] :timeout Specifies the amount of time to wait for the model to deploy. Server default: 20s.
         # @option arguments [String] :wait_for Specifies the allocation status to wait for before returning. Server default: started.
         # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trained-model-deployment.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-trained-model-deployment
         #
         def start_trained_model_deployment(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "ml.start_trained_model_deployment" }
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.start_trained_model_deployment' }
 
-          defined_params = [:model_id].inject({}) do |set_variables, variable|
+          defined_params = [:model_id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -64,7 +65,7 @@ module ElasticsearchServerless
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body = nil
+          body = arguments.delete(:body)
 
           _model_id = arguments.delete(:model_id)
 

data/lib/elasticsearch-serverless/api/machine_learning/stop_data_frame_analytics.rb

@@ -43,14 +43,13 @@ module ElasticsearchServerless
         #  stops. Defaults to 20 seconds. Server default: 20s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-data-frame-analytics
         #
         def stop_data_frame_analytics(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "ml.stop_data_frame_analytics" }
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.stop_data_frame_analytics' }
 
-          defined_params = [:id].inject({}) do |set_variables, variable|
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/machine_learning/stop_datafeed.rb

@@ -41,14 +41,13 @@ module ElasticsearchServerless
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-datafeed
         #
         def stop_datafeed(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "ml.stop_datafeed" }
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.stop_datafeed' }
 
-          defined_params = [:datafeed_id].inject({}) do |set_variables, variable|
+          defined_params = [:datafeed_id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/machine_learning/stop_trained_model_deployment.rb

@@ -33,14 +33,13 @@ module ElasticsearchServerless
         #  restart the model deployment.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/stop-trained-model-deployment.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-trained-model-deployment
         #
         def stop_trained_model_deployment(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "ml.stop_trained_model_deployment" }
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.stop_trained_model_deployment' }
 
-          defined_params = [:model_id].inject({}) do |set_variables, variable|
+          defined_params = [:model_id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/machine_learning/update_data_frame_analytics.rb

@@ -30,14 +30,13 @@ module ElasticsearchServerless
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-data-frame-analytics
         #
         def update_data_frame_analytics(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "ml.update_data_frame_analytics" }
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.update_data_frame_analytics' }
 
-          defined_params = [:id].inject({}) do |set_variables, variable|
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/machine_learning/update_datafeed.rb

@@ -45,14 +45,13 @@ module ElasticsearchServerless
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-datafeed
         #
         def update_datafeed(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "ml.update_datafeed" }
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.update_datafeed' }
 
-          defined_params = [:datafeed_id].inject({}) do |set_variables, variable|
+          defined_params = [:datafeed_id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/machine_learning/update_filter.rb

@@ -29,14 +29,13 @@ module ElasticsearchServerless
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-filter
         #
         def update_filter(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "ml.update_filter" }
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.update_filter' }
 
-          defined_params = [:filter_id].inject({}) do |set_variables, variable|
+          defined_params = [:filter_id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/machine_learning/update_job.rb

@@ -29,14 +29,13 @@ module ElasticsearchServerless
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-job
         #
         def update_job(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "ml.update_job" }
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.update_job' }
 
-          defined_params = [:job_id].inject({}) do |set_variables, variable|
+          defined_params = [:job_id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/machine_learning/update_trained_model_deployment.rb

@@ -34,14 +34,13 @@ module ElasticsearchServerless
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-trained-model-deployment
         #
         def update_trained_model_deployment(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "ml.update_trained_model_deployment" }
+          request_opts = { endpoint: arguments[:endpoint] || 'ml.update_trained_model_deployment' }
 
-          defined_params = [:model_id].inject({}) do |set_variables, variable|
+          defined_params = [:model_id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/mget.rb

@@ -25,6 +25,14 @@ module ElasticsearchServerless
       # Get multiple JSON documents by ID from one or more indices.
       # If you specify an index in the request URI, you only need to specify the document IDs in the request body.
       # To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.
+      # **Filter source fields**
+      # By default, the +_source+ field is returned for every document (if stored).
+      # Use the +_source+ and +_source_include+ or +source_exclude+ attributes to filter what fields are returned for a particular document.
+      # You can include the +_source+, +_source_includes+, and +_source_excludes+ query parameters in the request URI to specify the defaults to use when there are no per-document instructions.
+      # **Get stored fields**
+      # Use the +stored_fields+ attribute to specify the set of stored fields you want to retrieve.
+      # Any requested fields that are not stored are ignored.
+      # You can include the +stored_fields+ query parameter in the request URI to specify the defaults to use when there are no per-document instructions.
       #
       # @option arguments [String] :index Name of the index to retrieve documents from when +ids+ are specified, or when a document in the +docs+ array does not specify an index.
       # @option arguments [Boolean] :force_synthetic_source Should this request force synthetic _source?
@@ -44,14 +52,13 @@ module ElasticsearchServerless
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mget
       #
       def mget(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "mget" }
+        request_opts = { endpoint: arguments[:endpoint] || 'mget' }
 
-        defined_params = [:index].inject({}) do |set_variables, variable|
+        defined_params = [:index].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -68,7 +75,7 @@ module ElasticsearchServerless
         path   = if _index
                    "#{Utils.listify(_index)}/_mget"
                  else
-                   "_mget"
+                   '_mget'
                  end
         params = Utils.process_params(arguments)
 

data/lib/elasticsearch-serverless/api/msearch.rb

@@ -24,10 +24,12 @@ module ElasticsearchServerless
       # Run multiple searches.
       # The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.
       # The structure is as follows:
-      #   header
-      #   body
-      #   header
-      #   body
+      # +
+      # header\n
+      # body\n
+      # header\n
+      # body\n
+      # +
       # This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.
       # IMPORTANT: The final line of data must end with a newline character +\n+.
       # Each newline character may be preceded by a carriage return +\r+.
@@ -55,14 +57,13 @@ module ElasticsearchServerless
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body searches
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch
       #
       def msearch(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "msearch" }
+        request_opts = { endpoint: arguments[:endpoint] || 'msearch' }
 
-        defined_params = [:index].inject({}) do |set_variables, variable|
+        defined_params = [:index].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -79,31 +80,29 @@ module ElasticsearchServerless
         path   = if _index
                    "#{Utils.listify(_index)}/_msearch"
                  else
-                   "_msearch"
+                   '_msearch'
                  end
         params = Utils.process_params(arguments)
 
-        case
-        when body.is_a?(Array) && body.any? { |d| d.has_key? :search }
-          payload = body.inject([]) do |sum, item|
+        if body.is_a?(Array) && body.any? { |d| d.key? :search }
+          payload = body.each_with_object([]) do |item, sum|
             meta = item
             data = meta.delete(:search)
 
             sum << meta
             sum << data
-            sum
           end.map { |item| ElasticsearchServerless::API.serializer.dump(item) }
-          payload << "" unless payload.empty?
+          payload << '' unless payload.empty?
           payload = payload.join("\n")
-        when body.is_a?(Array)
+        elsif body.is_a?(Array)
           payload = body.map { |d| d.is_a?(String) ? d : ElasticsearchServerless::API.serializer.dump(d) }
-          payload << "" unless payload.empty?
+          payload << '' unless payload.empty?
           payload = payload.join("\n")
         else
           payload = body
         end
 
-        headers.merge!("Content-Type" => "application/x-ndjson")
+        headers.merge!('Content-Type' => 'application/x-ndjson')
         ElasticsearchServerless::API::Response.new(
           perform_request(method, path, params, payload, headers, request_opts)
         )

data/lib/elasticsearch-serverless/api/msearch_template.rb

@@ -22,28 +22,37 @@ module ElasticsearchServerless
   module API
     module Actions
       # Run multiple templated searches.
+      # Run multiple templated searches with a single request.
+      # If you are providing a text file or text input to +curl+, use the +--data-binary+ flag instead of +-d+ to preserve newlines.
+      # For example:
+      # +
+      # $ cat requests
+      # { "index": "my-index" }
+      # { "id": "my-search-template", "params": { "query_string": "hello world", "from": 0, "size": 10 }}
+      # { "index": "my-other-index" }
+      # { "id": "my-other-search-template", "params": { "query_type": "match_all" }}
+      # $ curl -H "Content-Type: application/x-ndjson" -XGET localhost:9200/_msearch/template --data-binary "@requests"; echo
+      # +
       #
-      # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases to search.
-      #  Supports wildcards (+*+).
+      # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to search.
+      #  It supports wildcards (+*+).
       #  To search all data streams and indices, omit this parameter or use +*+.
       # @option arguments [Boolean] :ccs_minimize_roundtrips If +true+, network round-trips are minimized for cross-cluster search requests. Server default: true.
-      # @option arguments [Integer] :max_concurrent_searches Maximum number of concurrent searches the API can run.
+      # @option arguments [Integer] :max_concurrent_searches The maximum number of concurrent searches the API can run.
       # @option arguments [String] :search_type The type of the search operation.
-      #  Available options: +query_then_fetch+, +dfs_query_then_fetch+.
       # @option arguments [Boolean] :rest_total_hits_as_int If +true+, the response returns +hits.total+ as an integer.
       #  If +false+, it returns +hits.total+ as an object.
       # @option arguments [Boolean] :typed_keys If +true+, the response prefixes aggregation and suggester names with their respective types.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body search_templates
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch-template
       #
       def msearch_template(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "msearch_template" }
+        request_opts = { endpoint: arguments[:endpoint] || 'msearch_template' }
 
-        defined_params = [:index].inject({}) do |set_variables, variable|
+        defined_params = [:index].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -60,21 +69,19 @@ module ElasticsearchServerless
         path   = if _index
                    "#{Utils.listify(_index)}/_msearch/template"
                  else
-                   "_msearch/template"
+                   '_msearch/template'
                  end
         params = Utils.process_params(arguments)
 
-        case
-        when body.is_a?(Array)
+        if body.is_a?(Array)
           payload = body.map { |d| d.is_a?(String) ? d : ElasticsearchServerless::API.serializer.dump(d) }
-          payload << "" unless payload.empty?
-          payload = payload.join("
-")
+          payload << '' unless payload.empty?
+          payload = payload.join("\n")
         else
           payload = body
         end
 
-        headers.merge!("Content-Type" => "application/x-ndjson")
+        headers.merge!('Content-Type' => 'application/x-ndjson')
         ElasticsearchServerless::API::Response.new(
           perform_request(method, path, params, payload, headers, request_opts)
         )

data/lib/elasticsearch-serverless/api/mtermvectors.rb

@@ -22,37 +22,40 @@ module ElasticsearchServerless
   module API
     module Actions
       # Get multiple term vectors.
+      # Get multiple term vectors with a single request.
       # You can specify existing documents by index and ID or provide artificial documents in the body of the request.
       # You can specify the index in the request body or request URI.
       # The response contains a +docs+ array with all the fetched termvectors.
       # Each element has the structure provided by the termvectors API.
+      # **Artificial documents**
+      # You can also use +mtermvectors+ to generate term vectors for artificial documents provided in the body of the request.
+      # The mapping used is determined by the specified +_index+.
       #
-      # @option arguments [String] :index Name of the index that contains the documents.
+      # @option arguments [String] :index The name of the index that contains the documents.
       # @option arguments [Array<String>] :ids A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
-      # @option arguments [String, Array<String>] :fields Comma-separated list or wildcard expressions of fields to include in the statistics.
-      #  Used as the default list unless a specific field list is provided in the +completion_fields+ or +fielddata_fields+ parameters.
+      # @option arguments [String, Array<String>] :fields A comma-separated list or wildcard expressions of fields to include in the statistics.
+      #  It is used as the default list unless a specific field list is provided in the +completion_fields+ or +fielddata_fields+ parameters.
       # @option arguments [Boolean] :field_statistics If +true+, the response includes the document count, sum of document frequencies, and sum of total term frequencies. Server default: true.
       # @option arguments [Boolean] :offsets If +true+, the response includes term offsets. Server default: true.
       # @option arguments [Boolean] :payloads If +true+, the response includes term payloads. Server default: true.
       # @option arguments [Boolean] :positions If +true+, the response includes term positions. Server default: true.
-      # @option arguments [String] :preference Specifies the node or shard the operation should be performed on.
-      #  Random by default.
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  It is random by default.
       # @option arguments [Boolean] :realtime If true, the request is real-time as opposed to near-real-time. Server default: true.
-      # @option arguments [String] :routing Custom value used to route operations to a specific shard.
+      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
       # @option arguments [Boolean] :term_statistics If true, the response includes term frequency and document frequency.
       # @option arguments [Integer] :version If +true+, returns the document version as part of a hit.
-      # @option arguments [String] :version_type Specific version type.
+      # @option arguments [String] :version_type The version type.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mtermvectors
       #
       def mtermvectors(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "mtermvectors" }
+        request_opts = { endpoint: arguments[:endpoint] || 'mtermvectors' }
 
-        defined_params = [:index].inject({}) do |set_variables, variable|
+        defined_params = [:index].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -72,7 +75,7 @@ module ElasticsearchServerless
         path   = if _index
                    "#{Utils.listify(_index)}/_mtermvectors"
                  else
-                   "_mtermvectors"
+                   '_mtermvectors'
                  end
         params = Utils.process_params(arguments)
 

data/lib/elasticsearch-serverless/api/open_point_in_time.rb

@@ -29,30 +29,47 @@ module ElasticsearchServerless
       # +search_after+ requests, then the results of those requests might not be consistent as changes happening
       # between searches are only visible to the more recent point in time.
       # A point in time must be opened explicitly before being used in search requests.
-      # The +keep_alive+ parameter tells Elasticsearch how long it should persist.
+      # A subsequent search request with the +pit+ parameter must not specify +index+, +routing+, or +preference+ values as these parameters are copied from the point in time.
+      # Just like regular searches, you can use +from+ and +size+ to page through point in time search results, up to the first 10,000 hits.
+      # If you want to retrieve more hits, use PIT with +search_after+.
+      # IMPORTANT: The open point in time request and each subsequent search request can return different identifiers; always use the most recently received ID for the next search request.
+      # When a PIT that contains shard failures is used in a search request, the missing are always reported in the search response as a +NoShardAvailableActionException+ exception.
+      # To get rid of these exceptions, a new PIT needs to be created so that shards missing from the previous PIT can be handled, assuming they become available in the meantime.
+      # **Keeping point in time alive**
+      # The +keep_alive+ parameter, which is passed to a open point in time request and search request, extends the time to live of the corresponding point in time.
+      # The value does not need to be long enough to process all data — it just needs to be long enough for the next request.
+      # Normally, the background merge process optimizes the index by merging together smaller segments to create new, bigger segments.
+      # Once the smaller segments are no longer needed they are deleted.
+      # However, open point-in-times prevent the old segments from being deleted since they are still in use.
+      # TIP: Keeping older segments alive means that more disk space and file handles are needed.
+      # Ensure that you have configured your nodes to have ample free file handles.
+      # Additionally, if a segment contains deleted or updated documents then the point in time must keep track of whether each document in the segment was live at the time of the initial search request.
+      # Ensure that your nodes have sufficient heap space if you have many open point-in-times on an index that is subject to ongoing deletes or updates.
+      # Note that a point-in-time doesn't prevent its associated indices from being deleted.
+      # You can check how many point-in-times (that is, search contexts) are open with the nodes stats API.
       #
       # @option arguments [String, Array] :index A comma-separated list of index names to open point in time; use +_all+ or empty string to perform the operation on all indices (*Required*)
-      # @option arguments [Time] :keep_alive Extends the time to live of the corresponding point in time. (*Required*)
+      # @option arguments [Time] :keep_alive Extend the length of time that the point in time persists. (*Required*)
       # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
-      # @option arguments [String] :preference Specifies the node or shard the operation should be performed on.
-      #  Random by default.
-      # @option arguments [String] :routing Custom value used to route operations to a specific shard.
-      # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  By default, it is random.
+      # @option arguments [String] :routing A custom value that is used to route operations to a specific shard.
+      # @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
       #  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
-      #  Supports comma-separated values, such as +open,hidden+. Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
-      # @option arguments [Boolean] :allow_partial_search_results If +false+, creating a point in time request when a shard is missing or unavailable will throw an exception.
+      #  It supports comma-separated values, such as +open,hidden+. Valid values are: +all+, +open+, +closed+, +hidden+, +none+. Server default: open.
+      # @option arguments [Boolean] :allow_partial_search_results Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT.
+      #  If +false+, creating a point in time request when a shard is missing or unavailable will throw an exception.
       #  If +true+, the point in time will contain all the shards that are available at the time of the request.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time
       #
       def open_point_in_time(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "open_point_in_time" }
+        request_opts = { endpoint: arguments[:endpoint] || 'open_point_in_time' }
 
-        defined_params = [:index].inject({}) do |set_variables, variable|
+        defined_params = [:index].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/ping.rb

@@ -22,14 +22,14 @@ module ElasticsearchServerless
   module API
     module Actions
       # Ping the cluster.
-      # Returns whether the cluster is running.
+      # Get information about whether the cluster is running.
       #
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cluster
       #
       def ping(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "ping" }
+        request_opts = { endpoint: arguments[:endpoint] || 'ping' }
 
         arguments = arguments.clone
         headers = arguments.delete(:headers) || {}
@@ -37,17 +37,15 @@ module ElasticsearchServerless
         body = nil
 
         method = ElasticsearchServerless::API::HTTP_HEAD
-        path   = ""
+        path   = ''
         params = {}
 
         begin
-          perform_request(method, path, params, body, headers, request_opts).status == 200 ? true : false
+          perform_request(method, path, params, body, headers, request_opts).status == 200
         rescue Exception => e
-          if e.class.to_s =~ /NotFound|ConnectionFailed/ || e.message =~ /Not *Found|404|ConnectionFailed/i
-            false
-          else
-            raise e
-          end
+          raise e unless e.class.to_s =~ /NotFound|ConnectionFailed/ || e.message =~ /Not *Found|404|ConnectionFailed/i
+
+          false
         end
       end
     end