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.
@@ -12,6 +12,12 @@ module Openlayer
12
12
  # @return [String]
13
13
  required :inference_pipeline_id, String
14
14
 
15
+ # @!attribute asc
16
+ # Whether or not to sort on the sortColumn in ascending order.
17
+ #
18
+ # @return [Boolean, nil]
19
+ optional :asc, Openlayer::Internal::Type::Boolean
20
+
15
21
  # @!attribute page
16
22
  # The page to return in a paginated query.
17
23
  #
@@ -24,14 +30,249 @@ module Openlayer
24
30
  # @return [Integer, nil]
25
31
  optional :per_page, Integer
26
32
 
27
- # @!method initialize(inference_pipeline_id:, page: nil, per_page: nil, request_options: {})
33
+ # @!attribute sort_column
34
+ # Name of the column to sort on
35
+ #
36
+ # @return [String, nil]
37
+ optional :sort_column, String
38
+
39
+ # @!attribute column_filters
40
+ #
41
+ # @return [Array<Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter, Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter, Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter>, nil]
42
+ optional :column_filters,
43
+ -> {
44
+ Openlayer::Internal::Type::ArrayOf[union: Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter]
45
+ },
46
+ api_name: :columnFilters,
47
+ nil?: true
48
+
49
+ # @!attribute exclude_row_id_list
50
+ #
51
+ # @return [Array<Integer>, nil]
52
+ optional :exclude_row_id_list,
53
+ Openlayer::Internal::Type::ArrayOf[Integer],
54
+ api_name: :excludeRowIdList,
55
+ nil?: true
56
+
57
+ # @!attribute not_search_query_and
58
+ #
59
+ # @return [Array<String>, nil]
60
+ optional :not_search_query_and,
61
+ Openlayer::Internal::Type::ArrayOf[String],
62
+ api_name: :notSearchQueryAnd,
63
+ nil?: true
64
+
65
+ # @!attribute not_search_query_or
66
+ #
67
+ # @return [Array<String>, nil]
68
+ optional :not_search_query_or,
69
+ Openlayer::Internal::Type::ArrayOf[String],
70
+ api_name: :notSearchQueryOr,
71
+ nil?: true
72
+
73
+ # @!attribute row_id_list
74
+ #
75
+ # @return [Array<Integer>, nil]
76
+ optional :row_id_list, Openlayer::Internal::Type::ArrayOf[Integer], api_name: :rowIdList, nil?: true
77
+
78
+ # @!attribute search_query_and
79
+ #
80
+ # @return [Array<String>, nil]
81
+ optional :search_query_and,
82
+ Openlayer::Internal::Type::ArrayOf[String],
83
+ api_name: :searchQueryAnd,
84
+ nil?: true
85
+
86
+ # @!attribute search_query_or
87
+ #
88
+ # @return [Array<String>, nil]
89
+ optional :search_query_or,
90
+ Openlayer::Internal::Type::ArrayOf[String],
91
+ api_name: :searchQueryOr,
92
+ nil?: true
93
+
94
+ # @!method initialize(inference_pipeline_id:, asc: nil, page: nil, per_page: nil, sort_column: nil, column_filters: nil, exclude_row_id_list: nil, not_search_query_and: nil, not_search_query_or: nil, row_id_list: nil, search_query_and: nil, search_query_or: nil, request_options: {})
28
95
  # @param inference_pipeline_id [String]
29
96
  #
97
+ # @param asc [Boolean] Whether or not to sort on the sortColumn in ascending order.
98
+ #
30
99
  # @param page [Integer] The page to return in a paginated query.
31
100
  #
32
101
  # @param per_page [Integer] Maximum number of items to return per page.
33
102
  #
103
+ # @param sort_column [String] Name of the column to sort on
104
+ #
105
+ # @param column_filters [Array<Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter, Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter, Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter>, nil]
106
+ #
107
+ # @param exclude_row_id_list [Array<Integer>, nil]
108
+ #
109
+ # @param not_search_query_and [Array<String>, nil]
110
+ #
111
+ # @param not_search_query_or [Array<String>, nil]
112
+ #
113
+ # @param row_id_list [Array<Integer>, nil]
114
+ #
115
+ # @param search_query_and [Array<String>, nil]
116
+ #
117
+ # @param search_query_or [Array<String>, nil]
118
+ #
34
119
  # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
120
+
121
+ module ColumnFilter
122
+ extend Openlayer::Internal::Type::Union
123
+
124
+ variant -> { Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter }
125
+
126
+ variant -> { Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter }
127
+
128
+ variant -> { Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter }
129
+
130
+ class SetColumnFilter < Openlayer::Internal::Type::BaseModel
131
+ # @!attribute measurement
132
+ # The name of the column.
133
+ #
134
+ # @return [String]
135
+ required :measurement, String
136
+
137
+ # @!attribute operator
138
+ #
139
+ # @return [Symbol, Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::Operator]
140
+ required :operator,
141
+ enum: -> { Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::Operator }
142
+
143
+ # @!attribute value
144
+ #
145
+ # @return [Array<String, Float>]
146
+ required :value,
147
+ -> { Openlayer::Internal::Type::ArrayOf[union: Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::Value] }
148
+
149
+ # @!method initialize(measurement:, operator:, value:)
150
+ # @param measurement [String] The name of the column.
151
+ #
152
+ # @param operator [Symbol, Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter::Operator]
153
+ #
154
+ # @param value [Array<String, Float>]
155
+
156
+ # @see Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter#operator
157
+ module Operator
158
+ extend Openlayer::Internal::Type::Enum
159
+
160
+ CONTAINS_NONE = :contains_none
161
+ CONTAINS_ANY = :contains_any
162
+ CONTAINS_ALL = :contains_all
163
+ ONE_OF = :one_of
164
+ NONE_OF = :none_of
165
+
166
+ # @!method self.values
167
+ # @return [Array<Symbol>]
168
+ end
169
+
170
+ module Value
171
+ extend Openlayer::Internal::Type::Union
172
+
173
+ variant String
174
+
175
+ variant Float
176
+
177
+ # @!method self.variants
178
+ # @return [Array(String, Float)]
179
+ end
180
+ end
181
+
182
+ class NumericColumnFilter < Openlayer::Internal::Type::BaseModel
183
+ # @!attribute measurement
184
+ # The name of the column.
185
+ #
186
+ # @return [String]
187
+ required :measurement, String
188
+
189
+ # @!attribute operator
190
+ #
191
+ # @return [Symbol, Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter::Operator]
192
+ required :operator,
193
+ enum: -> { Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter::Operator }
194
+
195
+ # @!attribute value
196
+ #
197
+ # @return [Float, nil]
198
+ required :value, Float, nil?: true
199
+
200
+ # @!method initialize(measurement:, operator:, value:)
201
+ # @param measurement [String] The name of the column.
202
+ #
203
+ # @param operator [Symbol, Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter::Operator]
204
+ #
205
+ # @param value [Float, nil]
206
+
207
+ # @see Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter#operator
208
+ module Operator
209
+ extend Openlayer::Internal::Type::Enum
210
+
211
+ GREATER = :>
212
+ GREATER_OR_EQUALS = :">="
213
+ IS = :is
214
+ LESS = :<
215
+ LESS_OR_EQUALS = :"<="
216
+ NOT_EQUALS = :"!="
217
+
218
+ # @!method self.values
219
+ # @return [Array<Symbol>]
220
+ end
221
+ end
222
+
223
+ class StringColumnFilter < Openlayer::Internal::Type::BaseModel
224
+ # @!attribute measurement
225
+ # The name of the column.
226
+ #
227
+ # @return [String]
228
+ required :measurement, String
229
+
230
+ # @!attribute operator
231
+ #
232
+ # @return [Symbol, Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter::Operator]
233
+ required :operator,
234
+ enum: -> { Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter::Operator }
235
+
236
+ # @!attribute value
237
+ #
238
+ # @return [String, Boolean]
239
+ required :value,
240
+ union: -> { Openlayer::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter::Value }
241
+
242
+ # @!method initialize(measurement:, operator:, value:)
243
+ # @param measurement [String] The name of the column.
244
+ #
245
+ # @param operator [Symbol, Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter::Operator]
246
+ #
247
+ # @param value [String, Boolean]
248
+
249
+ # @see Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter#operator
250
+ module Operator
251
+ extend Openlayer::Internal::Type::Enum
252
+
253
+ IS = :is
254
+ NOT_EQUALS = :"!="
255
+
256
+ # @!method self.values
257
+ # @return [Array<Symbol>]
258
+ end
259
+
260
+ # @see Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter#value
261
+ module Value
262
+ extend Openlayer::Internal::Type::Union
263
+
264
+ variant String
265
+
266
+ variant Openlayer::Internal::Type::Boolean
267
+
268
+ # @!method self.variants
269
+ # @return [Array(String, Boolean)]
270
+ end
271
+ end
272
+
273
+ # @!method self.variants
274
+ # @return [Array(Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter, Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter, Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter)]
275
+ end
35
276
  end
36
277
  end
37
278
  end
@@ -47,6 +47,8 @@ module Openlayer
47
47
 
48
48
  InferencePipelineRetrieveParams = Openlayer::Models::InferencePipelineRetrieveParams
49
49
 
50
+ InferencePipelineRetrieveSessionsParams = Openlayer::Models::InferencePipelineRetrieveSessionsParams
51
+
50
52
  InferencePipelineRetrieveUsersParams = Openlayer::Models::InferencePipelineRetrieveUsersParams
51
53
 
52
54
  InferencePipelines = Openlayer::Models::InferencePipelines
@@ -88,19 +88,89 @@ module Openlayer
88
88
  )
89
89
  end
90
90
 
91
+ # Get aggregated session data for an inference pipeline with pagination and
92
+ # metadata.
93
+ #
94
+ # Returns a list of sessions for the inference pipeline, including activity
95
+ # statistics such as record counts, token usage, cost, latency, and the first and
96
+ # last records.
97
+ #
98
+ # @overload retrieve_sessions(inference_pipeline_id, asc: nil, page: nil, per_page: nil, sort_column: nil, column_filters: nil, exclude_row_id_list: nil, not_search_query_and: nil, not_search_query_or: nil, row_id_list: nil, search_query_and: nil, search_query_or: nil, request_options: {})
99
+ #
100
+ # @param inference_pipeline_id [String] Path param: The inference pipeline id (a UUID).
101
+ #
102
+ # @param asc [Boolean] Query param: Whether or not to sort on the sortColumn in ascending order.
103
+ #
104
+ # @param page [Integer] Query param: The page to return in a paginated query.
105
+ #
106
+ # @param per_page [Integer] Query param: Maximum number of items to return per page.
107
+ #
108
+ # @param sort_column [String] Query param: Name of the column to sort on
109
+ #
110
+ # @param column_filters [Array<Openlayer::Models::InferencePipelineRetrieveSessionsParams::ColumnFilter::SetColumnFilter, Openlayer::Models::InferencePipelineRetrieveSessionsParams::ColumnFilter::NumericColumnFilter, Openlayer::Models::InferencePipelineRetrieveSessionsParams::ColumnFilter::StringColumnFilter>, nil] Body param
111
+ #
112
+ # @param exclude_row_id_list [Array<Integer>, nil] Body param
113
+ #
114
+ # @param not_search_query_and [Array<String>, nil] Body param
115
+ #
116
+ # @param not_search_query_or [Array<String>, nil] Body param
117
+ #
118
+ # @param row_id_list [Array<Integer>, nil] Body param
119
+ #
120
+ # @param search_query_and [Array<String>, nil] Body param
121
+ #
122
+ # @param search_query_or [Array<String>, nil] Body param
123
+ #
124
+ # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
125
+ #
126
+ # @return [Openlayer::Models::InferencePipelineRetrieveSessionsResponse]
127
+ #
128
+ # @see Openlayer::Models::InferencePipelineRetrieveSessionsParams
129
+ def retrieve_sessions(inference_pipeline_id, params = {})
130
+ query_params = [:asc, :page, :per_page, :sort_column]
131
+ parsed, options = Openlayer::InferencePipelineRetrieveSessionsParams.dump_request(params)
132
+ query = Openlayer::Internal::Util.encode_query_params(parsed.slice(*query_params))
133
+ @client.request(
134
+ method: :post,
135
+ path: ["inference-pipelines/%1$s/sessions", inference_pipeline_id],
136
+ query: query.transform_keys(per_page: "perPage", sort_column: "sortColumn"),
137
+ body: parsed.except(*query_params),
138
+ model: Openlayer::Models::InferencePipelineRetrieveSessionsResponse,
139
+ options: options
140
+ )
141
+ end
142
+
91
143
  # Get aggregated user data for an inference pipeline with pagination and metadata.
92
144
  #
93
145
  # Returns a list of users who have interacted with the inference pipeline,
94
146
  # including their activity statistics such as session counts, record counts, token
95
147
  # usage, and costs.
96
148
  #
97
- # @overload retrieve_users(inference_pipeline_id, page: nil, per_page: nil, request_options: {})
149
+ # @overload retrieve_users(inference_pipeline_id, asc: nil, page: nil, per_page: nil, sort_column: nil, column_filters: nil, exclude_row_id_list: nil, not_search_query_and: nil, not_search_query_or: nil, row_id_list: nil, search_query_and: nil, search_query_or: nil, request_options: {})
98
150
  #
99
- # @param inference_pipeline_id [String] The inference pipeline id (a UUID).
151
+ # @param inference_pipeline_id [String] Path param: The inference pipeline id (a UUID).
152
+ #
153
+ # @param asc [Boolean] Query param: Whether or not to sort on the sortColumn in ascending order.
154
+ #
155
+ # @param page [Integer] Query param: The page to return in a paginated query.
156
+ #
157
+ # @param per_page [Integer] Query param: Maximum number of items to return per page.
100
158
  #
101
- # @param page [Integer] The page to return in a paginated query.
159
+ # @param sort_column [String] Query param: Name of the column to sort on
102
160
  #
103
- # @param per_page [Integer] Maximum number of items to return per page.
161
+ # @param column_filters [Array<Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::SetColumnFilter, Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::NumericColumnFilter, Openlayer::Models::InferencePipelineRetrieveUsersParams::ColumnFilter::StringColumnFilter>, nil] Body param
162
+ #
163
+ # @param exclude_row_id_list [Array<Integer>, nil] Body param
164
+ #
165
+ # @param not_search_query_and [Array<String>, nil] Body param
166
+ #
167
+ # @param not_search_query_or [Array<String>, nil] Body param
168
+ #
169
+ # @param row_id_list [Array<Integer>, nil] Body param
170
+ #
171
+ # @param search_query_and [Array<String>, nil] Body param
172
+ #
173
+ # @param search_query_or [Array<String>, nil] Body param
104
174
  #
105
175
  # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
106
176
  #
@@ -108,12 +178,14 @@ module Openlayer
108
178
  #
109
179
  # @see Openlayer::Models::InferencePipelineRetrieveUsersParams
110
180
  def retrieve_users(inference_pipeline_id, params = {})
181
+ query_params = [:asc, :page, :per_page, :sort_column]
111
182
  parsed, options = Openlayer::InferencePipelineRetrieveUsersParams.dump_request(params)
112
- query = Openlayer::Internal::Util.encode_query_params(parsed)
183
+ query = Openlayer::Internal::Util.encode_query_params(parsed.slice(*query_params))
113
184
  @client.request(
114
- method: :get,
185
+ method: :post,
115
186
  path: ["inference-pipelines/%1$s/users", inference_pipeline_id],
116
- query: query.transform_keys(per_page: "perPage"),
187
+ query: query.transform_keys(per_page: "perPage", sort_column: "sortColumn"),
188
+ body: parsed.except(*query_params),
117
189
  model: Openlayer::Models::InferencePipelineRetrieveUsersResponse,
118
190
  options: options
119
191
  )
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Openlayer
4
- VERSION = "0.11.2"
4
+ VERSION = "0.12.0"
5
5
  end
data/lib/openlayer.rb CHANGED
@@ -59,6 +59,8 @@ require_relative "openlayer/models/commits/test_result_list_response"
59
59
  require_relative "openlayer/models/inference_pipeline_delete_params"
60
60
  require_relative "openlayer/models/inference_pipeline_retrieve_params"
61
61
  require_relative "openlayer/models/inference_pipeline_retrieve_response"
62
+ require_relative "openlayer/models/inference_pipeline_retrieve_sessions_params"
63
+ require_relative "openlayer/models/inference_pipeline_retrieve_sessions_response"
62
64
  require_relative "openlayer/models/inference_pipeline_retrieve_users_params"
63
65
  require_relative "openlayer/models/inference_pipeline_retrieve_users_response"
64
66
  require_relative "openlayer/models/inference_pipelines/data_stream_params"