turbopuffer 2.4.0 → 2.6.0

data/rbi/turbopuffer/models/namespace_start_copy_from_response.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class NamespaceStartCopyFromResponse < Turbopuffer::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Turbopuffer::Models::NamespaceStartCopyFromResponse,
+            Turbopuffer::Internal::AnyHash
+          )
+        end
+
+      # The token identifying the copy operation.
+      sig { returns(String) }
+      attr_accessor :token
+
+      sig { params(token: String).returns(T.attached_class) }
+      def self.new(
+        # The token identifying the copy operation.
+        token:
+      )
+      end
+
+      sig { override.returns({ token: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/namespace_update_schema_params.rbi

@@ -24,7 +24,14 @@ module Turbopuffer
       sig do
         returns(
           T.nilable(
-            T::Hash[Symbol, T.any(String, Turbopuffer::AttributeSchemaConfig)]
+            T::Hash[
+              Symbol,
+              T.any(
+                String,
+                Turbopuffer::AttributeSchemaConfig,
+                Turbopuffer::AttributeSchemaDrop
+              )
+            ]
           )
         )
       end
@@ -35,7 +42,11 @@ module Turbopuffer
           schema:
             T::Hash[
               Symbol,
-              T.any(String, Turbopuffer::AttributeSchemaConfig::OrHash)
+              T.any(
+                String,
+                Turbopuffer::AttributeSchemaConfig::OrHash,
+                Turbopuffer::AttributeSchemaDrop::OrHash
+              )
             ]
         ).void
       end
@@ -47,7 +58,11 @@ module Turbopuffer
           schema:
             T::Hash[
               Symbol,
-              T.any(String, Turbopuffer::AttributeSchemaConfig::OrHash)
+              T.any(
+                String,
+                Turbopuffer::AttributeSchemaConfig::OrHash,
+                Turbopuffer::AttributeSchemaDrop::OrHash
+              )
             ],
           request_options: Turbopuffer::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -67,7 +82,11 @@ module Turbopuffer
             schema:
               T::Hash[
                 Symbol,
-                T.any(String, Turbopuffer::AttributeSchemaConfig)
+                T.any(
+                  String,
+                  Turbopuffer::AttributeSchemaConfig,
+                  Turbopuffer::AttributeSchemaDrop
+                )
               ],
             request_options: Turbopuffer::RequestOptions
           }

data/rbi/turbopuffer/models/namespace_write_params.rbi

@@ -68,6 +68,17 @@ module Turbopuffer
       end
       attr_writer :copy_from_namespace
 
+      # If `true`, ensures the namespace is created, even if the request writes no
+      # documents. Creating an empty namespace requires the `id` type to be declared in
+      # `schema`. If `false`, a namespace is never created, and a 404 is returned if it
+      # does not exist. If omitted, a namespace is created by the first request that
+      # writes documents.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :create_namespace
+
+      sig { params(create_namespace: T::Boolean).void }
+      attr_writer :create_namespace
+
       # The filter specifying which documents to delete.
       sig { returns(T.nilable(T.anything)) }
       attr_reader :delete_by_filter
@@ -192,7 +203,14 @@ module Turbopuffer
       sig do
         returns(
           T.nilable(
-            T::Hash[Symbol, T.any(String, Turbopuffer::AttributeSchemaConfig)]
+            T::Hash[
+              Symbol,
+              T.any(
+                String,
+                Turbopuffer::AttributeSchemaConfig,
+                Turbopuffer::AttributeSchemaDrop
+              )
+            ]
           )
         )
       end
@@ -203,7 +221,11 @@ module Turbopuffer
           schema:
             T::Hash[
               Symbol,
-              T.any(String, Turbopuffer::AttributeSchemaConfig::OrHash)
+              T.any(
+                String,
+                Turbopuffer::AttributeSchemaConfig::OrHash,
+                Turbopuffer::AttributeSchemaDrop::OrHash
+              )
             ]
         ).void
       end
@@ -254,6 +276,7 @@ module Turbopuffer
               String,
               Turbopuffer::CopyFromNamespaceParams::CopyFromNamespaceConfig::OrHash
             ),
+          create_namespace: T::Boolean,
           delete_by_filter: T.anything,
           delete_by_filter_allow_partial: T::Boolean,
           delete_condition: T.anything,
@@ -275,7 +298,11 @@ module Turbopuffer
           schema:
             T::Hash[
               Symbol,
-              T.any(String, Turbopuffer::AttributeSchemaConfig::OrHash)
+              T.any(
+                String,
+                Turbopuffer::AttributeSchemaConfig::OrHash,
+                Turbopuffer::AttributeSchemaDrop::OrHash
+              )
             ],
           sharding: Turbopuffer::ShardingConfig::OrHash,
           upsert_columns: Turbopuffer::Columns::OrHash,
@@ -290,6 +317,12 @@ module Turbopuffer
         branch_from_namespace: nil,
         # The namespace to copy documents from.
         copy_from_namespace: nil,
+        # If `true`, ensures the namespace is created, even if the request writes no
+        # documents. Creating an empty namespace requires the `id` type to be declared in
+        # `schema`. If `false`, a namespace is never created, and a 404 is returned if it
+        # does not exist. If omitted, a namespace is created by the first request that
+        # writes documents.
+        create_namespace: nil,
         # The filter specifying which documents to delete.
         delete_by_filter: nil,
         # Allow partial completion when filter matches too many documents.
@@ -351,6 +384,7 @@ module Turbopuffer
                 String,
                 Turbopuffer::CopyFromNamespaceParams::CopyFromNamespaceConfig
               ),
+            create_namespace: T::Boolean,
             delete_by_filter: T.anything,
             delete_by_filter_allow_partial: T::Boolean,
             delete_condition: T.anything,
@@ -371,7 +405,11 @@ module Turbopuffer
             schema:
               T::Hash[
                 Symbol,
-                T.any(String, Turbopuffer::AttributeSchemaConfig)
+                T.any(
+                  String,
+                  Turbopuffer::AttributeSchemaConfig,
+                  Turbopuffer::AttributeSchemaDrop
+                )
               ],
             sharding: Turbopuffer::ShardingConfig,
             upsert_columns: Turbopuffer::Columns,

data/rbi/turbopuffer/models/operation_error.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class OperationError < Turbopuffer::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Turbopuffer::OperationError, Turbopuffer::Internal::AnyHash)
+        end
+
+      # The response to an unsuccessful request.
+      sig { returns(Turbopuffer::OperationError::Detail) }
+      attr_reader :detail
+
+      sig { params(detail: Turbopuffer::OperationError::Detail::OrHash).void }
+      attr_writer :detail
+
+      # The HTTP status code of the operation's error.
+      sig { returns(Integer) }
+      attr_accessor :status_code
+
+      sig do
+        params(
+          detail: Turbopuffer::OperationError::Detail::OrHash,
+          status_code: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The response to an unsuccessful request.
+        detail:,
+        # The HTTP status code of the operation's error.
+        status_code:
+      )
+      end
+
+      sig do
+        override.returns(
+          { detail: Turbopuffer::OperationError::Detail, status_code: Integer }
+        )
+      end
+      def to_hash
+      end
+
+      class Detail < Turbopuffer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Turbopuffer::OperationError::Detail,
+              Turbopuffer::Internal::AnyHash
+            )
+          end
+
+        # The error message.
+        sig { returns(String) }
+        attr_accessor :error
+
+        # The status of the request.
+        sig { returns(Symbol) }
+        attr_accessor :status
+
+        # The response to an unsuccessful request.
+        sig { params(error: String, status: Symbol).returns(T.attached_class) }
+        def self.new(
+          # The error message.
+          error:,
+          # The status of the request.
+          status: :error
+        )
+        end
+
+        sig { override.returns({ error: String, status: Symbol }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/rerank_limit.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class RerankLimit < Turbopuffer::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Turbopuffer::RerankLimit, Turbopuffer::Internal::AnyHash)
+        end
+
+      # Limits the total number of documents returned after reranking.
+      sig { returns(Integer) }
+      attr_accessor :total
+
+      # Limits the total number of reranked documents returned.
+      sig { params(total: Integer).returns(T.attached_class) }
+      def self.new(
+        # Limits the total number of documents returned after reranking.
+        total:
+      )
+      end
+
+      sig { override.returns({ total: Integer }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/write_result.rbi

@@ -0,0 +1,159 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class WriteResult < Turbopuffer::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Turbopuffer::WriteResult, 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 IDs of documents that were deleted. Only included when `return_affected_ids`
+      # is true and at least one document was deleted.
+      sig { returns(T.nilable(T::Array[Turbopuffer::ID::Variants])) }
+      attr_reader :deleted_ids
+
+      sig { params(deleted_ids: T::Array[Turbopuffer::ID::Variants]).void }
+      attr_writer :deleted_ids
+
+      # The IDs of documents that were patched. Only included when `return_affected_ids`
+      # is true and at least one document was patched.
+      sig { returns(T.nilable(T::Array[Turbopuffer::ID::Variants])) }
+      attr_reader :patched_ids
+
+      sig { params(patched_ids: T::Array[Turbopuffer::ID::Variants]).void }
+      attr_writer :patched_ids
+
+      # The performance information for a write request.
+      sig { returns(T.nilable(Turbopuffer::WritePerformance)) }
+      attr_reader :performance
+
+      sig { params(performance: Turbopuffer::WritePerformance::OrHash).void }
+      attr_writer :performance
+
+      # 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
+
+      # Whether more documents match the filter for partial operations.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :rows_remaining
+
+      sig { params(rows_remaining: T::Boolean).void }
+      attr_writer :rows_remaining
+
+      # 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 IDs of documents that were upserted. Only included when
+      # `return_affected_ids` is true and at least one document was upserted.
+      sig { returns(T.nilable(T::Array[Turbopuffer::ID::Variants])) }
+      attr_reader :upserted_ids
+
+      sig { params(upserted_ids: T::Array[Turbopuffer::ID::Variants]).void }
+      attr_writer :upserted_ids
+
+      # The response to a successful write request.
+      sig do
+        params(
+          billing: Turbopuffer::WriteBilling::OrHash,
+          message: String,
+          rows_affected: Integer,
+          deleted_ids: T::Array[Turbopuffer::ID::Variants],
+          patched_ids: T::Array[Turbopuffer::ID::Variants],
+          performance: Turbopuffer::WritePerformance::OrHash,
+          rows_deleted: Integer,
+          rows_patched: Integer,
+          rows_remaining: T::Boolean,
+          rows_upserted: Integer,
+          upserted_ids: T::Array[Turbopuffer::ID::Variants],
+          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 IDs of documents that were deleted. Only included when `return_affected_ids`
+        # is true and at least one document was deleted.
+        deleted_ids: nil,
+        # The IDs of documents that were patched. Only included when `return_affected_ids`
+        # is true and at least one document was patched.
+        patched_ids: nil,
+        # The performance information for a write request.
+        performance: nil,
+        # The number of rows deleted by the write request.
+        rows_deleted: nil,
+        # The number of rows patched by the write request.
+        rows_patched: nil,
+        # Whether more documents match the filter for partial operations.
+        rows_remaining: nil,
+        # The number of rows upserted by the write request.
+        rows_upserted: nil,
+        # The IDs of documents that were upserted. Only included when
+        # `return_affected_ids` is true and at least one document was upserted.
+        upserted_ids: nil,
+        # The status of the request.
+        status: :OK
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            billing: Turbopuffer::WriteBilling,
+            message: String,
+            rows_affected: Integer,
+            status: Symbol,
+            deleted_ids: T::Array[Turbopuffer::ID::Variants],
+            patched_ids: T::Array[Turbopuffer::ID::Variants],
+            performance: Turbopuffer::WritePerformance,
+            rows_deleted: Integer,
+            rows_patched: Integer,
+            rows_remaining: T::Boolean,
+            rows_upserted: Integer,
+            upserted_ids: T::Array[Turbopuffer::ID::Variants]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models.rbi

@@ -15,6 +15,8 @@ module Turbopuffer
 
   AttributeSchemaConfig = Turbopuffer::Models::AttributeSchemaConfig
 
+  AttributeSchemaDrop = Turbopuffer::Models::AttributeSchemaDrop
+
   AttributeType = Turbopuffer::Models::AttributeType
 
   Bm25ClauseParams = Turbopuffer::Models::Bm25ClauseParams
@@ -31,6 +33,11 @@ module Turbopuffer
   ContainsAnyTokenFilterParams =
     Turbopuffer::Models::ContainsAnyTokenFilterParams
 
+  CopyFromNamespaceOperation = Turbopuffer::Models::CopyFromNamespaceOperation
+
+  CopyFromNamespaceOperationResult =
+    Turbopuffer::Models::CopyFromNamespaceOperationResult
+
   CopyFromNamespaceParams = Turbopuffer::Models::CopyFromNamespaceParams
 
   DecayParams = Turbopuffer::Models::DecayParams
@@ -82,12 +89,17 @@ module Turbopuffer
 
   NamespaceMultiQueryParams = Turbopuffer::Models::NamespaceMultiQueryParams
 
+  NamespacePollCopyFromParams = Turbopuffer::Models::NamespacePollCopyFromParams
+
   NamespaceQueryParams = Turbopuffer::Models::NamespaceQueryParams
 
   NamespaceRecallParams = Turbopuffer::Models::NamespaceRecallParams
 
   NamespaceSchemaParams = Turbopuffer::Models::NamespaceSchemaParams
 
+  NamespaceStartCopyFromParams =
+    Turbopuffer::Models::NamespaceStartCopyFromParams
+
   NamespaceSummary = Turbopuffer::Models::NamespaceSummary
 
   NamespaceUpdateMetadataParams =
@@ -97,12 +109,16 @@ module Turbopuffer
 
   NamespaceWriteParams = Turbopuffer::Models::NamespaceWriteParams
 
+  OperationError = Turbopuffer::Models::OperationError
+
   PinningConfig = Turbopuffer::Models::PinningConfig
 
   QueryBilling = Turbopuffer::Models::QueryBilling
 
   QueryPerformance = Turbopuffer::Models::QueryPerformance
 
+  RerankLimit = Turbopuffer::Models::RerankLimit
+
   Row = Turbopuffer::Models::Row
 
   RrfParams = Turbopuffer::Models::RrfParams
@@ -122,4 +138,6 @@ module Turbopuffer
   WriteBilling = Turbopuffer::Models::WriteBilling
 
   WritePerformance = Turbopuffer::Models::WritePerformance
+
+  WriteResult = Turbopuffer::Models::WriteResult
 end

data/rbi/turbopuffer/resources/namespaces.rbi

@@ -80,6 +80,7 @@ module Turbopuffer
           group_by: T::Array[T.anything],
           include_attributes: Turbopuffer::IncludeAttributes::Variants,
           limit: T.any(Integer, Turbopuffer::Limit::OrHash),
+          offset: Integer,
           rank_by: T.anything,
           top_k: Integer,
           vector_encoding: Turbopuffer::VectorEncoding::OrSymbol,
@@ -113,6 +114,9 @@ module Turbopuffer
         include_attributes: nil,
         # Body param: Limits the documents returned by a query.
         limit: nil,
+        # Body param: Number of documents to skip before returning results. Supported only
+        # in v2 queries with an explicit `rank_by` and `top_k` or `limit`.
+        offset: nil,
         # Body param: How to rank the documents in the namespace.
         rank_by: nil,
         # Body param: The number of results to return.
@@ -159,6 +163,8 @@ module Turbopuffer
           namespace: String,
           consistency:
             Turbopuffer::NamespaceMultiQueryParams::Consistency::OrHash,
+          limit: T.any(Integer, Turbopuffer::RerankLimit::OrHash),
+          offset: Integer,
           rerank_by: T.anything,
           vector_encoding: Turbopuffer::VectorEncoding::OrSymbol,
           request_options: Turbopuffer::RequestOptions::OrHash
@@ -171,6 +177,11 @@ module Turbopuffer
         namespace: nil,
         # Body param: The consistency level for a query.
         consistency: nil,
+        # Body param: Limits the total number of reranked documents returned.
+        limit: nil,
+        # Body param: Number of reranked documents to skip before returning results.
+        # Requires `rerank_by` and `limit`.
+        offset: nil,
         # Body param: How to combine the rows returned by each sub-query into a single
         # ranked list.
         rerank_by: nil,
@@ -180,6 +191,23 @@ module Turbopuffer
       )
       end
 
+      # Retrieve the current status of a copy operation.
+      sig do
+        params(
+          token: String,
+          namespace: String,
+          request_options: Turbopuffer::RequestOptions::OrHash
+        ).returns(Turbopuffer::CopyFromNamespaceOperation::Variants)
+      end
+      def poll_copy_from(
+        # The operation token obtained when starting the copy.
+        token,
+        # The name of the namespace.
+        namespace: nil,
+        request_options: {}
+      )
+      end
+
       # Query, filter, full-text search and vector search documents.
       sig do
         params(
@@ -193,6 +221,7 @@ module Turbopuffer
           group_by: T::Array[T.anything],
           include_attributes: Turbopuffer::IncludeAttributes::Variants,
           limit: T.any(Integer, Turbopuffer::Limit::OrHash),
+          offset: Integer,
           rank_by: T.anything,
           top_k: Integer,
           vector_encoding: Turbopuffer::VectorEncoding::OrSymbol,
@@ -226,6 +255,9 @@ module Turbopuffer
         include_attributes: nil,
         # Body param: Limits the documents returned by a query.
         limit: nil,
+        # Body param: Number of documents to skip before returning results. Supported only
+        # in v2 queries with an explicit `rank_by` and `top_k` or `limit`.
+        offset: nil,
         # Body param: How to rank the documents in the namespace.
         rank_by: nil,
         # Body param: The number of results to return.
@@ -281,12 +313,47 @@ module Turbopuffer
       )
       end
 
+      # Start copying all documents from another namespace into this one. Returns an
+      # operation token without waiting for the copy to finish. Use the token to poll
+      # for progress and the result.
+      sig do
+        params(
+          source_namespace: String,
+          namespace: String,
+          dest_encryption:
+            T.any(
+              Turbopuffer::Encryption::CustomerManaged::OrHash,
+              Turbopuffer::Encryption::Default::OrHash
+            ),
+          source_api_key: String,
+          source_region: String,
+          request_options: Turbopuffer::RequestOptions::OrHash
+        ).returns(Turbopuffer::Models::NamespaceStartCopyFromResponse)
+      end
+      def start_copy_from(
+        # Body param: The namespace to copy documents from.
+        source_namespace:,
+        # Path param: The name of the namespace.
+        namespace: nil,
+        # Body param: (Optional) The encryption configuration for the destination
+        # namespace.
+        dest_encryption: nil,
+        # Body param: (Optional) An API key for the organization containing the source
+        # namespace
+        source_api_key: nil,
+        # Body param: (Optional) The region of the source namespace.
+        source_region: nil,
+        request_options: {}
+      )
+      end
+
       # Update metadata configuration for a namespace.
       sig do
         params(
           namespace: String,
           pinning:
             T.nilable(T.any(T::Boolean, Turbopuffer::PinningConfig::OrHash)),
+          read_only: T::Boolean,
           request_options: Turbopuffer::RequestOptions::OrHash
         ).returns(Turbopuffer::NamespaceMetadata)
       end
@@ -300,6 +367,10 @@ module Turbopuffer
         # - `true`: enable pinning with default configuration
         # - Object: set pinning configuration
         pinning: nil,
+        # Body param: Set to `true` to reject document and schema writes, or `false` to
+        # allow them. Writes already in progress may still commit. Metadata updates remain
+        # available.
+        read_only: nil,
         request_options: {}
       )
       end
@@ -311,7 +382,11 @@ module Turbopuffer
           schema:
             T::Hash[
               Symbol,
-              T.any(String, Turbopuffer::AttributeSchemaConfig::OrHash)
+              T.any(
+                String,
+                Turbopuffer::AttributeSchemaConfig::OrHash,
+                Turbopuffer::AttributeSchemaDrop::OrHash
+              )
             ],
           request_options: Turbopuffer::RequestOptions::OrHash
         ).returns(T::Hash[Symbol, Turbopuffer::AttributeSchemaConfig])
@@ -339,6 +414,7 @@ module Turbopuffer
               String,
               Turbopuffer::CopyFromNamespaceParams::CopyFromNamespaceConfig::OrHash
             ),
+          create_namespace: T::Boolean,
           delete_by_filter: T.anything,
           delete_by_filter_allow_partial: T::Boolean,
           delete_condition: T.anything,
@@ -360,7 +436,11 @@ module Turbopuffer
           schema:
             T::Hash[
               Symbol,
-              T.any(String, Turbopuffer::AttributeSchemaConfig::OrHash)
+              T.any(
+                String,
+                Turbopuffer::AttributeSchemaConfig::OrHash,
+                Turbopuffer::AttributeSchemaDrop::OrHash
+              )
             ],
           sharding: Turbopuffer::ShardingConfig::OrHash,
           upsert_columns: Turbopuffer::Columns::OrHash,
@@ -376,6 +456,12 @@ module Turbopuffer
         branch_from_namespace: nil,
         # Body param: The namespace to copy documents from.
         copy_from_namespace: nil,
+        # Body param: If `true`, ensures the namespace is created, even if the request
+        # writes no documents. Creating an empty namespace requires the `id` type to be
+        # declared in `schema`. If `false`, a namespace is never created, and a 404 is
+        # returned if it does not exist. If omitted, a namespace is created by the first
+        # request that writes documents.
+        create_namespace: nil,
         # Body param: The filter specifying which documents to delete.
         delete_by_filter: nil,
         # Body param: Allow partial completion when filter matches too many documents.