turbopuffer 2.4.0 → 2.5.0

data/lib/turbopuffer/models/write_result.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    class WriteResult < 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 deleted_ids
+      #   The IDs of documents that were deleted. Only included when `return_affected_ids`
+      #   is true and at least one document was deleted.
+      #
+      #   @return [Array<String, Integer>, nil]
+      optional :deleted_ids, -> { Turbopuffer::Internal::Type::ArrayOf[union: Turbopuffer::ID] }
+
+      # @!attribute patched_ids
+      #   The IDs of documents that were patched. Only included when `return_affected_ids`
+      #   is true and at least one document was patched.
+      #
+      #   @return [Array<String, Integer>, nil]
+      optional :patched_ids, -> { Turbopuffer::Internal::Type::ArrayOf[union: Turbopuffer::ID] }
+
+      # @!attribute performance
+      #   The performance information for a write request.
+      #
+      #   @return [Turbopuffer::Models::WritePerformance, nil]
+      optional :performance, -> { Turbopuffer::WritePerformance }
+
+      # @!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_remaining
+      #   Whether more documents match the filter for partial operations.
+      #
+      #   @return [Boolean, nil]
+      optional :rows_remaining, Turbopuffer::Internal::Type::Boolean
+
+      # @!attribute rows_upserted
+      #   The number of rows upserted by the write request.
+      #
+      #   @return [Integer, nil]
+      optional :rows_upserted, Integer
+
+      # @!attribute upserted_ids
+      #   The IDs of documents that were upserted. Only included when
+      #   `return_affected_ids` is true and at least one document was upserted.
+      #
+      #   @return [Array<String, Integer>, nil]
+      optional :upserted_ids, -> { Turbopuffer::Internal::Type::ArrayOf[union: Turbopuffer::ID] }
+
+      # @!method initialize(billing:, message:, rows_affected:, deleted_ids: nil, patched_ids: nil, performance: nil, rows_deleted: nil, rows_patched: nil, rows_remaining: nil, rows_upserted: nil, upserted_ids: nil, status: :OK)
+      #   Some parameter documentations has been truncated, see
+      #   {Turbopuffer::Models::WriteResult} for more details.
+      #
+      #   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 deleted_ids [Array<String, Integer>] The IDs of documents that were deleted. Only included when `return_affected_ids`
+      #
+      #   @param patched_ids [Array<String, Integer>] The IDs of documents that were patched. Only included when `return_affected_ids`
+      #
+      #   @param performance [Turbopuffer::Models::WritePerformance] The performance information for a 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_remaining [Boolean] Whether more documents match the filter for partial operations.
+      #
+      #   @param rows_upserted [Integer] The number of rows upserted by the write request.
+      #
+      #   @param upserted_ids [Array<String, Integer>] The IDs of documents that were upserted. Only included when `return_affected_ids
+      #
+      #   @param status [Symbol, :OK] The status of the request.
+    end
+  end
+end

data/lib/turbopuffer/models.rb

@@ -64,6 +64,10 @@ module Turbopuffer
 
   ContainsAnyTokenFilterParams = Turbopuffer::Models::ContainsAnyTokenFilterParams
 
+  CopyFromNamespaceOperation = Turbopuffer::Models::CopyFromNamespaceOperation
+
+  CopyFromNamespaceOperationResult = Turbopuffer::Models::CopyFromNamespaceOperationResult
+
   CopyFromNamespaceParams = Turbopuffer::Models::CopyFromNamespaceParams
 
   DecayParams = Turbopuffer::Models::DecayParams
@@ -114,12 +118,16 @@ 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 = Turbopuffer::Models::NamespaceUpdateMetadataParams
@@ -128,12 +136,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
@@ -153,4 +165,6 @@ module Turbopuffer
   WriteBilling = Turbopuffer::Models::WriteBilling
 
   WritePerformance = Turbopuffer::Models::WritePerformance
+
+  WriteResult = Turbopuffer::Models::WriteResult
 end

data/lib/turbopuffer/resources/namespaces.rb

@@ -98,7 +98,7 @@ module Turbopuffer
       #
       # Explain a query plan.
       #
-      # @overload explain_query(namespace: nil, aggregate_by: nil, compute_attributes: nil, consistency: nil, distance_metric: nil, exclude_attributes: nil, filters: nil, group_by: nil, include_attributes: nil, limit: nil, rank_by: nil, top_k: nil, vector_encoding: nil, request_options: {})
+      # @overload explain_query(namespace: nil, aggregate_by: nil, compute_attributes: nil, consistency: nil, distance_metric: nil, exclude_attributes: nil, filters: nil, group_by: nil, include_attributes: nil, limit: nil, offset: nil, rank_by: nil, top_k: nil, vector_encoding: nil, request_options: {})
       #
       # @param namespace [String] Path param: The name of the namespace.
       #
@@ -120,6 +120,8 @@ module Turbopuffer
       #
       # @param limit [Integer, Turbopuffer::Models::Limit] Body param: Limits the documents returned by a query.
       #
+      # @param offset [Integer] Body param: Number of documents to skip before returning results. Supported only
+      #
       # @param rank_by [Object] Body param: How to rank the documents in the namespace.
       #
       # @param top_k [Integer] Body param: The number of results to return.
@@ -201,7 +203,7 @@ module Turbopuffer
       #
       # Issue multiple concurrent queries filter or search documents.
       #
-      # @overload multi_query(queries:, namespace: nil, consistency: nil, rerank_by: nil, vector_encoding: nil, request_options: {})
+      # @overload multi_query(queries:, namespace: nil, consistency: nil, limit: nil, offset: nil, rerank_by: nil, vector_encoding: nil, request_options: {})
       #
       # @param queries [Array<Turbopuffer::Models::NamespaceMultiQueryParams::Query>] Body param
       #
@@ -209,6 +211,10 @@ module Turbopuffer
       #
       # @param consistency [Turbopuffer::Models::NamespaceMultiQueryParams::Consistency] Body param: The consistency level for a query.
       #
+      # @param limit [Integer, Turbopuffer::Models::RerankLimit] Body param: Limits the total number of reranked documents returned.
+      #
+      # @param offset [Integer] Body param: Number of reranked documents to skip before returning results. Requi
+      #
       # @param rerank_by [Object] Body param: How to combine the rows returned by each sub-query into a single ran
       #
       # @param vector_encoding [Symbol, Turbopuffer::Models::VectorEncoding] Body param: The encoding to use for vectors in the response.
@@ -233,12 +239,39 @@ module Turbopuffer
         )
       end
 
+      # Retrieve the current status of a copy operation.
+      #
+      # @overload poll_copy_from(token, namespace: nil, request_options: {})
+      #
+      # @param token [String] The operation token obtained when starting the copy.
+      #
+      # @param namespace [String] The name of the namespace.
+      #
+      # @param request_options [Turbopuffer::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Turbopuffer::Models::CopyFromNamespaceOperation::Running, Turbopuffer::Models::CopyFromNamespaceOperation::Finished]
+      #
+      # @see Turbopuffer::Models::NamespacePollCopyFromParams
+      def poll_copy_from(token, params = {})
+        parsed, options = Turbopuffer::NamespacePollCopyFromParams.dump_request(params)
+        namespace =
+          parsed.delete(:namespace) do
+            @client.default_namespace
+          end
+        @client.request(
+          method: :get,
+          path: ["v1/namespaces/%1$s/operations/%2$s?stainless_overload=pollCopyFrom", namespace, token],
+          model: Turbopuffer::CopyFromNamespaceOperation,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {Turbopuffer::Models::NamespaceQueryParams} for more details.
       #
       # Query, filter, full-text search and vector search documents.
       #
-      # @overload query(namespace: nil, aggregate_by: nil, compute_attributes: nil, consistency: nil, distance_metric: nil, exclude_attributes: nil, filters: nil, group_by: nil, include_attributes: nil, limit: nil, rank_by: nil, top_k: nil, vector_encoding: nil, request_options: {})
+      # @overload query(namespace: nil, aggregate_by: nil, compute_attributes: nil, consistency: nil, distance_metric: nil, exclude_attributes: nil, filters: nil, group_by: nil, include_attributes: nil, limit: nil, offset: nil, rank_by: nil, top_k: nil, vector_encoding: nil, request_options: {})
       #
       # @param namespace [String] Path param: The name of the namespace.
       #
@@ -260,6 +293,8 @@ module Turbopuffer
       #
       # @param limit [Integer, Turbopuffer::Models::Limit] Body param: Limits the documents returned by a query.
       #
+      # @param offset [Integer] Body param: Number of documents to skip before returning results. Supported only
+      #
       # @param rank_by [Object] Body param: How to rank the documents in the namespace.
       #
       # @param top_k [Integer] Body param: The number of results to return.
@@ -350,17 +385,58 @@ module Turbopuffer
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Turbopuffer::Models::NamespaceStartCopyFromParams} for more details.
+      #
+      # 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.
+      #
+      # @overload start_copy_from(source_namespace:, namespace: nil, dest_encryption: nil, source_api_key: nil, source_region: nil, request_options: {})
+      #
+      # @param source_namespace [String] Body param: The namespace to copy documents from.
+      #
+      # @param namespace [String] Path param: The name of the namespace.
+      #
+      # @param dest_encryption [Turbopuffer::Models::Encryption::CustomerManaged, Turbopuffer::Models::Encryption::Default] Body param: (Optional) The encryption configuration for the destination namespac
+      #
+      # @param source_api_key [String] Body param: (Optional) An API key for the organization containing the source nam
+      #
+      # @param source_region [String] Body param: (Optional) The region of the source namespace.
+      #
+      # @param request_options [Turbopuffer::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Turbopuffer::Models::NamespaceStartCopyFromResponse]
+      #
+      # @see Turbopuffer::Models::NamespaceStartCopyFromParams
+      def start_copy_from(params)
+        parsed, options = Turbopuffer::NamespaceStartCopyFromParams.dump_request(params)
+        namespace =
+          parsed.delete(:namespace) do
+            @client.default_namespace
+          end
+        @client.request(
+          method: :post,
+          path: ["v2/namespaces/%1$s/async?stainless_overload=startCopyFrom", namespace],
+          body: {copy_from_namespace: parsed},
+          model: Turbopuffer::Models::NamespaceStartCopyFromResponse,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {Turbopuffer::Models::NamespaceUpdateMetadataParams} for more details.
       #
       # Update metadata configuration for a namespace.
       #
-      # @overload update_metadata(namespace: nil, pinning: nil, request_options: {})
+      # @overload update_metadata(namespace: nil, pinning: nil, read_only: nil, request_options: {})
       #
       # @param namespace [String] Path param: The name of the namespace.
       #
       # @param pinning [Boolean, Turbopuffer::Models::PinningConfig, nil] Body param: Configuration for namespace pinning.
       #
+      # @param read_only [Boolean] Body param: Set to `true` to reject document and schema writes, or `false` to al
+      #
       # @param request_options [Turbopuffer::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Turbopuffer::Models::NamespaceMetadata]

data/lib/turbopuffer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Turbopuffer
-  VERSION = "2.4.0"
+  VERSION = "2.5.0"
 end

data/lib/turbopuffer.rb

@@ -68,6 +68,8 @@ require_relative "turbopuffer/models/client_namespaces_params"
 require_relative "turbopuffer/models/columns"
 require_relative "turbopuffer/models/contains_all_tokens_filter_params"
 require_relative "turbopuffer/models/contains_any_token_filter_params"
+require_relative "turbopuffer/models/copy_from_namespace_operation"
+require_relative "turbopuffer/models/copy_from_namespace_operation_result"
 require_relative "turbopuffer/models/copy_from_namespace_params"
 require_relative "turbopuffer/models/decay_params"
 require_relative "turbopuffer/models/distance_metric"
@@ -98,20 +100,25 @@ require_relative "turbopuffer/models/namespace_metadata"
 require_relative "turbopuffer/models/namespace_metadata_params"
 require_relative "turbopuffer/models/namespace_multi_query_params"
 require_relative "turbopuffer/models/namespace_multi_query_response"
+require_relative "turbopuffer/models/namespace_poll_copy_from_params"
 require_relative "turbopuffer/models/namespace_query_params"
 require_relative "turbopuffer/models/namespace_query_response"
 require_relative "turbopuffer/models/namespace_recall_params"
 require_relative "turbopuffer/models/namespace_recall_response"
 require_relative "turbopuffer/models/namespace_schema_params"
 require_relative "turbopuffer/models/namespace_schema_response"
+require_relative "turbopuffer/models/namespace_start_copy_from_params"
+require_relative "turbopuffer/models/namespace_start_copy_from_response"
 require_relative "turbopuffer/models/namespace_summary"
 require_relative "turbopuffer/models/namespace_update_metadata_params"
 require_relative "turbopuffer/models/namespace_update_schema_params"
 require_relative "turbopuffer/models/namespace_update_schema_response"
 require_relative "turbopuffer/models/namespace_write_params"
 require_relative "turbopuffer/models/namespace_write_response"
+require_relative "turbopuffer/models/operation_error"
 require_relative "turbopuffer/models/query_billing"
 require_relative "turbopuffer/models/query_performance"
+require_relative "turbopuffer/models/rerank_limit"
 require_relative "turbopuffer/models/row"
 require_relative "turbopuffer/models/rrf_params"
 require_relative "turbopuffer/models/saturate_params"
@@ -122,6 +129,7 @@ require_relative "turbopuffer/models/vector"
 require_relative "turbopuffer/models/vector_encoding"
 require_relative "turbopuffer/models/write_billing"
 require_relative "turbopuffer/models/write_performance"
+require_relative "turbopuffer/models/write_result"
 require_relative "turbopuffer/models"
 require_relative "turbopuffer/resources/namespaces"
 require_relative "turbopuffer/namespace"

data/rbi/turbopuffer/client.rbi

@@ -10,7 +10,7 @@ module Turbopuffer
 
     DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
 
-    # API key used for authentication
+    # API key used for authentication.
     sig { returns(String) }
     attr_reader :api_key
 
@@ -73,7 +73,7 @@ module Turbopuffer
       ).returns(T.attached_class)
     end
     def self.new(
-      # API key used for authentication Defaults to `ENV["TURBOPUFFER_API_KEY"]`
+      # API key used for authentication. Defaults to `ENV["TURBOPUFFER_API_KEY"]`
       api_key: ENV["TURBOPUFFER_API_KEY"],
       # The turbopuffer region to use. Defaults to `ENV["TURBOPUFFER_REGION"]`
       region: ENV["TURBOPUFFER_REGION"],

data/rbi/turbopuffer/models/copy_from_namespace_operation.rbi

@@ -0,0 +1,133 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    # The current status of a copy operation.
+    module CopyFromNamespaceOperation
+      extend Turbopuffer::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Turbopuffer::CopyFromNamespaceOperation::Running,
+            Turbopuffer::CopyFromNamespaceOperation::Finished
+          )
+        end
+
+      class Running < Turbopuffer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Turbopuffer::CopyFromNamespaceOperation::Running,
+              Turbopuffer::Internal::AnyHash
+            )
+          end
+
+        # The time at which the operation started.
+        sig { returns(Time) }
+        attr_accessor :start_time
+
+        sig { returns(Symbol) }
+        attr_accessor :status
+
+        # A freeform description of the operation's progress. May be absent, and its
+        # format may change.
+        sig { returns(T.nilable(String)) }
+        attr_reader :progress
+
+        sig { params(progress: String).void }
+        attr_writer :progress
+
+        sig do
+          params(start_time: Time, progress: String, status: Symbol).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The time at which the operation started.
+          start_time:,
+          # A freeform description of the operation's progress. May be absent, and its
+          # format may change.
+          progress: nil,
+          status: :running
+        )
+        end
+
+        sig do
+          override.returns(
+            { start_time: Time, status: Symbol, progress: String }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Finished < Turbopuffer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Turbopuffer::CopyFromNamespaceOperation::Finished,
+              Turbopuffer::Internal::AnyHash
+            )
+          end
+
+        # The time at which the operation finished.
+        sig { returns(Time) }
+        attr_accessor :finish_time
+
+        sig { returns(Turbopuffer::CopyFromNamespaceOperationResult::Variants) }
+        attr_accessor :result
+
+        # The time at which the operation started.
+        sig { returns(Time) }
+        attr_accessor :start_time
+
+        sig { returns(Symbol) }
+        attr_accessor :status
+
+        sig do
+          params(
+            finish_time: Time,
+            result:
+              T.any(
+                Turbopuffer::CopyFromNamespaceOperationResult::Success::OrHash,
+                Turbopuffer::CopyFromNamespaceOperationResult::Error::OrHash
+              ),
+            start_time: Time,
+            status: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The time at which the operation finished.
+          finish_time:,
+          result:,
+          # The time at which the operation started.
+          start_time:,
+          status: :finished
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              finish_time: Time,
+              result: Turbopuffer::CopyFromNamespaceOperationResult::Variants,
+              start_time: Time,
+              status: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      sig do
+        override.returns(
+          T::Array[Turbopuffer::CopyFromNamespaceOperation::Variants]
+        )
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/copy_from_namespace_operation_result.rbi

@@ -0,0 +1,85 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    module CopyFromNamespaceOperationResult
+      extend Turbopuffer::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Turbopuffer::CopyFromNamespaceOperationResult::Success,
+            Turbopuffer::CopyFromNamespaceOperationResult::Error
+          )
+        end
+
+      class Success < Turbopuffer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Turbopuffer::CopyFromNamespaceOperationResult::Success,
+              Turbopuffer::Internal::AnyHash
+            )
+          end
+
+        # The response to a successful write request.
+        sig { returns(Turbopuffer::WriteResult) }
+        attr_reader :success
+
+        sig { params(success: Turbopuffer::WriteResult::OrHash).void }
+        attr_writer :success
+
+        sig do
+          params(success: Turbopuffer::WriteResult::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The response to a successful write request.
+          success:
+        )
+        end
+
+        sig { override.returns({ success: Turbopuffer::WriteResult }) }
+        def to_hash
+        end
+      end
+
+      class Error < Turbopuffer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Turbopuffer::CopyFromNamespaceOperationResult::Error,
+              Turbopuffer::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Turbopuffer::OperationError) }
+        attr_reader :error
+
+        sig { params(error: Turbopuffer::OperationError::OrHash).void }
+        attr_writer :error
+
+        sig do
+          params(error: Turbopuffer::OperationError::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(error:)
+        end
+
+        sig { override.returns({ error: Turbopuffer::OperationError }) }
+        def to_hash
+        end
+      end
+
+      sig do
+        override.returns(
+          T::Array[Turbopuffer::CopyFromNamespaceOperationResult::Variants]
+        )
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/namespace_explain_query_params.rbi

@@ -104,6 +104,14 @@ module Turbopuffer
       sig { params(limit: T.any(Integer, Turbopuffer::Limit::OrHash)).void }
       attr_writer :limit
 
+      # Number of documents to skip before returning results. Supported only in v2
+      # queries with an explicit `rank_by` and `top_k` or `limit`.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :offset
+
+      sig { params(offset: Integer).void }
+      attr_writer :offset
+
       # How to rank the documents in the namespace.
       sig { returns(T.nilable(T.anything)) }
       attr_reader :rank_by
@@ -140,6 +148,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,
@@ -172,6 +181,9 @@ module Turbopuffer
         include_attributes: nil,
         # Limits the documents returned by a query.
         limit: nil,
+        # 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,
         # How to rank the documents in the namespace.
         rank_by: nil,
         # The number of results to return.
@@ -195,6 +207,7 @@ module Turbopuffer
             group_by: T::Array[T.anything],
             include_attributes: Turbopuffer::IncludeAttributes::Variants,
             limit: T.any(Integer, Turbopuffer::Limit),
+            offset: Integer,
             rank_by: T.anything,
             top_k: Integer,
             vector_encoding: Turbopuffer::VectorEncoding::OrSymbol,