stretchy-model 0.6.0 → 0.6.6

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

@@ -1,24 +1,41 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a rank_features attribute for the model.
+  # The RankFeatures attribute type
   #
-  # A rank_features field can index numeric feature vectors, so that they can later be used to boost documents in queries with a rank_feature query.
-
-  # It is analogous to the rank_feature data type but is better suited when the list of features is sparse so that it wouldn’t be reasonable to add one field to the mappings for each of them.
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :positive_score_impact - The Boolean indicating if features correlate positively with the score. If set to false, the score decreases with the value of the feature instead of increasing. Defaults to true.
+  # This class is used to define a rank_features attribute for a model. It provides support for the Elasticsearch rank_features data type, which is a type of data type that can index numeric feature vectors, so that they can later be used to boost documents in queries with a rank_feature query. It is better suited when the list of features is sparse so that it wouldn’t be reasonable to add one field to the mappings for each of them.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:rank_features`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:positive_score_impact:` The Boolean indicating if features correlate positively with the score. If set to false, the score decreases with the value of the feature instead of increasing. Defaults to true.
+  #
+  # ---
+  #
+  # ### Examples
   #
-  # Examples
+  # #### Define a rank_features attribute
   #
-  #   class MyModel < Stretchy::Record
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :negative_reviews, :rank_features, positive_score_impact: false
   #   end
+  # ```
   #
-  # Returns nothing.
-  class RankFeatures < Stretchy::Attributes::Type::Base
+  class RankFeatures < Stretchy::Attributes::Type::Hash
     OPTIONS = [:positive_score_impact]
 
+    def mappings(name)
+      options = {type: type}
+      OPTIONS.each { |option| options[option] = send(option) unless send(option).nil? }
+      { name =>  options }.as_json 
+    end
+
     def type
       :rank_features
     end
+
+    def type_for_database
+      :rank_features
+    end
   end
 end

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

@@ -1,25 +1,35 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a search_as_you_type attribute for the model. This field type is optimized to provide out-of-the-box support for queries that serve an as-you-type completion use case.
-  #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :max_shingle_size - The Integer indicating the largest shingle size to create. Valid values are 2 to 4. Defaults to 3.
-  #        :analyzer - The String analyzer to be used for text fields, both at index-time and at search-time. Defaults to the default index analyzer, or the standard analyzer.
-  #        :index - The Boolean indicating if the field should be searchable. Defaults to true.
-  #        :index_options - The String indicating what information should be stored in the index, for search and highlighting purposes. Defaults to 'positions'.
-  #        :norms - The Boolean indicating if field-length should be taken into account when scoring queries. Defaults to true.
-  #        :store - The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
-  #        :search_analyzer - The String analyzer that should be used at search time on text fields. Defaults to the analyzer setting.
-  #        :search_quote_analyzer - The String analyzer that should be used at search time when a phrase is encountered. Defaults to the search_analyzer setting.
-  #        :similarity - The String indicating which scoring algorithm or similarity should be used. Defaults to 'BM25'.
-  #        :term_vector - The String indicating if term vectors should be stored for the field. Defaults to 'no'.
-  #
-  # Examples
-  #
-  #   class MyModel < Stretchy::Record
+  # The SearchAsYouType attribute type
+  #
+  # This class is used to define a search_as_you_type attribute for a model. This field type is optimized to provide out-of-the-box support for queries that serve an as-you-type completion use case.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:search_as_you_type`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:max_shingle_size:` The Integer indicating the largest shingle size to create. Valid values are 2 to 4. Defaults to 3.
+  #    - `:analyzer:` The String analyzer to be used for text fields, both at index-time and at search-time. Defaults to the default index analyzer, or the standard analyzer.
+  #    - `:index:` The Boolean indicating if the field should be searchable. Defaults to true.
+  #    - `:index_options:` The String indicating what information should be stored in the index, for search and highlighting purposes. Defaults to 'positions'.
+  #    - `:norms:` The Boolean indicating if field-length should be taken into account when scoring queries. Defaults to true.
+  #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+  #    - `:search_analyzer:` The String analyzer that should be used at search time on text fields. Defaults to the analyzer setting.
+  #    - `:search_quote_analyzer:` The String analyzer that should be used at search time when a phrase is encountered. Defaults to the search_analyzer setting.
+  #    - `:similarity:` The String indicating which scoring algorithm or similarity should be used. Defaults to 'BM25'.
+  #    - `:term_vector:` The String indicating if term vectors should be stored for the field. Defaults to 'no'.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a search_as_you_type attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :name, :search_as_you_type, max_shingle_size: 4
   #   end
+  # ```
   #
-  # Returns nothing.
   class SearchAsYouType < Stretchy::Attributes::Type::Base
     OPTIONS = [:max_shingle_size, :analyzer, :index, :index_options, :norms, :store, :search_analyzer, :search_quote_analyzer, :similarity, :term_vector]
 

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

@@ -1,19 +1,29 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a shape attribute for the model. This field type is used for complex shapes.
+  # The Shape attribute type
   #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :orientation - The String indicating how to interpret vertex order for polygons / multipolygons. Can be 'right', 'ccw', 'counterclockwise', 'left', 'cw', 'clockwise'. Defaults to 'ccw'.
-  #        :ignore_malformed - The Boolean indicating if malformed GeoJSON or WKT shapes should be ignored. Defaults to false.
-  #        :ignore_z_value - The Boolean indicating if the z value of three dimension points should be ignored. Defaults to true.
-  #        :coerce - The Boolean indicating if unclosed linear rings in polygons will be automatically closed. Defaults to false.
+  # This class is used to define a shape attribute for a model. It provides support for the Elasticsearch shape data type, which is a type of data type that can hold complex shapes represented as GeoJSON or WKT.
   #
-  # Examples
+  # ### Parameters
   #
-  #   class MyModel < Stretchy::Record
+  # - `type:` `:shape`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:orientation:` The String indicating how to interpret vertex order for polygons / multipolygons. Can be 'right', 'ccw', 'counterclockwise', 'left', 'cw', 'clockwise'. Defaults to 'ccw'.
+  #    - `:ignore_malformed:` The Boolean indicating if malformed GeoJSON or WKT shapes should be ignored. Defaults to false.
+  #    - `:ignore_z_value:` The Boolean indicating if the z value of three dimension points should be ignored. Defaults to true.
+  #    - `:coerce:` The Boolean indicating if unclosed linear rings in polygons will be automatically closed. Defaults to false.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a shape attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :boundary, :shape, orientation: 'cw'
   #   end
+  # ```
   #
-  # Returns nothing.
   class Shape < Stretchy::Attributes::Type::Base
     OPTIONS = [:orientation, :ignore_malformed, :ignore_z_value, :coerce]
 

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

@@ -1,21 +1,27 @@
-# 
-# attribute :ml, :sparse_vector
-# 
-# {
-#   "mappings": {
-#     "properties": {
-#       "ml.tokens": {
-#         "type": "sparse_vector"
-#       }
-#     }
-#   }
-# }
-#
-
-
 module Stretchy
   module Attributes
       module Type
+          # The SparseVector attribute type
+          #
+          # This class is used to define a sparse_vector attribute for a model. It provides support for the Elasticsearch sparse_vector data type, which is a type of data type that can hold sparse vectors of float values.
+          #
+          # ### Parameters
+          #
+          # - `type:` `:sparse_vector`.
+          # - `options:` The Hash of options for the attribute. This type does not have any specific options.
+          #
+          # ---
+          #
+          # ### Examples
+          #
+          # #### Define a sparse_vector attribute
+          #
+          # ```ruby
+          #   class MyModel < StretchyModel
+          #     attribute :ml, :sparse_vector
+          #   end
+          # ```
+          #
           class SparseVector < Stretchy::Attributes::Type::Base
 
               def type
@@ -23,12 +29,10 @@ module Stretchy
               end
 
               def mappings(name) 
-                  {
-                    properties: {
-                      "#{name}.tokens": {
-                          type: "sparse_vector"
-                      }
-                    }
+                {
+                  "#{name}.tokens": {
+                      type: "sparse_vector"
+                  }
                 }.as_json
               end
           end

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

@@ -1,5 +1,46 @@
 module Stretchy::Attributes::Type
-  class String < Stretchy::Attributes::Type::Text # :nodoc:
+  # The String attribute type
+  #
+  # _alias for `:text`_
+  #
+  # This class is used to define a string attribute for a model. It provides support for the Elasticsearch text data type, which is a type of data type that can hold text. In this library, the string type is an alias for the text type.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:string`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:analyzer:` The String analyzer to be used for the text field, both at index-time and at search-time. Defaults to the default index analyzer, or the standard analyzer.
+  #    - `:eager_global_ordinals:` The Boolean indicating if global ordinals should be loaded eagerly on refresh. Defaults to false.
+  #    - `:fielddata:` The Boolean indicating if the field can use in-memory fielddata for sorting, aggregations, or scripting. Defaults to false.
+  #    - `:fielddata_frequency_filter:` The Hash of expert settings which allow to decide which values to load in memory when fielddata is enabled.
+  #    - `:fields:` The Hash of multi-fields allow the same string value to be indexed in multiple ways for different purposes. By default, a 'keyword' field is added. Set to false to disable.
+  #    - `:index:` The Boolean indicating if the field should be searchable. Defaults to true.
+  #    - `:index_options:` The String indicating what information should be stored in the index, for search and highlighting purposes. Defaults to 'positions'.
+  #    - `:index_prefixes:` The Hash indicating if term prefixes of between 2 and 5 characters are indexed into a separate field.
+  #    - `:index_phrases:` The Boolean indicating if two-term word combinations (shingles) are indexed into a separate field. Defaults to false.
+  #    - `:norms:` The Boolean indicating if field-length should be taken into account when scoring queries. Defaults to true.
+  #    - `:position_increment_gap:` The Integer indicating the number of fake term position which should be inserted between each element of an array of strings. Defaults to 100.
+  #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+  #    - `:search_analyzer:` The String analyzer that should be used at search time on the text field. Defaults to the analyzer setting.
+  #    - `:search_quote_analyzer:` The String analyzer that should be used at search time when a phrase is encountered. Defaults to the search_analyzer setting.
+  #    - `:similarity:` The String indicating which scoring algorithm or similarity should be used. Defaults to 'BM25'.
+  #    - `:term_vector:` The String indicating if term vectors should be stored for the field. Defaults to 'no'.
+  #    - `:meta:` The Hash of metadata about the field.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a string attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
+  #     attribute :name, :string
+  #   end
+  # ```
+  #
+  class String < Stretchy::Attributes::Type::Text
+    
     def type
       :string
     end

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

@@ -1,37 +1,57 @@
 module Stretchy::Attributes::Type
-    # Public: Defines a text attribute for the model. This field type is used for text strings.
-    #
-    # opts - The Hash options used to refine the attribute (default: {}):
-    #        :analyzer - The String analyzer to be used for the text field, both at index-time and at search-time. Defaults to the default index analyzer, or the standard analyzer.
-    #        :eager_global_ordinals - The Boolean indicating if global ordinals should be loaded eagerly on refresh. Defaults to false.
-    #        :fielddata - The Boolean indicating if the field can use in-memory fielddata for sorting, aggregations, or scripting. Defaults to false.
-    #        :fielddata_frequency_filter - The Hash of expert settings which allow to decide which values to load in memory when fielddata is enabled.
-    #        :fields - The Hash of multi-fields allow the same string value to be indexed in multiple ways for different purposes. By default, a 'keyword' field is added. Set to false to disable.
-    #        :index - The Boolean indicating if the field should be searchable. Defaults to true.
-    #        :index_options - The String indicating what information should be stored in the index, for search and highlighting purposes. Defaults to 'positions'.
-    #        :index_prefixes - The Hash indicating if term prefixes of between 2 and 5 characters are indexed into a separate field.
-    #        :index_phrases - The Boolean indicating if two-term word combinations (shingles) are indexed into a separate field. Defaults to false.
-    #        :norms - The Boolean indicating if field-length should be taken into account when scoring queries. Defaults to true.
-    #        :position_increment_gap - The Integer indicating the number of fake term position which should be inserted between each element of an array of strings. Defaults to 100.
-    #        :store - The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
-    #        :search_analyzer - The String analyzer that should be used at search time on the text field. Defaults to the analyzer setting.
-    #        :search_quote_analyzer - The String analyzer that should be used at search time when a phrase is encountered. Defaults to the search_analyzer setting.
-    #        :similarity - The String indicating which scoring algorithm or similarity should be used. Defaults to 'BM25'.
-    #        :term_vector - The String indicating if term vectors should be stored for the field. Defaults to 'no'.
-    #        :meta - The Hash of metadata about the field.
-    #
-    #
-    # Examples
-    #
-    #   class MyModel
-    #     include StretchyModel
+    # The Text attribute type
+    #
+    # This class is used to define a text attribute for a model. It provides support for the Elasticsearch text data type, which is a type of data type that can hold text strings.
+    #
+    # >[!NOTE]
+    # >
+    # > The default for the `:text` type is to have a keyword multified if `field:` is not specified and `fields:` is not explicitly false.
+    # > This can be disabled by setting `Stretchy.configuration.add_keyword_field_to_text_attributes` to false.
+    # > The default keyword field name is `:keyword`, but this can be changed by setting `Stretchy.configuration.default_keyword_field`.
+    #
+    # ### Parameters
+    #
+    # - `type:` `:text`.
+    # - `options:` The Hash of options for the attribute.
+    #    - `:analyzer:` The String analyzer to be used for the text field, both at index-time and at search-time. Defaults to the default index analyzer, or the standard analyzer.
+    #    - `:eager_global_ordinals:` The Boolean indicating if global ordinals should be loaded eagerly on refresh. Defaults to false.
+    #    - `:fielddata:` The Boolean indicating if the field can use in-memory fielddata for sorting, aggregations, or scripting. Defaults to false.
+    #    - `:fielddata_frequency_filter:` The Hash of expert settings which allow to decide which values to load in memory when fielddata is enabled.
+    #    - `:fields:` The Hash of multi-fields allow the same string value to be indexed in multiple ways for different purposes. By default, a 'keyword' field is added. Set to false to disable.
+    #    - `:index:` The Boolean indicating if the field should be searchable. Defaults to true.
+    #    - `:index_options:` The String indicating what information should be stored in the index, for search and highlighting purposes. Defaults to 'positions'.
+    #    - `:index_prefixes:` The Hash indicating if term prefixes of between 2 and 5 characters are indexed into a separate field.
+    #    - `:index_phrases:` The Boolean indicating if two-term word combinations (shingles) are indexed into a separate field. Defaults to false.
+    #    - `:norms:` The Boolean indicating if field-length should be taken into account when scoring queries. Defaults to true.
+    #    - `:position_increment_gap:` The Integer indicating the number of fake term position which should be inserted between each element of an array of strings. Defaults to 100.
+    #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+    #    - `:search_analyzer:` The String analyzer that should be used at search time on the text field. Defaults to the analyzer setting.
+    #    - `:search_quote_analyzer:` The String analyzer that should be used at search time when a phrase is encountered. Defaults to the search_analyzer setting.
+    #    - `:similarity:` The String indicating which scoring algorithm or similarity should be used. Defaults to 'BM25'.
+    #    - `:term_vector:` The String indicating if term vectors should be stored for the field. Defaults to 'no'.
+    #    - `:meta:` The Hash of metadata about the field.
+    #
+    # ---
+    #
+    # ### Examples
+    #
+    # #### Define a text attribute
+    #
+    # ```ruby
+    #   class MyModel < StretchyModel
     #     attribute :description, :text, analyzer: 'english'
     #   end
+    # ```
     #
-    # Returns nothing.
     class Text < Stretchy::Attributes::Type::Base
       OPTIONS = [:analyzer, :eager_global_ordinals, :fielddata, :fielddata_frequency_filter, :fields, :index, :index_options, :index_prefixes, :index_phrases, :norms, :position_increment_gap, :store, :search_analyzer, :search_quote_analyzer, :similarity, :term_vector, :meta]
-  
+
+      def initialize(**args)
+        # Add a keyword field by default if no fields are specified
+        args.reverse_merge!(fields: {keyword: {type: :keyword, ignore_above: 256}}) if args[:fields].nil? && Stretchy.configuration.add_keyword_field_to_text_attributes
+        super 
+      end
+
       def type
         :text
       end
@@ -40,6 +60,11 @@ module Stretchy::Attributes::Type
         :text
       end
 
+      # The default for the `:text` type is to have a keyword field if no fields are specified.
+      def keyword_field?
+        fields.find { |k,d| d[:type].to_sym == :keyword}.present?
+      end
+
       def mappings(name)
         options = {type: type_for_database}
         OPTIONS.each { |option| options[option] = send(option) unless send(option).nil? }

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

@@ -1,21 +1,31 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a token_count attribute for the model. This field type is used for counting the number of tokens in a string.
+  # The TokenCount attribute type
   #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :analyzer - The String analyzer to be used to analyze the string value. Required.
-  #        :enable_position_increments - The Boolean indicating if position increments should be counted. Defaults to true.
-  #        :doc_values - The Boolean indicating if the field should be stored on disk in a column-stride fashion. Defaults to true.
-  #        :index - The Boolean indicating if the field should be searchable. Defaults to true.
-  #        :null_value - The Numeric value to be substituted for any explicit null values. Defaults to null.
-  #        :store - The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+  # This class is used to define a token_count attribute for a model. It provides support for the Elasticsearch token_count data type, which is a type of data type that can count the number of tokens in a string.
   #
-  # Examples
+  # ### Parameters
   #
-  #   class MyModel < Stretchy::Record
+  # - `type:` `:token_count`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:analyzer:` The String analyzer to be used to analyze the string value. Required.
+  #    - `:enable_position_increments:` The Boolean indicating if position increments should be counted. Defaults to true.
+  #    - `:doc_values:` The Boolean indicating if the field should be stored on disk in a column-stride fashion. Defaults to true.
+  #    - `:index:` The Boolean indicating if the field should be searchable. Defaults to true.
+  #    - `:null_value:` The Numeric value to be substituted for any explicit null values. Defaults to null.
+  #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a token_count attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :description_token_count, :token_count, analyzer: 'standard'
   #   end
+  # ```
   #
-  # Returns nothing.
   class TokenCount < Stretchy::Attributes::Type::Base
     OPTIONS = [:analyzer, :enable_position_increments, :doc_values, :index, :null_value, :store]
 

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

@@ -1,16 +1,26 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a version attribute for the model. This field type is used for software versions following the Semantic Versioning rules.
+  # The Version attribute type
   #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :meta - The Hash of metadata about the field.
+  # This class is used to define a version attribute for a model. This field type is used for software versions following the Semantic Versioning rules.
   #
-  # Examples
+  # ### Parameters
   #
-  #   class MyModel < Stretchy::Record
+  # - `type:` `:version`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:meta:` The Hash of metadata about the field.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a version attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :software_version, :version
   #   end
+  # ```
   #
-  # Returns nothing.
   class Version < Stretchy::Attributes::Type::Base
     OPTIONS = [:meta]
 

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

@@ -1,33 +1,44 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a wildcard attribute for the model. This field type is a specialization of the keyword field, but it supports wildcard searches.
-  #
-  # 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.
-  #
-  # Examples
-  #
-  #   class MyModel
-  #     include StretchyModel
+  # The Wildcard attribute type
+  #
+  # This class is used to define a wildcard attribute for a model. This field type is a specialization of the keyword field, but it supports wildcard searches.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:wildcard`.
+  # - `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.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a wildcard attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :description_wildcard, :wildcard
   #   end
+  # ```
   #
-  # Returns nothing.
   class Wildcard < Stretchy::Attributes::Type::Keyword
+    OPTIONS = [:doc_values, :eager_global_ordinals, :fields, :ignore_above, :index, :index_options, :meta, :norms, :null_value, :on_script_error, :script, :store, :similarity, :normalizer, :split_queries_on_whitespace, :time_series_dimension]
+    attr_reader *OPTIONS
     def type
       :wildcard
     end

data/lib/stretchy/attributes.rb

@@ -1,4 +1,32 @@
 module Stretchy
+  # used to define and manage the attributes of a model in Stretchy. It provides methods for getting and setting attribute values, inspecting the model, and registering attribute types.
+  #
+  # ### Methods
+  #
+  # - `[](attribute)`: Retrieves the value of the specified attribute.
+  # - `[]=(attribute, value)`: Sets the value of the specified attribute.
+  # - `inspect`: Returns a string representation of the model, including its class name and attributes.
+  # - `self.inspect`: Returns a string representation of the model class, including its name and attribute types.
+  # - `attribute_mappings`: Returns a JSON representation of the attribute mappings for the model.
+  # - `self.register!`: Registers the attribute types with ActiveModel.
+  #
+  # ### Example
+  #
+  # In this example, the `Attributes` module is used to define an attribute for `MyModel`, get and set the attribute value, inspect the model and the model class, and get the attribute mappings.
+  #
+  # ```ruby
+  # class MyModel < Stretchy::Record
+  #   attribute :title, :string
+  # end
+  #
+  # model = MyModel.new(title: "hello")
+  # model[:title] # => "hello"
+  # model.inspect # => "#<MyModel title: hello>"
+  # MyModel.inspect # => "#<MyModel title: string>"
+  # MyModel.attribute_mappings # => {properties: {title: {type: "string"}}}
+  # ```
+  #
+  #
   module Attributes
     extend ActiveSupport::Concern
 
@@ -38,11 +66,13 @@ module Stretchy
       ActiveModel::Type.register(:ip, Stretchy::Attributes::Type::IP)
       ActiveModel::Type.register(:join, Stretchy::Attributes::Type::Join)
       ActiveModel::Type.register(:keyword, Stretchy::Attributes::Type::Keyword)
+      ActiveModel::Type.register(:knn_vector, Stretchy::Attributes::Type::KnnVector)
       ActiveModel::Type.register(:match_only_text, Stretchy::Attributes::Type::MatchOnlyText)
       ActiveModel::Type.register(:nested, Stretchy::Attributes::Type::Nested)
       ActiveModel::Type.register(:percolator, Stretchy::Attributes::Type::Percolator)
       ActiveModel::Type.register(:point, Stretchy::Attributes::Type::Point)
       ActiveModel::Type.register(:rank_feature, Stretchy::Attributes::Type::RankFeature)
+      ActiveModel::Type.register(:rank_features, Stretchy::Attributes::Type::RankFeatures)
 
       ActiveModel::Type.register(:text, Stretchy::Attributes::Type::Text)
       ActiveModel::Type.register(:token_count, Stretchy::Attributes::Type::TokenCount)