stretchy-model 0.6.5 → 0.7.0

data/lib/opensearch/api/actions/machine_learning/connector/delete.rb

@@ -0,0 +1,42 @@
+module OpenSearch
+  module API
+    module Connector
+      module Actions
+        # Deletes a connector.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :connector_id The unique identifier of the connector to be deleted.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.13/delete-connector-api.html
+        #
+        def delete(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'connector.delete' }
+
+          defined_params = [:connector_id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'connector_id' missing" unless arguments[:connector_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _connector_id = arguments.delete(:connector_id)
+
+          method = OpenSearch::API::HTTP_DELETE
+          path   = "_plugins/_ml/connectors/#{Utils.__listify(_connector_id)}"
+          params = {}
+
+          perform_request(method, path, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/machine_learning/connector/get.rb

@@ -0,0 +1,42 @@
+module OpenSearch
+  module API
+    module Connector
+      module Actions
+        # Returns the details about a connector.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :connector_id The unique identifier of the connector to be returned.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.13/get-connector-api.html
+        #
+        def get(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'connector.get' }
+
+          defined_params = [:connector_id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'connector_id' missing" unless arguments[:connector_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _connector_id = arguments.delete(:connector_id)
+
+          method = OpenSearch::API::HTTP_GET
+          path   = "_plugins/_ml/connectors/#{Utils.__listify(_connector_id)}"
+          params = {}
+
+          perform_request(method, path, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/machine_learning/connector/list.rb

@@ -0,0 +1,38 @@
+module OpenSearch
+  module API
+    module Connector
+      module Actions
+        # Lists all connectors.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [Integer] :from Starting offset (default: 0)
+        # @option arguments [Integer] :size Specifies a max number of results to get (default: 100)
+        # @option arguments [List] :index_name A comma-separated list of connector index names to fetch connector documents for
+        # @option arguments [List] :connector_name A comma-separated list of connector names to fetch connector documents for
+        # @option arguments [List] :service_type A comma-separated list of connector service types to fetch connector documents for
+        # @option arguments [String] :query A search string for querying connectors, filtering results by matching against connector names, descriptions, and index names
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.13/list-connector-api.html
+        #
+        def list(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'connector.list' }
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body   = nil
+
+          method = OpenSearch::API::HTTP_GET
+          path   = '_plugins/_ml/connectors'
+          params = Utils.process_params(arguments)
+
+          perform_request(method, path, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/machine_learning/connector/post.rb

@@ -0,0 +1,35 @@
+module OpenSearch
+  module API
+    module Connector
+      module Actions
+        # Creates a connector.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The connector configuration. (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.13/create-connector-api.html
+        #
+        def post(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'connector.post' }
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body   = arguments.delete(:body)
+
+          method = OpenSearch::API::HTTP_POST
+          path   = '_plugins/_ml/connectors/_create'
+          params = {}
+
+          perform_request(method, path, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/machine_learning/connector/put.rb

@@ -0,0 +1,44 @@
+module OpenSearch
+  module API
+    module Connector
+      module Actions
+        # Creates or updates a connector.
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :connector_id The unique identifier of the connector to be created or updated.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The connector configuration. (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.13/create-connector-api.html
+        #
+        def put(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'connector.put' }
+
+          defined_params = [:connector_id].each_with_object({}) do |variable, set_variables|
+            set_variables[variable] = arguments[variable] if arguments.key?(variable)
+          end
+          request_opts[:defined_params] = defined_params unless defined_params.empty?
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'connector_id' missing" unless arguments[:connector_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _connector_id = arguments.delete(:connector_id)
+
+          method = OpenSearch::API::HTTP_PUT
+          path   = "_plugins/_ml/connectors/#{Utils.__listify(_connector_id)}"
+          params = {}
+
+          perform_request(method, path, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/machine_learning/models/predict.rb

@@ -0,0 +1,32 @@
+module OpenSearch
+  module API
+    module MachineLearning
+	    module Models
+	      module Actions
+	        # Register a model.
+	        #
+	        # @option arguments [String] :model_id The model id
+	        # @option arguments [Hash] :body The deploy options
+	        #
+          # 
+          # POST /_plugins/_ml/models/<model_id>/_predict
+	        def predict(arguments = {})
+						raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]
+            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+	          _id = arguments.delete(:model_id)
+	          arguments = arguments.clone
+						headers = arguments.delete(:headers) || {}
+	
+	          method = OpenSearch::API::HTTP_POST
+	          path   = "_plugins/_ml/models/#{Utils.__listify(_id)}/_predict"
+	          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+	
+	          body = arguments[:body]
+            perform_request(method, path, params, body, headers).body
+	        end
+	
+	      end
+	    end
+    end
+  end
+end

data/lib/opensearch/api/namespace/connector.rb

@@ -0,0 +1,19 @@
+module OpenSearch
+  module API
+    module Connector
+      module Actions; end
+
+      # Client for the "connector" namespace (includes the {Connector::Actions} methods)
+      #
+      class ConnectorClient
+        include Common::Client, Common::Client::Base, Connector::Actions
+      end
+
+      # Proxy method for {ConnectorClient}, available in the receiving object
+      #
+      def connector
+        @connector ||= ConnectorClient.new(self)
+      end
+    end
+  end
+end

data/lib/stretchy/attributes/transformers/keyword_transformer.rb

@@ -1,6 +1,20 @@
 module Stretchy
   module Attributes
     module Transformers
+      # Applies transformations to keyword fields in queries
+      #
+      # ### Examples
+      #
+      # ```ruby
+      # class Goat < StretchyModel
+      #  attribute :name, :keyword
+      #  attribute :age, :integer
+      # end
+      # 
+      # Goat.where(name: 'billy').to_elastic
+      # # => {query: {term: {'name.keyword': 'billy'}}}
+      #
+      # ```
       class KeywordTransformer
 
           KEYWORD_AGGREGATION_KEYS = [:terms, :rare_terms, :significant_terms, :cardinality, :string_stats]
@@ -24,61 +38,53 @@ module Stretchy
             end
           end
           
-          def keyword?(arg)
-            attr = @attribute_types[arg.to_s] 
-            return false unless attr
-            attr.is_a?(Stretchy::Attributes::Type::Keyword)
+          def keyword_available?(arg)
+            attrib = @attribute_types[arg.to_s.split(".").first] 
+            return false unless attrib 
+            attrib.respond_to?(:keyword_field?) && attrib.keyword_field?
+          end
+
+          def keyword_field_for(arg)
+            attrib = @attribute_types[arg.to_s.split(".").first]
+            keyword_field = attrib.respond_to?(:fields) ? attrib.fields.find { |k,d| d[:type].to_sym == :keyword }&.first : nil
+            keyword_field || Stretchy.configuration.default_keyword_field
           end
 
           def protected?(arg)
             return false if arg.nil?
-            Stretchy::Relations::AggregationMethods::AGGREGATION_METHODS.include?(arg.to_sym)
+            Stretchy::Relations::AggregationMethods.registry.include?(arg.to_sym)
           end
           
+          # Add `.keyword` to attributes that have a keyword subfield but aren't `:keywords`
+          # this is for text fields that have a keyword subfield
+          # `:text` and `:string` fields add a `:keyword` subfield to the attribute mapping automatically
           def transform(item, *ignore) 
-            item.each_with_object({}) do |(k, v), new_item|
-              if ignore && ignore.include?(k)
-                new_item[k] = v
+            return item unless Stretchy.configuration.auto_target_keywords
+            if item.is_a?(String)
+              return (!protected?(item) && keyword_available?(item)) ? "#{item}.#{keyword_field_for(item)}" : item 
+            end
+            item.each_with_object({}) do |(key, value), new_item|
+              if ignore && ignore.include?(key)
+                new_item[key] = value
                 next
               end
-              new_key = (!protected?(k) && keyword?(k)) ? "#{k}.keyword" : k
 
-              new_value = v
+              new_key = (!protected?(key) && keyword_available?(key)) ? "#{key}.#{keyword_field_for(key)}" : key
+
+              new_value = value
           
               if new_value.is_a?(Hash)
-                new_value = transform(new_value)
+                new_value = transform(new_value, *ignore)
               elsif new_value.is_a?(Array)
-                new_value = new_value.map { |i| i.is_a?(Hash) ? transform(i) : i }
+                new_value = new_value.map { |i| i.is_a?(Hash) ? transform(i, *ignore) : i }
               elsif new_value.is_a?(String) || new_value.is_a?(Symbol) 
-                new_value = "#{new_value}.keyword" if keyword?(new_value)
+                new_value = "#{new_value}.#{keyword_field_for(new_value)}" if keyword_available?(new_value) && new_value.to_s !~  Regexp.new("\.#{keyword_field_for(new_value)}$")
               end
 
               new_item[new_key] = new_value
             end
           end
 
-          # If terms are used, we assume that the field is a keyword field
-          # and append .keyword to the field name
-          # {terms: {field: 'gender'}}
-          # or nested aggs
-          # {terms: {field: 'gender'}, aggs: {name: {terms: {field: 'position.name'}}}}
-          # should be converted to
-          # {terms: {field: 'gender.keyword'}, aggs: {name: {terms: {field: 'position.name.keyword'}}}}
-          # {date_histogram: {field: 'created_at', interval: 'day'}}
-          # TODO: There may be cases where we don't want to add .keyword to the field and there should be a way to override this
-          def assume_keyword_field(args={}, parent_match=false)
-            if args.is_a?(Hash)
-              args.each do |k, v|
-                if v.is_a?(Hash) 
-                  assume_keyword_field(v, KEYWORD_AGGREGATION_FIELDS.include?(k))
-                else
-                  next unless v.is_a?(String) || v.is_a?(Symbol)
-                  args[k] = ([:field, :fields].include?(k.to_sym) && v !~ /\.keyword$/ && parent_match) ? "#{v}.keyword" : v.to_s
-                end
-              end
-            end
-          end
-
       end
     end
   end

data/lib/stretchy/attributes/type/array.rb

@@ -1,5 +1,28 @@
 module Stretchy::Attributes::Type
-  class Array < Stretchy::Attributes::Type::Base # :nodoc:
+  # The Array attribute type
+  #
+  # This class is used to define an array attribute for a model. It provides support for the Elasticsearch array data type, which is a type of data type that can hold multiple values.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:array`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:data_type:` The Symbol representing the data type for the array. Defaults to `:text`.
+  #    - `:fields:` The Boolean indicating if fields should be included in the mapping. Defaults to `true`.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define an array attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
+  #     attribute :tags, :array, data_type: :text
+  #   end
+  # ```
+  #
+  class Array < Stretchy::Attributes::Type::Base
     OPTIONS = [:data_type, :fields]
     def type
       :array

data/lib/stretchy/attributes/type/base.rb

@@ -5,7 +5,6 @@ module Stretchy
 
               OPTIONS = []
 
-      
               def initialize(**args)
 
                 define_option_methods!
@@ -13,11 +12,16 @@ module Stretchy
                 args.each do |k, v|
                   if self.class::OPTIONS.include?(k)
                     instance_variable_set("@#{k}", v) 
-                    args.delete(k)
                   end
+                  args.delete(k)
                 end
                 super
               end
+
+              def keyword_field?
+                return false unless respond_to? :fields
+                fields.present? && fields.include?(:keyword)
+              end
       
               def mappings(name)
                 options = {type: type_for_database}

data/lib/stretchy/attributes/type/binary.rb

@@ -1,23 +1,30 @@
-# Public: Defines a binary attribute for the model.
-#
-# name - The Symbol name of the attribute.
-# opts - The Hash options used to refine the attribute (default: {}):
-#        :doc_values - The Boolean indicating if the field should be stored on disk in a column-stride fashion.
-#                      This allows it to be used later for sorting, aggregations, or scripting. Defaults to false.
-#        :store - The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
-#
-# Examples
-#
-#   class MyModel
-#     include StretchyModel
-#     attribute :name, :binary, doc_values: true, store: true
-#   end
-#
-# Returns nothing.
 module Stretchy
     module Attributes
         module Type
-            class Binary < ActiveModel::Type::Value
+            # The Binary attribute type
+            #
+            # This class is used to define a binary attribute for a model. It provides support for the Elasticsearch binary data type, which is a type of data type that can hold binary data.
+            #
+            # ### Parameters
+            #
+            # - `type:` `:binary`.
+            # - `options:` The Hash of options for the attribute.
+            #    - `:doc_values:` The Boolean indicating if the field should be stored on disk in a column-stride fashion. This allows it to be used later for sorting, aggregations, or scripting. Defaults to false.
+            #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+            #
+            # ---
+            #
+            # ### Examples
+            #
+            # #### Define a binary attribute
+            #
+            # ```ruby
+            #   class MyModel < StretchyModel
+            #     attribute :data, :binary, doc_values: true, store: true
+            #   end
+            # ```
+            #
+            class Binary < Stretchy::Attributes::Type::Base
                 OPTIONS = [:doc_values, :store]
                 attr_reader *OPTIONS 
 

data/lib/stretchy/attributes/type/boolean.rb

@@ -1,28 +1,35 @@
-# Public: Defines a boolean attribute for the model.
-#
-# name - The Symbol name of the attribute.
-# opts - The Hash options used to refine the attribute (default: {}):
-#        :doc_values - The Boolean indicating if the field should be stored on disk in a column-stride fashion.
-#                      This allows it to be used later for sorting, aggregations, or scripting. Defaults to true.
-#        :index - The Boolean indicating if the field should be quickly searchable. Defaults to true.
-#        :ignore_malformed - The Boolean indicating if exceptions thrown when trying to index the wrong data type into a field should be ignored. Defaults to false.
-#        :null_value - The Boolean value to be substituted for any explicit null values. Defaults to null.
-#        :on_script_error - The String defining what to do if the script defined by the :script parameter throws an error at indexing time. Can be 'fail' or 'continue'.
-#        :script - The String script that will index values generated by this script, rather than reading the values directly from the source.
-#        :store - The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
-#        :meta - The Hash metadata about the field.
-#
-# Examples
-#
-#   class MyModel
-#     include StretchyModel
-#     attribute :name, :boolean, doc_values: true, store: true
-#   end
-#
-# Returns nothing.
 module Stretchy
   module Attributes
     module Type
+      # The Boolean attribute type
+      #
+      # This class is used to define a boolean attribute for a model. It provides support for the Elasticsearch boolean data type, which is a type of data type that can hold true or false values.
+      #
+      # ### Parameters
+      #
+      # - `type:` `:boolean`.
+      # - `options:` The Hash of options for the attribute.
+      #    - `:doc_values:` The Boolean indicating if the field should be stored on disk in a column-stride fashion. This allows it to be used later for sorting, aggregations, or scripting. Defaults to true.
+      #    - `:index:` The Boolean indicating if the field should be quickly searchable. Defaults to true.
+      #    - `:ignore_malformed:` The Boolean indicating if exceptions thrown when trying to index the wrong data type into a field should be ignored. Defaults to false.
+      #    - `:null_value:` The Boolean value to be substituted for any explicit null values. Defaults to null.
+      #    - `:on_script_error:` The String defining what to do if the script defined by the :script parameter throws an error at indexing time. Can be 'fail' or 'continue'.
+      #    - `:script:` The String script that will index values generated by this script, rather than reading the values directly from the source.
+      #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+      #    - `:meta:` The Hash metadata about the field.
+      #
+      # ---
+      #
+      # ### Examples
+      #
+      # #### Define a boolean attribute
+      #
+      # ```ruby
+      #   class MyModel < StretchyModel
+      #     attribute :is_active, :boolean, doc_values: true, store: true
+      #   end
+      # ```
+      #
       class Boolean < Stretchy::Attributes::Type::Base
 
         OPTIONS = [:doc_values, :index, :ignore_malformed, :null_value, :on_script_error, :script, :store, :meta]

data/lib/stretchy/attributes/type/completion.rb

@@ -1,20 +1,28 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a completion attribute for the model.
+  # Completion attribute type for Elasticsearch completion suggester.
   #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :analyzer - The String index analyzer to use. Defaults to 'simple'.
-  #        :search_analyzer - The String search analyzer to use. Defaults to the value of :analyzer.
-  #        :preserve_separators - The Boolean indicating if separators should be preserved. Defaults to true.
-  #        :preserve_position_increments - The Boolean indicating if position increments should be enabled. Defaults to true.
-  #        :max_input_length - The Integer limit for the length of a single input. Defaults to 50.
+  # This class is used to define a completion attribute for a model. It provides support for the Elasticsearch completion suggester, which is a type of suggester that provides auto-complete functionality.
   #
-  # Examples
+  # ### Parameters
   #
-  #   class MyModel < Stretchy::Record
+  # - `analyzer:` The String index analyzer to use. Defaults to 'simple'.
+  # - `search_analyzer:` The String search analyzer to use. Defaults to the value of `analyzer`.
+  # - `preserve_separators:` The Boolean indicating if separators should be preserved. Defaults to true.
+  # - `preserve_position_increments:` The Boolean indicating if position increments should be enabled. Defaults to true.
+  # - `max_input_length:` The Integer limit for the length of a single input. Defaults to 50.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a completion attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :name, :completion, analyzer: 'simple', max_input_length: 100
   #   end
+  # ```
   #
-  # Returns nothing.
   class Completion < Stretchy::Attributes::Type::Base
     OPTIONS = [:analyzer, :search_analyzer, :preserve_separators, :preserve_position_increments, :max_input_length]
     attr_reader *OPTIONS

data/lib/stretchy/attributes/type/constant_keyword.rb

@@ -1,33 +1,42 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a constant_keyword attribute for the model. This field type is a specialization of the keyword field, but it only accepts a single value.
-  #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :doc_values - The Boolean indicating if the field should be stored on disk in a column-stride fashion. Defaults to true.
-  #        :eager_global_ordinals - The Boolean indicating if global ordinals should be loaded eagerly on refresh. Defaults to false.
-  #        :fields - The Hash of multi-fields for the same string value to be indexed in multiple ways.
-  #        :ignore_above - The Integer limit for the length of the string. Strings longer than this limit will not be indexed. Defaults to 2147483647.
-  #        :index - The Boolean indicating if the field should be quickly searchable. Defaults to true.
-  #        :index_options - The String indicating what information should be stored in the index for scoring purposes. Defaults to 'docs'.
-  #        :meta - The Hash metadata about the field.
-  #        :norms - The Boolean indicating if field-length should be taken into account when scoring queries. Defaults to false.
-  #        :null_value - The String value to be substituted for any explicit null values. Defaults to null.
-  #        :on_script_error - The String defining what to do if the script defined by the :script parameter throws an error at indexing time. Can be 'fail' or 'continue'.
-  #        :script - The String script that will index values generated by this script, rather than reading the values directly from the source.
-  #        :store - The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
-  #        :similarity - The String scoring algorithm or similarity to be used. Defaults to 'BM25'.
-  #        :normalizer - The String pre-processor for the keyword prior to indexing. Defaults to null.
-  #        :split_queries_on_whitespace - The Boolean indicating if full text queries should split the input on whitespace. Defaults to false.
-  #        :time_series_dimension - The Boolean indicating if the field is a time series dimension. Defaults to false.
-  #        :value - The String value to associate with all documents in the index.
-  #
-  # Examples
-  #
-  #   class MyModel
-  #     include StretchyModel
+  # The ConstantKeyword attribute type
+  #
+  # This class is used to define a constant_keyword attribute for a model. This field type is a specialization of the keyword field, but it only accepts a single value.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:constant_keyword`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:doc_values:` The Boolean indicating if the field should be stored on disk in a column-stride fashion. Defaults to true.
+  #    - `:eager_global_ordinals:` The Boolean indicating if global ordinals should be loaded eagerly on refresh. Defaults to false.
+  #    - `:fields:` The Hash of multi-fields for the same string value to be indexed in multiple ways.
+  #    - `:ignore_above:` The Integer limit for the length of the string. Strings longer than this limit will not be indexed. Defaults to 2147483647.
+  #    - `:index:` The Boolean indicating if the field should be quickly searchable. Defaults to true.
+  #    - `:index_options:` The String indicating what information should be stored in the index for scoring purposes. Defaults to 'docs'.
+  #    - `:meta:` The Hash metadata about the field.
+  #    - `:norms:` The Boolean indicating if field-length should be taken into account when scoring queries. Defaults to false.
+  #    - `:null_value:` The String value to be substituted for any explicit null values. Defaults to null.
+  #    - `:on_script_error:` The String defining what to do if the script defined by the :script parameter throws an error at indexing time. Can be 'fail' or 'continue'.
+  #    - `:script:` The String script that will index values generated by this script, rather than reading the values directly from the source.
+  #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+  #    - `:similarity:` The String scoring algorithm or similarity to be used. Defaults to 'BM25'.
+  #    - `:normalizer:` The String pre-processor for the keyword prior to indexing. Defaults to null.
+  #    - `:split_queries_on_whitespace:` The Boolean indicating if full text queries should split the input on whitespace. Defaults to false.
+  #    - `:time_series_dimension:` The Boolean indicating if the field is a time series dimension. Defaults to false.
+  #    - `:value:` The String value to associate with all documents in the index.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a constant_keyword attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :status, :constant_keyword, value: 'active'
   #   end
+  # ```
   #
-  # Returns nothing.
   class ConstantKeyword < Stretchy::Attributes::Type::Keyword
     OPTIONS = OPTIONS + [:value]
     attr_reader *OPTIONS