elasticsearch-serverless 0.6.0 → 0.7.0

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

@@ -25,98 +25,107 @@ module ElasticsearchServerless
       # Get search hits that match the query defined in the request.
       # You can provide search queries using the +q+ query string parameter or the request body.
       # If both are specified, only the query parameter is used.
+      # If the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges.
+      # To search a point in time (PIT) for an alias, you must have the +read+ index privilege for the alias's data streams or indices.
+      # **Search slicing**
+      # When paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the +slice+ and +pit+ properties.
+      # By default the splitting is done first on the shards, then locally on each shard.
+      # The local splitting partitions the shard into contiguous ranges based on Lucene document IDs.
+      # For instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.
+      # IMPORTANT: The same point-in-time ID should be used for all slices.
+      # If different PIT IDs are used, slices can overlap and miss documents.
+      # This situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.
       #
-      # @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 +*+ or +_all+.
       # @option arguments [Boolean] :allow_no_indices If +false+, the request returns an error if any wildcard expression, index alias, or +_all+ value targets only missing or closed indices.
       #  This behavior applies even if the request targets other open indices.
       #  For example, a request targeting +foo*,bar*+ returns an error if an index starts with +foo+ but no index starts with +bar+. Server default: true.
-      # @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. Server default: true.
-      # @option arguments [String] :analyzer Analyzer to use for the query string.
-      #  This parameter can only be used when the q query string parameter is specified.
-      # @option arguments [Boolean] :analyze_wildcard If true, wildcard and prefix queries are analyzed.
-      #  This parameter can only be used when the q query string parameter is specified.
+      # @option arguments [Boolean] :allow_partial_search_results If +true+ and there are shard request timeouts or shard failures, the request returns partial results.
+      #  If +false+, it returns an error with no partial results.To override the default behavior, you can set the +search.default_allow_partial_results+ cluster setting to +false+. Server default: true.
+      # @option arguments [String] :analyzer The analyzer to use for the query string.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
+      # @option arguments [Boolean] :analyze_wildcard If +true+, wildcard and prefix queries are analyzed.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
       # @option arguments [Integer] :batched_reduce_size The number of shard results that should be reduced at once on the coordinating node.
-      #  This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. Server default: 512.
-      # @option arguments [Boolean] :ccs_minimize_roundtrips If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. Server default: true.
-      # @option arguments [String] :default_operator The default operator for query string query: AND or OR.
-      #  This parameter can only be used when the +q+ query string parameter is specified. Server default: OR.
-      # @option arguments [String] :df Field to use as default where no field prefix is given in the query string.
-      #  This parameter can only be used when the q query string parameter is specified.
-      # @option arguments [String, Array<String>] :docvalue_fields A comma-separated list of fields to return as the docvalue representation for each hit.
-      # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
+      #  If the potential number of shards in the request can be large, this value should be used as a protection mechanism to reduce the memory overhead per search request. Server default: 512.
+      # @option arguments [Boolean] :ccs_minimize_roundtrips If +true+, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests. Server default: true.
+      # @option arguments [String] :default_operator The default operator for the query string query: +AND+ or +OR+.
+      #  This parameter can be used only when the +q+ query string parameter is specified. Server default: OR.
+      # @option arguments [String] :df The field to use as a default when no field prefix is given in the query string.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
+      # @option arguments [String, Array<String>] :docvalue_fields A comma-separated list of fields to return as the docvalue representation of a field for each hit.
+      # @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+.
-      # @option arguments [Boolean] :explain If +true+, returns detailed information about score computation as part of a hit.
+      #  It supports comma-separated values such as +open,hidden+. Server default: open.
+      # @option arguments [Boolean] :explain If +true+, the request returns detailed information about score computation as part of a hit.
       # @option arguments [Boolean] :ignore_throttled If +true+, concrete, expanded or aliased indices will be ignored when frozen. Server default: true.
       # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
-      # @option arguments [Boolean] :include_named_queries_score Indicates whether hit.matched_queries should be rendered as a map that includes
-      #  the name of the matched query associated with its score (true)
-      #  or as an array containing the name of the matched queries (false)
-      #  This functionality reruns each named query on every hit in a search response.
+      # @option arguments [Boolean] :include_named_queries_score If +true+, the response includes the score contribution from any named queries.This functionality reruns each named query on every hit in a search response.
       #  Typically, this adds a small overhead to a request.
       #  However, using computationally expensive named queries on a large number of hits may add significant overhead.
       # @option arguments [Boolean] :lenient If +true+, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
-      #  This parameter can only be used when the +q+ query string parameter is specified.
-      # @option arguments [Integer] :max_concurrent_shard_requests Defines the number of concurrent shard requests per node this search executes concurrently.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
+      # @option arguments [Integer] :max_concurrent_shard_requests The number of concurrent shard requests per node that the search runs concurrently.
       #  This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. Server default: 5.
-      # @option arguments [String] :preference Nodes and shards used for the search.
-      #  By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are:
-      #  +_only_local+ to run the search only on shards on the local node;
-      #  +_local+ to, if possible, run the search on shards on the local node, or if not, select shards using the default method;
-      #  +_only_nodes:<node-id>,<node-id>+ to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method;
-      #  +_prefer_nodes:<node-id>,<node-id>+ to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method;
-      #  +_shards:<shard>,<shard>+ to run the search only on the specified shards;
+      # @option arguments [String] :preference The nodes and shards used for the search.
+      #  By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness.
+      #  Valid values are:
+      #  - +_only_local+ to run the search only on shards on the local node.
+      #  - +_local+ to, if possible, run the search on shards on the local node, or if not, select shards using the default method.
+      #  - +_only_nodes:<node-id>,<node-id>+ to run the search on only the specified nodes IDs. If suitable shards exist on more than one selected node, use shards on those nodes using the default method. If none of the specified nodes are available, select shards from any available node using the default method.
+      #  - +_prefer_nodes:<node-id>,<node-id>+ to if possible, run the search on the specified nodes IDs. If not, select shards using the default method.
+      #  +_shards:<shard>,<shard>+ to run the search only on the specified shards. You can combine this value with other +preference+ values. However, the +_shards+ value must come first. For example: +_shards:2,3|_local+.
       #  +<custom-string>+ (any string that does not start with +_+) to route searches with the same +<custom-string>+ to the same shards in the same order.
-      # @option arguments [Integer] :pre_filter_shard_size Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold.
+      # @option arguments [Integer] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold.
       #  This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint).
       #  When unspecified, the pre-filter phase is executed if any of these conditions is met:
-      #  the request targets more than 128 shards;
-      #  the request targets one or more read-only index;
-      #  the primary sort of the query targets an indexed field.
+      #  - The request targets more than 128 shards.
+      #  - The request targets one or more read-only index.
+      #  - The primary sort of the query targets an indexed field.
       # @option arguments [Boolean] :request_cache If +true+, the caching of search results is enabled for requests where +size+ is +0+.
-      #  Defaults to index level settings.
-      # @option arguments [String] :routing Custom value used to route operations to a specific shard.
-      # @option arguments [Time] :scroll Period to retain the search context for scrolling. See Scroll search results.
+      #  It defaults to index level settings.
+      # @option arguments [String] :routing A custom value that is used to route operations to a specific shard.
+      # @option arguments [Time] :scroll The period to retain the search context for scrolling.
       #  By default, this value cannot exceed +1d+ (24 hours).
-      #  You can change this limit using the +search.max_keep_alive+ cluster-level setting.
-      # @option arguments [String] :search_type How distributed term frequencies are calculated for relevance scoring.
+      #  You can change this limit by using the +search.max_keep_alive+ cluster-level setting.
+      # @option arguments [String] :search_type Indicates how distributed term frequencies are calculated for relevance scoring.
       # @option arguments [Array<String>] :stats Specific +tag+ of the request for logging and statistical purposes.
       # @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit.
       #  If no fields are specified, no stored fields are included in the response.
       #  If this field is specified, the +_source+ parameter defaults to +false+.
       #  You can pass +_source: true+ to return both source fields and stored fields in the search response.
-      # @option arguments [String] :suggest_field Specifies which field to use for suggestions.
-      # @option arguments [String] :suggest_mode Specifies the suggest mode.
-      #  This parameter can only be used when the +suggest_field+ and +suggest_text+ query string parameters are specified. Server default: missing.
-      # @option arguments [Integer] :suggest_size Number of suggestions to return.
-      #  This parameter can only be used when the +suggest_field+ and +suggest_text+ query string parameters are specified.
+      # @option arguments [String] :suggest_field The field to use for suggestions.
+      # @option arguments [String] :suggest_mode The suggest mode.
+      #  This parameter can be used only when the +suggest_field+ and +suggest_text+ query string parameters are specified. Server default: missing.
+      # @option arguments [Integer] :suggest_size The number of suggestions to return.
+      #  This parameter can be used only when the +suggest_field+ and +suggest_text+ query string parameters are specified.
       # @option arguments [String] :suggest_text The source text for which the suggestions should be returned.
-      #  This parameter can only be used when the +suggest_field+ and +suggest_text+ query string parameters are specified.
-      # @option arguments [Integer] :terminate_after Maximum number of documents to collect for each shard.
+      #  This parameter can be used only when the +suggest_field+ and +suggest_text+ query string parameters are specified.
+      # @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard.
       #  If a query reaches this limit, Elasticsearch terminates the query early.
-      #  Elasticsearch collects documents before sorting.
-      #  Use with caution.
+      #  Elasticsearch collects documents before sorting.IMPORTANT: Use with caution.
       #  Elasticsearch applies this parameter to each shard handling the request.
       #  When possible, let Elasticsearch perform early termination automatically.
       #  Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
       #  If set to +0+ (default), the query does not terminate early. Server default: 0.
-      # @option arguments [Time] :timeout Specifies the period of time to wait for a response from each shard.
+      # @option arguments [Time] :timeout The period of time to wait for a response from each shard.
       #  If no response is received before the timeout expires, the request fails and returns an error.
-      # @option arguments [Boolean, Integer] :track_total_hits Number of hits matching the query to count accurately.
+      #  It defaults to no timeout.
+      # @option arguments [Boolean, Integer] :track_total_hits The number of hits matching the query to count accurately.
       #  If +true+, the exact number of hits is returned at the cost of some performance.
       #  If +false+, the response does not include the total number of hits matching the query. Server default: 10000.
-      # @option arguments [Boolean] :track_scores If +true+, calculate and return document scores, even if the scores are not used for sorting.
-      # @option arguments [Boolean] :typed_keys If +true+, aggregation and suggester names are be prefixed by their respective types in the response. Server default: true.
+      # @option arguments [Boolean] :track_scores If +true+, the request calculates and returns document scores, even if the scores are not used for sorting.
+      # @option arguments [Boolean] :typed_keys If +true+, aggregation and suggester names are be prefixed by their respective types in the response.
       # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether +hits.total+ should be rendered as an integer or an object in the rest search response.
-      # @option arguments [Boolean] :version If +true+, returns document version as part of a hit.
-      # @option arguments [Boolean, String, Array<String>] :_source Indicates which source fields are returned for matching documents.
+      # @option arguments [Boolean] :version If +true+, the request returns the document version as part of a hit.
+      # @option arguments [Boolean, String, Array<String>] :_source The source fields that are returned for matching documents.
       #  These fields are returned in the +hits._source+ property of the search response.
       #  Valid values are:
-      #  +true+ to return the entire document source;
-      #  +false+ to not return the document source;
-      #  +<string>+ to return the source fields that are specified as a comma-separated list (supports wildcard (+*+) patterns). Server default: true.
+      #  - +true+ to return the entire document source.
+      #  - +false+ to not return the document source.
+      #  - +<string>+ to return the source fields that are specified as a comma-separated list that supports wildcard (+*+) patterns. Server default: true.
       # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
       #  You can also use this parameter to exclude fields from the subset specified in +_source_includes+ query parameter.
       #  If the +_source+ parameter is +false+, this parameter is ignored.
@@ -124,31 +133,30 @@ module ElasticsearchServerless
       #  If this parameter is specified, only these source fields are returned.
       #  You can exclude fields from this subset using the +_source_excludes+ query parameter.
       #  If the +_source+ parameter is +false+, this parameter is ignored.
-      # @option arguments [Boolean] :seq_no_primary_term If +true+, returns sequence number and primary term of the last modification of each hit.
-      # @option arguments [String] :q Query in the Lucene query string syntax using query parameter search.
-      #  Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.
-      # @option arguments [Integer] :size Defines the number of hits to return.
+      # @option arguments [Boolean] :seq_no_primary_term If +true+, the request returns the sequence number and primary term of the last modification of each hit.
+      # @option arguments [String] :q A query in the Lucene query string syntax.
+      #  Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.IMPORTANT: This parameter overrides the query parameter in the request body.
+      #  If both parameters are specified, documents matching the query request body parameter are not returned.
+      # @option arguments [Integer] :size The number of hits to return.
       #  By default, you cannot page through more than 10,000 hits using the +from+ and +size+ parameters.
       #  To page through more hits, use the +search_after+ parameter. Server default: 10.
-      # @option arguments [Integer] :from Starting document offset.
-      #  Needs to be non-negative.
+      # @option arguments [Integer] :from The starting document offset, which must be non-negative.
       #  By default, you cannot page through more than 10,000 hits using the +from+ and +size+ parameters.
       #  To page through more hits, use the +search_after+ parameter. Server default: 0.
-      # @option arguments [String] :sort A comma-separated list of <field>:<direction> pairs.
+      # @option arguments [String] :sort A comma-separated list of +<field>:<direction>+ pairs.
       # @option arguments [Boolean] :force_synthetic_source Should this request force synthetic _source?
       #  Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
       #  Fetches with this enabled will be slower the enabling synthetic source natively in the index.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search
       #
       def search(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "search" }
+        request_opts = { endpoint: arguments[:endpoint] || 'search' }
 
-        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?
 
@@ -168,7 +176,7 @@ module ElasticsearchServerless
         path   = if _index
                    "#{Utils.listify(_index)}/_search"
                  else
-                   "_search"
+                   '_search'
                  end
         params = Utils.process_params(arguments)
 

data/lib/elasticsearch-serverless/api/search_application/delete.rb

@@ -29,17 +29,16 @@ module ElasticsearchServerless
         # as-is with no warranties. Beta features are not subject to the support
         # SLA of official GA features.
         #
-        # @option arguments [String] :name The name of the search application to delete (*Required*)
+        # @option arguments [String] :name The name of the search application to delete. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete
         #
         def delete(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "search_application.delete" }
+          request_opts = { endpoint: arguments[:endpoint] || 'search_application.delete' }
 
-          defined_params = [:name].inject({}) do |set_variables, variable|
+          defined_params = [:name].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/search_application/delete_behavioral_analytics.rb

@@ -32,14 +32,13 @@ module ElasticsearchServerless
         # @option arguments [String] :name The name of the analytics collection to be deleted (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-analytics-collection.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete-behavioral-analytics
         #
         def delete_behavioral_analytics(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "search_application.delete_behavioral_analytics" }
+          request_opts = { endpoint: arguments[:endpoint] || 'search_application.delete_behavioral_analytics' }
 
-          defined_params = [:name].inject({}) do |set_variables, variable|
+          defined_params = [:name].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/search_application/get.rb

@@ -31,14 +31,13 @@ module ElasticsearchServerless
         # @option arguments [String] :name The name of the search application (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/get-search-application.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get
         #
         def get(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "search_application.get" }
+          request_opts = { endpoint: arguments[:endpoint] || 'search_application.get' }
 
-          defined_params = [:name].inject({}) do |set_variables, variable|
+          defined_params = [:name].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/search_application/get_behavioral_analytics.rb

@@ -31,14 +31,13 @@ module ElasticsearchServerless
         # @option arguments [Array<String>] :name A list of analytics collections to limit the returned information
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics
         #
         def get_behavioral_analytics(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "search_application.get_behavioral_analytics" }
+          request_opts = { endpoint: arguments[:endpoint] || 'search_application.get_behavioral_analytics' }
 
-          defined_params = [:name].inject({}) do |set_variables, variable|
+          defined_params = [:name].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?
 
@@ -53,7 +52,7 @@ module ElasticsearchServerless
           path   = if _name
                      "_application/analytics/#{Utils.listify(_name)}"
                    else
-                     "_application/analytics"
+                     '_application/analytics'
                    end
           params = {}
 

data/lib/elasticsearch-serverless/api/search_application/list.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module SearchApplication
       module Actions
-        # Returns the existing search applications.
+        # Get search applications.
+        # Get information about search applications.
         # This functionality is in Beta and is subject to change. The design and
         # code is less mature than official GA features and is being provided
         # as-is with no warranties. Beta features are not subject to the support
@@ -33,10 +34,10 @@ module ElasticsearchServerless
         # @option arguments [Integer] :size Specifies a max number of results to get.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/list-search-applications.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics
         #
         def list(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "search_application.list" }
+          request_opts = { endpoint: arguments[:endpoint] || 'search_application.list' }
 
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
@@ -44,7 +45,7 @@ module ElasticsearchServerless
           body = nil
 
           method = ElasticsearchServerless::API::HTTP_GET
-          path   = "_application/search_application"
+          path   = '_application/search_application'
           params = Utils.process_params(arguments)
 
           ElasticsearchServerless::API::Response.new(

data/lib/elasticsearch-serverless/api/search_application/put.rb

@@ -33,14 +33,13 @@ module ElasticsearchServerless
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body search_application
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put
         #
         def put(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "search_application.put" }
+          request_opts = { endpoint: arguments[:endpoint] || 'search_application.put' }
 
-          defined_params = [:name].inject({}) do |set_variables, variable|
+          defined_params = [:name].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/search_application/put_behavioral_analytics.rb

@@ -31,14 +31,13 @@ module ElasticsearchServerless
         # @option arguments [String] :name The name of the analytics collection to be created or updated. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/put-analytics-collection.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put-behavioral-analytics
         #
         def put_behavioral_analytics(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "search_application.put_behavioral_analytics" }
+          request_opts = { endpoint: arguments[:endpoint] || 'search_application.put_behavioral_analytics' }
 
-          defined_params = [:name].inject({}) do |set_variables, variable|
+          defined_params = [:name].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/search_application/search.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/master/search-application-search.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-search
         #
         def search(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "search_application.search" }
+          request_opts = { endpoint: arguments[:endpoint] || 'search_application.search' }
 
-          defined_params = [:name].inject({}) do |set_variables, variable|
+          defined_params = [:name].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/search_mvt.rb

@@ -23,41 +23,163 @@ module ElasticsearchServerless
     module Actions
       # Search a vector tile.
       # Search a vector tile for geospatial values.
+      # Before using this API, you should be familiar with the Mapbox vector tile specification.
+      # The API returns results as a binary mapbox vector tile.
+      # Internally, Elasticsearch translates a vector tile search API request into a search containing:
+      # * A +geo_bounding_box+ query on the +<field>+. The query uses the +<zoom>/<x>/<y>+ tile as a bounding box.
+      # * A +geotile_grid+ or +geohex_grid+ aggregation on the +<field>+. The +grid_agg+ parameter determines the aggregation type. The aggregation uses the +<zoom>/<x>/<y>+ tile as a bounding box.
+      # * Optionally, a +geo_bounds+ aggregation on the +<field>+. The search only includes this aggregation if the +exact_bounds+ parameter is +true+.
+      # * If the optional parameter +with_labels+ is +true+, the internal search will include a dynamic runtime field that calls the +getLabelPosition+ function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.
+      # For example, Elasticsearch may translate a vector tile search API request with a +grid_agg+ argument of +geotile+ and an +exact_bounds+ argument of +true+ into the following search
+      # +
+      # GET my-index/_search
+      # {
+      #   "size": 10000,
+      #   "query": {
+      #     "geo_bounding_box": {
+      #       "my-geo-field": {
+      #         "top_left": {
+      #           "lat": -40.979898069620134,
+      #           "lon": -45
+      #         },
+      #         "bottom_right": {
+      #           "lat": -66.51326044311186,
+      #           "lon": 0
+      #         }
+      #       }
+      #     }
+      #   },
+      #   "aggregations": {
+      #     "grid": {
+      #       "geotile_grid": {
+      #         "field": "my-geo-field",
+      #         "precision": 11,
+      #         "size": 65536,
+      #         "bounds": {
+      #           "top_left": {
+      #             "lat": -40.979898069620134,
+      #             "lon": -45
+      #           },
+      #           "bottom_right": {
+      #             "lat": -66.51326044311186,
+      #             "lon": 0
+      #           }
+      #         }
+      #       }
+      #     },
+      #     "bounds": {
+      #       "geo_bounds": {
+      #         "field": "my-geo-field",
+      #         "wrap_longitude": false
+      #       }
+      #     }
+      #   }
+      # }
+      # +
+      # The API returns results as a binary Mapbox vector tile.
+      # Mapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:
+      # * A +hits+ layer containing a feature for each +<field>+ value matching the +geo_bounding_box+ query.
+      # * An +aggs+ layer containing a feature for each cell of the +geotile_grid+ or +geohex_grid+. The layer only contains features for cells with matching data.
+      # * A meta layer containing:
+      #   * A feature containing a bounding box. By default, this is the bounding box of the tile.
+      #   * Value ranges for any sub-aggregations on the +geotile_grid+ or +geohex_grid+.
+      #   * Metadata for the search.
+      # The API only returns features that can display at its zoom level.
+      # For example, if a polygon feature has no area at its zoom level, the API omits it.
+      # The API returns errors as UTF-8 encoded JSON.
+      # IMPORTANT: You can specify several options for this API as either a query parameter or request body parameter.
+      # If you specify both parameters, the query parameter takes precedence.
+      # **Grid precision for geotile**
+      # For a +grid_agg+ of +geotile+, you can use cells in the +aggs+ layer as tiles for lower zoom levels.
+      # +grid_precision+ represents the additional zoom levels available through these cells. The final precision is computed by as follows: +<zoom> + grid_precision+.
+      # For example, if +<zoom>+ is 7 and +grid_precision+ is 8, then the +geotile_grid+ aggregation will use a precision of 15.
+      # The maximum final precision is 29.
+      # The +grid_precision+ also determines the number of cells for the grid as follows: +(2^grid_precision) x (2^grid_precision)+.
+      # For example, a value of 8 divides the tile into a grid of 256 x 256 cells.
+      # The +aggs+ layer only contains features for cells with matching data.
+      # **Grid precision for geohex**
+      # For a +grid_agg+ of +geohex+, Elasticsearch uses +<zoom>+ and +grid_precision+ to calculate a final precision as follows: +<zoom> + grid_precision+.
+      # This precision determines the H3 resolution of the hexagonal cells produced by the +geohex+ aggregation.
+      # The following table maps the H3 resolution for each precision.
+      # For example, if +<zoom>+ is 3 and +grid_precision+ is 3, the precision is 6.
+      # At a precision of 6, hexagonal cells have an H3 resolution of 2.
+      # If +<zoom>+ is 3 and +grid_precision+ is 4, the precision is 7.
+      # At a precision of 7, hexagonal cells have an H3 resolution of 3.
+      # | Precision | Unique tile bins | H3 resolution | Unique hex bins |  Ratio |
+      # | --------- | ---------------- | ------------- | ----------------| ----- |
+      # | 1  | 4                  | 0  | 122             | 30.5           |
+      # | 2  | 16                 | 0  | 122             | 7.625          |
+      # | 3  | 64                 | 1  | 842             | 13.15625       |
+      # | 4  | 256                | 1  | 842             | 3.2890625      |
+      # | 5  | 1024               | 2  | 5882            | 5.744140625    |
+      # | 6  | 4096               | 2  | 5882            | 1.436035156    |
+      # | 7  | 16384              | 3  | 41162           | 2.512329102    |
+      # | 8  | 65536              | 3  | 41162           | 0.6280822754   |
+      # | 9  | 262144             | 4  | 288122          | 1.099098206    |
+      # | 10 | 1048576            | 4  | 288122          | 0.2747745514   |
+      # | 11 | 4194304            | 5  | 2016842         | 0.4808526039   |
+      # | 12 | 16777216           | 6  | 14117882        | 0.8414913416   |
+      # | 13 | 67108864           | 6  | 14117882        | 0.2103728354   |
+      # | 14 | 268435456          | 7  | 98825162        | 0.3681524172   |
+      # | 15 | 1073741824         | 8  | 691776122       | 0.644266719    |
+      # | 16 | 4294967296         | 8  | 691776122       | 0.1610666797   |
+      # | 17 | 17179869184        | 9  | 4842432842      | 0.2818666889   |
+      # | 18 | 68719476736        | 10 | 33897029882     | 0.4932667053   |
+      # | 19 | 274877906944       | 11 | 237279209162    | 0.8632167343   |
+      # | 20 | 1099511627776      | 11 | 237279209162    | 0.2158041836   |
+      # | 21 | 4398046511104      | 12 | 1660954464122   | 0.3776573213   |
+      # | 22 | 17592186044416     | 13 | 11626681248842  | 0.6609003122   |
+      # | 23 | 70368744177664     | 13 | 11626681248842  | 0.165225078    |
+      # | 24 | 281474976710656    | 14 | 81386768741882  | 0.2891438866   |
+      # | 25 | 1125899906842620   | 15 | 569707381193162 | 0.5060018015   |
+      # | 26 | 4503599627370500   | 15 | 569707381193162 | 0.1265004504   |
+      # | 27 | 18014398509482000  | 15 | 569707381193162 | 0.03162511259  |
+      # | 28 | 72057594037927900  | 15 | 569707381193162 | 0.007906278149 |
+      # | 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |
+      # Hexagonal cells don't align perfectly on a vector tile.
+      # Some cells may intersect more than one vector tile.
+      # To compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.
+      # Elasticsearch uses the H3 resolution that is closest to the corresponding geotile density.
       #
       # @option arguments [String, Array] :index Comma-separated list of data streams, indices, or aliases to search (*Required*)
       # @option arguments [String] :field Field containing geospatial data to return (*Required*)
       # @option arguments [Integer] :zoom Zoom level for the vector tile to search (*Required*)
       # @option arguments [Integer] :x X coordinate for the vector tile to search (*Required*)
       # @option arguments [Integer] :y Y coordinate for the vector tile to search (*Required*)
-      # @option arguments [Boolean] :exact_bounds If false, the meta layer’s feature is the bounding box of the tile.
-      #  If true, the meta layer’s feature is a bounding box resulting from a
+      # @option arguments [Boolean] :exact_bounds If +false+, the meta layer's feature is the bounding box of the tile.
+      #  If true, the meta layer's feature is a bounding box resulting from a
       #  geo_bounds aggregation. The aggregation runs on <field> values that intersect
       #  the <zoom>/<x>/<y> tile with wrap_longitude set to false. The resulting
       #  bounding box may be larger than the vector tile.
-      # @option arguments [Integer] :extent Size, in pixels, of a side of the tile. Vector tiles are square with equal sides. Server default: 4096.
+      # @option arguments [Integer] :extent The size, in pixels, of a side of the tile. Vector tiles are square with equal sides. Server default: 4096.
       # @option arguments [String] :grid_agg Aggregation used to create a grid for +field+.
       # @option arguments [Integer] :grid_precision Additional zoom levels available through the aggs layer. For example, if <zoom> is 7
       #  and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results
-      #  don’t include the aggs layer. Server default: 8.
+      #  don't include the aggs layer. Server default: 8.
       # @option arguments [String] :grid_type Determines the geometry type for features in the aggs layer. In the aggs layer,
       #  each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon
       #  of the cells bounding box. If 'point' each feature is a Point that is the centroid
       #  of the cell. Server default: grid.
       # @option arguments [Integer] :size Maximum number of features to return in the hits layer. Accepts 0-10000.
-      #  If 0, results don’t include the hits layer. Server default: 10000.
+      #  If 0, results don't include the hits layer. Server default: 10000.
       # @option arguments [Boolean] :with_labels If +true+, the hits and aggs layers will contain additional point features representing
       #  suggested label positions for the original features.
+      #  - +Point+ and +MultiPoint+ features will have one of the points selected.
+      #  - +Polygon+ and +MultiPolygon+ features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree.
+      #  - +LineString+ features will likewise provide a roughly central point selected from the triangle-tree.
+      #  - The aggregation results will provide one central point for each aggregation bucket.
+      #  All attributes from the original features will also be copied to the new label features.
+      #  In addition, the new features will be distinguishable using the tag +_mvt_label_position+.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-mvt
       #
       def search_mvt(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "search_mvt" }
+        request_opts = { endpoint: arguments[:endpoint] || 'search_mvt' }
 
-        defined_params = [:index, :field, :zoom, :x, :y].inject({}) do |set_variables, variable|
+        defined_params = [:index, :field, :zoom, :x, :y].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?