turbopuffer 0.1.0 → 1.2.0

data/rbi/turbopuffer/models/namespace_update_schema_params.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class NamespaceUpdateSchemaParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Turbopuffer::NamespaceUpdateSchemaParams,
+            Turbopuffer::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :namespace
+
+      sig { params(namespace: String).void }
+      attr_writer :namespace
+
+      # The desired schema for the namespace.
+      sig do
+        returns(
+          T.nilable(
+            T::Hash[Symbol, T.any(String, Turbopuffer::AttributeSchemaConfig)]
+          )
+        )
+      end
+      attr_reader :schema
+
+      sig do
+        params(
+          schema:
+            T::Hash[
+              Symbol,
+              T.any(String, Turbopuffer::AttributeSchemaConfig::OrHash)
+            ]
+        ).void
+      end
+      attr_writer :schema
+
+      sig do
+        params(
+          namespace: String,
+          schema:
+            T::Hash[
+              Symbol,
+              T.any(String, Turbopuffer::AttributeSchemaConfig::OrHash)
+            ],
+          request_options: Turbopuffer::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        namespace: nil,
+        # The desired schema for the namespace.
+        schema: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            namespace: String,
+            schema:
+              T::Hash[
+                Symbol,
+                T.any(String, Turbopuffer::AttributeSchemaConfig)
+              ],
+            request_options: Turbopuffer::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/namespace_update_schema_response.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    NamespaceUpdateSchemaResponse =
+      T.let(
+        Turbopuffer::Internal::Type::HashOf[Turbopuffer::AttributeSchemaConfig],
+        Turbopuffer::Internal::Type::Converter
+      )
+  end
+end

data/rbi/turbopuffer/models/namespace_write_params.rbi

@@ -0,0 +1,290 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class NamespaceWriteParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Turbopuffer::NamespaceWriteParams,
+            Turbopuffer::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :namespace
+
+      sig { params(namespace: String).void }
+      attr_writer :namespace
+
+      # The namespace to copy documents from.
+      sig { returns(T.nilable(String)) }
+      attr_reader :copy_from_namespace
+
+      sig { params(copy_from_namespace: String).void }
+      attr_writer :copy_from_namespace
+
+      # The filter specifying which documents to delete.
+      sig { returns(T.nilable(T.anything)) }
+      attr_reader :delete_by_filter
+
+      sig { params(delete_by_filter: T.anything).void }
+      attr_writer :delete_by_filter
+
+      # A condition evaluated against the current value of each document targeted by a
+      # delete write. Only documents that pass the condition are deleted.
+      sig { returns(T.nilable(T.anything)) }
+      attr_reader :delete_condition
+
+      sig { params(delete_condition: T.anything).void }
+      attr_writer :delete_condition
+
+      sig { returns(T.nilable(T::Array[Turbopuffer::ID::Variants])) }
+      attr_reader :deletes
+
+      sig { params(deletes: T::Array[Turbopuffer::ID::Variants]).void }
+      attr_writer :deletes
+
+      # A function used to calculate vector similarity.
+      sig { returns(T.nilable(Turbopuffer::DistanceMetric::OrSymbol)) }
+      attr_reader :distance_metric
+
+      sig do
+        params(distance_metric: Turbopuffer::DistanceMetric::OrSymbol).void
+      end
+      attr_writer :distance_metric
+
+      # The encryption configuration for a namespace.
+      sig { returns(T.nilable(Turbopuffer::NamespaceWriteParams::Encryption)) }
+      attr_reader :encryption
+
+      sig do
+        params(
+          encryption: Turbopuffer::NamespaceWriteParams::Encryption::OrHash
+        ).void
+      end
+      attr_writer :encryption
+
+      # A list of documents in columnar format. Each key is a column name, mapped to an
+      # array of values for that column.
+      sig { returns(T.nilable(Turbopuffer::Columns)) }
+      attr_reader :patch_columns
+
+      sig { params(patch_columns: Turbopuffer::Columns::OrHash).void }
+      attr_writer :patch_columns
+
+      # A condition evaluated against the current value of each document targeted by a
+      # patch write. Only documents that pass the condition are patched.
+      sig { returns(T.nilable(T.anything)) }
+      attr_reader :patch_condition
+
+      sig { params(patch_condition: T.anything).void }
+      attr_writer :patch_condition
+
+      sig { returns(T.nilable(T::Array[Turbopuffer::Row])) }
+      attr_reader :patch_rows
+
+      sig { params(patch_rows: T::Array[Turbopuffer::Row::OrHash]).void }
+      attr_writer :patch_rows
+
+      # The schema of the attributes attached to the documents.
+      sig do
+        returns(
+          T.nilable(
+            T::Hash[Symbol, T.any(String, Turbopuffer::AttributeSchemaConfig)]
+          )
+        )
+      end
+      attr_reader :schema
+
+      sig do
+        params(
+          schema:
+            T::Hash[
+              Symbol,
+              T.any(String, Turbopuffer::AttributeSchemaConfig::OrHash)
+            ]
+        ).void
+      end
+      attr_writer :schema
+
+      # A list of documents in columnar format. Each key is a column name, mapped to an
+      # array of values for that column.
+      sig { returns(T.nilable(Turbopuffer::Columns)) }
+      attr_reader :upsert_columns
+
+      sig { params(upsert_columns: Turbopuffer::Columns::OrHash).void }
+      attr_writer :upsert_columns
+
+      # A condition evaluated against the current value of each document targeted by an
+      # upsert write. Only documents that pass the condition are upserted.
+      sig { returns(T.nilable(T.anything)) }
+      attr_reader :upsert_condition
+
+      sig { params(upsert_condition: T.anything).void }
+      attr_writer :upsert_condition
+
+      sig { returns(T.nilable(T::Array[Turbopuffer::Row])) }
+      attr_reader :upsert_rows
+
+      sig { params(upsert_rows: T::Array[Turbopuffer::Row::OrHash]).void }
+      attr_writer :upsert_rows
+
+      sig do
+        params(
+          namespace: String,
+          copy_from_namespace: String,
+          delete_by_filter: T.anything,
+          delete_condition: T.anything,
+          deletes: T::Array[Turbopuffer::ID::Variants],
+          distance_metric: Turbopuffer::DistanceMetric::OrSymbol,
+          encryption: Turbopuffer::NamespaceWriteParams::Encryption::OrHash,
+          patch_columns: Turbopuffer::Columns::OrHash,
+          patch_condition: T.anything,
+          patch_rows: T::Array[Turbopuffer::Row::OrHash],
+          schema:
+            T::Hash[
+              Symbol,
+              T.any(String, Turbopuffer::AttributeSchemaConfig::OrHash)
+            ],
+          upsert_columns: Turbopuffer::Columns::OrHash,
+          upsert_condition: T.anything,
+          upsert_rows: T::Array[Turbopuffer::Row::OrHash],
+          request_options: Turbopuffer::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        namespace: nil,
+        # The namespace to copy documents from.
+        copy_from_namespace: nil,
+        # The filter specifying which documents to delete.
+        delete_by_filter: nil,
+        # A condition evaluated against the current value of each document targeted by a
+        # delete write. Only documents that pass the condition are deleted.
+        delete_condition: nil,
+        deletes: nil,
+        # A function used to calculate vector similarity.
+        distance_metric: nil,
+        # The encryption configuration for a namespace.
+        encryption: nil,
+        # A list of documents in columnar format. Each key is a column name, mapped to an
+        # array of values for that column.
+        patch_columns: nil,
+        # A condition evaluated against the current value of each document targeted by a
+        # patch write. Only documents that pass the condition are patched.
+        patch_condition: nil,
+        patch_rows: nil,
+        # The schema of the attributes attached to the documents.
+        schema: nil,
+        # A list of documents in columnar format. Each key is a column name, mapped to an
+        # array of values for that column.
+        upsert_columns: nil,
+        # A condition evaluated against the current value of each document targeted by an
+        # upsert write. Only documents that pass the condition are upserted.
+        upsert_condition: nil,
+        upsert_rows: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            namespace: String,
+            copy_from_namespace: String,
+            delete_by_filter: T.anything,
+            delete_condition: T.anything,
+            deletes: T::Array[Turbopuffer::ID::Variants],
+            distance_metric: Turbopuffer::DistanceMetric::OrSymbol,
+            encryption: Turbopuffer::NamespaceWriteParams::Encryption,
+            patch_columns: Turbopuffer::Columns,
+            patch_condition: T.anything,
+            patch_rows: T::Array[Turbopuffer::Row],
+            schema:
+              T::Hash[
+                Symbol,
+                T.any(String, Turbopuffer::AttributeSchemaConfig)
+              ],
+            upsert_columns: Turbopuffer::Columns,
+            upsert_condition: T.anything,
+            upsert_rows: T::Array[Turbopuffer::Row],
+            request_options: Turbopuffer::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Encryption < Turbopuffer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Turbopuffer::NamespaceWriteParams::Encryption,
+              Turbopuffer::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(Turbopuffer::NamespaceWriteParams::Encryption::Cmek)
+          )
+        end
+        attr_reader :cmek
+
+        sig do
+          params(
+            cmek: Turbopuffer::NamespaceWriteParams::Encryption::Cmek::OrHash
+          ).void
+        end
+        attr_writer :cmek
+
+        # The encryption configuration for a namespace.
+        sig do
+          params(
+            cmek: Turbopuffer::NamespaceWriteParams::Encryption::Cmek::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(cmek: nil)
+        end
+
+        sig do
+          override.returns(
+            { cmek: Turbopuffer::NamespaceWriteParams::Encryption::Cmek }
+          )
+        end
+        def to_hash
+        end
+
+        class Cmek < Turbopuffer::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Turbopuffer::NamespaceWriteParams::Encryption::Cmek,
+                Turbopuffer::Internal::AnyHash
+              )
+            end
+
+          # 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.
+          sig { returns(String) }
+          attr_accessor :key_name
+
+          sig { params(key_name: String).returns(T.attached_class) }
+          def self.new(
+            # 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.
+            key_name:
+          )
+          end
+
+          sig { override.returns({ key_name: String }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/namespace_write_response.rbi

@@ -0,0 +1,101 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class NamespaceWriteResponse < Turbopuffer::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Turbopuffer::Models::NamespaceWriteResponse,
+            Turbopuffer::Internal::AnyHash
+          )
+        end
+
+      # The billing information for a write request.
+      sig { returns(Turbopuffer::WriteBilling) }
+      attr_reader :billing
+
+      sig { params(billing: Turbopuffer::WriteBilling::OrHash).void }
+      attr_writer :billing
+
+      # A message describing the result of the write request.
+      sig { returns(String) }
+      attr_accessor :message
+
+      # The number of rows affected by the write request.
+      sig { returns(Integer) }
+      attr_accessor :rows_affected
+
+      # The status of the request.
+      sig { returns(Symbol) }
+      attr_accessor :status
+
+      # The number of rows deleted by the write request.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :rows_deleted
+
+      sig { params(rows_deleted: Integer).void }
+      attr_writer :rows_deleted
+
+      # The number of rows patched by the write request.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :rows_patched
+
+      sig { params(rows_patched: Integer).void }
+      attr_writer :rows_patched
+
+      # The number of rows upserted by the write request.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :rows_upserted
+
+      sig { params(rows_upserted: Integer).void }
+      attr_writer :rows_upserted
+
+      # The response to a successful write request.
+      sig do
+        params(
+          billing: Turbopuffer::WriteBilling::OrHash,
+          message: String,
+          rows_affected: Integer,
+          rows_deleted: Integer,
+          rows_patched: Integer,
+          rows_upserted: Integer,
+          status: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The billing information for a write request.
+        billing:,
+        # A message describing the result of the write request.
+        message:,
+        # The number of rows affected by the write request.
+        rows_affected:,
+        # The number of rows deleted by the write request.
+        rows_deleted: nil,
+        # The number of rows patched by the write request.
+        rows_patched: nil,
+        # The number of rows upserted by the write request.
+        rows_upserted: nil,
+        # The status of the request.
+        status: :OK
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            billing: Turbopuffer::WriteBilling,
+            message: String,
+            rows_affected: Integer,
+            status: Symbol,
+            rows_deleted: Integer,
+            rows_patched: Integer,
+            rows_upserted: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/query.rbi

@@ -0,0 +1,132 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class Query < Turbopuffer::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Turbopuffer::Query, Turbopuffer::Internal::AnyHash)
+        end
+
+      # Aggregations to compute over all documents in the namespace that match the
+      # filters.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_reader :aggregate_by
+
+      sig { params(aggregate_by: T::Hash[Symbol, T.anything]).void }
+      attr_writer :aggregate_by
+
+      # A function used to calculate vector similarity.
+      sig { returns(T.nilable(Turbopuffer::DistanceMetric::OrSymbol)) }
+      attr_reader :distance_metric
+
+      sig do
+        params(distance_metric: Turbopuffer::DistanceMetric::OrSymbol).void
+      end
+      attr_writer :distance_metric
+
+      # List of attribute names to exclude from the response. All other attributes will
+      # be included in the response.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :exclude_attributes
+
+      sig { params(exclude_attributes: T::Array[String]).void }
+      attr_writer :exclude_attributes
+
+      # Exact filters for attributes to refine search results for. Think of it as a SQL
+      # WHERE clause.
+      sig { returns(T.nilable(T.anything)) }
+      attr_reader :filters
+
+      sig { params(filters: T.anything).void }
+      attr_writer :filters
+
+      # Groups documents by the specified attributes (the "group key") before computing
+      # aggregates. Aggregates are computed separately for each group.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :group_by
+
+      sig { params(group_by: T::Array[String]).void }
+      attr_writer :group_by
+
+      # Whether to include attributes in the response.
+      sig { returns(T.nilable(Turbopuffer::IncludeAttributes::Variants)) }
+      attr_reader :include_attributes
+
+      sig do
+        params(
+          include_attributes: Turbopuffer::IncludeAttributes::Variants
+        ).void
+      end
+      attr_writer :include_attributes
+
+      # How to rank the documents in the namespace.
+      sig { returns(T.nilable(T.anything)) }
+      attr_reader :rank_by
+
+      sig { params(rank_by: T.anything).void }
+      attr_writer :rank_by
+
+      # The number of results to return.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :top_k
+
+      sig { params(top_k: Integer).void }
+      attr_writer :top_k
+
+      # Query, filter, full-text search and vector search documents.
+      sig do
+        params(
+          aggregate_by: T::Hash[Symbol, T.anything],
+          distance_metric: Turbopuffer::DistanceMetric::OrSymbol,
+          exclude_attributes: T::Array[String],
+          filters: T.anything,
+          group_by: T::Array[String],
+          include_attributes: Turbopuffer::IncludeAttributes::Variants,
+          rank_by: T.anything,
+          top_k: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Aggregations to compute over all documents in the namespace that match the
+        # filters.
+        aggregate_by: nil,
+        # A function used to calculate vector similarity.
+        distance_metric: nil,
+        # List of attribute names to exclude from the response. All other attributes will
+        # be included in the response.
+        exclude_attributes: nil,
+        # Exact filters for attributes to refine search results for. Think of it as a SQL
+        # WHERE clause.
+        filters: nil,
+        # Groups documents by the specified attributes (the "group key") before computing
+        # aggregates. Aggregates are computed separately for each group.
+        group_by: nil,
+        # Whether to include attributes in the response.
+        include_attributes: nil,
+        # How to rank the documents in the namespace.
+        rank_by: nil,
+        # The number of results to return.
+        top_k: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            aggregate_by: T::Hash[Symbol, T.anything],
+            distance_metric: Turbopuffer::DistanceMetric::OrSymbol,
+            exclude_attributes: T::Array[String],
+            filters: T.anything,
+            group_by: T::Array[String],
+            include_attributes: Turbopuffer::IncludeAttributes::Variants,
+            rank_by: T.anything,
+            top_k: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/query_billing.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class QueryBilling < Turbopuffer::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Turbopuffer::QueryBilling, Turbopuffer::Internal::AnyHash)
+        end
+
+      # The number of billable logical bytes queried from the namespace.
+      sig { returns(Integer) }
+      attr_accessor :billable_logical_bytes_queried
+
+      # The number of billable logical bytes returned from the query.
+      sig { returns(Integer) }
+      attr_accessor :billable_logical_bytes_returned
+
+      # The billing information for a query.
+      sig do
+        params(
+          billable_logical_bytes_queried: Integer,
+          billable_logical_bytes_returned: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The number of billable logical bytes queried from the namespace.
+        billable_logical_bytes_queried:,
+        # The number of billable logical bytes returned from the query.
+        billable_logical_bytes_returned:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            billable_logical_bytes_queried: Integer,
+            billable_logical_bytes_returned: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end