Class: LiteLLMClient::DailySpendMetadata

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DailySpendMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash



96
97
98
99
100
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
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
 
# File 'lib/litellm_client/models/daily_spend_metadata.rb', line 96

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `LiteLLMClient::DailySpendMetadata` 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::DailySpendMetadata`. 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?(:'total_spend')
    self.total_spend = attributes[:'total_spend']
  else
    self.total_spend = 0.0
  end

  if attributes.key?(:'total_prompt_tokens')
    self.total_prompt_tokens = attributes[:'total_prompt_tokens']
  else
    self.total_prompt_tokens = 0
  end

  if attributes.key?(:'total_completion_tokens')
    self.total_completion_tokens = attributes[:'total_completion_tokens']
  else
    self.total_completion_tokens = 0
  end

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

  if attributes.key?(:'total_api_requests')
    self.total_api_requests = attributes[:'total_api_requests']
  else
    self.total_api_requests = 0
  end

  if attributes.key?(:'total_successful_requests')
    self.total_successful_requests = attributes[:'total_successful_requests']
  else
    self.total_successful_requests = 0
  end

  if attributes.key?(:'total_failed_requests')
    self.total_failed_requests = attributes[:'total_failed_requests']
  else
    self.total_failed_requests = 0
  end

  if attributes.key?(:'total_cache_read_input_tokens')
    self.total_cache_read_input_tokens = attributes[:'total_cache_read_input_tokens']
  else
    self.total_cache_read_input_tokens = 0
  end

  if attributes.key?(:'total_cache_creation_input_tokens')
    self.total_cache_creation_input_tokens = attributes[:'total_cache_creation_input_tokens']
  else
    self.total_cache_creation_input_tokens = 0
  end

  if attributes.key?(:'page')
    self.page = attributes[:'page']
  else
    self.page = 1
  end

  if attributes.key?(:'total_pages')
    self.total_pages = attributes[:'total_pages']
  else
    self.total_pages = 1
  end

  if attributes.key?(:'has_more')
    self.has_more = attributes[:'has_more']
  else
    self.has_more = false
  end
end

Instance Attribute Details

#has_more ⇒ Object

Returns the value of attribute has_more.



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

def has_more
  @has_more
end

#page ⇒ Object

Returns the value of attribute page.



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

def page
  @page
end

#total_api_requests ⇒ Object

Returns the value of attribute total_api_requests.



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

def total_api_requests
  @total_api_requests
end

#total_cache_creation_input_tokens ⇒ Object

Returns the value of attribute total_cache_creation_input_tokens.



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

def total_cache_creation_input_tokens
  @total_cache_creation_input_tokens
end

#total_cache_read_input_tokens ⇒ Object

Returns the value of attribute total_cache_read_input_tokens.



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

def total_cache_read_input_tokens
  @total_cache_read_input_tokens
end

#total_completion_tokens ⇒ Object

Returns the value of attribute total_completion_tokens.



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

def total_completion_tokens
  @total_completion_tokens
end

#total_failed_requests ⇒ Object

Returns the value of attribute total_failed_requests.



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

def total_failed_requests
  @total_failed_requests
end

#total_pages ⇒ Object

Returns the value of attribute total_pages.



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

def total_pages
  @total_pages
end

#total_prompt_tokens ⇒ Object

Returns the value of attribute total_prompt_tokens.



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

def total_prompt_tokens
  @total_prompt_tokens
end

#total_spend ⇒ Object

Returns the value of attribute total_spend.



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

def total_spend
  @total_spend
end

#total_successful_requests ⇒ Object

Returns the value of attribute total_successful_requests.



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

def total_successful_requests
  @total_successful_requests
end

#total_tokens ⇒ Object

Returns the value of attribute total_tokens.



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

def total_tokens
  @total_tokens
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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/litellm_client/models/daily_spend_metadata.rb', line 256

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_map ⇒ Object

Returns attribute mapping this model knows about



61
62
63
 
# File 'lib/litellm_client/models/daily_spend_metadata.rb', line 61

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/litellm_client/models/daily_spend_metadata.rb', line 66

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/litellm_client/models/daily_spend_metadata.rb', line 43

def self.attribute_map
  {
    :'total_spend' => :'total_spend',
    :'total_prompt_tokens' => :'total_prompt_tokens',
    :'total_completion_tokens' => :'total_completion_tokens',
    :'total_tokens' => :'total_tokens',
    :'total_api_requests' => :'total_api_requests',
    :'total_successful_requests' => :'total_successful_requests',
    :'total_failed_requests' => :'total_failed_requests',
    :'total_cache_read_input_tokens' => :'total_cache_read_input_tokens',
    :'total_cache_creation_input_tokens' => :'total_cache_creation_input_tokens',
    :'page' => :'page',
    :'total_pages' => :'total_pages',
    :'has_more' => :'has_more'
  }
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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/litellm_client/models/daily_spend_metadata.rb', line 232

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_nullable ⇒ Object

List of attributes with nullable: true



89
90
91
92
 
# File 'lib/litellm_client/models/daily_spend_metadata.rb', line 89

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/litellm_client/models/daily_spend_metadata.rb', line 71

def self.openapi_types
  {
    :'total_spend' => :'Float',
    :'total_prompt_tokens' => :'Integer',
    :'total_completion_tokens' => :'Integer',
    :'total_tokens' => :'Integer',
    :'total_api_requests' => :'Integer',
    :'total_successful_requests' => :'Integer',
    :'total_failed_requests' => :'Integer',
    :'total_cache_read_input_tokens' => :'Integer',
    :'total_cache_creation_input_tokens' => :'Integer',
    :'page' => :'Integer',
    :'total_pages' => :'Integer',
    :'has_more' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/litellm_client/models/daily_spend_metadata.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total_spend == o.total_spend &&
      total_prompt_tokens == o.total_prompt_tokens &&
      total_completion_tokens == o.total_completion_tokens &&
      total_tokens == o.total_tokens &&
      total_api_requests == o.total_api_requests &&
      total_successful_requests == o.total_successful_requests &&
      total_failed_requests == o.total_failed_requests &&
      total_cache_read_input_tokens == o.total_cache_read_input_tokens &&
      total_cache_creation_input_tokens == o.total_cache_creation_input_tokens &&
      page == o.page &&
      total_pages == o.total_pages &&
      has_more == o.has_more
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



327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/litellm_client/models/daily_spend_metadata.rb', line 327

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


219
220
221
 
# File 'lib/litellm_client/models/daily_spend_metadata.rb', line 219

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



225
226
227
 
# File 'lib/litellm_client/models/daily_spend_metadata.rb', line 225

def hash
  [total_spend, total_prompt_tokens, total_completion_tokens, total_tokens, total_api_requests, total_successful_requests, total_failed_requests, total_cache_read_input_tokens, total_cache_creation_input_tokens, page, total_pages, has_more].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



185
186
187
188
189
 
# File 'lib/litellm_client/models/daily_spend_metadata.rb', line 185

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



303
304
305
 
# File 'lib/litellm_client/models/daily_spend_metadata.rb', line 303

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/litellm_client/models/daily_spend_metadata.rb', line 309

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



297
298
299
 
# File 'lib/litellm_client/models/daily_spend_metadata.rb', line 297

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



193
194
195
196
 
# File 'lib/litellm_client/models/daily_spend_metadata.rb', line 193

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end