elasticsearch-serverless 0.5.0 → 0.7.0

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

@@ -22,34 +22,57 @@ module ElasticsearchServerless
   module API
     module Actions
       # Get term vector information.
-      # Returns information and statistics about terms in the fields of a particular document.
+      # Get information and statistics about terms in the fields of a particular document.
+      # You can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.
+      # You can specify the fields you are interested in through the +fields+ parameter or by adding the fields to the request body.
+      # For example:
+      # +
+      # GET /my-index-000001/_termvectors/1?fields=message
+      # +
+      # Fields can be specified using wildcards, similar to the multi match query.
+      # Term vectors are real-time by default, not near real-time.
+      # This can be changed by setting +realtime+ parameter to +false+.
+      # You can request three types of values: _term information_, _term statistics_, and _field statistics_.
+      # By default, all term information and field statistics are returned for all fields but term statistics are excluded.
+      # **Term information**
+      # * term frequency in the field (always returned)
+      # * term positions (+positions: true+)
+      # * start and end offsets (+offsets: true+)
+      # * term payloads (+payloads: true+), as base64 encoded bytes
+      # If the requested information wasn't stored in the index, it will be computed on the fly if possible.
+      # Additionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.
       #
-      # @option arguments [String] :index Name of the index that contains the document. (*Required*)
-      # @option arguments [String] :id Unique identifier of the document.
-      # @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 [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 [String] :index The name of the index that contains the document. (*Required*)
+      # @option arguments [String] :id A unique identifier for the document.
+      # @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 (how many documents contain this field).
+      #  - The sum of document frequencies (the sum of document frequencies for all terms in this field).
+      #  - The sum of total term frequencies (the sum of total term frequencies of each term in this field). 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 [Boolean] :term_statistics If +true+, the response includes term frequency and document frequency.
+      # @option arguments [String] :routing A custom value that is used to route operations to a specific shard.
+      # @option arguments [Boolean] :term_statistics If +true+, the response includes:
+      #  - The total term frequency (how often a term occurs in all documents).
+      #  - The document frequency (the number of documents containing the current term).
+      #  By default these values are not returned since term statistics can have a serious performance impact.
       # @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-termvectors.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-termvectors
       #
       def termvectors(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "termvectors" }
+        request_opts = { endpoint: arguments[:endpoint] || 'termvectors' }
 
-        defined_params = [:index, :id].inject({}) do |set_variables, variable|
+        defined_params = [:index, :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?
 
@@ -86,8 +109,8 @@ module ElasticsearchServerless
       # Deprecated: Use the plural version, {#termvectors}
       #
       def termvector(arguments = {})
-        warn "[DEPRECATION] `termvector` is deprecated. Please use the plural version, `termvectors` instead."
-        termvectors(arguments.merge endpoint: '_termvector')
+        warn '[DEPRECATION] `termvector` is deprecated. Please use the plural version, `termvectors` instead.'
+        termvectors(arguments.merge(endpoint: '_termvector'))
       end
     end
   end

data/lib/elasticsearch-serverless/api/transform/delete_transform.rb

@@ -23,7 +23,6 @@ module ElasticsearchServerless
     module Transform
       module Actions
         # Delete a transform.
-        # Deletes a transform.
         #
         # @option arguments [String] :transform_id Identifier for the transform. (*Required*)
         # @option arguments [Boolean] :force If this value is false, the transform must be stopped before it can be deleted. If true, the transform is
@@ -33,14 +32,13 @@ module ElasticsearchServerless
         # @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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-delete-transform
         #
         def delete_transform(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "transform.delete_transform" }
+          request_opts = { endpoint: arguments[:endpoint] || 'transform.delete_transform' }
 
-          defined_params = [:transform_id].inject({}) do |set_variables, variable|
+          defined_params = [:transform_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/transform/get_transform.rb

@@ -23,7 +23,7 @@ module ElasticsearchServerless
     module Transform
       module Actions
         # Get transforms.
-        # Retrieves configuration information for transforms.
+        # Get configuration information for transforms.
         #
         # @option arguments [String, Array<String>] :transform_id Identifier for the transform. It can be a transform identifier or a
         #  wildcard expression. You can get information for all transforms by using
@@ -42,14 +42,13 @@ module ElasticsearchServerless
         #  be retrieved and then added to another cluster.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform
         #
         def get_transform(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "transform.get_transform" }
+          request_opts = { endpoint: arguments[:endpoint] || 'transform.get_transform' }
 
-          defined_params = [:transform_id].inject({}) do |set_variables, variable|
+          defined_params = [:transform_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 +63,7 @@ module ElasticsearchServerless
           path   = if _transform_id
                      "_transform/#{Utils.listify(_transform_id)}"
                    else
-                     "_transform"
+                     '_transform'
                    end
           params = Utils.process_params(arguments)
 

data/lib/elasticsearch-serverless/api/transform/get_transform_stats.rb

@@ -23,7 +23,7 @@ module ElasticsearchServerless
     module Transform
       module Actions
         # Get transform stats.
-        # Retrieves usage information for transforms.
+        # Get usage information for transforms.
         #
         # @option arguments [String, Array<String>] :transform_id Identifier for the transform. It can be a transform identifier or a
         #  wildcard expression. You can get information for all transforms by using
@@ -40,14 +40,13 @@ module ElasticsearchServerless
         # @option arguments [Time] :timeout Controls the time to wait for the stats
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform-stats
         #
         def get_transform_stats(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "transform.get_transform_stats" }
+          request_opts = { endpoint: arguments[:endpoint] || 'transform.get_transform_stats' }
 
-          defined_params = [:transform_id].inject({}) do |set_variables, variable|
+          defined_params = [:transform_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/transform/preview_transform.rb

@@ -35,14 +35,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/preview-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-preview-transform
         #
         def preview_transform(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "transform.preview_transform" }
+          request_opts = { endpoint: arguments[:endpoint] || 'transform.preview_transform' }
 
-          defined_params = [:transform_id].inject({}) do |set_variables, variable|
+          defined_params = [:transform_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?
 
@@ -62,7 +61,7 @@ module ElasticsearchServerless
           path   = if _transform_id
                      "_transform/#{Utils.listify(_transform_id)}/_preview"
                    else
-                     "_transform/_preview"
+                     '_transform/_preview'
                    end
           params = Utils.process_params(arguments)
 

data/lib/elasticsearch-serverless/api/transform/put_transform.rb

@@ -52,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/current/put-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-put-transform
         #
         def put_transform(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "transform.put_transform" }
+          request_opts = { endpoint: arguments[:endpoint] || 'transform.put_transform' }
 
-          defined_params = [:transform_id].inject({}) do |set_variables, variable|
+          defined_params = [:transform_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/transform/reset_transform.rb

@@ -23,7 +23,6 @@ module ElasticsearchServerless
     module Transform
       module Actions
         # Reset a transform.
-        # Resets a transform.
         # Before you can reset it, you must stop it; alternatively, use the +force+ query parameter.
         # If the destination index was created by the transform, it is deleted.
         #
@@ -31,16 +30,16 @@ module ElasticsearchServerless
         #  hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. (*Required*)
         # @option arguments [Boolean] :force If this value is +true+, the transform is reset regardless of its current state. If it's +false+, the transform
         #  must be stopped before it can be reset.
+        # @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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-reset-transform
         #
         def reset_transform(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "transform.reset_transform" }
+          request_opts = { endpoint: arguments[:endpoint] || 'transform.reset_transform' }
 
-          defined_params = [:transform_id].inject({}) do |set_variables, variable|
+          defined_params = [:transform_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/transform/schedule_now_transform.rb

@@ -23,24 +23,23 @@ module ElasticsearchServerless
     module Transform
       module Actions
         # Schedule a transform to start now.
-        # Instantly runs a transform to process data.
-        # If you _schedule_now a transform, it will process the new data instantly,
-        # without waiting for the configured frequency interval. After _schedule_now API is called,
-        # the transform will be processed again at now + frequency unless _schedule_now API
+        # Instantly run a transform to process data.
+        # If you run this API, the transform will process the new data instantly,
+        # without waiting for the configured frequency interval. After the API is called,
+        # the transform will be processed again at +now + frequency+ unless the API
         # is called again in the meantime.
         #
         # @option arguments [String] :transform_id Identifier for the transform. (*Required*)
         # @option arguments [Time] :timeout Controls the time to wait for the scheduling to take place Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-schedule-now-transform
         #
         def schedule_now_transform(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "transform.schedule_now_transform" }
+          request_opts = { endpoint: arguments[:endpoint] || 'transform.schedule_now_transform' }
 
-          defined_params = [:transform_id].inject({}) do |set_variables, variable|
+          defined_params = [:transform_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/transform/start_transform.rb

@@ -23,7 +23,6 @@ module ElasticsearchServerless
     module Transform
       module Actions
         # Start a transform.
-        # Starts a transform.
         # When you start a transform, it creates the destination index if it does not already exist. The +number_of_shards+ is
         # set to +1+ and the +auto_expand_replicas+ is set to +0-1+. If it is a pivot transform, it deduces the mapping
         # definitions for the destination index from the source indices and the transform aggregations. If fields in the
@@ -43,14 +42,13 @@ module ElasticsearchServerless
         # @option arguments [String] :from Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-start-transform
         #
         def start_transform(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "transform.start_transform" }
+          request_opts = { endpoint: arguments[:endpoint] || 'transform.start_transform' }
 
-          defined_params = [:transform_id].inject({}) do |set_variables, variable|
+          defined_params = [:transform_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/transform/stop_transform.rb

@@ -41,14 +41,13 @@ module ElasticsearchServerless
         #  immediately and the indexer is stopped asynchronously in the background.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-stop-transform
         #
         def stop_transform(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "transform.stop_transform" }
+          request_opts = { endpoint: arguments[:endpoint] || 'transform.stop_transform' }
 
-          defined_params = [:transform_id].inject({}) do |set_variables, variable|
+          defined_params = [:transform_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/transform/update_transform.rb

@@ -39,14 +39,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-transform.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-update-transform
         #
         def update_transform(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "transform.update_transform" }
+          request_opts = { endpoint: arguments[:endpoint] || 'transform.update_transform' }
 
-          defined_params = [:transform_id].inject({}) do |set_variables, variable|
+          defined_params = [:transform_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/update.rb

@@ -22,40 +22,52 @@ module ElasticsearchServerless
   module API
     module Actions
       # Update a document.
-      # Updates a document by running a script or passing a partial document.
+      # Update a document by running a script or passing a partial document.
+      # If the Elasticsearch security features are enabled, you must have the +index+ or +write+ index privilege for the target index or index alias.
+      # The script can update, delete, or skip modifying the document.
+      # The API also supports passing a partial document, which is merged into the existing document.
+      # To fully replace an existing document, use the index API.
+      # This operation:
+      # * Gets the document (collocated with the shard) from the index.
+      # * Runs the specified script.
+      # * Indexes the result.
+      # The document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation.
+      # The +_source+ field must be enabled to use this API.
+      # In addition to +_source+, you can access the following variables through the +ctx+ map: +_index+, +_type+, +_id+, +_version+, +_routing+, and +_now+ (the current timestamp).
       #
-      # @option arguments [String] :id Document ID (*Required*)
-      # @option arguments [String] :index The name of the index (*Required*)
+      # @option arguments [String] :id A unique identifier for the document to be updated. (*Required*)
+      # @option arguments [String] :index The name of the target index.
+      #  By default, the index is created automatically if it doesn't exist. (*Required*)
       # @option arguments [Integer] :if_primary_term Only perform the operation if the document has this primary term.
       # @option arguments [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
+      # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Server default: true.
       # @option arguments [String] :lang The script language. Server default: painless.
-      # @option arguments [String] :refresh If 'true', Elasticsearch refreshes the affected shards to make this operation
-      #  visible to search, if 'wait_for' then wait for a refresh to make this operation
-      #  visible to search, if 'false' do nothing with refreshes. Server default: false.
-      # @option arguments [Boolean] :require_alias If true, the destination must be an index alias.
-      # @option arguments [Integer] :retry_on_conflict Specify how many times should the operation be retried when a conflict occurs. Server default: 0.
-      # @option arguments [String] :routing Custom value used to route operations to a specific shard.
-      # @option arguments [Time] :timeout Period to wait for dynamic mapping updates and active shards.
-      #  This guarantees Elasticsearch waits for at least the timeout before failing.
+      # @option arguments [String] :refresh If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.
+      #  If 'wait_for', it waits for a refresh to make this operation visible to search.
+      #  If 'false', it does nothing with refreshes. Server default: false.
+      # @option arguments [Boolean] :require_alias If +true+, the destination must be an index alias.
+      # @option arguments [Integer] :retry_on_conflict The number of times the operation should be retried when a conflict occurs. Server default: 0.
+      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
+      # @option arguments [Time] :timeout The period to wait for the following operations: dynamic mapping updates and waiting for active shards.
+      #  Elasticsearch waits for at least the timeout period before failing.
       #  The actual wait time could be longer, particularly when multiple waits occur. Server default: 1m.
-      # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operations.
-      #  Set to 'all' or any positive integer up to the total number of shards in the index
-      #  (number_of_replicas+1). Defaults to 1 meaning the primary shard. Server default: 1.
-      # @option arguments [Boolean, String, Array<String>] :_source Set to false to disable source retrieval. You can also specify a comma-separated
-      #  list of the fields you want to retrieve. Server default: true.
-      # @option arguments [String, Array<String>] :_source_excludes Specify the source fields you want to exclude.
-      # @option arguments [String, Array<String>] :_source_includes Specify the source fields you want to retrieve.
+      # @option arguments [Integer, String] :wait_for_active_shards The number of copies of each shard that must be active before proceeding with the operation.
+      #  Set to 'all' or any positive integer up to the total number of shards in the index (+number_of_replicas++1).
+      #  The default value of +1+ means it waits for each primary shard to be active. Server default: 1.
+      # @option arguments [Boolean, String, Array<String>] :_source If +false+, source retrieval is turned off.
+      #  You can also specify a comma-separated list of the fields you want to retrieve. Server default: true.
+      # @option arguments [String, Array<String>] :_source_excludes The source fields you want to exclude.
+      # @option arguments [String, Array<String>] :_source_includes The source fields you want to retrieve.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update
       #
       def update(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "update" }
+        request_opts = { endpoint: arguments[:endpoint] || 'update' }
 
-        defined_params = [:index, :id].inject({}) do |set_variables, variable|
+        defined_params = [:index, :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?
 
@@ -77,11 +89,11 @@ module ElasticsearchServerless
         params = Utils.process_params(arguments)
 
         if Array(arguments[:ignore]).include?(404)
-          Utils.rescue_from_not_found {
+          Utils.rescue_from_not_found do
             ElasticsearchServerless::API::Response.new(
               perform_request(method, path, params, body, headers, request_opts)
             )
-          }
+          end
         else
           ElasticsearchServerless::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)