turbopuffer 2.6.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 +4 -4
- data/CHANGELOG.md +26 -0
- data/README.md +1 -1
- data/lib/turbopuffer/models/namespace_metadata.rb +9 -1
- data/lib/turbopuffer/models/namespace_query_params.rb +9 -1
- data/lib/turbopuffer/models/query_performance.rb +18 -1
- data/lib/turbopuffer/models/rerank_model_params.rb +38 -0
- data/lib/turbopuffer/models/write_performance.rb +21 -1
- data/lib/turbopuffer/models.rb +2 -0
- data/lib/turbopuffer/resources/namespaces.rb +3 -1
- data/lib/turbopuffer/version.rb +1 -1
- data/lib/turbopuffer.rb +1 -0
- data/rbi/turbopuffer/models/namespace_metadata.rbi +20 -4
- data/rbi/turbopuffer/models/namespace_query_params.rbi +11 -0
- data/rbi/turbopuffer/models/query_performance.rbi +27 -3
- data/rbi/turbopuffer/models/rerank_model_params.rbi +48 -0
- data/rbi/turbopuffer/models/write_performance.rbi +37 -3
- data/rbi/turbopuffer/models.rbi +2 -0
- data/rbi/turbopuffer/resources/namespaces.rbi +3 -0
- data/sig/turbopuffer/models/namespace_metadata.rbs +18 -3
- data/sig/turbopuffer/models/namespace_query_params.rbs +9 -0
- data/sig/turbopuffer/models/query_performance.rbs +17 -3
- data/sig/turbopuffer/models/rerank_model_params.rbs +18 -0
- data/sig/turbopuffer/models/write_performance.rbs +24 -3
- data/sig/turbopuffer/models.rbs +2 -0
- data/sig/turbopuffer/resources/namespaces.rbs +1 -0
- metadata +5 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a9ea10142f4e8c684cf18f5657f30b47bfa9f6e3abdae0473e720ac63ac82e7a
|
|
4
|
+
data.tar.gz: cb8e5b3806055824b02f4d135c6687c93a9b9f4cc22f239c1dc03c5e22782b04
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 04f840dc0dd750b28b63a46e1b363abb277508d3a25dbc216d5095fd89a408b2093b944a7421f044bab242b2457298ccfe5471c9ea42df2975a5b7b310ad9856
|
|
7
|
+
data.tar.gz: b8b809ed55838462235995bb2ab0f7e20aafdf96273e3dfff1e71086bc777bbe0d5d5583c1e6e858b97bc3f064b4d1682c60cc48cbe28232436c5d8598659c0b
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,31 @@
|
|
|
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
|
+
|
|
16
|
+
## [2.7.0](https://github.com/turbopuffer/turbopuffer-ruby/compare/v2.6.0...v2.7.0) (2026-10-08)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Features
|
|
20
|
+
|
|
21
|
+
* embedding: openapi embedding stats ([8e507b4](https://github.com/turbopuffer/turbopuffer-ruby/commit/8e507b4be4c36b6a451e4ae1caee59d477fcc494))
|
|
22
|
+
* metadata: expose unindexed_rows in index status ([d9fe3b0](https://github.com/turbopuffer/turbopuffer-ruby/commit/d9fe3b065aff2fb578c7f950cce4c2664037b0a5))
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
### Chores
|
|
26
|
+
|
|
27
|
+
* regenerate SDK ([b6678e9](https://github.com/turbopuffer/turbopuffer-ruby/commit/b6678e9fd9a33f4545541da85e7578d377154801))
|
|
28
|
+
|
|
3
29
|
## [2.6.0](https://github.com/turbopuffer/turbopuffer-ruby/compare/v2.5.0...v2.6.0) (2026-10-07)
|
|
4
30
|
|
|
5
31
|
|
data/README.md
CHANGED
|
@@ -124,12 +124,20 @@ module Turbopuffer
|
|
|
124
124
|
# @return [Integer]
|
|
125
125
|
required :unindexed_bytes, Integer
|
|
126
126
|
|
|
127
|
-
# @!
|
|
127
|
+
# @!attribute unindexed_rows
|
|
128
|
+
# The number of rows in the write-ahead log that have not yet been indexed.
|
|
129
|
+
#
|
|
130
|
+
# @return [Integer]
|
|
131
|
+
required :unindexed_rows, Integer
|
|
132
|
+
|
|
133
|
+
# @!method initialize(unindexed_bytes:, unindexed_rows:, status: :updating)
|
|
128
134
|
# Some parameter documentations has been truncated, see
|
|
129
135
|
# {Turbopuffer::Models::NamespaceMetadata::Index::IndexUpdating} for more details.
|
|
130
136
|
#
|
|
131
137
|
# @param unindexed_bytes [Integer] The number of bytes in the namespace that are in the write-ahead log but have no
|
|
132
138
|
#
|
|
139
|
+
# @param unindexed_rows [Integer] The number of rows in the write-ahead log that have not yet been indexed.
|
|
140
|
+
#
|
|
133
141
|
# @param status [Symbol, :updating]
|
|
134
142
|
end
|
|
135
143
|
|
|
@@ -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.
|
|
@@ -41,7 +41,20 @@ module Turbopuffer
|
|
|
41
41
|
# @return [Integer]
|
|
42
42
|
required :server_total_ms, Integer
|
|
43
43
|
|
|
44
|
-
# @!
|
|
44
|
+
# @!attribute embedding_ms
|
|
45
|
+
# Time spent embedding text, in milliseconds. Only set when using a native
|
|
46
|
+
# embedding model.
|
|
47
|
+
#
|
|
48
|
+
# @return [Integer, nil]
|
|
49
|
+
optional :embedding_ms, Integer
|
|
50
|
+
|
|
51
|
+
# @!attribute embedding_tokens
|
|
52
|
+
# The number of tokens embedded. Only set when using a native embedding model.
|
|
53
|
+
#
|
|
54
|
+
# @return [Integer, nil]
|
|
55
|
+
optional :embedding_tokens, Integer
|
|
56
|
+
|
|
57
|
+
# @!method initialize(approx_namespace_size:, cache_hit_ratio:, cache_temperature:, exhaustive_search_count:, query_execution_ms:, server_total_ms:, embedding_ms: nil, embedding_tokens: nil)
|
|
45
58
|
# Some parameter documentations has been truncated, see
|
|
46
59
|
# {Turbopuffer::Models::QueryPerformance} for more details.
|
|
47
60
|
#
|
|
@@ -58,6 +71,10 @@ module Turbopuffer
|
|
|
58
71
|
# @param query_execution_ms [Integer] Request time measured on the server, excluding time spent waiting due to the nam
|
|
59
72
|
#
|
|
60
73
|
# @param server_total_ms [Integer] Request time measured on the server, including time spent waiting for other quer
|
|
74
|
+
#
|
|
75
|
+
# @param embedding_ms [Integer] Time spent embedding text, in milliseconds. Only set when using a native embeddi
|
|
76
|
+
#
|
|
77
|
+
# @param embedding_tokens [Integer] The number of tokens embedded. Only set when using a native embedding model.
|
|
61
78
|
end
|
|
62
79
|
end
|
|
63
80
|
end
|
|
@@ -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
|
|
@@ -9,10 +9,30 @@ module Turbopuffer
|
|
|
9
9
|
# @return [Integer]
|
|
10
10
|
required :server_total_ms, Integer
|
|
11
11
|
|
|
12
|
-
# @!
|
|
12
|
+
# @!attribute embedding_ms
|
|
13
|
+
# Time spent embedding text, in milliseconds. Only set when using a native
|
|
14
|
+
# embedding model.
|
|
15
|
+
#
|
|
16
|
+
# @return [Integer, nil]
|
|
17
|
+
optional :embedding_ms, Integer
|
|
18
|
+
|
|
19
|
+
# @!attribute embedding_tokens
|
|
20
|
+
# The number of tokens embedded. Only set when using a native embedding model.
|
|
21
|
+
#
|
|
22
|
+
# @return [Integer, nil]
|
|
23
|
+
optional :embedding_tokens, Integer
|
|
24
|
+
|
|
25
|
+
# @!method initialize(server_total_ms:, embedding_ms: nil, embedding_tokens: nil)
|
|
26
|
+
# Some parameter documentations has been truncated, see
|
|
27
|
+
# {Turbopuffer::Models::WritePerformance} for more details.
|
|
28
|
+
#
|
|
13
29
|
# The performance information for a write request.
|
|
14
30
|
#
|
|
15
31
|
# @param server_total_ms [Integer] Request time measured on the server, in milliseconds.
|
|
32
|
+
#
|
|
33
|
+
# @param embedding_ms [Integer] Time spent embedding text, in milliseconds. Only set when using a native embeddi
|
|
34
|
+
#
|
|
35
|
+
# @param embedding_tokens [Integer] The number of tokens embedded. Only set when using a native embedding model.
|
|
16
36
|
end
|
|
17
37
|
end
|
|
18
38
|
end
|
data/lib/turbopuffer/models.rb
CHANGED
|
@@ -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.
|
data/lib/turbopuffer/version.rb
CHANGED
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"
|
|
@@ -180,20 +180,36 @@ module Turbopuffer
|
|
|
180
180
|
sig { returns(Integer) }
|
|
181
181
|
attr_accessor :unindexed_bytes
|
|
182
182
|
|
|
183
|
+
# The number of rows in the write-ahead log that have not yet been indexed.
|
|
184
|
+
sig { returns(Integer) }
|
|
185
|
+
attr_accessor :unindexed_rows
|
|
186
|
+
|
|
183
187
|
sig do
|
|
184
|
-
params(
|
|
185
|
-
|
|
186
|
-
|
|
188
|
+
params(
|
|
189
|
+
unindexed_bytes: Integer,
|
|
190
|
+
unindexed_rows: Integer,
|
|
191
|
+
status: Symbol
|
|
192
|
+
).returns(T.attached_class)
|
|
187
193
|
end
|
|
188
194
|
def self.new(
|
|
189
195
|
# The number of bytes in the namespace that are in the write-ahead log but have
|
|
190
196
|
# not yet been indexed.
|
|
191
197
|
unindexed_bytes:,
|
|
198
|
+
# The number of rows in the write-ahead log that have not yet been indexed.
|
|
199
|
+
unindexed_rows:,
|
|
192
200
|
status: :updating
|
|
193
201
|
)
|
|
194
202
|
end
|
|
195
203
|
|
|
196
|
-
sig
|
|
204
|
+
sig do
|
|
205
|
+
override.returns(
|
|
206
|
+
{
|
|
207
|
+
status: Symbol,
|
|
208
|
+
unindexed_bytes: Integer,
|
|
209
|
+
unindexed_rows: Integer
|
|
210
|
+
}
|
|
211
|
+
)
|
|
212
|
+
end
|
|
197
213
|
def to_hash
|
|
198
214
|
end
|
|
199
215
|
end
|
|
@@ -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
|
|
@@ -34,6 +34,21 @@ module Turbopuffer
|
|
|
34
34
|
sig { returns(Integer) }
|
|
35
35
|
attr_accessor :server_total_ms
|
|
36
36
|
|
|
37
|
+
# Time spent embedding text, in milliseconds. Only set when using a native
|
|
38
|
+
# embedding model.
|
|
39
|
+
sig { returns(T.nilable(Integer)) }
|
|
40
|
+
attr_reader :embedding_ms
|
|
41
|
+
|
|
42
|
+
sig { params(embedding_ms: Integer).void }
|
|
43
|
+
attr_writer :embedding_ms
|
|
44
|
+
|
|
45
|
+
# The number of tokens embedded. Only set when using a native embedding model.
|
|
46
|
+
sig { returns(T.nilable(Integer)) }
|
|
47
|
+
attr_reader :embedding_tokens
|
|
48
|
+
|
|
49
|
+
sig { params(embedding_tokens: Integer).void }
|
|
50
|
+
attr_writer :embedding_tokens
|
|
51
|
+
|
|
37
52
|
# The performance information for a query.
|
|
38
53
|
sig do
|
|
39
54
|
params(
|
|
@@ -42,7 +57,9 @@ module Turbopuffer
|
|
|
42
57
|
cache_temperature: String,
|
|
43
58
|
exhaustive_search_count: Integer,
|
|
44
59
|
query_execution_ms: Integer,
|
|
45
|
-
server_total_ms: Integer
|
|
60
|
+
server_total_ms: Integer,
|
|
61
|
+
embedding_ms: Integer,
|
|
62
|
+
embedding_tokens: Integer
|
|
46
63
|
).returns(T.attached_class)
|
|
47
64
|
end
|
|
48
65
|
def self.new(
|
|
@@ -59,7 +76,12 @@ module Turbopuffer
|
|
|
59
76
|
query_execution_ms:,
|
|
60
77
|
# Request time measured on the server, including time spent waiting for other
|
|
61
78
|
# queries to complete if the namespace was at its concurrency limit.
|
|
62
|
-
server_total_ms
|
|
79
|
+
server_total_ms:,
|
|
80
|
+
# Time spent embedding text, in milliseconds. Only set when using a native
|
|
81
|
+
# embedding model.
|
|
82
|
+
embedding_ms: nil,
|
|
83
|
+
# The number of tokens embedded. Only set when using a native embedding model.
|
|
84
|
+
embedding_tokens: nil
|
|
63
85
|
)
|
|
64
86
|
end
|
|
65
87
|
|
|
@@ -71,7 +93,9 @@ module Turbopuffer
|
|
|
71
93
|
cache_temperature: String,
|
|
72
94
|
exhaustive_search_count: Integer,
|
|
73
95
|
query_execution_ms: Integer,
|
|
74
|
-
server_total_ms: Integer
|
|
96
|
+
server_total_ms: Integer,
|
|
97
|
+
embedding_ms: Integer,
|
|
98
|
+
embedding_tokens: Integer
|
|
75
99
|
}
|
|
76
100
|
)
|
|
77
101
|
end
|
|
@@ -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
|
|
@@ -12,15 +12,49 @@ module Turbopuffer
|
|
|
12
12
|
sig { returns(Integer) }
|
|
13
13
|
attr_accessor :server_total_ms
|
|
14
14
|
|
|
15
|
+
# Time spent embedding text, in milliseconds. Only set when using a native
|
|
16
|
+
# embedding model.
|
|
17
|
+
sig { returns(T.nilable(Integer)) }
|
|
18
|
+
attr_reader :embedding_ms
|
|
19
|
+
|
|
20
|
+
sig { params(embedding_ms: Integer).void }
|
|
21
|
+
attr_writer :embedding_ms
|
|
22
|
+
|
|
23
|
+
# The number of tokens embedded. Only set when using a native embedding model.
|
|
24
|
+
sig { returns(T.nilable(Integer)) }
|
|
25
|
+
attr_reader :embedding_tokens
|
|
26
|
+
|
|
27
|
+
sig { params(embedding_tokens: Integer).void }
|
|
28
|
+
attr_writer :embedding_tokens
|
|
29
|
+
|
|
15
30
|
# The performance information for a write request.
|
|
16
|
-
sig
|
|
31
|
+
sig do
|
|
32
|
+
params(
|
|
33
|
+
server_total_ms: Integer,
|
|
34
|
+
embedding_ms: Integer,
|
|
35
|
+
embedding_tokens: Integer
|
|
36
|
+
).returns(T.attached_class)
|
|
37
|
+
end
|
|
17
38
|
def self.new(
|
|
18
39
|
# Request time measured on the server, in milliseconds.
|
|
19
|
-
server_total_ms
|
|
40
|
+
server_total_ms:,
|
|
41
|
+
# Time spent embedding text, in milliseconds. Only set when using a native
|
|
42
|
+
# embedding model.
|
|
43
|
+
embedding_ms: nil,
|
|
44
|
+
# The number of tokens embedded. Only set when using a native embedding model.
|
|
45
|
+
embedding_tokens: nil
|
|
20
46
|
)
|
|
21
47
|
end
|
|
22
48
|
|
|
23
|
-
sig
|
|
49
|
+
sig do
|
|
50
|
+
override.returns(
|
|
51
|
+
{
|
|
52
|
+
server_total_ms: Integer,
|
|
53
|
+
embedding_ms: Integer,
|
|
54
|
+
embedding_tokens: Integer
|
|
55
|
+
}
|
|
56
|
+
)
|
|
57
|
+
end
|
|
24
58
|
def to_hash
|
|
25
59
|
end
|
|
26
60
|
end
|
data/rbi/turbopuffer/models.rbi
CHANGED
|
@@ -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.
|
|
@@ -88,16 +88,31 @@ module Turbopuffer
|
|
|
88
88
|
def to_hash: -> { status: :"up-to-date" }
|
|
89
89
|
end
|
|
90
90
|
|
|
91
|
-
type index_updating =
|
|
91
|
+
type index_updating =
|
|
92
|
+
{
|
|
93
|
+
status: :updating,
|
|
94
|
+
unindexed_bytes: Integer,
|
|
95
|
+
unindexed_rows: Integer
|
|
96
|
+
}
|
|
92
97
|
|
|
93
98
|
class IndexUpdating < Turbopuffer::Internal::Type::BaseModel
|
|
94
99
|
attr_accessor status: :updating
|
|
95
100
|
|
|
96
101
|
attr_accessor unindexed_bytes: Integer
|
|
97
102
|
|
|
98
|
-
|
|
103
|
+
attr_accessor unindexed_rows: Integer
|
|
99
104
|
|
|
100
|
-
def
|
|
105
|
+
def initialize: (
|
|
106
|
+
unindexed_bytes: Integer,
|
|
107
|
+
unindexed_rows: Integer,
|
|
108
|
+
?status: :updating
|
|
109
|
+
) -> void
|
|
110
|
+
|
|
111
|
+
def to_hash: -> {
|
|
112
|
+
status: :updating,
|
|
113
|
+
unindexed_bytes: Integer,
|
|
114
|
+
unindexed_rows: Integer
|
|
115
|
+
}
|
|
101
116
|
end
|
|
102
117
|
|
|
103
118
|
def self?.variants: -> ::Array[Turbopuffer::Models::NamespaceMetadata::index]
|
|
@@ -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
|
|
@@ -7,7 +7,9 @@ module Turbopuffer
|
|
|
7
7
|
cache_temperature: String,
|
|
8
8
|
exhaustive_search_count: Integer,
|
|
9
9
|
query_execution_ms: Integer,
|
|
10
|
-
server_total_ms: Integer
|
|
10
|
+
server_total_ms: Integer,
|
|
11
|
+
embedding_ms: Integer,
|
|
12
|
+
embedding_tokens: Integer
|
|
11
13
|
}
|
|
12
14
|
|
|
13
15
|
class QueryPerformance < Turbopuffer::Internal::Type::BaseModel
|
|
@@ -23,13 +25,23 @@ module Turbopuffer
|
|
|
23
25
|
|
|
24
26
|
attr_accessor server_total_ms: Integer
|
|
25
27
|
|
|
28
|
+
attr_reader embedding_ms: Integer?
|
|
29
|
+
|
|
30
|
+
def embedding_ms=: (Integer) -> Integer
|
|
31
|
+
|
|
32
|
+
attr_reader embedding_tokens: Integer?
|
|
33
|
+
|
|
34
|
+
def embedding_tokens=: (Integer) -> Integer
|
|
35
|
+
|
|
26
36
|
def initialize: (
|
|
27
37
|
approx_namespace_size: Integer,
|
|
28
38
|
cache_hit_ratio: Float,
|
|
29
39
|
cache_temperature: String,
|
|
30
40
|
exhaustive_search_count: Integer,
|
|
31
41
|
query_execution_ms: Integer,
|
|
32
|
-
server_total_ms: Integer
|
|
42
|
+
server_total_ms: Integer,
|
|
43
|
+
?embedding_ms: Integer,
|
|
44
|
+
?embedding_tokens: Integer
|
|
33
45
|
) -> void
|
|
34
46
|
|
|
35
47
|
def to_hash: -> {
|
|
@@ -38,7 +50,9 @@ module Turbopuffer
|
|
|
38
50
|
cache_temperature: String,
|
|
39
51
|
exhaustive_search_count: Integer,
|
|
40
52
|
query_execution_ms: Integer,
|
|
41
|
-
server_total_ms: Integer
|
|
53
|
+
server_total_ms: Integer,
|
|
54
|
+
embedding_ms: Integer,
|
|
55
|
+
embedding_tokens: Integer
|
|
42
56
|
}
|
|
43
57
|
end
|
|
44
58
|
end
|
|
@@ -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
|
|
@@ -1,13 +1,34 @@
|
|
|
1
1
|
module Turbopuffer
|
|
2
2
|
module Models
|
|
3
|
-
type write_performance =
|
|
3
|
+
type write_performance =
|
|
4
|
+
{
|
|
5
|
+
server_total_ms: Integer,
|
|
6
|
+
embedding_ms: Integer,
|
|
7
|
+
embedding_tokens: Integer
|
|
8
|
+
}
|
|
4
9
|
|
|
5
10
|
class WritePerformance < Turbopuffer::Internal::Type::BaseModel
|
|
6
11
|
attr_accessor server_total_ms: Integer
|
|
7
12
|
|
|
8
|
-
|
|
13
|
+
attr_reader embedding_ms: Integer?
|
|
9
14
|
|
|
10
|
-
def
|
|
15
|
+
def embedding_ms=: (Integer) -> Integer
|
|
16
|
+
|
|
17
|
+
attr_reader embedding_tokens: Integer?
|
|
18
|
+
|
|
19
|
+
def embedding_tokens=: (Integer) -> Integer
|
|
20
|
+
|
|
21
|
+
def initialize: (
|
|
22
|
+
server_total_ms: Integer,
|
|
23
|
+
?embedding_ms: Integer,
|
|
24
|
+
?embedding_tokens: Integer
|
|
25
|
+
) -> void
|
|
26
|
+
|
|
27
|
+
def to_hash: -> {
|
|
28
|
+
server_total_ms: Integer,
|
|
29
|
+
embedding_ms: Integer,
|
|
30
|
+
embedding_tokens: Integer
|
|
31
|
+
}
|
|
11
32
|
end
|
|
12
33
|
end
|
|
13
34
|
end
|
data/sig/turbopuffer/models.rbs
CHANGED
|
@@ -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.
|
|
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-
|
|
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
|