Class: OpenApiOpenAIClient::RealtimeResponse

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

Overview

The response resource.

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

Initializes the object



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

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

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

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

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

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

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

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

Instance Attribute Details

#id ⇒ Object

The unique ID of the response.



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

def id
  @id
end

#metadata ⇒ Object

Developer-provided string key-value pairs associated with this response.



34
35
36
 
# File 'lib/openapi_openai/models/realtime_response.rb', line 34

def metadata
  @metadata
end

#object ⇒ Object

The object type, must be realtime.response.



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

def object
  @object
end

#output ⇒ Object

The list of output items generated by the response.



31
32
33
 
# File 'lib/openapi_openai/models/realtime_response.rb', line 31

def output
  @output
end

#status ⇒ Object

The final status of the response (completed, cancelled, failed, or incomplete).



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

def status
  @status
end

#status_details ⇒ Object

Returns the value of attribute status_details.



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

def status_details
  @status_details
end

#usage ⇒ Object

Returns the value of attribute usage.



36
37
38
 
# File 'lib/openapi_openai/models/realtime_response.rb', line 36

def usage
  @usage
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



74
75
76
 
# File 'lib/openapi_openai/models/realtime_response.rb', line 74

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/openapi_openai/models/realtime_response.rb', line 79

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/openapi_openai/models/realtime_response.rb', line 61

def self.attribute_map
  {
    :'id' => :'id',
    :'object' => :'object',
    :'status' => :'status',
    :'status_details' => :'status_details',
    :'output' => :'output',
    :'metadata' => :'metadata',
    :'usage' => :'usage'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



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

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



97
98
99
100
101
 
# File 'lib/openapi_openai/models/realtime_response.rb', line 97

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/openapi_openai/models/realtime_response.rb', line 84

def self.openapi_types
  {
    :'id' => :'String',
    :'object' => :'String',
    :'status' => :'String',
    :'status_details' => :'RealtimeResponseStatusDetails',
    :'output' => :'Array<RealtimeConversationItem>',
    :'metadata' => :'Object',
    :'usage' => :'RealtimeResponseUsage'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/openapi_openai/models/realtime_response.rb', line 191

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      object == o.object &&
      status == o.status &&
      status_details == o.status_details &&
      output == o.output &&
      metadata == o.metadata &&
      usage == o.usage
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


205
206
207
 
# File 'lib/openapi_openai/models/realtime_response.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



211
212
213
 
# File 'lib/openapi_openai/models/realtime_response.rb', line 211

def hash
  [id, object, status, status_details, output, metadata, usage].hash
end

#list_invalid_properties ⇒ Object

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



152
153
154
155
156
 
# File 'lib/openapi_openai/models/realtime_response.rb', line 152

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

#to_hash ⇒ Hash

Returns the object in the form of hash



240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/openapi_openai/models/realtime_response.rb', line 240

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



160
161
162
163
164
165
166
167
 
# File 'lib/openapi_openai/models/realtime_response.rb', line 160

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  object_validator = EnumAttributeValidator.new('String', ["realtime.response"])
  return false unless object_validator.valid?(@object)
  status_validator = EnumAttributeValidator.new('String', ["completed", "cancelled", "failed", "incomplete"])
  return false unless status_validator.valid?(@status)
  true
end