turbopuffer 2.7.0 → 2.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ef31174cdc912d308aff4e1392291db0bc29aaa5accdfe5f715a51bccb46e6f7
4
- data.tar.gz: b73f653240c84d4ecd85be785bf236c77e236c1c95547754339b3e94e98feb7d
3
+ metadata.gz: a9ea10142f4e8c684cf18f5657f30b47bfa9f6e3abdae0473e720ac63ac82e7a
4
+ data.tar.gz: cb8e5b3806055824b02f4d135c6687c93a9b9f4cc22f239c1dc03c5e22782b04
5
5
  SHA512:
6
- metadata.gz: 1c2a3e24797234d50a2d0606b449a589ceec5c9b29debb461f7e1e0559170d8c7c3237bf1d70df606affcdbf96142b8905ca42f17a01cbe11a660535d22d10de
7
- data.tar.gz: 6e33f83ad2b352168124205f2ac50d93101ae784eb379cc77ae20182eaf9cc3cfe9ac19a02c104c640e1225903f410369ebc1d1e9f828008b2907b6dc4e19d5f
6
+ metadata.gz: 04f840dc0dd750b28b63a46e1b363abb277508d3a25dbc216d5095fd89a408b2093b944a7421f044bab242b2457298ccfe5471c9ea42df2975a5b7b310ad9856
7
+ data.tar.gz: b8b809ed55838462235995bb2ab0f7e20aafdf96273e3dfff1e71086bc777bbe0d5d5583c1e6e858b97bc3f064b4d1682c60cc48cbe28232436c5d8598659c0b
data/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # Changelog
2
2
 
3
+ ## [2.8.0](https://github.com/turbopuffer/turbopuffer-ruby/compare/v2.7.0...v2.8.0) (2026-10-13)
4
+
5
+
6
+ ### Features
7
+
8
+ * rerank: support reranking with a model ([1e57cad](https://github.com/turbopuffer/turbopuffer-ruby/commit/1e57cadcb4369d6e5eac22eac5e7bf6bba4b516b))
9
+
10
+
11
+ ### Chores
12
+
13
+ * regenerate SDK ([707ebd4](https://github.com/turbopuffer/turbopuffer-ruby/commit/707ebd46ade3bb8e2dfc29546f7117b1ae890b26))
14
+ * regenerate SDK ([5f41594](https://github.com/turbopuffer/turbopuffer-ruby/commit/5f41594877a1bf91b5c14d57f80ea56b2f1f979d))
15
+
3
16
  ## [2.7.0](https://github.com/turbopuffer/turbopuffer-ruby/compare/v2.6.0...v2.7.0) (2026-10-08)
4
17
 
5
18
 
data/README.md CHANGED
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
17
17
  <!-- x-release-please-start-version -->
18
18
 
19
19
  ```ruby
20
- gem "turbopuffer", "~> 2.7.0"
20
+ gem "turbopuffer", "~> 2.8.0"
21
21
  ```
22
22
 
23
23
  <!-- x-release-please-end -->
@@ -85,6 +85,12 @@ module Turbopuffer
85
85
  # @return [Object, nil]
86
86
  optional :rank_by, Turbopuffer::Internal::Type::Unknown
87
87
 
88
+ # @!attribute rerank_by
89
+ # Rerank retrieved candidates with a model.
90
+ #
91
+ # @return [Turbopuffer::Models::RerankModelParams, nil]
92
+ optional :rerank_by, -> { Turbopuffer::RerankModelParams }
93
+
88
94
  # @!attribute top_k
89
95
  # The number of results to return.
90
96
  #
@@ -97,7 +103,7 @@ module Turbopuffer
97
103
  # @return [Symbol, Turbopuffer::Models::VectorEncoding, nil]
98
104
  optional :vector_encoding, enum: -> { Turbopuffer::VectorEncoding }
99
105
 
100
- # @!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: {})
106
+ # @!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, rerank_by: nil, top_k: nil, vector_encoding: nil, request_options: {})
101
107
  # Some parameter documentations has been truncated, see
102
108
  # {Turbopuffer::Models::NamespaceQueryParams} for more details.
103
109
  #
@@ -125,6 +131,8 @@ module Turbopuffer
125
131
  #
126
132
  # @param rank_by [Object] How to rank the documents in the namespace.
127
133
  #
134
+ # @param rerank_by [Turbopuffer::Models::RerankModelParams] Rerank retrieved candidates with a model.
135
+ #
128
136
  # @param top_k [Integer] The number of results to return.
129
137
  #
130
138
  # @param vector_encoding [Symbol, Turbopuffer::Models::VectorEncoding] The encoding to use for vectors in the response.
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Turbopuffer
4
+ module Models
5
+ class RerankModelParams < Turbopuffer::Internal::Type::BaseModel
6
+ # @!attribute attribute
7
+ # The string attribute to score. Must be included in `include_attributes` in every
8
+ # query.
9
+ #
10
+ # @return [String]
11
+ required :attribute, String
12
+
13
+ # @!attribute model
14
+ # Which reranking model to use.
15
+ #
16
+ # @return [String]
17
+ required :model, String
18
+
19
+ # @!attribute query
20
+ # The query text to score each document against.
21
+ #
22
+ # @return [String]
23
+ required :query, String
24
+
25
+ # @!method initialize(attribute:, model:, query:)
26
+ # Some parameter documentations has been truncated, see
27
+ # {Turbopuffer::Models::RerankModelParams} for more details.
28
+ #
29
+ # Rerank retrieved candidates with a model.
30
+ #
31
+ # @param attribute [String] The string attribute to score. Must be included in `include_attributes` in every
32
+ #
33
+ # @param model [String] Which reranking model to use.
34
+ #
35
+ # @param query [String] The query text to score each document against.
36
+ end
37
+ end
38
+ end
@@ -148,6 +148,8 @@ module Turbopuffer
148
148
 
149
149
  RerankLimit = Turbopuffer::Models::RerankLimit
150
150
 
151
+ RerankModelParams = Turbopuffer::Models::RerankModelParams
152
+
151
153
  Row = Turbopuffer::Models::Row
152
154
 
153
155
  RrfParams = Turbopuffer::Models::RrfParams
@@ -271,7 +271,7 @@ module Turbopuffer
271
271
  #
272
272
  # Query, filter, full-text search and vector search documents.
273
273
  #
274
- # @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: {})
274
+ # @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, rerank_by: nil, top_k: nil, vector_encoding: nil, request_options: {})
275
275
  #
276
276
  # @param namespace [String] Path param: The name of the namespace.
277
277
  #
@@ -297,6 +297,8 @@ module Turbopuffer
297
297
  #
298
298
  # @param rank_by [Object] Body param: How to rank the documents in the namespace.
299
299
  #
300
+ # @param rerank_by [Turbopuffer::Models::RerankModelParams] Body param: Rerank retrieved candidates with a model.
301
+ #
300
302
  # @param top_k [Integer] Body param: The number of results to return.
301
303
  #
302
304
  # @param vector_encoding [Symbol, Turbopuffer::Models::VectorEncoding] Body param: The encoding to use for vectors in the response.
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Turbopuffer
4
- VERSION = "2.7.0"
4
+ VERSION = "2.8.0"
5
5
  end
data/lib/turbopuffer.rb CHANGED
@@ -120,6 +120,7 @@ require_relative "turbopuffer/models/operation_error"
120
120
  require_relative "turbopuffer/models/query_billing"
121
121
  require_relative "turbopuffer/models/query_performance"
122
122
  require_relative "turbopuffer/models/rerank_limit"
123
+ require_relative "turbopuffer/models/rerank_model_params"
123
124
  require_relative "turbopuffer/models/row"
124
125
  require_relative "turbopuffer/models/rrf_params"
125
126
  require_relative "turbopuffer/models/saturate_params"
@@ -114,6 +114,13 @@ module Turbopuffer
114
114
  sig { params(rank_by: T.anything).void }
115
115
  attr_writer :rank_by
116
116
 
117
+ # Rerank retrieved candidates with a model.
118
+ sig { returns(T.nilable(Turbopuffer::RerankModelParams)) }
119
+ attr_reader :rerank_by
120
+
121
+ sig { params(rerank_by: Turbopuffer::RerankModelParams::OrHash).void }
122
+ attr_writer :rerank_by
123
+
117
124
  # The number of results to return.
118
125
  sig { returns(T.nilable(Integer)) }
119
126
  attr_reader :top_k
@@ -144,6 +151,7 @@ module Turbopuffer
144
151
  limit: T.any(Integer, Turbopuffer::Limit::OrHash),
145
152
  offset: Integer,
146
153
  rank_by: T.anything,
154
+ rerank_by: Turbopuffer::RerankModelParams::OrHash,
147
155
  top_k: Integer,
148
156
  vector_encoding: Turbopuffer::VectorEncoding::OrSymbol,
149
157
  request_options: Turbopuffer::RequestOptions::OrHash
@@ -180,6 +188,8 @@ module Turbopuffer
180
188
  offset: nil,
181
189
  # How to rank the documents in the namespace.
182
190
  rank_by: nil,
191
+ # Rerank retrieved candidates with a model.
192
+ rerank_by: nil,
183
193
  # The number of results to return.
184
194
  top_k: nil,
185
195
  # The encoding to use for vectors in the response.
@@ -203,6 +213,7 @@ module Turbopuffer
203
213
  limit: T.any(Integer, Turbopuffer::Limit),
204
214
  offset: Integer,
205
215
  rank_by: T.anything,
216
+ rerank_by: Turbopuffer::RerankModelParams,
206
217
  top_k: Integer,
207
218
  vector_encoding: Turbopuffer::VectorEncoding::OrSymbol,
208
219
  request_options: Turbopuffer::RequestOptions
@@ -0,0 +1,48 @@
1
+ # typed: strong
2
+
3
+ module Turbopuffer
4
+ module Models
5
+ class RerankModelParams < Turbopuffer::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(Turbopuffer::RerankModelParams, Turbopuffer::Internal::AnyHash)
9
+ end
10
+
11
+ # The string attribute to score. Must be included in `include_attributes` in every
12
+ # query.
13
+ sig { returns(String) }
14
+ attr_accessor :attribute
15
+
16
+ # Which reranking model to use.
17
+ sig { returns(String) }
18
+ attr_accessor :model
19
+
20
+ # The query text to score each document against.
21
+ sig { returns(String) }
22
+ attr_accessor :query
23
+
24
+ # Rerank retrieved candidates with a model.
25
+ sig do
26
+ params(attribute: String, model: String, query: String).returns(
27
+ T.attached_class
28
+ )
29
+ end
30
+ def self.new(
31
+ # The string attribute to score. Must be included in `include_attributes` in every
32
+ # query.
33
+ attribute:,
34
+ # Which reranking model to use.
35
+ model:,
36
+ # The query text to score each document against.
37
+ query:
38
+ )
39
+ end
40
+
41
+ sig do
42
+ override.returns({ attribute: String, model: String, query: String })
43
+ end
44
+ def to_hash
45
+ end
46
+ end
47
+ end
48
+ end
@@ -119,6 +119,8 @@ module Turbopuffer
119
119
 
120
120
  RerankLimit = Turbopuffer::Models::RerankLimit
121
121
 
122
+ RerankModelParams = Turbopuffer::Models::RerankModelParams
123
+
122
124
  Row = Turbopuffer::Models::Row
123
125
 
124
126
  RrfParams = Turbopuffer::Models::RrfParams
@@ -223,6 +223,7 @@ module Turbopuffer
223
223
  limit: T.any(Integer, Turbopuffer::Limit::OrHash),
224
224
  offset: Integer,
225
225
  rank_by: T.anything,
226
+ rerank_by: Turbopuffer::RerankModelParams::OrHash,
226
227
  top_k: Integer,
227
228
  vector_encoding: Turbopuffer::VectorEncoding::OrSymbol,
228
229
  request_options: Turbopuffer::RequestOptions::OrHash
@@ -260,6 +261,8 @@ module Turbopuffer
260
261
  offset: nil,
261
262
  # Body param: How to rank the documents in the namespace.
262
263
  rank_by: nil,
264
+ # Body param: Rerank retrieved candidates with a model.
265
+ rerank_by: nil,
263
266
  # Body param: The number of results to return.
264
267
  top_k: nil,
265
268
  # Body param: The encoding to use for vectors in the response.
@@ -14,6 +14,7 @@ module Turbopuffer
14
14
  limit: Turbopuffer::Models::NamespaceQueryParams::limit,
15
15
  offset: Integer,
16
16
  rank_by: top,
17
+ rerank_by: Turbopuffer::RerankModelParams,
17
18
  top_k: Integer,
18
19
  vector_encoding: Turbopuffer::Models::vector_encoding
19
20
  }
@@ -79,6 +80,12 @@ module Turbopuffer
79
80
 
80
81
  def rank_by=: (top) -> top
81
82
 
83
+ attr_reader rerank_by: Turbopuffer::RerankModelParams?
84
+
85
+ def rerank_by=: (
86
+ Turbopuffer::RerankModelParams
87
+ ) -> Turbopuffer::RerankModelParams
88
+
82
89
  attr_reader top_k: Integer?
83
90
 
84
91
  def top_k=: (Integer) -> Integer
@@ -102,6 +109,7 @@ module Turbopuffer
102
109
  ?limit: Turbopuffer::Models::NamespaceQueryParams::limit,
103
110
  ?offset: Integer,
104
111
  ?rank_by: top,
112
+ ?rerank_by: Turbopuffer::RerankModelParams,
105
113
  ?top_k: Integer,
106
114
  ?vector_encoding: Turbopuffer::Models::vector_encoding,
107
115
  ?request_options: Turbopuffer::request_opts
@@ -120,6 +128,7 @@ module Turbopuffer
120
128
  limit: Turbopuffer::Models::NamespaceQueryParams::limit,
121
129
  offset: Integer,
122
130
  rank_by: top,
131
+ rerank_by: Turbopuffer::RerankModelParams,
123
132
  top_k: Integer,
124
133
  vector_encoding: Turbopuffer::Models::vector_encoding,
125
134
  request_options: Turbopuffer::RequestOptions
@@ -0,0 +1,18 @@
1
+ module Turbopuffer
2
+ module Models
3
+ type rerank_model_params =
4
+ { attribute: String, model: String, query: String }
5
+
6
+ class RerankModelParams < Turbopuffer::Internal::Type::BaseModel
7
+ attr_accessor attribute: String
8
+
9
+ attr_accessor model: String
10
+
11
+ attr_accessor query: String
12
+
13
+ def initialize: (attribute: String, model: String, query: String) -> void
14
+
15
+ def to_hash: -> { attribute: String, model: String, query: String }
16
+ end
17
+ end
18
+ end
@@ -107,6 +107,8 @@ module Turbopuffer
107
107
 
108
108
  class RerankLimit = Turbopuffer::Models::RerankLimit
109
109
 
110
+ class RerankModelParams = Turbopuffer::Models::RerankModelParams
111
+
110
112
  class Row = Turbopuffer::Models::Row
111
113
 
112
114
  class RrfParams = Turbopuffer::Models::RrfParams
@@ -79,6 +79,7 @@ module Turbopuffer
79
79
  ?limit: Turbopuffer::Models::NamespaceQueryParams::limit,
80
80
  ?offset: Integer,
81
81
  ?rank_by: top,
82
+ ?rerank_by: Turbopuffer::RerankModelParams,
82
83
  ?top_k: Integer,
83
84
  ?vector_encoding: Turbopuffer::Models::vector_encoding,
84
85
  ?request_options: Turbopuffer::request_opts
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: turbopuffer
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.7.0
4
+ version: 2.8.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Turbopuffer
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-10-09 00:00:00.000000000 Z
11
+ date: 2026-10-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: cgi
@@ -137,6 +137,7 @@ files:
137
137
  - lib/turbopuffer/models/query_billing.rb
138
138
  - lib/turbopuffer/models/query_performance.rb
139
139
  - lib/turbopuffer/models/rerank_limit.rb
140
+ - lib/turbopuffer/models/rerank_model_params.rb
140
141
  - lib/turbopuffer/models/row.rb
141
142
  - lib/turbopuffer/models/rrf_params.rb
142
143
  - lib/turbopuffer/models/saturate_params.rb
@@ -239,6 +240,7 @@ files:
239
240
  - rbi/turbopuffer/models/query_billing.rbi
240
241
  - rbi/turbopuffer/models/query_performance.rbi
241
242
  - rbi/turbopuffer/models/rerank_limit.rbi
243
+ - rbi/turbopuffer/models/rerank_model_params.rbi
242
244
  - rbi/turbopuffer/models/row.rbi
243
245
  - rbi/turbopuffer/models/rrf_params.rbi
244
246
  - rbi/turbopuffer/models/saturate_params.rbi
@@ -340,6 +342,7 @@ files:
340
342
  - sig/turbopuffer/models/query_billing.rbs
341
343
  - sig/turbopuffer/models/query_performance.rbs
342
344
  - sig/turbopuffer/models/rerank_limit.rbs
345
+ - sig/turbopuffer/models/rerank_model_params.rbs
343
346
  - sig/turbopuffer/models/row.rbs
344
347
  - sig/turbopuffer/models/rrf_params.rbs
345
348
  - sig/turbopuffer/models/saturate_params.rbs