turbopuffer-ruby 0.2.0.pre.alpha.1

data/lib/turbopuffer/models/namespace_query_params.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Namespaces#query
+    class NamespaceQueryParams < 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::NamespaceQueryParams::Consistency, nil]
+      optional :consistency, -> { Turbopuffer::NamespaceQueryParams::Consistency }
+
+      # @!attribute distance_metric
+      #   A function used to calculate vector similarity.
+      #
+      #   @return [Symbol, Turbopuffer::Models::DistanceMetric, nil]
+      optional :distance_metric, enum: -> { Turbopuffer::DistanceMetric }
+
+      # @!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 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, filters: nil, include_attributes: nil, rank_by: nil, top_k: nil, vector_encoding: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Turbopuffer::Models::NamespaceQueryParams} 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::NamespaceQueryParams::Consistency] The consistency level for a query.
+      #
+      #   @param distance_metric [Symbol, Turbopuffer::Models::DistanceMetric] A function used to calculate vector similarity.
+      #
+      #   @param filters [Object] Exact filters for attributes to refine search results for. Think of it as a SQL
+      #
+      #   @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::NamespaceQueryParams::Consistency::Level, nil]
+        optional :level, enum: -> { Turbopuffer::NamespaceQueryParams::Consistency::Level }
+
+        # @!method initialize(level: nil)
+        #   The consistency level for a query.
+        #
+        #   @param level [Symbol, Turbopuffer::Models::NamespaceQueryParams::Consistency::Level] The query's consistency level.
+
+        # The query's consistency level.
+        #
+        # @see Turbopuffer::Models::NamespaceQueryParams::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_query_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Namespaces#query
+    class NamespaceQueryResponse < Turbopuffer::Internal::Type::BaseModel
+      # @!attribute billing
+      #   The billing information for a query.
+      #
+      #   @return [Turbopuffer::Models::QueryBilling]
+      required :billing, -> { Turbopuffer::QueryBilling }
+
+      # @!attribute performance
+      #   The performance information for a query.
+      #
+      #   @return [Turbopuffer::Models::QueryPerformance]
+      required :performance, -> { Turbopuffer::QueryPerformance }
+
+      # @!attribute aggregations
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :aggregations, Turbopuffer::Internal::Type::HashOf[Turbopuffer::Internal::Type::Unknown]
+
+      # @!attribute rows
+      #
+      #   @return [Array<Turbopuffer::Models::Row>, nil]
+      optional :rows, -> { Turbopuffer::Internal::Type::ArrayOf[Turbopuffer::Row] }
+
+      # @!method initialize(billing:, performance:, aggregations: nil, rows: nil)
+      #   The result of a query.
+      #
+      #   @param billing [Turbopuffer::Models::QueryBilling] The billing information for a query.
+      #
+      #   @param performance [Turbopuffer::Models::QueryPerformance] The performance information for a query.
+      #
+      #   @param aggregations [Hash{Symbol=>Object}]
+      #
+      #   @param rows [Array<Turbopuffer::Models::Row>]
+    end
+  end
+end

data/lib/turbopuffer/models/namespace_recall_params.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Namespaces#recall
+    class NamespaceRecallParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      # @!attribute namespace
+      #
+      #   @return [String, nil]
+      optional :namespace, String
+
+      # @!attribute filters
+      #   Filter by attributes. Same syntax as the query endpoint.
+      #
+      #   @return [Object, nil]
+      optional :filters, Turbopuffer::Internal::Type::Unknown
+
+      # @!attribute num
+      #   The number of searches to run.
+      #
+      #   @return [Integer, nil]
+      optional :num, Integer
+
+      # @!attribute queries
+      #   Use specific query vectors for the measurement. If omitted, sampled from the
+      #   index.
+      #
+      #   @return [Array<Float>, nil]
+      optional :queries, Turbopuffer::Internal::Type::ArrayOf[Float]
+
+      # @!attribute top_k
+      #   Search for `top_k` nearest neighbors.
+      #
+      #   @return [Integer, nil]
+      optional :top_k, Integer
+
+      # @!method initialize(namespace: nil, filters: nil, num: nil, queries: nil, top_k: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Turbopuffer::Models::NamespaceRecallParams} for more details.
+      #
+      #   @param namespace [String]
+      #
+      #   @param filters [Object] Filter by attributes. Same syntax as the query endpoint.
+      #
+      #   @param num [Integer] The number of searches to run.
+      #
+      #   @param queries [Array<Float>] Use specific query vectors for the measurement. If omitted, sampled from the ind
+      #
+      #   @param top_k [Integer] Search for `top_k` nearest neighbors.
+      #
+      #   @param request_options [Turbopuffer::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/turbopuffer/models/namespace_recall_response.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Namespaces#recall
+    class NamespaceRecallResponse < Turbopuffer::Internal::Type::BaseModel
+      # @!attribute avg_ann_count
+      #   The average number of documents retrieved by the approximate nearest neighbor
+      #   searches.
+      #
+      #   @return [Float]
+      required :avg_ann_count, Float
+
+      # @!attribute avg_exhaustive_count
+      #   The average number of documents retrieved by the exhaustive searches.
+      #
+      #   @return [Float]
+      required :avg_exhaustive_count, Float
+
+      # @!attribute avg_recall
+      #   The average recall of the queries.
+      #
+      #   @return [Float]
+      required :avg_recall, Float
+
+      # @!method initialize(avg_ann_count:, avg_exhaustive_count:, avg_recall:)
+      #   Some parameter documentations has been truncated, see
+      #   {Turbopuffer::Models::NamespaceRecallResponse} for more details.
+      #
+      #   The response to a successful cache warm request.
+      #
+      #   @param avg_ann_count [Float] The average number of documents retrieved by the approximate nearest neighbor se
+      #
+      #   @param avg_exhaustive_count [Float] The average number of documents retrieved by the exhaustive searches.
+      #
+      #   @param avg_recall [Float] The average recall of the queries.
+    end
+  end
+end

data/lib/turbopuffer/models/namespace_schema_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Namespaces#schema
+    class NamespaceSchemaParams < 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_schema_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @type [Turbopuffer::Internal::Type::Converter]
+    NamespaceSchemaResponse = Turbopuffer::Internal::Type::HashOf[-> { Turbopuffer::AttributeSchemaConfig }]
+  end
+end

data/lib/turbopuffer/models/namespace_summary.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Client#namespaces
+    class NamespaceSummary < Turbopuffer::Internal::Type::BaseModel
+      # @!attribute id
+      #   The namespace ID.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:)
+      #   A summary of a namespace.
+      #
+      #   @param id [String] The namespace ID.
+    end
+  end
+end

data/lib/turbopuffer/models/namespace_update_schema_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Namespaces#update_schema
+    class NamespaceUpdateSchemaParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      # @!attribute namespace
+      #
+      #   @return [String, nil]
+      optional :namespace, String
+
+      # @!attribute schema
+      #   The desired schema for the namespace.
+      #
+      #   @return [Hash{Symbol=>String, Turbopuffer::Models::AttributeSchemaConfig}, nil]
+      optional :schema, -> { Turbopuffer::Internal::Type::HashOf[union: Turbopuffer::AttributeSchema] }
+
+      # @!method initialize(namespace: nil, schema: nil, request_options: {})
+      #   @param namespace [String]
+      #
+      #   @param schema [Hash{Symbol=>String, Turbopuffer::Models::AttributeSchemaConfig}] The desired schema for the namespace.
+      #
+      #   @param request_options [Turbopuffer::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/turbopuffer/models/namespace_update_schema_response.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @type [Turbopuffer::Internal::Type::Converter]
+    NamespaceUpdateSchemaResponse =
+      Turbopuffer::Internal::Type::HashOf[-> { Turbopuffer::AttributeSchemaConfig }]
+  end
+end

data/lib/turbopuffer/models/namespace_write_params.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Namespaces#write
+    class NamespaceWriteParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      # @!attribute namespace
+      #
+      #   @return [String, nil]
+      optional :namespace, String
+
+      # @!attribute copy_from_namespace
+      #   The namespace to copy documents from.
+      #
+      #   @return [String, nil]
+      optional :copy_from_namespace, String
+
+      # @!attribute delete_by_filter
+      #   The filter specifying which documents to delete.
+      #
+      #   @return [Object, nil]
+      optional :delete_by_filter, Turbopuffer::Internal::Type::Unknown
+
+      # @!attribute delete_condition
+      #   A condition evaluated against the current value of each document targeted by a
+      #   delete write. Only documents that pass the condition are deleted.
+      #
+      #   @return [Object, nil]
+      optional :delete_condition, Turbopuffer::Internal::Type::Unknown
+
+      # @!attribute deletes
+      #
+      #   @return [Array<String, Integer>, nil]
+      optional :deletes, -> { Turbopuffer::Internal::Type::ArrayOf[union: Turbopuffer::ID] }
+
+      # @!attribute distance_metric
+      #   A function used to calculate vector similarity.
+      #
+      #   @return [Symbol, Turbopuffer::Models::DistanceMetric, nil]
+      optional :distance_metric, enum: -> { Turbopuffer::DistanceMetric }
+
+      # @!attribute encryption
+      #   The encryption configuration for a namespace.
+      #
+      #   @return [Turbopuffer::Models::NamespaceWriteParams::Encryption, nil]
+      optional :encryption, -> { Turbopuffer::NamespaceWriteParams::Encryption }
+
+      # @!attribute patch_columns
+      #   A list of documents in columnar format. Each key is a column name, mapped to an
+      #   array of values for that column.
+      #
+      #   @return [Turbopuffer::Models::Columns, nil]
+      optional :patch_columns, -> { Turbopuffer::Columns }
+
+      # @!attribute patch_condition
+      #   A condition evaluated against the current value of each document targeted by a
+      #   patch write. Only documents that pass the condition are patched.
+      #
+      #   @return [Object, nil]
+      optional :patch_condition, Turbopuffer::Internal::Type::Unknown
+
+      # @!attribute patch_rows
+      #
+      #   @return [Array<Turbopuffer::Models::Row>, nil]
+      optional :patch_rows, -> { Turbopuffer::Internal::Type::ArrayOf[Turbopuffer::Row] }
+
+      # @!attribute schema
+      #   The schema of the attributes attached to the documents.
+      #
+      #   @return [Hash{Symbol=>String, Turbopuffer::Models::AttributeSchemaConfig}, nil]
+      optional :schema, -> { Turbopuffer::Internal::Type::HashOf[union: Turbopuffer::AttributeSchema] }
+
+      # @!attribute upsert_columns
+      #   A list of documents in columnar format. Each key is a column name, mapped to an
+      #   array of values for that column.
+      #
+      #   @return [Turbopuffer::Models::Columns, nil]
+      optional :upsert_columns, -> { Turbopuffer::Columns }
+
+      # @!attribute upsert_condition
+      #   A condition evaluated against the current value of each document targeted by an
+      #   upsert write. Only documents that pass the condition are upserted.
+      #
+      #   @return [Object, nil]
+      optional :upsert_condition, Turbopuffer::Internal::Type::Unknown
+
+      # @!attribute upsert_rows
+      #
+      #   @return [Array<Turbopuffer::Models::Row>, nil]
+      optional :upsert_rows, -> { Turbopuffer::Internal::Type::ArrayOf[Turbopuffer::Row] }
+
+      # @!method initialize(namespace: nil, copy_from_namespace: nil, delete_by_filter: nil, delete_condition: nil, deletes: nil, distance_metric: nil, encryption: nil, patch_columns: nil, patch_condition: nil, patch_rows: nil, schema: nil, upsert_columns: nil, upsert_condition: nil, upsert_rows: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Turbopuffer::Models::NamespaceWriteParams} for more details.
+      #
+      #   @param namespace [String]
+      #
+      #   @param copy_from_namespace [String] The namespace to copy documents from.
+      #
+      #   @param delete_by_filter [Object] The filter specifying which documents to delete.
+      #
+      #   @param delete_condition [Object] A condition evaluated against the current value of each document targeted by a d
+      #
+      #   @param deletes [Array<String, Integer>]
+      #
+      #   @param distance_metric [Symbol, Turbopuffer::Models::DistanceMetric] A function used to calculate vector similarity.
+      #
+      #   @param encryption [Turbopuffer::Models::NamespaceWriteParams::Encryption] The encryption configuration for a namespace.
+      #
+      #   @param patch_columns [Turbopuffer::Models::Columns] A list of documents in columnar format. Each key is a column name, mapped to an
+      #
+      #   @param patch_condition [Object] A condition evaluated against the current value of each document targeted by a p
+      #
+      #   @param patch_rows [Array<Turbopuffer::Models::Row>]
+      #
+      #   @param schema [Hash{Symbol=>String, Turbopuffer::Models::AttributeSchemaConfig}] The schema of the attributes attached to the documents.
+      #
+      #   @param upsert_columns [Turbopuffer::Models::Columns] A list of documents in columnar format. Each key is a column name, mapped to an
+      #
+      #   @param upsert_condition [Object] A condition evaluated against the current value of each document targeted by an
+      #
+      #   @param upsert_rows [Array<Turbopuffer::Models::Row>]
+      #
+      #   @param request_options [Turbopuffer::RequestOptions, Hash{Symbol=>Object}]
+
+      class Encryption < Turbopuffer::Internal::Type::BaseModel
+        # @!attribute cmek
+        #
+        #   @return [Turbopuffer::Models::NamespaceWriteParams::Encryption::Cmek, nil]
+        optional :cmek, -> { Turbopuffer::NamespaceWriteParams::Encryption::Cmek }
+
+        # @!method initialize(cmek: nil)
+        #   The encryption configuration for a namespace.
+        #
+        #   @param cmek [Turbopuffer::Models::NamespaceWriteParams::Encryption::Cmek]
+
+        # @see Turbopuffer::Models::NamespaceWriteParams::Encryption#cmek
+        class Cmek < Turbopuffer::Internal::Type::BaseModel
+          # @!attribute key_name
+          #   The identifier of the CMEK key to use for encryption. For GCP, the
+          #   fully-qualified resource name of the key. For AWS, the ARN of the key.
+          #
+          #   @return [String]
+          required :key_name, String
+
+          # @!method initialize(key_name:)
+          #   Some parameter documentations has been truncated, see
+          #   {Turbopuffer::Models::NamespaceWriteParams::Encryption::Cmek} for more details.
+          #
+          #   @param key_name [String] The identifier of the CMEK key to use for encryption. For GCP, the fully-qualifi
+        end
+      end
+    end
+  end
+end

data/lib/turbopuffer/models/namespace_write_response.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Namespaces#write
+    class NamespaceWriteResponse < Turbopuffer::Internal::Type::BaseModel
+      # @!attribute billing
+      #   The billing information for a write request.
+      #
+      #   @return [Turbopuffer::Models::WriteBilling]
+      required :billing, -> { Turbopuffer::WriteBilling }
+
+      # @!attribute message
+      #   A message describing the result of the write request.
+      #
+      #   @return [String]
+      required :message, String
+
+      # @!attribute rows_affected
+      #   The number of rows affected by the write request.
+      #
+      #   @return [Integer]
+      required :rows_affected, Integer
+
+      # @!attribute status
+      #   The status of the request.
+      #
+      #   @return [Symbol, :OK]
+      required :status, const: :OK
+
+      # @!attribute rows_deleted
+      #   The number of rows deleted by the write request.
+      #
+      #   @return [Integer, nil]
+      optional :rows_deleted, Integer
+
+      # @!attribute rows_patched
+      #   The number of rows patched by the write request.
+      #
+      #   @return [Integer, nil]
+      optional :rows_patched, Integer
+
+      # @!attribute rows_upserted
+      #   The number of rows upserted by the write request.
+      #
+      #   @return [Integer, nil]
+      optional :rows_upserted, Integer
+
+      # @!method initialize(billing:, message:, rows_affected:, rows_deleted: nil, rows_patched: nil, rows_upserted: nil, status: :OK)
+      #   The response to a successful write request.
+      #
+      #   @param billing [Turbopuffer::Models::WriteBilling] The billing information for a write request.
+      #
+      #   @param message [String] A message describing the result of the write request.
+      #
+      #   @param rows_affected [Integer] The number of rows affected by the write request.
+      #
+      #   @param rows_deleted [Integer] The number of rows deleted by the write request.
+      #
+      #   @param rows_patched [Integer] The number of rows patched by the write request.
+      #
+      #   @param rows_upserted [Integer] The number of rows upserted by the write request.
+      #
+      #   @param status [Symbol, :OK] The status of the request.
+    end
+  end
+end

data/lib/turbopuffer/models/query.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    class Query < Turbopuffer::Internal::Type::BaseModel
+      # @!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 distance_metric
+      #   A function used to calculate vector similarity.
+      #
+      #   @return [Symbol, Turbopuffer::Models::DistanceMetric, nil]
+      optional :distance_metric, enum: -> { Turbopuffer::DistanceMetric }
+
+      # @!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 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
+
+      # @!method initialize(aggregate_by: nil, distance_metric: nil, filters: nil, include_attributes: nil, rank_by: nil, top_k: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Turbopuffer::Models::Query} for more details.
+      #
+      #   Query, filter, full-text search and vector search documents.
+      #
+      #   @param aggregate_by [Hash{Symbol=>Object}] Aggregations to compute over all documents in the namespace that match the filte
+      #
+      #   @param distance_metric [Symbol, Turbopuffer::Models::DistanceMetric] A function used to calculate vector similarity.
+      #
+      #   @param filters [Object] Exact filters for attributes to refine search results for. Think of it as a SQL
+      #
+      #   @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.
+    end
+  end
+end

data/lib/turbopuffer/models/query_billing.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    class QueryBilling < Turbopuffer::Internal::Type::BaseModel
+      # @!attribute billable_logical_bytes_queried
+      #   The number of billable logical bytes queried from the namespace.
+      #
+      #   @return [Integer]
+      required :billable_logical_bytes_queried, Integer
+
+      # @!attribute billable_logical_bytes_returned
+      #   The number of billable logical bytes returned from the query.
+      #
+      #   @return [Integer]
+      required :billable_logical_bytes_returned, Integer
+
+      # @!method initialize(billable_logical_bytes_queried:, billable_logical_bytes_returned:)
+      #   The billing information for a query.
+      #
+      #   @param billable_logical_bytes_queried [Integer] The number of billable logical bytes queried from the namespace.
+      #
+      #   @param billable_logical_bytes_returned [Integer] The number of billable logical bytes returned from the query.
+    end
+  end
+end