turbopuffer 1.10.1 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0b9d75ffeb9b95bd7c2b698ddce5d0464115795cafc0f1368e9e583f64ba467
-  data.tar.gz: 432d7a0a4279ed1e4789043504f38a24d79822e4ccaaff4a767ff0bf2c7bbf67
+  metadata.gz: aff3f7179132d59af69be514c2bea471786e9f46d00dcda5f11b612282a5aa85
+  data.tar.gz: 79f1e6d41e927345bc44b546b6a26332748a25eaedb0b23e4e9b1f9d3054857a
 SHA512:
-  metadata.gz: c8ed79654d90b6efe5c829f829c633ac127558008a85d2d6c93aed2a4c84b2a27853a85968f9e62bac95845e2563323b9dc612f254c6127b95256f11bf0464b2
-  data.tar.gz: 1dc2b1ed8cea6b18b68f7aa3019e67fee88620d263b92da4f32cb0b2cfa353075ea88e563240669c5d3802def2a24d6c12fbae0c9bc87ce6f606c960555dea99
+  metadata.gz: 764da2c1ede0bab20b13fbfba3ec7b2114c1f92dd95f847640aaceb9dab9394e64911080177f648bf42b01c69cb6e0fd15a7414f464f2336df2bc20d84177bfd
+  data.tar.gz: 5de4d67ad3b28f4bb20506e1e21480eb277fa0cc48963b3c9afeadb8bc10e337bac501aaca6b8143608892a08891d7c5f340239deef89fc9c381ca933c81f6d6

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 1.11.0 (2026-01-22)
+
+Full Changelog: [v1.10.1...v1.11.0](https://github.com/turbopuffer/turbopuffer-ruby/compare/v1.10.1...v1.11.0)
+
+### Features
+
+* [TPUF-1097] tpuf: return failed IDs for conditional writes ([5b8d225](https://github.com/turbopuffer/turbopuffer-ruby/commit/5b8d2252d81caecd59c3d44458def2a107a263ed))
+* Apigen integration ([11ae24b](https://github.com/turbopuffer/turbopuffer-ruby/commit/11ae24be6ffab51d5676abca1e5082a962037ccd))
+* disable response compression by default ([#34](https://github.com/turbopuffer/turbopuffer-ruby/issues/34)) ([2ca1437](https://github.com/turbopuffer/turbopuffer-ruby/commit/2ca143712013e6eab35e9de8847ad7e644dbbf58))
+
+
+### Chores
+
+* configure new SDK language ([abc9dfe](https://github.com/turbopuffer/turbopuffer-ruby/commit/abc9dfe9d94f2d3d5cda214f1c9f4625a002cdb1))
+* fix typo in descriptions ([5ce373b](https://github.com/turbopuffer/turbopuffer-ruby/commit/5ce373b8c0de6f51917446464420cb51c021c067))
+* **internal:** update `actions/checkout` version ([09e5d5c](https://github.com/turbopuffer/turbopuffer-ruby/commit/09e5d5c35c7e9254227e3c4005849543c4f51b9e))
+
 ## 1.10.1 (2026-01-09)
 
 Full Changelog: [v1.10.0...v1.10.1](https://github.com/turbopuffer/turbopuffer-ruby/compare/v1.10.0...v1.10.1)

data/README.md

@@ -4,6 +4,15 @@ The Turbopuffer Ruby library provides convenient access to the Turbopuffer REST
 
 It is generated with [Stainless](https://www.stainless.com/).
 
+## MCP Server
+
+Use the Turbopuffer MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
+
+[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40turbopuffer%2Fturbopuffer-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0dXJib3B1ZmZlci90dXJib3B1ZmZlci1tY3AiXX0)
+[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40turbopuffer%2Fturbopuffer-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40turbopuffer%2Fturbopuffer-mcp%22%5D%7D)
+
+> Note: You may need to set environment variables in your MCP client.
+
 ## Documentation
 
 Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/turbopuffer).
@@ -17,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "turbopuffer", "~> 1.10.1"
+gem "turbopuffer", "~> 1.11.0"
 ```
 
 <!-- x-release-please-end -->
@@ -160,6 +169,19 @@ On timeout, `Turbopuffer::Errors::APITimeoutError` is raised.
 
 Note that requests that time out are retried by default.
 
+### Compression
+
+By default, the client does not request compressed responses. To enable compression:
+
+```ruby
+turbopuffer = Turbopuffer::Client.new(
+  compression: true
+)
+
+# Or, configure per-request:
+turbopuffer.namespaces(prefix: "foo", request_options: {compression: true})
+```
+
 ## Advanced concepts
 
 ### BaseModel

data/lib/turbopuffer/client.rb

@@ -82,6 +82,8 @@ module Turbopuffer
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
     # `"https://api.example.com/v2/"`. Defaults to `ENV["TURBOPUFFER_BASE_URL"]`
     #
+    # @param compression [Boolean] Whether to request compressed responses. Defaults to false.
+    #
     # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
     #
     # @param timeout [Float]
@@ -94,6 +96,7 @@ module Turbopuffer
       region: ENV["TURBOPUFFER_REGION"],
       default_namespace: nil,
       base_url: ENV["TURBOPUFFER_BASE_URL"],
+      compression: false,
       max_retries: self.class::DEFAULT_MAX_RETRIES,
       timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
@@ -123,7 +126,8 @@ module Turbopuffer
         timeout: timeout,
         max_retries: max_retries,
         initial_retry_delay: initial_retry_delay,
-        max_retry_delay: max_retry_delay
+        max_retry_delay: max_retry_delay,
+        headers: compression ? {} : {"accept-encoding" => "identity"}
       )
     end
   end

data/lib/turbopuffer/internal/transport/base_client.rb

@@ -266,6 +266,8 @@ module Turbopuffer
         #
         #   @option opts [Float, nil] :timeout
         #
+        #   @option opts [Boolean, nil] :compression
+        #
         # @return [Hash{Symbol=>Object}]
         private def build_request(req, opts)
           method, uninterpolated_path = req.fetch_values(:method, :path)
@@ -274,9 +276,20 @@ module Turbopuffer
 
           query = Turbopuffer::Internal::Util.deep_merge(req[:query].to_h, opts[:extra_query].to_h)
 
+          compression_headers =
+            case opts[:compression]
+            when true
+              {"accept-encoding" => nil}
+            when false
+              {"accept-encoding" => "identity"}
+            else
+              {}
+            end
+
           headers = Turbopuffer::Internal::Util.normalized_headers(
             @headers,
             auth_headers,
+            compression_headers,
             req[:headers].to_h,
             opts[:extra_headers].to_h
           )

data/lib/turbopuffer/models/namespace_write_params.rb

@@ -91,6 +91,14 @@ module Turbopuffer
       #   @return [Array<Turbopuffer::Models::Row>, nil]
       optional :patch_rows, -> { Turbopuffer::Internal::Type::ArrayOf[Turbopuffer::Row] }
 
+      # @!attribute return_affected_ids
+      #   If true, return the IDs of affected rows (deleted, patched, upserted) in the
+      #   response. For filtered and conditional writes, only IDs for writes that
+      #   succeeded will be included.
+      #
+      #   @return [Boolean, nil]
+      optional :return_affected_ids, Turbopuffer::Internal::Type::Boolean
+
       # @!attribute schema
       #   The schema of the attributes attached to the documents.
       #
@@ -116,7 +124,7 @@ module Turbopuffer
       #   @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_by_filter_allow_partial: nil, delete_condition: nil, deletes: nil, disable_backpressure: nil, distance_metric: nil, encryption: nil, patch_by_filter: nil, patch_by_filter_allow_partial: nil, patch_columns: nil, patch_condition: nil, patch_rows: nil, schema: nil, upsert_columns: nil, upsert_condition: nil, upsert_rows: nil, request_options: {})
+      # @!method initialize(namespace: nil, copy_from_namespace: nil, delete_by_filter: nil, delete_by_filter_allow_partial: nil, delete_condition: nil, deletes: nil, disable_backpressure: nil, distance_metric: nil, encryption: nil, patch_by_filter: nil, patch_by_filter_allow_partial: nil, patch_columns: nil, patch_condition: nil, patch_rows: nil, return_affected_ids: 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.
       #
@@ -148,6 +156,8 @@ module Turbopuffer
       #
       #   @param patch_rows [Array<Turbopuffer::Models::Row>]
       #
+      #   @param return_affected_ids [Boolean] If true, return the IDs of affected rows (deleted, patched, upserted) in the res
+      #
       #   @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
@@ -175,13 +185,13 @@ module Turbopuffer
           required :source_namespace, String
 
           # @!attribute source_api_key
-          #   An API key for the organization containing the source namespace
+          #   (Optional) An API key for the organization containing the source namespace
           #
           #   @return [String, nil]
           optional :source_api_key, String
 
           # @!attribute source_region
-          #   The region of the source namespace.
+          #   (Optional) The region of the source namespace.
           #
           #   @return [String, nil]
           optional :source_region, String
@@ -189,9 +199,9 @@ module Turbopuffer
           # @!method initialize(source_namespace:, source_api_key: nil, source_region: nil)
           #   @param source_namespace [String] The namespace to copy documents from.
           #
-          #   @param source_api_key [String] An API key for the organization containing the source namespace
+          #   @param source_api_key [String] (Optional) An API key for the organization containing the source namespace
           #
-          #   @param source_region [String] The region of the source namespace.
+          #   @param source_region [String] (Optional) The region of the source namespace.
         end
 
         # @!method self.variants

data/lib/turbopuffer/models/namespace_write_response.rb

@@ -28,6 +28,20 @@ module Turbopuffer
       #   @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 rows_deleted
       #   The number of rows deleted by the write request.
       #
@@ -52,7 +66,17 @@ module Turbopuffer
       #   @return [Integer, nil]
       optional :rows_upserted, Integer
 
-      # @!method initialize(billing:, message:, rows_affected:, rows_deleted: nil, rows_patched: nil, rows_remaining: nil, rows_upserted: nil, status: :OK)
+      # @!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, 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::NamespaceWriteResponse} for more details.
+      #
       #   The response to a successful write request.
       #
       #   @param billing [Turbopuffer::Models::WriteBilling] The billing information for a write request.
@@ -61,6 +85,10 @@ module Turbopuffer
       #
       #   @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 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.
@@ -69,6 +97,8 @@ module Turbopuffer
       #
       #   @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

data/lib/turbopuffer/request_options.rb

@@ -65,6 +65,12 @@ module Turbopuffer
     #   @return [Float, nil]
     optional :timeout, Float
 
+    # @!attribute compression
+    #   Whether to request compressed responses.
+    #
+    #   @return [Boolean, nil]
+    optional :compression, Turbopuffer::Internal::Type::Boolean
+
     # @!method initialize(values = {})
     #   Returns a new instance of RequestOptions.
     #

data/lib/turbopuffer/resources/namespaces.rb

@@ -131,7 +131,7 @@ module Turbopuffer
       #
       # @overload multi_query(queries:, namespace: nil, consistency: nil, vector_encoding: nil, request_options: {})
       #
-      # @param queries [Array<Turbopuffer::Models::Query>] Body param:
+      # @param queries [Array<Turbopuffer::Models::Query>] Body param
       #
       # @param namespace [String] Path param: The name of the namespace.
       #
@@ -305,7 +305,7 @@ module Turbopuffer
       #
       # Create, update, or delete documents.
       #
-      # @overload write(namespace: nil, copy_from_namespace: nil, delete_by_filter: nil, delete_by_filter_allow_partial: nil, delete_condition: nil, deletes: nil, disable_backpressure: nil, distance_metric: nil, encryption: nil, patch_by_filter: nil, patch_by_filter_allow_partial: nil, patch_columns: nil, patch_condition: nil, patch_rows: nil, schema: nil, upsert_columns: nil, upsert_condition: nil, upsert_rows: nil, request_options: {})
+      # @overload write(namespace: nil, copy_from_namespace: nil, delete_by_filter: nil, delete_by_filter_allow_partial: nil, delete_condition: nil, deletes: nil, disable_backpressure: nil, distance_metric: nil, encryption: nil, patch_by_filter: nil, patch_by_filter_allow_partial: nil, patch_columns: nil, patch_condition: nil, patch_rows: nil, return_affected_ids: nil, schema: nil, upsert_columns: nil, upsert_condition: nil, upsert_rows: nil, request_options: {})
       #
       # @param namespace [String] Path param: The name of the namespace.
       #
@@ -317,7 +317,7 @@ module Turbopuffer
       #
       # @param delete_condition [Object] Body param: A condition evaluated against the current value of each document tar
       #
-      # @param deletes [Array<String, Integer>] Body param:
+      # @param deletes [Array<String, Integer>] Body param
       #
       # @param disable_backpressure [Boolean] Body param: Disables write throttling (HTTP 429 responses) during high-volume in
       #
@@ -333,7 +333,9 @@ module Turbopuffer
       #
       # @param patch_condition [Object] Body param: A condition evaluated against the current value of each document tar
       #
-      # @param patch_rows [Array<Turbopuffer::Models::Row>] Body param:
+      # @param patch_rows [Array<Turbopuffer::Models::Row>] Body param
+      #
+      # @param return_affected_ids [Boolean] Body param: If true, return the IDs of affected rows (deleted, patched, upserted
       #
       # @param schema [Hash{Symbol=>String, Turbopuffer::Models::AttributeSchemaConfig}] Body param: The schema of the attributes attached to the documents.
       #
@@ -341,7 +343,7 @@ module Turbopuffer
       #
       # @param upsert_condition [Object] Body param: A condition evaluated against the current value of each document tar
       #
-      # @param upsert_rows [Array<Turbopuffer::Models::Row>] Body param:
+      # @param upsert_rows [Array<Turbopuffer::Models::Row>] Body param
       #
       # @param request_options [Turbopuffer::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/turbopuffer/version.rb

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

data/rbi/turbopuffer/client.rbi

@@ -65,6 +65,7 @@ module Turbopuffer
         region: T.nilable(String),
         default_namespace: T.nilable(String),
         base_url: T.nilable(String),
+        compression: T::Boolean,
         max_retries: Integer,
         timeout: Float,
         initial_retry_delay: Float,
@@ -80,6 +81,8 @@ module Turbopuffer
       # Override the default base URL for the API, e.g.,
       # `"https://api.example.com/v2/"`. Defaults to `ENV["TURBOPUFFER_BASE_URL"]`
       base_url: ENV["TURBOPUFFER_BASE_URL"],
+      # Whether to request compressed responses. Defaults to false.
+      compression: false,
       # Max number of retries to attempt after a failed retryable request.
       max_retries: Turbopuffer::Client::DEFAULT_MAX_RETRIES,
       timeout: Turbopuffer::Client::DEFAULT_TIMEOUT_IN_SECONDS,

data/rbi/turbopuffer/models/namespace_write_params.rbi

@@ -142,6 +142,15 @@ module Turbopuffer
       sig { params(patch_rows: T::Array[Turbopuffer::Row::OrHash]).void }
       attr_writer :patch_rows
 
+      # If true, return the IDs of affected rows (deleted, patched, upserted) in the
+      # response. For filtered and conditional writes, only IDs for writes that
+      # succeeded will be included.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :return_affected_ids
+
+      sig { params(return_affected_ids: T::Boolean).void }
+      attr_writer :return_affected_ids
+
       # The schema of the attributes attached to the documents.
       sig do
         returns(
@@ -206,6 +215,7 @@ module Turbopuffer
           patch_columns: Turbopuffer::Columns::OrHash,
           patch_condition: T.anything,
           patch_rows: T::Array[Turbopuffer::Row::OrHash],
+          return_affected_ids: T::Boolean,
           schema:
             T::Hash[
               Symbol,
@@ -246,6 +256,10 @@ module Turbopuffer
         # patch write. Only documents that pass the condition are patched.
         patch_condition: nil,
         patch_rows: nil,
+        # If true, return the IDs of affected rows (deleted, patched, upserted) in the
+        # response. For filtered and conditional writes, only IDs for writes that
+        # succeeded will be included.
+        return_affected_ids: 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
@@ -280,6 +294,7 @@ module Turbopuffer
             patch_columns: Turbopuffer::Columns,
             patch_condition: T.anything,
             patch_rows: T::Array[Turbopuffer::Row],
+            return_affected_ids: T::Boolean,
             schema:
               T::Hash[
                 Symbol,
@@ -320,14 +335,14 @@ module Turbopuffer
           sig { returns(String) }
           attr_accessor :source_namespace
 
-          # An API key for the organization containing the source namespace
+          # (Optional) An API key for the organization containing the source namespace
           sig { returns(T.nilable(String)) }
           attr_reader :source_api_key
 
           sig { params(source_api_key: String).void }
           attr_writer :source_api_key
 
-          # The region of the source namespace.
+          # (Optional) The region of the source namespace.
           sig { returns(T.nilable(String)) }
           attr_reader :source_region
 
@@ -344,9 +359,9 @@ module Turbopuffer
           def self.new(
             # The namespace to copy documents from.
             source_namespace:,
-            # An API key for the organization containing the source namespace
+            # (Optional) An API key for the organization containing the source namespace
             source_api_key: nil,
-            # The region of the source namespace.
+            # (Optional) The region of the source namespace.
             source_region: nil
           )
           end

data/rbi/turbopuffer/models/namespace_write_response.rbi

@@ -30,6 +30,22 @@ module Turbopuffer
       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 number of rows deleted by the write request.
       sig { returns(T.nilable(Integer)) }
       attr_reader :rows_deleted
@@ -58,16 +74,27 @@ module Turbopuffer
       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],
           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
@@ -78,6 +105,12 @@ module Turbopuffer
         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 number of rows deleted by the write request.
         rows_deleted: nil,
         # The number of rows patched by the write request.
@@ -86,6 +119,9 @@ module Turbopuffer
         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
       )
@@ -98,10 +134,13 @@ module Turbopuffer
             message: String,
             rows_affected: Integer,
             status: Symbol,
+            deleted_ids: T::Array[Turbopuffer::ID::Variants],
+            patched_ids: T::Array[Turbopuffer::ID::Variants],
             rows_deleted: Integer,
             rows_patched: Integer,
             rows_remaining: T::Boolean,
-            rows_upserted: Integer
+            rows_upserted: Integer,
+            upserted_ids: T::Array[Turbopuffer::ID::Variants]
           }
         )
       end

data/rbi/turbopuffer/request_options.rbi

@@ -49,6 +49,10 @@ module Turbopuffer
     sig { returns(T.nilable(Float)) }
     attr_accessor :timeout
 
+    # Whether to request compressed responses.
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_accessor :compression
+
     # Returns a new instance of RequestOptions.
     sig do
       params(values: Turbopuffer::Internal::AnyHash).returns(T.attached_class)

data/rbi/turbopuffer/resources/namespaces.rbi

@@ -106,7 +106,7 @@ module Turbopuffer
         ).returns(Turbopuffer::Models::NamespaceMultiQueryResponse)
       end
       def multi_query(
-        # Body param:
+        # Body param
         queries:,
         # Path param: The name of the namespace.
         namespace: nil,
@@ -254,6 +254,7 @@ module Turbopuffer
           patch_columns: Turbopuffer::Columns::OrHash,
           patch_condition: T.anything,
           patch_rows: T::Array[Turbopuffer::Row::OrHash],
+          return_affected_ids: T::Boolean,
           schema:
             T::Hash[
               Symbol,
@@ -277,7 +278,7 @@ module Turbopuffer
         # Body param: 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,
-        # Body param:
+        # Body param
         deletes: nil,
         # Body param: Disables write throttling (HTTP 429 responses) during high-volume
         # ingestion.
@@ -296,8 +297,12 @@ module Turbopuffer
         # Body param: 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,
-        # Body param:
+        # Body param
         patch_rows: nil,
+        # Body param: If true, return the IDs of affected rows (deleted, patched,
+        # upserted) in the response. For filtered and conditional writes, only IDs for
+        # writes that succeeded will be included.
+        return_affected_ids: nil,
         # Body param: The schema of the attributes attached to the documents.
         schema: nil,
         # Body param: A list of documents in columnar format. Each key is a column name,
@@ -307,7 +312,7 @@ module Turbopuffer
         # targeted by an upsert write. Only documents that pass the condition are
         # upserted.
         upsert_condition: nil,
-        # Body param:
+        # Body param
         upsert_rows: nil,
         request_options: {}
       )

data/sig/turbopuffer/client.rbs

@@ -32,6 +32,7 @@ module Turbopuffer
       ?region: String?,
       ?default_namespace: String?,
       ?base_url: String?,
+      ?compression: bool,
       ?max_retries: Integer,
       ?timeout: Float,
       ?initial_retry_delay: Float,

data/sig/turbopuffer/models/namespace_write_params.rbs

@@ -16,6 +16,7 @@ module Turbopuffer
         patch_columns: Turbopuffer::Columns,
         patch_condition: top,
         patch_rows: ::Array[Turbopuffer::Row],
+        return_affected_ids: bool,
         schema: ::Hash[Symbol, Turbopuffer::Models::attribute_schema],
         upsert_columns: Turbopuffer::Columns,
         upsert_condition: top,
@@ -93,6 +94,10 @@ module Turbopuffer
 
       def patch_rows=: (::Array[Turbopuffer::Row]) -> ::Array[Turbopuffer::Row]
 
+      attr_reader return_affected_ids: bool?
+
+      def return_affected_ids=: (bool) -> bool
+
       attr_reader schema: ::Hash[Symbol, Turbopuffer::Models::attribute_schema]?
 
       def schema=: (
@@ -126,6 +131,7 @@ module Turbopuffer
         ?patch_columns: Turbopuffer::Columns,
         ?patch_condition: top,
         ?patch_rows: ::Array[Turbopuffer::Row],
+        ?return_affected_ids: bool,
         ?schema: ::Hash[Symbol, Turbopuffer::Models::attribute_schema],
         ?upsert_columns: Turbopuffer::Columns,
         ?upsert_condition: top,
@@ -148,6 +154,7 @@ module Turbopuffer
         patch_columns: Turbopuffer::Columns,
         patch_condition: top,
         patch_rows: ::Array[Turbopuffer::Row],
+        return_affected_ids: bool,
         schema: ::Hash[Symbol, Turbopuffer::Models::attribute_schema],
         upsert_columns: Turbopuffer::Columns,
         upsert_condition: top,

data/sig/turbopuffer/models/namespace_write_response.rbs

@@ -6,10 +6,13 @@ module Turbopuffer
         message: String,
         rows_affected: Integer,
         status: :OK,
+        deleted_ids: ::Array[Turbopuffer::Models::id],
+        patched_ids: ::Array[Turbopuffer::Models::id],
         rows_deleted: Integer,
         rows_patched: Integer,
         rows_remaining: bool,
-        rows_upserted: Integer
+        rows_upserted: Integer,
+        upserted_ids: ::Array[Turbopuffer::Models::id]
       }
 
     class NamespaceWriteResponse < Turbopuffer::Internal::Type::BaseModel
@@ -21,6 +24,18 @@ module Turbopuffer
 
       attr_accessor status: :OK
 
+      attr_reader deleted_ids: ::Array[Turbopuffer::Models::id]?
+
+      def deleted_ids=: (
+        ::Array[Turbopuffer::Models::id]
+      ) -> ::Array[Turbopuffer::Models::id]
+
+      attr_reader patched_ids: ::Array[Turbopuffer::Models::id]?
+
+      def patched_ids=: (
+        ::Array[Turbopuffer::Models::id]
+      ) -> ::Array[Turbopuffer::Models::id]
+
       attr_reader rows_deleted: Integer?
 
       def rows_deleted=: (Integer) -> Integer
@@ -37,14 +52,23 @@ module Turbopuffer
 
       def rows_upserted=: (Integer) -> Integer
 
+      attr_reader upserted_ids: ::Array[Turbopuffer::Models::id]?
+
+      def upserted_ids=: (
+        ::Array[Turbopuffer::Models::id]
+      ) -> ::Array[Turbopuffer::Models::id]
+
       def initialize: (
         billing: Turbopuffer::WriteBilling,
         message: String,
         rows_affected: Integer,
+        ?deleted_ids: ::Array[Turbopuffer::Models::id],
+        ?patched_ids: ::Array[Turbopuffer::Models::id],
         ?rows_deleted: Integer,
         ?rows_patched: Integer,
         ?rows_remaining: bool,
         ?rows_upserted: Integer,
+        ?upserted_ids: ::Array[Turbopuffer::Models::id],
         ?status: :OK
       ) -> void
 
@@ -53,10 +77,13 @@ module Turbopuffer
         message: String,
         rows_affected: Integer,
         status: :OK,
+        deleted_ids: ::Array[Turbopuffer::Models::id],
+        patched_ids: ::Array[Turbopuffer::Models::id],
         rows_deleted: Integer,
         rows_patched: Integer,
         rows_remaining: bool,
-        rows_upserted: Integer
+        rows_upserted: Integer,
+        upserted_ids: ::Array[Turbopuffer::Models::id]
       }
     end
   end

data/sig/turbopuffer/request_options.rbs

@@ -11,7 +11,8 @@ module Turbopuffer
       extra_headers: ::Hash[String, String?]?,
       extra_body: top?,
       max_retries: Integer?,
-      timeout: Float?
+      timeout: Float?,
+      compression: bool?
     }
 
   class RequestOptions < Turbopuffer::Internal::Type::BaseModel
@@ -29,6 +30,8 @@ module Turbopuffer
 
     attr_accessor timeout: Float?
 
+    attr_accessor compression: bool?
+
     def initialize: (
       ?Turbopuffer::request_options | ::Hash[Symbol, top] values
     ) -> void

data/sig/turbopuffer/resources/namespaces.rbs

@@ -90,6 +90,7 @@ module Turbopuffer
         ?patch_columns: Turbopuffer::Columns,
         ?patch_condition: top,
         ?patch_rows: ::Array[Turbopuffer::Row],
+        ?return_affected_ids: bool,
         ?schema: ::Hash[Symbol, Turbopuffer::Models::attribute_schema],
         ?upsert_columns: Turbopuffer::Columns,
         ?upsert_condition: top,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turbopuffer
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.11.0
 platform: ruby
 authors:
 - Turbopuffer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-09 00:00:00.000000000 Z
+date: 2026-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi