turbopuffer 0.1.0 → 1.2.0

data/lib/turbopuffer/internal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Internal
+    extend Turbopuffer::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{Turbopuffer::Internal}::OMIT>" }
+      end
+        .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Turbopuffer::FilePart) }
+    end
+  end
+end

data/lib/turbopuffer/models/aggregation_group.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @type [Turbopuffer::Internal::Type::Converter]
+    AggregationGroup = Turbopuffer::Internal::Type::HashOf[Turbopuffer::Internal::Type::Unknown]
+  end
+end

data/lib/turbopuffer/models/attribute_schema.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # The schema for an attribute attached to a document.
+    module AttributeSchema
+      extend Turbopuffer::Internal::Type::Union
+
+      # The data type of the attribute. Valid values: string, int, uint, uuid, datetime, bool, []string, []int, []uint, []uuid, []datetime, [DIMS]f16, [DIMS]f32.
+      variant -> { Turbopuffer::AttributeType }
+
+      # Detailed configuration for an attribute attached to a document.
+      variant -> { Turbopuffer::AttributeSchemaConfig }
+
+      # @!method self.variants
+      #   @return [Array(String, Turbopuffer::Models::AttributeSchemaConfig)]
+    end
+  end
+end

data/lib/turbopuffer/models/attribute_schema_config.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    class AttributeSchemaConfig < Turbopuffer::Internal::Type::BaseModel
+      # @!attribute ann
+      #   Whether to create an approximate nearest neighbor index for the attribute.
+      #
+      #   @return [Boolean, nil]
+      optional :ann, Turbopuffer::Internal::Type::Boolean
+
+      # @!attribute filterable
+      #   Whether or not the attributes can be used in filters.
+      #
+      #   @return [Boolean, nil]
+      optional :filterable, Turbopuffer::Internal::Type::Boolean
+
+      # @!attribute full_text_search
+      #   Whether this attribute can be used as part of a BM25 full-text search. Requires
+      #   the `string` or `[]string` type, and by default, BM25-enabled attributes are not
+      #   filterable. You can override this by setting `filterable: true`.
+      #
+      #   @return [Boolean, Turbopuffer::Models::FullTextSearchConfig, nil]
+      optional :full_text_search, union: -> { Turbopuffer::FullTextSearch }
+
+      # @!attribute regex
+      #   Whether to enable Regex filters on this attribute.
+      #
+      #   @return [Boolean, nil]
+      optional :regex, Turbopuffer::Internal::Type::Boolean
+
+      # @!attribute type
+      #   The data type of the attribute. Valid values: string, int, uint, uuid, datetime,
+      #   bool, []string, []int, []uint, []uuid, []datetime, [DIMS]f16, [DIMS]f32.
+      #
+      #   @return [String, nil]
+      optional :type, String
+
+      # @!method initialize(ann: nil, filterable: nil, full_text_search: nil, regex: nil, type: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Turbopuffer::Models::AttributeSchemaConfig} for more details.
+      #
+      #   Detailed configuration for an attribute attached to a document.
+      #
+      #   @param ann [Boolean] Whether to create an approximate nearest neighbor index for the attribute.
+      #
+      #   @param filterable [Boolean] Whether or not the attributes can be used in filters.
+      #
+      #   @param full_text_search [Boolean, Turbopuffer::Models::FullTextSearchConfig] Whether this attribute can be used as part of a BM25 full-text search. Requires
+      #
+      #   @param regex [Boolean] Whether to enable Regex filters on this attribute.
+      #
+      #   @param type [String] The data type of the attribute. Valid values: string, int, uint, uuid, datetime,
+    end
+  end
+end

data/lib/turbopuffer/models/attribute_type.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    AttributeType = String
+  end
+end

data/lib/turbopuffer/models/client_namespaces_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Client#namespaces
+    class ClientNamespacesParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   Retrieve the next page of results.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute page_size
+      #   Limit the number of results per page.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute prefix
+      #   Retrieve only the namespaces that match the prefix.
+      #
+      #   @return [String, nil]
+      optional :prefix, String
+
+      # @!method initialize(cursor: nil, page_size: nil, prefix: nil, request_options: {})
+      #   @param cursor [String] Retrieve the next page of results.
+      #
+      #   @param page_size [Integer] Limit the number of results per page.
+      #
+      #   @param prefix [String] Retrieve only the namespaces that match the prefix.
+      #
+      #   @param request_options [Turbopuffer::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/turbopuffer/models/columns.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    class Columns < Turbopuffer::Internal::Type::BaseModel
+      # @!attribute id
+      #   The IDs of the documents.
+      #
+      #   @return [Array<String, Integer>]
+      required :id, -> { Turbopuffer::Internal::Type::ArrayOf[union: Turbopuffer::ID] }
+
+      # @!attribute vector
+      #   The vector embeddings of the documents.
+      #
+      #   @return [Array<Array<Float>, String>, Array<Float>, String, nil]
+      optional :vector, union: -> { Turbopuffer::Columns::Vector }
+
+      # @!method initialize(id:, vector: nil)
+      #   A list of documents in columnar format. Each key is a column name, mapped to an
+      #   array of values for that column.
+      #
+      #   @param id [Array<String, Integer>] The IDs of the documents.
+      #
+      #   @param vector [Array<Array<Float>, String>, Array<Float>, String] The vector embeddings of the documents.
+
+      # The vector embeddings of the documents.
+      #
+      # @see Turbopuffer::Models::Columns#vector
+      module Vector
+        extend Turbopuffer::Internal::Type::Union
+
+        # The vector embeddings of the documents.
+        variant -> { Turbopuffer::Models::Columns::Vector::VectorArray }
+
+        # A dense vector encoded as an array of floats.
+        variant -> { Turbopuffer::Models::Columns::Vector::FloatArray }
+
+        # A dense vector encoded as a base64 string.
+        variant String
+
+        # @!method self.variants
+        #   @return [Array(Array<Array<Float>, String>, Array<Float>, String)]
+
+        # @type [Turbopuffer::Internal::Type::Converter]
+        VectorArray = Turbopuffer::Internal::Type::ArrayOf[union: -> { Turbopuffer::Vector }]
+
+        # @type [Turbopuffer::Internal::Type::Converter]
+        FloatArray = Turbopuffer::Internal::Type::ArrayOf[Float]
+      end
+
+      def method_missing(name, *args, &block)
+        if @data.key?(name)
+          @data[name]
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(name, include_private = false)
+        @data.key?(name) || super
+      end
+    end
+  end
+end

data/lib/turbopuffer/models/distance_metric.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # A function used to calculate vector similarity.
+    module DistanceMetric
+      extend Turbopuffer::Internal::Type::Enum
+
+      # Defined as `1 - cosine_similarity` and ranges from 0 to 2. Lower is better.
+      COSINE_DISTANCE = :cosine_distance
+
+      # Defined as `sum((x - y)^2)`. Lower is better.
+      EUCLIDEAN_SQUARED = :euclidean_squared
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/turbopuffer/models/full_text_search.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # Whether this attribute can be used as part of a BM25 full-text search. Requires
+    # the `string` or `[]string` type, and by default, BM25-enabled attributes are not
+    # filterable. You can override this by setting `filterable: true`.
+    module FullTextSearch
+      extend Turbopuffer::Internal::Type::Union
+
+      variant Turbopuffer::Internal::Type::Boolean
+
+      # Configuration options for full-text search.
+      variant -> { Turbopuffer::FullTextSearchConfig }
+
+      # @!method self.variants
+      #   @return [Array(Boolean, Turbopuffer::Models::FullTextSearchConfig)]
+    end
+  end
+end

data/lib/turbopuffer/models/full_text_search_config.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    class FullTextSearchConfig < Turbopuffer::Internal::Type::BaseModel
+      # @!attribute b
+      #   The `b` document length normalization parameter for BM25. Defaults to `0.75`.
+      #
+      #   @return [Float, nil]
+      optional :b, Float
+
+      # @!attribute case_sensitive
+      #   Whether searching is case-sensitive. Defaults to `false` (i.e.
+      #   case-insensitive).
+      #
+      #   @return [Boolean, nil]
+      optional :case_sensitive, Turbopuffer::Internal::Type::Boolean
+
+      # @!attribute k1
+      #   The `k1` term saturation parameter for BM25. Defaults to `1.2`.
+      #
+      #   @return [Float, nil]
+      optional :k1, Float
+
+      # @!attribute language
+      #   Describes the language of a text attribute. Defaults to `english`.
+      #
+      #   @return [Symbol, Turbopuffer::Models::Language, nil]
+      optional :language, enum: -> { Turbopuffer::Language }
+
+      # @!attribute max_token_length
+      #   Maximum length of a token in bytes. Tokens larger than this value during
+      #   tokenization will be filtered out. Has to be between `1` and `254` (inclusive).
+      #   Defaults to `39`.
+      #
+      #   @return [Integer, nil]
+      optional :max_token_length, Integer
+
+      # @!attribute remove_stopwords
+      #   Removes common words from the text based on language. Defaults to `true` (i.e.
+      #   remove common words).
+      #
+      #   @return [Boolean, nil]
+      optional :remove_stopwords, Turbopuffer::Internal::Type::Boolean
+
+      # @!attribute stemming
+      #   Language-specific stemming for the text. Defaults to `false` (i.e., do not
+      #   stem).
+      #
+      #   @return [Boolean, nil]
+      optional :stemming, Turbopuffer::Internal::Type::Boolean
+
+      # @!attribute tokenizer
+      #   The tokenizer to use for full-text search on an attribute. Defaults to
+      #   `word_v2`.
+      #
+      #   @return [Symbol, Turbopuffer::Models::Tokenizer, nil]
+      optional :tokenizer, enum: -> { Turbopuffer::Tokenizer }
+
+      # @!method initialize(b: nil, case_sensitive: nil, k1: nil, language: nil, max_token_length: nil, remove_stopwords: nil, stemming: nil, tokenizer: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Turbopuffer::Models::FullTextSearchConfig} for more details.
+      #
+      #   Configuration options for full-text search.
+      #
+      #   @param b [Float] The `b` document length normalization parameter for BM25. Defaults to `0.75`.
+      #
+      #   @param case_sensitive [Boolean] Whether searching is case-sensitive. Defaults to `false` (i.e. case-insensitive)
+      #
+      #   @param k1 [Float] The `k1` term saturation parameter for BM25. Defaults to `1.2`.
+      #
+      #   @param language [Symbol, Turbopuffer::Models::Language] Describes the language of a text attribute. Defaults to `english`.
+      #
+      #   @param max_token_length [Integer] Maximum length of a token in bytes. Tokens larger than this value during tokeniz
+      #
+      #   @param remove_stopwords [Boolean] Removes common words from the text based on language. Defaults to `true` (i.e. r
+      #
+      #   @param stemming [Boolean] Language-specific stemming for the text. Defaults to `false` (i.e., do not stem)
+      #
+      #   @param tokenizer [Symbol, Turbopuffer::Models::Tokenizer] The tokenizer to use for full-text search on an attribute. Defaults to `word_v2`
+    end
+  end
+end

data/lib/turbopuffer/models/id.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # An identifier for a document.
+    module ID
+      extend Turbopuffer::Internal::Type::Union
+
+      # A UUID.
+      variant String
+
+      # An integer ID.
+      variant Integer
+
+      # @!method self.variants
+      #   @return [Array(String, Integer)]
+    end
+  end
+end

data/lib/turbopuffer/models/include_attributes.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # Whether to include attributes in the response.
+    module IncludeAttributes
+      extend Turbopuffer::Internal::Type::Union
+
+      # When `true`, include all attributes in the response. When `false`, include no attributes in the response.
+      variant Turbopuffer::Internal::Type::Boolean
+
+      # Include exactly the specified attributes in the response.
+      variant -> { Turbopuffer::Models::IncludeAttributes::StringArray }
+
+      # @!method self.variants
+      #   @return [Array(Boolean, Array<String>)]
+
+      # @type [Turbopuffer::Internal::Type::Converter]
+      StringArray = Turbopuffer::Internal::Type::ArrayOf[String]
+    end
+  end
+end

data/lib/turbopuffer/models/language.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # Describes the language of a text attribute. Defaults to `english`.
+    module Language
+      extend Turbopuffer::Internal::Type::Enum
+
+      ARABIC = :arabic
+      DANISH = :danish
+      DUTCH = :dutch
+      ENGLISH = :english
+      FINNISH = :finnish
+      FRENCH = :french
+      GERMAN = :german
+      GREEK = :greek
+      HUNGARIAN = :hungarian
+      ITALIAN = :italian
+      NORWEGIAN = :norwegian
+      PORTUGUESE = :portuguese
+      ROMANIAN = :romanian
+      RUSSIAN = :russian
+      SPANISH = :spanish
+      SWEDISH = :swedish
+      TAMIL = :tamil
+      TURKISH = :turkish
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/turbopuffer/models/namespace_delete_all_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Namespaces#delete_all
+    class NamespaceDeleteAllParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      # @!attribute namespace
+      #
+      #   @return [String, nil]
+      optional :namespace, String
+
+      # @!method initialize(namespace: nil, request_options: {})
+      #   @param namespace [String]
+      #   @param request_options [Turbopuffer::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/turbopuffer/models/namespace_delete_all_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Namespaces#delete_all
+    class NamespaceDeleteAllResponse < Turbopuffer::Internal::Type::BaseModel
+      # @!attribute status
+      #   The status of the request.
+      #
+      #   @return [Symbol, :OK]
+      required :status, const: :OK
+
+      # @!method initialize(status: :OK)
+      #   The response to a successful namespace deletion request.
+      #
+      #   @param status [Symbol, :OK] The status of the request.
+    end
+  end
+end

data/lib/turbopuffer/models/namespace_explain_query_params.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Namespaces#explain_query
+    class NamespaceExplainQueryParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      # @!attribute namespace
+      #
+      #   @return [String, nil]
+      optional :namespace, String
+
+      # @!attribute aggregate_by
+      #   Aggregations to compute over all documents in the namespace that match the
+      #   filters.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :aggregate_by, Turbopuffer::Internal::Type::HashOf[Turbopuffer::Internal::Type::Unknown]
+
+      # @!attribute consistency
+      #   The consistency level for a query.
+      #
+      #   @return [Turbopuffer::Models::NamespaceExplainQueryParams::Consistency, nil]
+      optional :consistency, -> { Turbopuffer::NamespaceExplainQueryParams::Consistency }
+
+      # @!attribute distance_metric
+      #   A function used to calculate vector similarity.
+      #
+      #   @return [Symbol, Turbopuffer::Models::DistanceMetric, nil]
+      optional :distance_metric, enum: -> { Turbopuffer::DistanceMetric }
+
+      # @!attribute exclude_attributes
+      #   List of attribute names to exclude from the response. All other attributes will
+      #   be included in the response.
+      #
+      #   @return [Array<String>, nil]
+      optional :exclude_attributes, Turbopuffer::Internal::Type::ArrayOf[String]
+
+      # @!attribute filters
+      #   Exact filters for attributes to refine search results for. Think of it as a SQL
+      #   WHERE clause.
+      #
+      #   @return [Object, nil]
+      optional :filters, Turbopuffer::Internal::Type::Unknown
+
+      # @!attribute group_by
+      #   Groups documents by the specified attributes (the "group key") before computing
+      #   aggregates. Aggregates are computed separately for each group.
+      #
+      #   @return [Array<String>, nil]
+      optional :group_by, Turbopuffer::Internal::Type::ArrayOf[String]
+
+      # @!attribute include_attributes
+      #   Whether to include attributes in the response.
+      #
+      #   @return [Boolean, Array<String>, nil]
+      optional :include_attributes, union: -> { Turbopuffer::IncludeAttributes }
+
+      # @!attribute rank_by
+      #   How to rank the documents in the namespace.
+      #
+      #   @return [Object, nil]
+      optional :rank_by, Turbopuffer::Internal::Type::Unknown
+
+      # @!attribute top_k
+      #   The number of results to return.
+      #
+      #   @return [Integer, nil]
+      optional :top_k, Integer
+
+      # @!attribute vector_encoding
+      #   The encoding to use for vectors in the response.
+      #
+      #   @return [Symbol, Turbopuffer::Models::VectorEncoding, nil]
+      optional :vector_encoding, enum: -> { Turbopuffer::VectorEncoding }
+
+      # @!method initialize(namespace: nil, aggregate_by: nil, consistency: nil, distance_metric: nil, exclude_attributes: nil, filters: nil, group_by: nil, include_attributes: nil, rank_by: nil, top_k: nil, vector_encoding: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Turbopuffer::Models::NamespaceExplainQueryParams} for more details.
+      #
+      #   @param namespace [String]
+      #
+      #   @param aggregate_by [Hash{Symbol=>Object}] Aggregations to compute over all documents in the namespace that match the filte
+      #
+      #   @param consistency [Turbopuffer::Models::NamespaceExplainQueryParams::Consistency] The consistency level for a query.
+      #
+      #   @param distance_metric [Symbol, Turbopuffer::Models::DistanceMetric] A function used to calculate vector similarity.
+      #
+      #   @param exclude_attributes [Array<String>] List of attribute names to exclude from the response. All other attributes will
+      #
+      #   @param filters [Object] Exact filters for attributes to refine search results for. Think of it as a SQL
+      #
+      #   @param group_by [Array<String>] Groups documents by the specified attributes (the "group key") before computing
+      #
+      #   @param include_attributes [Boolean, Array<String>] Whether to include attributes in the response.
+      #
+      #   @param rank_by [Object] How to rank the documents in the namespace.
+      #
+      #   @param top_k [Integer] The number of results to return.
+      #
+      #   @param vector_encoding [Symbol, Turbopuffer::Models::VectorEncoding] The encoding to use for vectors in the response.
+      #
+      #   @param request_options [Turbopuffer::RequestOptions, Hash{Symbol=>Object}]
+
+      class Consistency < Turbopuffer::Internal::Type::BaseModel
+        # @!attribute level
+        #   The query's consistency level.
+        #
+        #   @return [Symbol, Turbopuffer::Models::NamespaceExplainQueryParams::Consistency::Level, nil]
+        optional :level, enum: -> { Turbopuffer::NamespaceExplainQueryParams::Consistency::Level }
+
+        # @!method initialize(level: nil)
+        #   The consistency level for a query.
+        #
+        #   @param level [Symbol, Turbopuffer::Models::NamespaceExplainQueryParams::Consistency::Level] The query's consistency level.
+
+        # The query's consistency level.
+        #
+        # @see Turbopuffer::Models::NamespaceExplainQueryParams::Consistency#level
+        module Level
+          extend Turbopuffer::Internal::Type::Enum
+
+          # Strong consistency. Requires a round-trip to object storage to fetch the latest writes.
+          STRONG = :strong
+
+          # Eventual consistency. Does not require a round-trip to object storage, but may not see the latest writes.
+          EVENTUAL = :eventual
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/turbopuffer/models/namespace_explain_query_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Namespaces#explain_query
+    class NamespaceExplainQueryResponse < Turbopuffer::Internal::Type::BaseModel
+      # @!attribute plan_text
+      #   The textual representation of the query plan.
+      #
+      #   @return [String, nil]
+      optional :plan_text, String
+
+      # @!method initialize(plan_text: nil)
+      #   The response to a successful query explain.
+      #
+      #   @param plan_text [String] The textual representation of the query plan.
+    end
+  end
+end

data/lib/turbopuffer/models/namespace_hint_cache_warm_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Namespaces#hint_cache_warm
+    class NamespaceHintCacheWarmParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      # @!attribute namespace
+      #
+      #   @return [String, nil]
+      optional :namespace, String
+
+      # @!method initialize(namespace: nil, request_options: {})
+      #   @param namespace [String]
+      #   @param request_options [Turbopuffer::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/turbopuffer/models/namespace_hint_cache_warm_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Namespaces#hint_cache_warm
+    class NamespaceHintCacheWarmResponse < Turbopuffer::Internal::Type::BaseModel
+      # @!attribute status
+      #   The status of the request.
+      #
+      #   @return [Symbol, :ACCEPTED]
+      required :status, const: :ACCEPTED
+
+      # @!attribute message
+      #
+      #   @return [String, nil]
+      optional :message, String
+
+      # @!method initialize(message: nil, status: :ACCEPTED)
+      #   The response to a successful cache warm request.
+      #
+      #   @param message [String]
+      #
+      #   @param status [Symbol, :ACCEPTED] The status of the request.
+    end
+  end
+end