Class: OpenApiOpenAIClient::ProjectRateLimit

Inherits:
ApiModelBase show all
Defined in:
lib/openapi_openai/models/project_rate_limit.rb

Overview

Represents a project rate limit config.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ ProjectRateLimit

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 116

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#batch_1_day_max_input_tokens ⇒ Object

The maximum batch input tokens per day. Only present for relevant models.



44
45
46
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 44

def batch_1_day_max_input_tokens
  @batch_1_day_max_input_tokens
end

#id ⇒ Object

The identifier, which can be referenced in API endpoints.



23
24
25
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 23

def id
  @id
end

#max_audio_megabytes_per_1_minute ⇒ Object

The maximum audio megabytes per minute. Only present for relevant models.



38
39
40
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 38

def max_audio_megabytes_per_1_minute
  @max_audio_megabytes_per_1_minute
end

#max_images_per_1_minute ⇒ Object

The maximum images per minute. Only present for relevant models.



35
36
37
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 35

def max_images_per_1_minute
  @max_images_per_1_minute
end

#max_requests_per_1_day ⇒ Object

The maximum requests per day. Only present for relevant models.



41
42
43
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 41

def max_requests_per_1_day
  @max_requests_per_1_day
end

#max_requests_per_1_minute ⇒ Object

The maximum requests per minute.



29
30
31
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 29

def max_requests_per_1_minute
  @max_requests_per_1_minute
end

#max_tokens_per_1_minute ⇒ Object

The maximum tokens per minute.



32
33
34
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 32

def max_tokens_per_1_minute
  @max_tokens_per_1_minute
end

#model ⇒ Object

The model this rate limit applies to.



26
27
28
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 26

def model
  @model
end

#object ⇒ Object

The object type, which is always project.rate_limit



20
21
22
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 20

def object
  @object
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



84
85
86
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 84

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 89

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 69

def self.attribute_map
  {
    :'object' => :'object',
    :'id' => :'id',
    :'model' => :'model',
    :'max_requests_per_1_minute' => :'max_requests_per_1_minute',
    :'max_tokens_per_1_minute' => :'max_tokens_per_1_minute',
    :'max_images_per_1_minute' => :'max_images_per_1_minute',
    :'max_audio_megabytes_per_1_minute' => :'max_audio_megabytes_per_1_minute',
    :'max_requests_per_1_day' => :'max_requests_per_1_day',
    :'batch_1_day_max_input_tokens' => :'batch_1_day_max_input_tokens'
  }
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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 300

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



109
110
111
112
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 109

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

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 94

def self.openapi_types
  {
    :'object' => :'String',
    :'id' => :'String',
    :'model' => :'String',
    :'max_requests_per_1_minute' => :'Integer',
    :'max_tokens_per_1_minute' => :'Integer',
    :'max_images_per_1_minute' => :'Integer',
    :'max_audio_megabytes_per_1_minute' => :'Integer',
    :'max_requests_per_1_day' => :'Integer',
    :'batch_1_day_max_input_tokens' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 271

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      object == o.object &&
      id == o.id &&
      model == o.model &&
      max_requests_per_1_minute == o.max_requests_per_1_minute &&
      max_tokens_per_1_minute == o.max_tokens_per_1_minute &&
      max_images_per_1_minute == o.max_images_per_1_minute &&
      max_audio_megabytes_per_1_minute == o.max_audio_megabytes_per_1_minute &&
      max_requests_per_1_day == o.max_requests_per_1_day &&
      batch_1_day_max_input_tokens == o.batch_1_day_max_input_tokens
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


287
288
289
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 287

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



293
294
295
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 293

def hash
  [object, id, model, max_requests_per_1_minute, max_tokens_per_1_minute, max_images_per_1_minute, max_audio_megabytes_per_1_minute, max_requests_per_1_day, batch_1_day_max_input_tokens].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



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
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 179

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

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

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 322

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/openapi_openai/models/project_rate_limit.rb', line 207

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["project.rate_limit"])
  return false unless object_validator.valid?(@object)
  return false if @id.nil?
  return false if @model.nil?
  return false if @max_requests_per_1_minute.nil?
  return false if @max_tokens_per_1_minute.nil?
  true
end