turbopuffer 2.3.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3a51779391cbefbadc2c92d4da69e9f2b8a16db31b09626fc610d979f8317af
-  data.tar.gz: f814addde33fea46dfea6c616ab8f71c34a4813a7f53283bdd3b04765ea9f91b
+  metadata.gz: c7a74005340bd71314cefec78857e87f61242c5e99ca0619718932862dfb9b3e
+  data.tar.gz: 90568747fb99e6f0c3e07e135600cd49e48e806023059f27f0f270bb3f20ca20
 SHA512:
-  metadata.gz: 66b621f09d12e2ae0540a69f163c596063b59c3a4df34416cd9c48330f167065af3ee4e1292d1d954adcfc7796b1d1a46fd023b50681f286d81e1984535e5880
-  data.tar.gz: 9b77397676c00954fd6ee3bad008eeedf6af798d41718d636841b9e12c35ab98caa434acaee6f157e006d9d08aa6491df57943ebfe8fa846fbcc131102a8d957
+  metadata.gz: e01efec060630c4a1b3840c93dc93148fd8724ffe326b7b697679a6d2a51eeecea9692ece6be917b3d42d7ed85ed1a958db57134f215b4290ab63f0c33521232
+  data.tar.gz: 9ce535511cfc814424db7cf0c6567b35724ddb1c75550224866a805040220b2daf28c9b0dfa686153f2a6e8a41c056066c29d0952a805594e7bda8cfe356351b

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # Changelog
 
+## 2.5.0 (2026-09-18)
+
+Full Changelog: [v2.4.0...v2.5.0](https://github.com/turbopuffer/turbopuffer-ruby/compare/v2.4.0...v2.5.0)
+
+### Features
+
+* Add `read_only` namespace field ([8dfb1f7](https://github.com/turbopuffer/turbopuffer-ruby/commit/8dfb1f77bf0f2ad5eb1c238a0c4b3df49549b9fd))
+* **api:** Merge remote-tracking branch 'origin/preview/benesch/named-rerank-limit-schema' ([917c0b7](https://github.com/turbopuffer/turbopuffer-ruby/commit/917c0b700820ef1d68eb92c485d02e1013fe4479))
+* Apply limit on rerank_by when provided ([fbd70cb](https://github.com/turbopuffer/turbopuffer-ruby/commit/fbd70cbaeb31bae86f197975d2bdd40669620cf1))
+* engine,openapi: async copy_from_namespace endpoints ([5af8916](https://github.com/turbopuffer/turbopuffer-ruby/commit/5af89166d027304ae1869e691bf79cade774c04a))
+* spec: no-op change to Stainless spec ([4e0d0cc](https://github.com/turbopuffer/turbopuffer-ruby/commit/4e0d0ccb819df54524e8b5c3fd3efea8105ddae7))
+* tpuf-engine: Adding pagination through `offset` ([1de87c9](https://github.com/turbopuffer/turbopuffer-ruby/commit/1de87c959126a8737a724c5cd594bd844cc43bf0))
+* tpuf-engine: expose billed_replicas in pinning metadata ([3f414fc](https://github.com/turbopuffer/turbopuffer-ruby/commit/3f414fcf1df33d8f41615755c5474f8fcd6713b2))
+
+
+### Bug Fixes
+
+* wrap start copy request bodies ([#70](https://github.com/turbopuffer/turbopuffer-ruby/issues/70)) ([4a44435](https://github.com/turbopuffer/turbopuffer-ruby/commit/4a444351b3a1dc68f0dcba86fe15dcac03d3ae88))
+
+## 2.4.0 (2026-07-30)
+
+Full Changelog: [v2.3.0...v2.4.0](https://github.com/turbopuffer/turbopuffer-ruby/compare/v2.3.0...v2.4.0)
+
+### Features
+
+* openapi: add RRF `weights` parameter ([621628b](https://github.com/turbopuffer/turbopuffer-ruby/commit/621628bc8d9ed54a0ab5006c20ba5f4ae03e966e))
+* spec: add sharding config to the openapi spec ([2228a03](https://github.com/turbopuffer/turbopuffer-ruby/commit/2228a031201ad1b3d20ae1c77d029d665c67e428))
+* spec: expose computed attributes ([597fdde](https://github.com/turbopuffer/turbopuffer-ruby/commit/597fdde888efd50b9873b056ab0c12fab5a9e600))
+* spec: hide HighlightConfig.rank_fragments_by's RankBy ref from Stainless ([59c2734](https://github.com/turbopuffer/turbopuffer-ruby/commit/59c273482fcfccce1fc8f4d8b8d3ae13c0fbbcdc))
+* spec: make compute_attributes value x-stainless-any ([c170466](https://github.com/turbopuffer/turbopuffer-ruby/commit/c17046653f2533e00e9129d4e807a5ab2c3b1cd6))
+* spec: rename HighlightConfig -> HighlightConfigParams ([36413c3](https://github.com/turbopuffer/turbopuffer-ruby/commit/36413c3bebab413e60ab51ba728437e66edaa7ab))
+* **stlc:** configurable CI runner and private-production-repo support in workflow templates ([12b486b](https://github.com/turbopuffer/turbopuffer-ruby/commit/12b486b953bf4521f18eb1187ba20812d30b3cfd))
+* support late_interaction parameter in sdks ([ac90617](https://github.com/turbopuffer/turbopuffer-ruby/commit/ac9061734ae8f47e823c20f381bf925c27634d8e))
+
+
+### Chores
+
+* **internal:** bound formatter parallelism to CPU count ([a56e5af](https://github.com/turbopuffer/turbopuffer-ruby/commit/a56e5af20b69bd39b12fbf2e9db2cd6d9b1b1ee8))
+* remove unused MCP package ([2b81b9a](https://github.com/turbopuffer/turbopuffer-ruby/commit/2b81b9ae116370e14cf1213e056b147277e6cca3))
+
 ## 2.3.0 (2026-06-16)
 
 Full Changelog: [v2.2.0...v2.3.0](https://github.com/turbopuffer/turbopuffer-ruby/compare/v2.2.0...v2.3.0)

data/README.md

@@ -4,15 +4,6 @@ The turbopuffer Ruby library provides convenient access to the [turbopuffer HTTP
 
 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=eyJuYW1lIjoiQHR1cmJvcHVmZmVyL3R1cmJvcHVmZmVyLW1jcCIsInRyYW5zcG9ydCI6Imh0dHAiLCJ1cmwiOiJodHRwczovL3R1cmJvcHVmZmVyLnN0bG1jcC5jb20iLCJoZWFkZXJzIjp7IngtdHVyYm9wdWZmZXItYXBpLWtleSI6InRwdWZfQTEuLi4ifX0)
-[![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%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fturbopuffer.stlmcp.com%22%2C%22headers%22%3A%7B%22x-turbopuffer-api-key%22%3A%22tpuf_A1...%22%7D%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).
@@ -26,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "turbopuffer", "~> 2.3.0"
+gem "turbopuffer", "~> 2.5.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/turbopuffer/client.rb

@@ -15,7 +15,7 @@ module Turbopuffer
     # Default max retry delay in seconds.
     DEFAULT_MAX_RETRY_DELAY = 8.0
 
-    # API key used for authentication
+    # API key used for authentication.
     # @return [String]
     attr_reader :api_key
 
@@ -74,7 +74,7 @@ module Turbopuffer
 
     # Creates and returns a new client for interacting with the API.
     #
-    # @param api_key [String, nil] API key used for authentication Defaults to `ENV["TURBOPUFFER_API_KEY"]`
+    # @param api_key [String, nil] API key used for authentication. Defaults to `ENV["TURBOPUFFER_API_KEY"]`
     #
     # @param region [String, nil] The turbopuffer region to use. Defaults to `ENV["TURBOPUFFER_REGION"]`
     #

data/lib/turbopuffer/internal/type/union.rb

@@ -6,14 +6,24 @@ module Turbopuffer
       # @api private
       #
       # @example
-      #   # `attribute_embed` is a `Turbopuffer::AttributeEmbed`
-      #   case attribute_embed
-      #   when String
-      #     # ...
-      #   when Turbopuffer::AttributeEmbedConfig
-      #     puts(attribute_embed.model)
+      #   # `copy_from_namespace_operation` is a `Turbopuffer::CopyFromNamespaceOperation`
+      #   case copy_from_namespace_operation
+      #   when Turbopuffer::CopyFromNamespaceOperation::Running
+      #     puts(copy_from_namespace_operation.start_time)
+      #   when Turbopuffer::CopyFromNamespaceOperation::Finished
+      #     puts(copy_from_namespace_operation.finish_time)
       #   else
-      #     puts(attribute_embed)
+      #     puts(copy_from_namespace_operation)
+      #   end
+      #
+      # @example
+      #   case copy_from_namespace_operation
+      #   in {status: :running, start_time: start_time, progress: progress}
+      #     puts(start_time)
+      #   in {status: :finished, finish_time: finish_time, result: result, start_time: start_time}
+      #     puts(finish_time)
+      #   else
+      #     puts(copy_from_namespace_operation)
       #   end
       module Union
         include Turbopuffer::Internal::Type::Converter

data/lib/turbopuffer/models/attribute_schema_config.rb

@@ -108,10 +108,23 @@ module Turbopuffer
           #   @return [Symbol, Turbopuffer::Models::DistanceMetric, nil]
           optional :distance_metric, enum: -> { Turbopuffer::DistanceMetric }
 
-          # @!method initialize(distance_metric: nil)
+          # @!attribute late_interaction
+          #   Opt in to late-interaction (MUVERA) indexing. Only valid on fixed-dim `[][N]f32`
+          #   vector array attributes, and is required to enable an ANN index on such
+          #   attributes. Defaults to `false`.
+          #
+          #   @return [Boolean, nil]
+          optional :late_interaction, Turbopuffer::Internal::Type::Boolean
+
+          # @!method initialize(distance_metric: nil, late_interaction: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Turbopuffer::Models::AttributeSchemaConfig::Ann::AnnConfig} for more details.
+          #
           #   Configuration options for ANN (Approximate Nearest Neighbor) indexing.
           #
           #   @param distance_metric [Symbol, Turbopuffer::Models::DistanceMetric] A function used to calculate vector similarity.
+          #
+          #   @param late_interaction [Boolean] Opt in to late-interaction (MUVERA) indexing. Only valid on fixed-dim `[][N]f32`
         end
 
         # @!method self.variants

data/lib/turbopuffer/models/copy_from_namespace_operation.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # The current status of a copy operation.
+    #
+    # @see Turbopuffer::Resources::Namespaces#poll_copy_from
+    module CopyFromNamespaceOperation
+      extend Turbopuffer::Internal::Type::Union
+
+      discriminator :status
+
+      variant :running, -> { Turbopuffer::CopyFromNamespaceOperation::Running }
+
+      variant :finished, -> { Turbopuffer::CopyFromNamespaceOperation::Finished }
+
+      class Running < Turbopuffer::Internal::Type::BaseModel
+        # @!attribute start_time
+        #   The time at which the operation started.
+        #
+        #   @return [Time]
+        required :start_time, Time
+
+        # @!attribute status
+        #
+        #   @return [Symbol, :running]
+        required :status, const: :running
+
+        # @!attribute progress
+        #   A freeform description of the operation's progress. May be absent, and its
+        #   format may change.
+        #
+        #   @return [String, nil]
+        optional :progress, String
+
+        # @!method initialize(start_time:, progress: nil, status: :running)
+        #   Some parameter documentations has been truncated, see
+        #   {Turbopuffer::Models::CopyFromNamespaceOperation::Running} for more details.
+        #
+        #   @param start_time [Time] The time at which the operation started.
+        #
+        #   @param progress [String] A freeform description of the operation's progress. May be absent, and its forma
+        #
+        #   @param status [Symbol, :running]
+      end
+
+      class Finished < Turbopuffer::Internal::Type::BaseModel
+        # @!attribute finish_time
+        #   The time at which the operation finished.
+        #
+        #   @return [Time]
+        required :finish_time, Time
+
+        # @!attribute result
+        #
+        #   @return [Turbopuffer::Models::CopyFromNamespaceOperationResult::Success, Turbopuffer::Models::CopyFromNamespaceOperationResult::Error]
+        required :result, union: -> { Turbopuffer::CopyFromNamespaceOperationResult }
+
+        # @!attribute start_time
+        #   The time at which the operation started.
+        #
+        #   @return [Time]
+        required :start_time, Time
+
+        # @!attribute status
+        #
+        #   @return [Symbol, :finished]
+        required :status, const: :finished
+
+        # @!method initialize(finish_time:, result:, start_time:, status: :finished)
+        #   @param finish_time [Time] The time at which the operation finished.
+        #
+        #   @param result [Turbopuffer::Models::CopyFromNamespaceOperationResult::Success, Turbopuffer::Models::CopyFromNamespaceOperationResult::Error]
+        #
+        #   @param start_time [Time] The time at which the operation started.
+        #
+        #   @param status [Symbol, :finished]
+      end
+
+      # @!method self.variants
+      #   @return [Array(Turbopuffer::Models::CopyFromNamespaceOperation::Running, Turbopuffer::Models::CopyFromNamespaceOperation::Finished)]
+    end
+  end
+end

data/lib/turbopuffer/models/copy_from_namespace_operation_result.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    module CopyFromNamespaceOperationResult
+      extend Turbopuffer::Internal::Type::Union
+
+      variant -> { Turbopuffer::CopyFromNamespaceOperationResult::Success }
+
+      variant -> { Turbopuffer::CopyFromNamespaceOperationResult::Error }
+
+      class Success < Turbopuffer::Internal::Type::BaseModel
+        # @!attribute success
+        #   The response to a successful write request.
+        #
+        #   @return [Turbopuffer::Models::WriteResult]
+        required :success, -> { Turbopuffer::WriteResult }
+
+        # @!method initialize(success:)
+        #   @param success [Turbopuffer::Models::WriteResult] The response to a successful write request.
+      end
+
+      class Error < Turbopuffer::Internal::Type::BaseModel
+        # @!attribute error
+        #
+        #   @return [Turbopuffer::Models::OperationError]
+        required :error, -> { Turbopuffer::OperationError }
+
+        # @!method initialize(error:)
+        #   @param error [Turbopuffer::Models::OperationError]
+      end
+
+      # @!method self.variants
+      #   @return [Array(Turbopuffer::Models::CopyFromNamespaceOperationResult::Success, Turbopuffer::Models::CopyFromNamespaceOperationResult::Error)]
+    end
+  end
+end

data/lib/turbopuffer/models/highlight_config_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    class HighlightConfigParams < Turbopuffer::Internal::Type::BaseModel
+      # @!attribute fragment_by
+      #   How to split a text attribute into fragments for highlighting.
+      #
+      #   @return [Symbol, Turbopuffer::Models::HighlightFragmentBy, nil]
+      optional :fragment_by, enum: -> { Turbopuffer::HighlightFragmentBy }
+
+      # @!attribute fragment_limit
+      #   The maximum number of fragments to return. Defaults to `3`.
+      #
+      #   @return [Integer, nil]
+      optional :fragment_limit, Integer
+
+      # @!attribute include_offsets
+      #   The units to report highlighted fragment offsets in.
+      #
+      #   @return [Symbol, Turbopuffer::Models::HighlightOffsetUnits, nil]
+      optional :include_offsets, enum: -> { Turbopuffer::HighlightOffsetUnits }
+
+      # @!attribute rank_fragments_by
+      #   How to rank candidate fragments within the attribute before selecting the top
+      #   `fragment_limit`. Defaults to the query's `rank_by`.
+      #
+      #   @return [Object, nil]
+      optional :rank_fragments_by, Turbopuffer::Internal::Type::Unknown
+
+      # @!method initialize(fragment_by: nil, fragment_limit: nil, include_offsets: nil, rank_fragments_by: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Turbopuffer::Models::HighlightConfigParams} for more details.
+      #
+      #   Additional (optional) parameters for the Highlight compute expression.
+      #
+      #   @param fragment_by [Symbol, Turbopuffer::Models::HighlightFragmentBy] How to split a text attribute into fragments for highlighting.
+      #
+      #   @param fragment_limit [Integer] The maximum number of fragments to return. Defaults to `3`.
+      #
+      #   @param include_offsets [Symbol, Turbopuffer::Models::HighlightOffsetUnits] The units to report highlighted fragment offsets in.
+      #
+      #   @param rank_fragments_by [Object] How to rank candidate fragments within the attribute before selecting the top `f
+    end
+  end
+end

data/lib/turbopuffer/models/highlight_fragment_by.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # How to split a text attribute into fragments for highlighting.
+    module HighlightFragmentBy
+      extend Turbopuffer::Internal::Type::Enum
+
+      # Treat the whole attribute as a single fragment.
+      NONE = :none
+
+      # Split the attribute into sentences. This is the default.
+      SENTENCE = :sentence
+
+      # Split the attribute into paragraphs.
+      PARAGRAPH = :paragraph
+
+      # Split the attribute into individual words.
+      WORD = :word
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/turbopuffer/models/highlight_offset_units.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # The units to report highlighted fragment offsets in.
+    module HighlightOffsetUnits
+      extend Turbopuffer::Internal::Type::Enum
+
+      UTF_8 = :"utf-8"
+      UTF_16 = :"utf-16"
+      CODEPOINTS = :codepoints
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/turbopuffer/models/namespace_explain_query_params.rb

@@ -19,6 +19,14 @@ module Turbopuffer
       #   @return [Hash{Symbol=>Object}, nil]
       optional :aggregate_by, Turbopuffer::Internal::Type::HashOf[Turbopuffer::Internal::Type::Unknown]
 
+      # @!attribute compute_attributes
+      #   Computes additional values on documents returned by a query. Each key is the
+      #   name of the computed attribute; each value is an expression describing how to
+      #   compute it.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :compute_attributes, Turbopuffer::Internal::Type::HashOf[Turbopuffer::Internal::Type::Unknown]
+
       # @!attribute consistency
       #   The consistency level for a query.
       #
@@ -64,6 +72,13 @@ module Turbopuffer
       #   @return [Integer, Turbopuffer::Models::Limit, nil]
       optional :limit, union: -> { Turbopuffer::NamespaceExplainQueryParams::Limit }
 
+      # @!attribute offset
+      #   Number of documents to skip before returning results. Supported only in v2
+      #   queries with an explicit `rank_by` and `top_k` or `limit`.
+      #
+      #   @return [Integer, nil]
+      optional :offset, Integer
+
       # @!attribute rank_by
       #   How to rank the documents in the namespace.
       #
@@ -82,7 +97,7 @@ module Turbopuffer
       #   @return [Symbol, Turbopuffer::Models::VectorEncoding, nil]
       optional :vector_encoding, enum: -> { Turbopuffer::VectorEncoding }
 
-      # @!method initialize(namespace: nil, aggregate_by: 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: {})
+      # @!method initialize(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: {})
       #   Some parameter documentations has been truncated, see
       #   {Turbopuffer::Models::NamespaceExplainQueryParams} for more details.
       #
@@ -90,6 +105,8 @@ module Turbopuffer
       #
       #   @param aggregate_by [Hash{Symbol=>Object}] Aggregations to compute over all documents in the namespace that match the filte
       #
+      #   @param compute_attributes [Hash{Symbol=>Object}] Computes additional values on documents returned by a query. Each key is the nam
+      #
       #   @param consistency [Turbopuffer::Models::NamespaceExplainQueryParams::Consistency] The consistency level for a query.
       #
       #   @param distance_metric [Symbol, Turbopuffer::Models::DistanceMetric] A function used to calculate vector similarity.
@@ -104,6 +121,8 @@ module Turbopuffer
       #
       #   @param limit [Integer, Turbopuffer::Models::Limit] Limits the documents returned by a query.
       #
+      #   @param offset [Integer] Number of documents to skip before returning results. Supported only in v2 queri
+      #
       #   @param rank_by [Object] How to rank the documents in the namespace.
       #
       #   @param top_k [Integer] The number of results to return.

data/lib/turbopuffer/models/namespace_metadata.rb

@@ -52,7 +52,22 @@ module Turbopuffer
       #   @return [Turbopuffer::Models::NamespaceMetadata::Pinning, nil]
       optional :pinning, -> { Turbopuffer::NamespaceMetadata::Pinning }
 
-      # @!method initialize(approx_logical_bytes:, approx_row_count:, created_at:, encryption:, index:, schema:, updated_at:, pinning: nil)
+      # @!attribute read_only
+      #   Whether document and schema writes are rejected. Omitted when `false`.
+      #
+      #   @return [Boolean, nil]
+      optional :read_only, Turbopuffer::Internal::Type::Boolean
+
+      # @!attribute sharding
+      #   Configuration for namespace sharding, which partitions a namespace's documents
+      #   across multiple internal shards to scale indexing and query throughput beyond a
+      #   single machine. Sharding can only be configured on a namespace's inaugural
+      #   write, and cannot be added to or changed on an existing namespace.
+      #
+      #   @return [Turbopuffer::Models::ShardingConfig, nil]
+      optional :sharding, -> { Turbopuffer::ShardingConfig }
+
+      # @!method initialize(approx_logical_bytes:, approx_row_count:, created_at:, encryption:, index:, schema:, updated_at:, pinning: nil, read_only: nil, sharding: nil)
       #   Some parameter documentations has been truncated, see
       #   {Turbopuffer::Models::NamespaceMetadata} for more details.
       #
@@ -73,6 +88,10 @@ module Turbopuffer
       #   @param updated_at [Time] The timestamp when the namespace was last modified by a write operation.
       #
       #   @param pinning [Turbopuffer::Models::NamespaceMetadata::Pinning] Configuration for namespace pinning, along with the current status of the pinned
+      #
+      #   @param read_only [Boolean] Whether document and schema writes are rejected. Omitted when `false`.
+      #
+      #   @param sharding [Turbopuffer::Models::ShardingConfig] Configuration for namespace sharding, which partitions a namespace's documents a
 
       # @see Turbopuffer::Models::NamespaceMetadata#index
       module Index
@@ -139,6 +158,15 @@ module Turbopuffer
           #   @return [Integer]
           required :ready_replicas, Integer
 
+          # @!attribute replicas
+          #   The number of running replicas for the namespace. Replicas are billed once
+          #   running, even before they finish warming their caches and become ready to serve
+          #   traffic. This count is updated independently and may briefly disagree with the
+          #   other status fields.
+          #
+          #   @return [Integer]
+          required :replicas, Integer
+
           # @!attribute updated_at
           #   The timestamp of the latest pinning status snapshot.
           #
@@ -152,7 +180,7 @@ module Turbopuffer
           #   @return [Float]
           required :utilization, Float
 
-          # @!method initialize(ready_replicas:, updated_at:, utilization:)
+          # @!method initialize(ready_replicas:, replicas:, updated_at:, utilization:)
           #   Some parameter documentations has been truncated, see
           #   {Turbopuffer::Models::NamespaceMetadata::Pinning::Status} for more details.
           #
@@ -160,6 +188,8 @@ module Turbopuffer
           #
           #   @param ready_replicas [Integer] The number of replicas that are warm and serving traffic.
           #
+          #   @param replicas [Integer] The number of running replicas for the namespace. Replicas are billed once runni
+          #
           #   @param updated_at [Time] The timestamp of the latest pinning status snapshot.
           #
           #   @param utilization [Float] Aggregate utilization for the pinned namespace, reported as a value between 0.0

data/lib/turbopuffer/models/namespace_metadata_patch.rb

@@ -14,13 +14,22 @@ module Turbopuffer
       #   @return [Boolean, Turbopuffer::Models::PinningConfig, nil]
       optional :pinning, union: -> { Turbopuffer::NamespaceMetadataPatch::Pinning }, nil?: true
 
-      # @!method initialize(pinning: nil)
+      # @!attribute read_only
+      #   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.
+      #
+      #   @return [Boolean, nil]
+      optional :read_only, Turbopuffer::Internal::Type::Boolean
+
+      # @!method initialize(pinning: nil, read_only: nil)
       #   Some parameter documentations has been truncated, see
       #   {Turbopuffer::Models::NamespaceMetadataPatch} for more details.
       #
       #   Request to update namespace metadata configuration.
       #
       #   @param pinning [Boolean, Turbopuffer::Models::PinningConfig, nil] Configuration for namespace pinning.
+      #
+      #   @param read_only [Boolean] Set to `true` to reject document and schema writes, or `false` to allow them. Wr
 
       # Configuration for namespace pinning.
       #

data/lib/turbopuffer/models/namespace_multi_query_params.rb

@@ -24,6 +24,19 @@ module Turbopuffer
       #   @return [Turbopuffer::Models::NamespaceMultiQueryParams::Consistency, nil]
       optional :consistency, -> { Turbopuffer::NamespaceMultiQueryParams::Consistency }
 
+      # @!attribute limit
+      #   Limits the total number of reranked documents returned.
+      #
+      #   @return [Integer, Turbopuffer::Models::RerankLimit, nil]
+      optional :limit, union: -> { Turbopuffer::NamespaceMultiQueryParams::Limit }
+
+      # @!attribute offset
+      #   Number of reranked documents to skip before returning results. Requires
+      #   `rerank_by` and `limit`.
+      #
+      #   @return [Integer, nil]
+      optional :offset, Integer
+
       # @!attribute rerank_by
       #   How to combine the rows returned by each sub-query into a single ranked list.
       #
@@ -36,13 +49,21 @@ module Turbopuffer
       #   @return [Symbol, Turbopuffer::Models::VectorEncoding, nil]
       optional :vector_encoding, enum: -> { Turbopuffer::VectorEncoding }
 
-      # @!method initialize(queries:, namespace: nil, consistency: nil, rerank_by: nil, vector_encoding: nil, request_options: {})
+      # @!method initialize(queries:, namespace: nil, consistency: nil, limit: nil, offset: nil, rerank_by: nil, vector_encoding: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Turbopuffer::Models::NamespaceMultiQueryParams} for more details.
+      #
       #   @param queries [Array<Turbopuffer::Models::NamespaceMultiQueryParams::Query>]
       #
       #   @param namespace [String]
       #
       #   @param consistency [Turbopuffer::Models::NamespaceMultiQueryParams::Consistency] The consistency level for a query.
       #
+      #   @param limit [Integer, Turbopuffer::Models::RerankLimit] Limits the total number of reranked documents returned.
+      #
+      #   @param offset [Integer] Number of reranked documents to skip before returning results. Requires
+      #   `rerank\_
+      #
       #   @param rerank_by [Object] How to combine the rows returned by each sub-query into a single ranked list.
       #
       #   @param vector_encoding [Symbol, Turbopuffer::Models::VectorEncoding] The encoding to use for vectors in the response.
@@ -57,6 +78,14 @@ module Turbopuffer
         #   @return [Hash{Symbol=>Object}, nil]
         optional :aggregate_by, Turbopuffer::Internal::Type::HashOf[Turbopuffer::Internal::Type::Unknown]
 
+        # @!attribute compute_attributes
+        #   Computes additional values on documents returned by a query. Each key is the
+        #   name of the computed attribute; each value is an expression describing how to
+        #   compute it.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :compute_attributes, Turbopuffer::Internal::Type::HashOf[Turbopuffer::Internal::Type::Unknown]
+
         # @!attribute distance_metric
         #   A function used to calculate vector similarity.
         #
@@ -96,6 +125,13 @@ module Turbopuffer
         #   @return [Integer, Turbopuffer::Models::Limit, nil]
         optional :limit, union: -> { Turbopuffer::NamespaceMultiQueryParams::Query::Limit }
 
+        # @!attribute offset
+        #   Number of documents to skip before returning results. Supported only in v2
+        #   queries with an explicit `rank_by` and `top_k` or `limit`.
+        #
+        #   @return [Integer, nil]
+        optional :offset, Integer
+
         # @!attribute rank_by
         #   How to rank the documents in the namespace.
         #
@@ -108,7 +144,7 @@ module Turbopuffer
         #   @return [Integer, nil]
         optional :top_k, Integer
 
-        # @!method initialize(aggregate_by: nil, distance_metric: nil, exclude_attributes: nil, filters: nil, group_by: nil, include_attributes: nil, limit: nil, rank_by: nil, top_k: nil)
+        # @!method initialize(aggregate_by: nil, compute_attributes: 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)
         #   Some parameter documentations has been truncated, see
         #   {Turbopuffer::Models::NamespaceMultiQueryParams::Query} for more details.
         #
@@ -116,6 +152,8 @@ module Turbopuffer
         #
         #   @param aggregate_by [Hash{Symbol=>Object}] Aggregations to compute over all documents in the namespace that match the filte
         #
+        #   @param compute_attributes [Hash{Symbol=>Object}] Computes additional values on documents returned by a query. Each key is the nam
+        #
         #   @param distance_metric [Symbol, Turbopuffer::Models::DistanceMetric] A function used to calculate vector similarity.
         #
         #   @param exclude_attributes [Array<String>] List of attribute names to exclude from the response. All other attributes will
@@ -128,6 +166,8 @@ module Turbopuffer
         #
         #   @param limit [Integer, Turbopuffer::Models::Limit] Limits the documents returned by a query.
         #
+        #   @param offset [Integer] Number of documents to skip before returning results. Supported only in v2 queri
+        #
         #   @param rank_by [Object] How to rank the documents in the namespace.
         #
         #   @param top_k [Integer] The number of results to return.
@@ -176,6 +216,19 @@ module Turbopuffer
           #   @return [Array<Symbol>]
         end
       end
+
+      # Limits the total number of reranked documents returned.
+      module Limit
+        extend Turbopuffer::Internal::Type::Union
+
+        variant Integer
+
+        # Limits the total number of reranked documents returned.
+        variant -> { Turbopuffer::RerankLimit }
+
+        # @!method self.variants
+        #   @return [Array(Integer, Turbopuffer::Models::RerankLimit)]
+      end
     end
   end
 end