Class: LiteLLMClient::LiteLLMSpendLogs

Inherits:
Object
  • Object
show all
Defined in:
lib/litellm_client/models/lite_llm_spend_logs.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LiteLLMSpendLogs

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 140

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `LiteLLMClient::LiteLLMSpendLogs` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `LiteLLMClient::LiteLLMSpendLogs`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'request_id')
    self.request_id = attributes[:'request_id']
  else
    self.request_id = nil
  end

  if attributes.key?(:'api_key')
    self.api_key = attributes[:'api_key']
  else
    self.api_key = nil
  end

  if attributes.key?(:'model')
    self.model = attributes[:'model']
  end

  if attributes.key?(:'api_base')
    self.api_base = attributes[:'api_base']
  end

  if attributes.key?(:'call_type')
    self.call_type = attributes[:'call_type']
  else
    self.call_type = nil
  end

  if attributes.key?(:'spend')
    self.spend = attributes[:'spend']
  end

  if attributes.key?(:'total_tokens')
    self.total_tokens = attributes[:'total_tokens']
  end

  if attributes.key?(:'prompt_tokens')
    self.prompt_tokens = attributes[:'prompt_tokens']
  end

  if attributes.key?(:'completion_tokens')
    self.completion_tokens = attributes[:'completion_tokens']
  end

  if attributes.key?(:'start_time')
    self.start_time = attributes[:'start_time']
  else
    self.start_time = nil
  end

  if attributes.key?(:'end_time')
    self.end_time = attributes[:'end_time']
  else
    self.end_time = nil
  end

  if attributes.key?(:'user')
    self.user = attributes[:'user']
  end

  if attributes.key?(:'metadata')
    self. = attributes[:'metadata']
  end

  if attributes.key?(:'cache_hit')
    self.cache_hit = attributes[:'cache_hit']
  end

  if attributes.key?(:'cache_key')
    self.cache_key = attributes[:'cache_key']
  end

  if attributes.key?(:'request_tags')
    self.request_tags = attributes[:'request_tags']
  end

  if attributes.key?(:'requester_ip_address')
    self.requester_ip_address = attributes[:'requester_ip_address']
  end

  if attributes.key?(:'messages')
    self.messages = attributes[:'messages']
  else
    self.messages = nil
  end

  if attributes.key?(:'response')
    self.response = attributes[:'response']
  else
    self.response = nil
  end
end

Instance Attribute Details

#api_baseObject

Returns the value of attribute api_base.



24
25
26
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 24

def api_base
  @api_base
end

#api_keyObject

Returns the value of attribute api_key.



20
21
22
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 20

def api_key
  @api_key
end

#cache_hitObject

Returns the value of attribute cache_hit.



44
45
46
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 44

def cache_hit
  @cache_hit
end

#cache_keyObject

Returns the value of attribute cache_key.



46
47
48
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 46

def cache_key
  @cache_key
end

#call_typeObject

Returns the value of attribute call_type.



26
27
28
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 26

def call_type
  @call_type
end

#completion_tokensObject

Returns the value of attribute completion_tokens.



34
35
36
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 34

def completion_tokens
  @completion_tokens
end

#end_timeObject

Returns the value of attribute end_time.



38
39
40
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 38

def end_time
  @end_time
end

#messagesObject

Returns the value of attribute messages.



52
53
54
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 52

def messages
  @messages
end

#metadataObject

Returns the value of attribute metadata.



42
43
44
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 42

def 
  @metadata
end

#modelObject

Returns the value of attribute model.



22
23
24
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 22

def model
  @model
end

#prompt_tokensObject

Returns the value of attribute prompt_tokens.



32
33
34
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 32

def prompt_tokens
  @prompt_tokens
end

#request_idObject

Returns the value of attribute request_id.



18
19
20
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 18

def request_id
  @request_id
end

#request_tagsObject

Returns the value of attribute request_tags.



48
49
50
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 48

def request_tags
  @request_tags
end

#requester_ip_addressObject

Returns the value of attribute requester_ip_address.



50
51
52
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 50

def requester_ip_address
  @requester_ip_address
end

#responseObject

Returns the value of attribute response.



54
55
56
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 54

def response
  @response
end

#spendObject

Returns the value of attribute spend.



28
29
30
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 28

def spend
  @spend
end

#start_timeObject

Returns the value of attribute start_time.



36
37
38
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 36

def start_time
  @start_time
end

#total_tokensObject

Returns the value of attribute total_tokens.



30
31
32
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 30

def total_tokens
  @total_tokens
end

#userObject

Returns the value of attribute user.



40
41
42
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 40

def user
  @user
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



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
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 370

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = LiteLLMClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



82
83
84
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 82

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



87
88
89
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 87

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 57

def self.attribute_map
  {
    :'request_id' => :'request_id',
    :'api_key' => :'api_key',
    :'model' => :'model',
    :'api_base' => :'api_base',
    :'call_type' => :'call_type',
    :'spend' => :'spend',
    :'total_tokens' => :'total_tokens',
    :'prompt_tokens' => :'prompt_tokens',
    :'completion_tokens' => :'completion_tokens',
    :'start_time' => :'startTime',
    :'end_time' => :'endTime',
    :'user' => :'user',
    :'metadata' => :'metadata',
    :'cache_hit' => :'cache_hit',
    :'cache_key' => :'cache_key',
    :'request_tags' => :'request_tags',
    :'requester_ip_address' => :'requester_ip_address',
    :'messages' => :'messages',
    :'response' => :'response'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 346

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullableObject

List of attributes with nullable: true



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 117

def self.openapi_nullable
  Set.new([
    :'model',
    :'api_base',
    :'spend',
    :'total_tokens',
    :'prompt_tokens',
    :'completion_tokens',
    :'start_time',
    :'end_time',
    :'user',
    :'metadata',
    :'cache_hit',
    :'cache_key',
    :'request_tags',
    :'requester_ip_address',
    :'messages',
    :'response'
  ])
end

.openapi_typesObject

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 92

def self.openapi_types
  {
    :'request_id' => :'String',
    :'api_key' => :'String',
    :'model' => :'String',
    :'api_base' => :'String',
    :'call_type' => :'String',
    :'spend' => :'Float',
    :'total_tokens' => :'Integer',
    :'prompt_tokens' => :'Integer',
    :'completion_tokens' => :'Integer',
    :'start_time' => :'Starttime',
    :'end_time' => :'Endtime',
    :'user' => :'String',
    :'metadata' => :'AnyOf',
    :'cache_hit' => :'String',
    :'cache_key' => :'String',
    :'request_tags' => :'AnyOf',
    :'requester_ip_address' => :'String',
    :'messages' => :'Messages',
    :'response' => :'Response'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 307

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      request_id == o.request_id &&
      api_key == o.api_key &&
      model == o.model &&
      api_base == o.api_base &&
      call_type == o.call_type &&
      spend == o.spend &&
      total_tokens == o.total_tokens &&
      prompt_tokens == o.prompt_tokens &&
      completion_tokens == o.completion_tokens &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      user == o.user &&
       == o. &&
      cache_hit == o.cache_hit &&
      cache_key == o.cache_key &&
      request_tags == o.request_tags &&
      requester_ip_address == o.requester_ip_address &&
      messages == o.messages &&
      response == o.response
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



441
442
443
444
445
446
447
448
449
450
451
452
453
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 441

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


333
334
335
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 333

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



339
340
341
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 339

def hash
  [request_id, api_key, model, api_base, call_type, spend, total_tokens, prompt_tokens, completion_tokens, start_time, end_time, user, , cache_hit, cache_key, request_tags, requester_ip_address, messages, response].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 247

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @request_id.nil?
    invalid_properties.push('invalid value for "request_id", request_id cannot be nil.')
  end

  if @api_key.nil?
    invalid_properties.push('invalid value for "api_key", api_key cannot be nil.')
  end

  if @call_type.nil?
    invalid_properties.push('invalid value for "call_type", call_type cannot be nil.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



417
418
419
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 417

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



423
424
425
426
427
428
429
430
431
432
433
434
435
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 423

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



411
412
413
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 411

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



267
268
269
270
271
272
273
# File 'lib/litellm_client/models/lite_llm_spend_logs.rb', line 267

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @request_id.nil?
  return false if @api_key.nil?
  return false if @call_type.nil?
  true
end