openlayer 0.11.2 → 0.12.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.
@@ -17,6 +17,13 @@ module Openlayer
17
17
  sig { returns(String) }
18
18
  attr_accessor :inference_pipeline_id
19
19
 
20
+ # Whether or not to sort on the sortColumn in ascending order.
21
+ sig { returns(T.nilable(T::Boolean)) }
22
+ attr_reader :asc
23
+
24
+ sig { params(asc: T::Boolean).void }
25
+ attr_writer :asc
26
+
20
27
  # The page to return in a paginated query.
21
28
  sig { returns(T.nilable(Integer)) }
22
29
  attr_reader :page
@@ -31,20 +38,89 @@ module Openlayer
31
38
  sig { params(per_page: Integer).void }
32
39
  attr_writer :per_page
33
40
 
41
+ # Name of the column to sort on
42
+ sig { returns(T.nilable(String)) }
43
+ attr_reader :sort_column
44
+
45
+ sig { params(sort_column: String).void }
46
+ attr_writer :sort_column
47
+
48
+ sig do
49
+ returns(
50
+ T.nilable(
51
+ T::Array[
52
+ T.any(
53
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter,
54
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter,
55
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter
56
+ )
57
+ ]
58
+ )
59
+ )
60
+ end
61
+ attr_accessor :column_filters
62
+
63
+ sig { returns(T.nilable(T::Array[Integer])) }
64
+ attr_accessor :exclude_row_id_list
65
+
66
+ sig { returns(T.nilable(T::Array[String])) }
67
+ attr_accessor :not_search_query_and
68
+
69
+ sig { returns(T.nilable(T::Array[String])) }
70
+ attr_accessor :not_search_query_or
71
+
72
+ sig { returns(T.nilable(T::Array[Integer])) }
73
+ attr_accessor :row_id_list
74
+
75
+ sig { returns(T.nilable(T::Array[String])) }
76
+ attr_accessor :search_query_and
77
+
78
+ sig { returns(T.nilable(T::Array[String])) }
79
+ attr_accessor :search_query_or
80
+
34
81
  sig do
35
82
  params(
36
83
  inference_pipeline_id: String,
84
+ asc: T::Boolean,
37
85
  page: Integer,
38
86
  per_page: Integer,
87
+ sort_column: String,
88
+ column_filters:
89
+ T.nilable(
90
+ T::Array[
91
+ T.any(
92
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::OrHash,
93
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter::OrHash,
94
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter::OrHash
95
+ )
96
+ ]
97
+ ),
98
+ exclude_row_id_list: T.nilable(T::Array[Integer]),
99
+ not_search_query_and: T.nilable(T::Array[String]),
100
+ not_search_query_or: T.nilable(T::Array[String]),
101
+ row_id_list: T.nilable(T::Array[Integer]),
102
+ search_query_and: T.nilable(T::Array[String]),
103
+ search_query_or: T.nilable(T::Array[String]),
39
104
  request_options: Openlayer::RequestOptions::OrHash
40
105
  ).returns(T.attached_class)
41
106
  end
42
107
  def self.new(
43
108
  inference_pipeline_id:,
109
+ # Whether or not to sort on the sortColumn in ascending order.
110
+ asc: nil,
44
111
  # The page to return in a paginated query.
45
112
  page: nil,
46
113
  # Maximum number of items to return per page.
47
114
  per_page: nil,
115
+ # Name of the column to sort on
116
+ sort_column: nil,
117
+ column_filters: nil,
118
+ exclude_row_id_list: nil,
119
+ not_search_query_and: nil,
120
+ not_search_query_or: nil,
121
+ row_id_list: nil,
122
+ search_query_and: nil,
123
+ search_query_or: nil,
48
124
  request_options: {}
49
125
  )
50
126
  end
@@ -53,14 +129,401 @@ module Openlayer
53
129
  override.returns(
54
130
  {
55
131
  inference_pipeline_id: String,
132
+ asc: T::Boolean,
56
133
  page: Integer,
57
134
  per_page: Integer,
135
+ sort_column: String,
136
+ column_filters:
137
+ T.nilable(
138
+ T::Array[
139
+ T.any(
140
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter,
141
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter,
142
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter
143
+ )
144
+ ]
145
+ ),
146
+ exclude_row_id_list: T.nilable(T::Array[Integer]),
147
+ not_search_query_and: T.nilable(T::Array[String]),
148
+ not_search_query_or: T.nilable(T::Array[String]),
149
+ row_id_list: T.nilable(T::Array[Integer]),
150
+ search_query_and: T.nilable(T::Array[String]),
151
+ search_query_or: T.nilable(T::Array[String]),
58
152
  request_options: Openlayer::RequestOptions
59
153
  }
60
154
  )
61
155
  end
62
156
  def to_hash
63
157
  end
158
+
159
+ module ColumnFilter
160
+ extend Openlayer::Internal::Type::Union
161
+
162
+ Variants =
163
+ T.type_alias do
164
+ T.any(
165
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter,
166
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter,
167
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter
168
+ )
169
+ end
170
+
171
+ class SetColumnFilter < Openlayer::Internal::Type::BaseModel
172
+ OrHash =
173
+ T.type_alias do
174
+ T.any(
175
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter,
176
+ Openlayer::Internal::AnyHash
177
+ )
178
+ end
179
+
180
+ # The name of the column.
181
+ sig { returns(String) }
182
+ attr_accessor :measurement
183
+
184
+ sig do
185
+ returns(
186
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::Operator::OrSymbol
187
+ )
188
+ end
189
+ attr_accessor :operator
190
+
191
+ sig do
192
+ returns(
193
+ T::Array[
194
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::Value::Variants
195
+ ]
196
+ )
197
+ end
198
+ attr_accessor :value
199
+
200
+ sig do
201
+ params(
202
+ measurement: String,
203
+ operator:
204
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::Operator::OrSymbol,
205
+ value:
206
+ T::Array[
207
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::Value::Variants
208
+ ]
209
+ ).returns(T.attached_class)
210
+ end
211
+ def self.new(
212
+ # The name of the column.
213
+ measurement:,
214
+ operator:,
215
+ value:
216
+ )
217
+ end
218
+
219
+ sig do
220
+ override.returns(
221
+ {
222
+ measurement: String,
223
+ operator:
224
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::Operator::OrSymbol,
225
+ value:
226
+ T::Array[
227
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::Value::Variants
228
+ ]
229
+ }
230
+ )
231
+ end
232
+ def to_hash
233
+ end
234
+
235
+ module Operator
236
+ extend Openlayer::Internal::Type::Enum
237
+
238
+ TaggedSymbol =
239
+ T.type_alias do
240
+ T.all(
241
+ Symbol,
242
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::Operator
243
+ )
244
+ end
245
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
246
+
247
+ CONTAINS_NONE =
248
+ T.let(
249
+ :contains_none,
250
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::Operator::TaggedSymbol
251
+ )
252
+ CONTAINS_ANY =
253
+ T.let(
254
+ :contains_any,
255
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::Operator::TaggedSymbol
256
+ )
257
+ CONTAINS_ALL =
258
+ T.let(
259
+ :contains_all,
260
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::Operator::TaggedSymbol
261
+ )
262
+ ONE_OF =
263
+ T.let(
264
+ :one_of,
265
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::Operator::TaggedSymbol
266
+ )
267
+ NONE_OF =
268
+ T.let(
269
+ :none_of,
270
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::Operator::TaggedSymbol
271
+ )
272
+
273
+ sig do
274
+ override.returns(
275
+ T::Array[
276
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::Operator::TaggedSymbol
277
+ ]
278
+ )
279
+ end
280
+ def self.values
281
+ end
282
+ end
283
+
284
+ module Value
285
+ extend Openlayer::Internal::Type::Union
286
+
287
+ Variants = T.type_alias { T.any(String, Float) }
288
+
289
+ sig do
290
+ override.returns(
291
+ T::Array[
292
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::Value::Variants
293
+ ]
294
+ )
295
+ end
296
+ def self.variants
297
+ end
298
+ end
299
+ end
300
+
301
+ class NumericColumnFilter < Openlayer::Internal::Type::BaseModel
302
+ OrHash =
303
+ T.type_alias do
304
+ T.any(
305
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter,
306
+ Openlayer::Internal::AnyHash
307
+ )
308
+ end
309
+
310
+ # The name of the column.
311
+ sig { returns(String) }
312
+ attr_accessor :measurement
313
+
314
+ sig do
315
+ returns(
316
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter::Operator::OrSymbol
317
+ )
318
+ end
319
+ attr_accessor :operator
320
+
321
+ sig { returns(T.nilable(Float)) }
322
+ attr_accessor :value
323
+
324
+ sig do
325
+ params(
326
+ measurement: String,
327
+ operator:
328
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter::Operator::OrSymbol,
329
+ value: T.nilable(Float)
330
+ ).returns(T.attached_class)
331
+ end
332
+ def self.new(
333
+ # The name of the column.
334
+ measurement:,
335
+ operator:,
336
+ value:
337
+ )
338
+ end
339
+
340
+ sig do
341
+ override.returns(
342
+ {
343
+ measurement: String,
344
+ operator:
345
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter::Operator::OrSymbol,
346
+ value: T.nilable(Float)
347
+ }
348
+ )
349
+ end
350
+ def to_hash
351
+ end
352
+
353
+ module Operator
354
+ extend Openlayer::Internal::Type::Enum
355
+
356
+ TaggedSymbol =
357
+ T.type_alias do
358
+ T.all(
359
+ Symbol,
360
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter::Operator
361
+ )
362
+ end
363
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
364
+
365
+ GREATER =
366
+ T.let(
367
+ :">",
368
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter::Operator::TaggedSymbol
369
+ )
370
+ GREATER_OR_EQUALS =
371
+ T.let(
372
+ :">=",
373
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter::Operator::TaggedSymbol
374
+ )
375
+ IS =
376
+ T.let(
377
+ :is,
378
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter::Operator::TaggedSymbol
379
+ )
380
+ LESS =
381
+ T.let(
382
+ :"<",
383
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter::Operator::TaggedSymbol
384
+ )
385
+ LESS_OR_EQUALS =
386
+ T.let(
387
+ :"<=",
388
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter::Operator::TaggedSymbol
389
+ )
390
+ NOT_EQUALS =
391
+ T.let(
392
+ :"!=",
393
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter::Operator::TaggedSymbol
394
+ )
395
+
396
+ sig do
397
+ override.returns(
398
+ T::Array[
399
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter::Operator::TaggedSymbol
400
+ ]
401
+ )
402
+ end
403
+ def self.values
404
+ end
405
+ end
406
+ end
407
+
408
+ class StringColumnFilter < Openlayer::Internal::Type::BaseModel
409
+ OrHash =
410
+ T.type_alias do
411
+ T.any(
412
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter,
413
+ Openlayer::Internal::AnyHash
414
+ )
415
+ end
416
+
417
+ # The name of the column.
418
+ sig { returns(String) }
419
+ attr_accessor :measurement
420
+
421
+ sig do
422
+ returns(
423
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter::Operator::OrSymbol
424
+ )
425
+ end
426
+ attr_accessor :operator
427
+
428
+ sig do
429
+ returns(
430
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter::Value::Variants
431
+ )
432
+ end
433
+ attr_accessor :value
434
+
435
+ sig do
436
+ params(
437
+ measurement: String,
438
+ operator:
439
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter::Operator::OrSymbol,
440
+ value:
441
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter::Value::Variants
442
+ ).returns(T.attached_class)
443
+ end
444
+ def self.new(
445
+ # The name of the column.
446
+ measurement:,
447
+ operator:,
448
+ value:
449
+ )
450
+ end
451
+
452
+ sig do
453
+ override.returns(
454
+ {
455
+ measurement: String,
456
+ operator:
457
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter::Operator::OrSymbol,
458
+ value:
459
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter::Value::Variants
460
+ }
461
+ )
462
+ end
463
+ def to_hash
464
+ end
465
+
466
+ module Operator
467
+ extend Openlayer::Internal::Type::Enum
468
+
469
+ TaggedSymbol =
470
+ T.type_alias do
471
+ T.all(
472
+ Symbol,
473
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter::Operator
474
+ )
475
+ end
476
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
477
+
478
+ IS =
479
+ T.let(
480
+ :is,
481
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter::Operator::TaggedSymbol
482
+ )
483
+ NOT_EQUALS =
484
+ T.let(
485
+ :"!=",
486
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter::Operator::TaggedSymbol
487
+ )
488
+
489
+ sig do
490
+ override.returns(
491
+ T::Array[
492
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter::Operator::TaggedSymbol
493
+ ]
494
+ )
495
+ end
496
+ def self.values
497
+ end
498
+ end
499
+
500
+ module Value
501
+ extend Openlayer::Internal::Type::Union
502
+
503
+ Variants = T.type_alias { T.any(String, T::Boolean) }
504
+
505
+ sig do
506
+ override.returns(
507
+ T::Array[
508
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter::Value::Variants
509
+ ]
510
+ )
511
+ end
512
+ def self.variants
513
+ end
514
+ end
515
+ end
516
+
517
+ sig do
518
+ override.returns(
519
+ T::Array[
520
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::Variants
521
+ ]
522
+ )
523
+ end
524
+ def self.variants
525
+ end
526
+ end
64
527
  end
65
528
  end
66
529
  end
@@ -11,6 +11,9 @@ module Openlayer
11
11
  InferencePipelineRetrieveParams =
12
12
  Openlayer::Models::InferencePipelineRetrieveParams
13
13
 
14
+ InferencePipelineRetrieveSessionsParams =
15
+ Openlayer::Models::InferencePipelineRetrieveSessionsParams
16
+
14
17
  InferencePipelineRetrieveUsersParams =
15
18
  Openlayer::Models::InferencePipelineRetrieveUsersParams
16
19
 
@@ -70,6 +70,67 @@ module Openlayer
70
70
  )
71
71
  end
72
72
 
73
+ # Get aggregated session data for an inference pipeline with pagination and
74
+ # metadata.
75
+ #
76
+ # Returns a list of sessions for the inference pipeline, including activity
77
+ # statistics such as record counts, token usage, cost, latency, and the first and
78
+ # last records.
79
+ sig do
80
+ params(
81
+ inference_pipeline_id: String,
82
+ asc: T::Boolean,
83
+ page: Integer,
84
+ per_page: Integer,
85
+ sort_column: String,
86
+ column_filters:
87
+ T.nilable(
88
+ T::Array[
89
+ T.any(
90
+ Openlayer::InferencePipelineRetrieveSessionsParams::ColumnFilter::SetColumnFilter::OrHash,
91
+ Openlayer::InferencePipelineRetrieveSessionsParams::ColumnFilter::NumericColumnFilter::OrHash,
92
+ Openlayer::InferencePipelineRetrieveSessionsParams::ColumnFilter::StringColumnFilter::OrHash
93
+ )
94
+ ]
95
+ ),
96
+ exclude_row_id_list: T.nilable(T::Array[Integer]),
97
+ not_search_query_and: T.nilable(T::Array[String]),
98
+ not_search_query_or: T.nilable(T::Array[String]),
99
+ row_id_list: T.nilable(T::Array[Integer]),
100
+ search_query_and: T.nilable(T::Array[String]),
101
+ search_query_or: T.nilable(T::Array[String]),
102
+ request_options: Openlayer::RequestOptions::OrHash
103
+ ).returns(Openlayer::Models::InferencePipelineRetrieveSessionsResponse)
104
+ end
105
+ def retrieve_sessions(
106
+ # Path param: The inference pipeline id (a UUID).
107
+ inference_pipeline_id,
108
+ # Query param: Whether or not to sort on the sortColumn in ascending order.
109
+ asc: nil,
110
+ # Query param: The page to return in a paginated query.
111
+ page: nil,
112
+ # Query param: Maximum number of items to return per page.
113
+ per_page: nil,
114
+ # Query param: Name of the column to sort on
115
+ sort_column: nil,
116
+ # Body param
117
+ column_filters: nil,
118
+ # Body param
119
+ exclude_row_id_list: nil,
120
+ # Body param
121
+ not_search_query_and: nil,
122
+ # Body param
123
+ not_search_query_or: nil,
124
+ # Body param
125
+ row_id_list: nil,
126
+ # Body param
127
+ search_query_and: nil,
128
+ # Body param
129
+ search_query_or: nil,
130
+ request_options: {}
131
+ )
132
+ end
133
+
73
134
  # Get aggregated user data for an inference pipeline with pagination and metadata.
74
135
  #
75
136
  # Returns a list of users who have interacted with the inference pipeline,
@@ -78,18 +139,54 @@ module Openlayer
78
139
  sig do
79
140
  params(
80
141
  inference_pipeline_id: String,
142
+ asc: T::Boolean,
81
143
  page: Integer,
82
144
  per_page: Integer,
145
+ sort_column: String,
146
+ column_filters:
147
+ T.nilable(
148
+ T::Array[
149
+ T.any(
150
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::OrHash,
151
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter::OrHash,
152
+ Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter::OrHash
153
+ )
154
+ ]
155
+ ),
156
+ exclude_row_id_list: T.nilable(T::Array[Integer]),
157
+ not_search_query_and: T.nilable(T::Array[String]),
158
+ not_search_query_or: T.nilable(T::Array[String]),
159
+ row_id_list: T.nilable(T::Array[Integer]),
160
+ search_query_and: T.nilable(T::Array[String]),
161
+ search_query_or: T.nilable(T::Array[String]),
83
162
  request_options: Openlayer::RequestOptions::OrHash
84
163
  ).returns(Openlayer::Models::InferencePipelineRetrieveUsersResponse)
85
164
  end
86
165
  def retrieve_users(
87
- # The inference pipeline id (a UUID).
166
+ # Path param: The inference pipeline id (a UUID).
88
167
  inference_pipeline_id,
89
- # The page to return in a paginated query.
168
+ # Query param: Whether or not to sort on the sortColumn in ascending order.
169
+ asc: nil,
170
+ # Query param: The page to return in a paginated query.
90
171
  page: nil,
91
- # Maximum number of items to return per page.
172
+ # Query param: Maximum number of items to return per page.
92
173
  per_page: nil,
174
+ # Query param: Name of the column to sort on
175
+ sort_column: nil,
176
+ # Body param
177
+ column_filters: nil,
178
+ # Body param
179
+ exclude_row_id_list: nil,
180
+ # Body param
181
+ not_search_query_and: nil,
182
+ # Body param
183
+ not_search_query_or: nil,
184
+ # Body param
185
+ row_id_list: nil,
186
+ # Body param
187
+ search_query_and: nil,
188
+ # Body param
189
+ search_query_or: nil,
93
190
  request_options: {}
94
191
  )
95
192
  end