Class: LiteLLMClient::BudgetManagementApi

Inherits:
Object
  • Object
show all
Defined in:
lib/litellm_client/api/budget_management_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BudgetManagementApi

Returns a new instance of BudgetManagementApi.



19
20
21
 
# File 'lib/litellm_client/api/budget_management_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/litellm_client/api/budget_management_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#budget_settings_budget_settings_get(budget_id, opts = {}) ⇒ Object

Budget Settings Get list of configurable params + current value for a budget item + description of each field Used on Admin UI. Query Parameters: - budget_id: str - The budget id to get information for

Parameters:

  • budget_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


27
28
29
30
 
# File 'lib/litellm_client/api/budget_management_api.rb', line 27

def budget_settings_budget_settings_get(budget_id, opts = {})
  data, _status_code, _headers = budget_settings_budget_settings_get_with_http_info(budget_id, opts)
  data
end

#budget_settings_budget_settings_get_with_http_info(budget_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Budget Settings Get list of configurable params + current value for a budget item + description of each field Used on Admin UI. Query Parameters: - budget_id: str - The budget id to get information for

Parameters:

  • budget_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/litellm_client/api/budget_management_api.rb', line 37

def budget_settings_budget_settings_get_with_http_info(budget_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BudgetManagementApi.budget_settings_budget_settings_get ...'
  end
  # verify the required parameter 'budget_id' is set
  if @api_client.config.client_side_validation && budget_id.nil?
    fail ArgumentError, "Missing the required parameter 'budget_id' when calling BudgetManagementApi.budget_settings_budget_settings_get"
  end
  # resource path
  local_var_path = '/budget/settings'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'budget_id'] = budget_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"BudgetManagementApi.budget_settings_budget_settings_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BudgetManagementApi#budget_settings_budget_settings_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_budget_budget_delete_post(budget_delete_request, opts = {}) ⇒ Object

Delete Budget Delete budget Parameters: - id: str - The budget id to delete

Parameters:

  • budget_delete_request (BudgetDeleteRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


91
92
93
94
 
# File 'lib/litellm_client/api/budget_management_api.rb', line 91

def delete_budget_budget_delete_post(budget_delete_request, opts = {})
  data, _status_code, _headers = delete_budget_budget_delete_post_with_http_info(budget_delete_request, opts)
  data
end

#delete_budget_budget_delete_post_with_http_info(budget_delete_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete Budget Delete budget Parameters: - id: str - The budget id to delete

Parameters:

  • budget_delete_request (BudgetDeleteRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/litellm_client/api/budget_management_api.rb', line 101

def delete_budget_budget_delete_post_with_http_info(budget_delete_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BudgetManagementApi.delete_budget_budget_delete_post ...'
  end
  # verify the required parameter 'budget_delete_request' is set
  if @api_client.config.client_side_validation && budget_delete_request.nil?
    fail ArgumentError, "Missing the required parameter 'budget_delete_request' when calling BudgetManagementApi.delete_budget_budget_delete_post"
  end
  # resource path
  local_var_path = '/budget/delete'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(budget_delete_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"BudgetManagementApi.delete_budget_budget_delete_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BudgetManagementApi#delete_budget_budget_delete_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#info_budget_budget_info_post(budget_request, opts = {}) ⇒ Object

Info Budget Get the budget id specific information Parameters: - budgets: List - The list of budget ids to get information for

Parameters:

  • budget_request (BudgetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


159
160
161
162
 
# File 'lib/litellm_client/api/budget_management_api.rb', line 159

def info_budget_budget_info_post(budget_request, opts = {})
  data, _status_code, _headers = info_budget_budget_info_post_with_http_info(budget_request, opts)
  data
end

#info_budget_budget_info_post_with_http_info(budget_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Info Budget Get the budget id specific information Parameters: - budgets: List - The list of budget ids to get information for

Parameters:

  • budget_request (BudgetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/litellm_client/api/budget_management_api.rb', line 169

def info_budget_budget_info_post_with_http_info(budget_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BudgetManagementApi.info_budget_budget_info_post ...'
  end
  # verify the required parameter 'budget_request' is set
  if @api_client.config.client_side_validation && budget_request.nil?
    fail ArgumentError, "Missing the required parameter 'budget_request' when calling BudgetManagementApi.info_budget_budget_info_post"
  end
  # resource path
  local_var_path = '/budget/info'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(budget_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"BudgetManagementApi.info_budget_budget_info_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BudgetManagementApi#info_budget_budget_info_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_budget_budget_list_get(opts = {}) ⇒ Object

List Budget List all the created budgets in proxy db. Used on Admin UI.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


226
227
228
229
 
# File 'lib/litellm_client/api/budget_management_api.rb', line 226

def list_budget_budget_list_get(opts = {})
  data, _status_code, _headers = list_budget_budget_list_get_with_http_info(opts)
  data
end

#list_budget_budget_list_get_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

List Budget List all the created budgets in proxy db. Used on Admin UI.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/litellm_client/api/budget_management_api.rb', line 235

def list_budget_budget_list_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BudgetManagementApi.list_budget_budget_list_get ...'
  end
  # resource path
  local_var_path = '/budget/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"BudgetManagementApi.list_budget_budget_list_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BudgetManagementApi#list_budget_budget_list_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#new_budget_budget_new_post(budget_new_request, opts = {}) ⇒ Object

New Budget Create a new budget object. Can apply this to teams, orgs, end-users, keys. Parameters: - budget_duration: Optional - Budget reset period ("30d", "1h", etc.) - budget_id: Optional - The id of the budget. If not provided, a new id will be generated. - max_budget: Optional - The max budget for the budget. - soft_budget: Optional - The soft budget for the budget. - max_parallel_requests: Optional - The max number of parallel requests for the budget. - tpm_limit: Optional - The tokens per minute limit for the budget. - rpm_limit: Optional - The requests per minute limit for the budget. - model_max_budget: Optional - Specify max budget for a given model. Example: {"max_budget": 100.0, "budget_duration": "1d", "tpm_limit": 100000, "rpm_limit": 100000} - budget_reset_at: Optional - Datetime when the initial budget is reset. Default is now.

Parameters:

  • budget_new_request (BudgetNewRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


284
285
286
287
 
# File 'lib/litellm_client/api/budget_management_api.rb', line 284

def new_budget_budget_new_post(budget_new_request, opts = {})
  data, _status_code, _headers = new_budget_budget_new_post_with_http_info(budget_new_request, opts)
  data
end

#new_budget_budget_new_post_with_http_info(budget_new_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

New Budget Create a new budget object. Can apply this to teams, orgs, end-users, keys. Parameters: - budget_duration: Optional - Budget reset period (&quot;30d&quot;, &quot;1h&quot;, etc.) - budget_id: Optional - The id of the budget. If not provided, a new id will be generated. - max_budget: Optional - The max budget for the budget. - soft_budget: Optional - The soft budget for the budget. - max_parallel_requests: Optional - The max number of parallel requests for the budget. - tpm_limit: Optional - The tokens per minute limit for the budget. - rpm_limit: Optional - The requests per minute limit for the budget. - model_max_budget: Optional - Specify max budget for a given model. Example: {&quot;max_budget&quot;: 100.0, &quot;budget_duration&quot;: &quot;1d&quot;, &quot;tpm_limit&quot;: 100000, &quot;rpm_limit&quot;: 100000} - budget_reset_at: Optional - Datetime when the initial budget is reset. Default is now.

Parameters:

  • budget_new_request (BudgetNewRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/litellm_client/api/budget_management_api.rb', line 294

def new_budget_budget_new_post_with_http_info(budget_new_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BudgetManagementApi.new_budget_budget_new_post ...'
  end
  # verify the required parameter 'budget_new_request' is set
  if @api_client.config.client_side_validation && budget_new_request.nil?
    fail ArgumentError, "Missing the required parameter 'budget_new_request' when calling BudgetManagementApi.new_budget_budget_new_post"
  end
  # resource path
  local_var_path = '/budget/new'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(budget_new_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"BudgetManagementApi.new_budget_budget_new_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BudgetManagementApi#new_budget_budget_new_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_budget_budget_update_post(budget_new_request, opts = {}) ⇒ Object

Update Budget Update an existing budget object. Parameters: - budget_duration: Optional - Budget reset period ("30d", "1h", etc.) - budget_id: Optional - The id of the budget. If not provided, a new id will be generated. - max_budget: Optional - The max budget for the budget. - soft_budget: Optional - The soft budget for the budget. - max_parallel_requests: Optional - The max number of parallel requests for the budget. - tpm_limit: Optional - The tokens per minute limit for the budget. - rpm_limit: Optional - The requests per minute limit for the budget. - model_max_budget: Optional - Specify max budget for a given model. Example: {"max_budget": 100.0, "budget_duration": "1d", "tpm_limit": 100000, "rpm_limit": 100000} - budget_reset_at: Optional - Update the Datetime when the budget was last reset.

Parameters:

  • budget_new_request (BudgetNewRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


352
353
354
355
 
# File 'lib/litellm_client/api/budget_management_api.rb', line 352

def update_budget_budget_update_post(budget_new_request, opts = {})
  data, _status_code, _headers = update_budget_budget_update_post_with_http_info(budget_new_request, opts)
  data
end

#update_budget_budget_update_post_with_http_info(budget_new_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Update Budget Update an existing budget object. Parameters: - budget_duration: Optional - Budget reset period (&quot;30d&quot;, &quot;1h&quot;, etc.) - budget_id: Optional - The id of the budget. If not provided, a new id will be generated. - max_budget: Optional - The max budget for the budget. - soft_budget: Optional - The soft budget for the budget. - max_parallel_requests: Optional - The max number of parallel requests for the budget. - tpm_limit: Optional - The tokens per minute limit for the budget. - rpm_limit: Optional - The requests per minute limit for the budget. - model_max_budget: Optional - Specify max budget for a given model. Example: {&quot;max_budget&quot;: 100.0, &quot;budget_duration&quot;: &quot;1d&quot;, &quot;tpm_limit&quot;: 100000, &quot;rpm_limit&quot;: 100000} - budget_reset_at: Optional - Update the Datetime when the budget was last reset.

Parameters:

  • budget_new_request (BudgetNewRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/litellm_client/api/budget_management_api.rb', line 362

def update_budget_budget_update_post_with_http_info(budget_new_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BudgetManagementApi.update_budget_budget_update_post ...'
  end
  # verify the required parameter 'budget_new_request' is set
  if @api_client.config.client_side_validation && budget_new_request.nil?
    fail ArgumentError, "Missing the required parameter 'budget_new_request' when calling BudgetManagementApi.update_budget_budget_update_post"
  end
  # resource path
  local_var_path = '/budget/update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(budget_new_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"BudgetManagementApi.update_budget_budget_update_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BudgetManagementApi#update_budget_budget_update_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end