Class: OpenApiOpenAIClient::CreateBatchRequest

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/openapi_openai/models/create_batch_request.rb

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 = {}) ⇒ CreateBatchRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



91
92
93
94
95
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
 
# File 'lib/openapi_openai/models/create_batch_request.rb', line 91

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

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

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

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

Instance Attribute Details

#completion_window ⇒ Object

The time frame within which the batch should be processed. Currently only 24h is supported.



25
26
27
 
# File 'lib/openapi_openai/models/create_batch_request.rb', line 25

def completion_window
  @completion_window
end

#endpoint ⇒ Object

The endpoint to be used for all requests in the batch. Currently /v1/chat/completions, /v1/embeddings, and /v1/completions are supported. Note that /v1/embeddings batches are also restricted to a maximum of 50,000 embedding inputs across all requests in the batch.



22
23
24
 
# File 'lib/openapi_openai/models/create_batch_request.rb', line 22

def endpoint
  @endpoint
end

#input_file_id ⇒ Object

The ID of an uploaded file that contains requests for the new batch. See [upload file](/docs/api-reference/files/create) for how to upload a file. Your input file must be formatted as a [JSONL file](/docs/api-reference/batch/request-input), and must be uploaded with the purpose batch. The file can contain up to 50,000 requests, and can be up to 200 MB in size.



19
20
21
 
# File 'lib/openapi_openai/models/create_batch_request.rb', line 19

def input_file_id
  @input_file_id
end

#metadata ⇒ Object

Optional custom metadata for the batch.



28
29
30
 
# File 'lib/openapi_openai/models/create_batch_request.rb', line 28

def metadata
  @metadata
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



63
64
65
 
# File 'lib/openapi_openai/models/create_batch_request.rb', line 63

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



68
69
70
 
# File 'lib/openapi_openai/models/create_batch_request.rb', line 68

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
 
# File 'lib/openapi_openai/models/create_batch_request.rb', line 53

def self.attribute_map
  {
    :'input_file_id' => :'input_file_id',
    :'endpoint' => :'endpoint',
    :'completion_window' => :'completion_window',
    :'metadata' => :'metadata'
  }
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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/openapi_openai/models/create_batch_request.rb', line 220

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



83
84
85
86
87
 
# File 'lib/openapi_openai/models/create_batch_request.rb', line 83

def self.openapi_nullable
  Set.new([
    :'metadata'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
 
# File 'lib/openapi_openai/models/create_batch_request.rb', line 73

def self.openapi_types
  {
    :'input_file_id' => :'String',
    :'endpoint' => :'String',
    :'completion_window' => :'String',
    :'metadata' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



196
197
198
199
200
201
202
203
 
# File 'lib/openapi_openai/models/create_batch_request.rb', line 196

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      input_file_id == o.input_file_id &&
      endpoint == o.endpoint &&
      completion_window == o.completion_window &&
      metadata == o.metadata
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


207
208
209
 
# File 'lib/openapi_openai/models/create_batch_request.rb', line 207

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



213
214
215
 
# File 'lib/openapi_openai/models/create_batch_request.rb', line 213

def hash
  [input_file_id, endpoint, completion_window, metadata].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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/openapi_openai/models/create_batch_request.rb', line 132

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

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

  if @completion_window.nil?
    invalid_properties.push('invalid value for "completion_window", completion_window 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



242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/openapi_openai/models/create_batch_request.rb', line 242

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



152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/openapi_openai/models/create_batch_request.rb', line 152

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @input_file_id.nil?
  return false if @endpoint.nil?
  endpoint_validator = EnumAttributeValidator.new('String', ["/v1/chat/completions", "/v1/embeddings", "/v1/completions"])
  return false unless endpoint_validator.valid?(@endpoint)
  return false if @completion_window.nil?
  completion_window_validator = EnumAttributeValidator.new('String', ["24h"])
  return false unless completion_window_validator.valid?(@completion_window)
  true
end