Class: OpenApiOpenAIClient::RealtimeServerEventResponseOutputItemDone

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

Overview

Returned when an Item is done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/openapi_openai/models/realtime_server_event_response_output_item_done.rb', line 95

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

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

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

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

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

Instance Attribute Details

#event_id ⇒ Object

The unique ID of the server event.



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

def event_id
  @event_id
end

#item ⇒ Object

Returns the value of attribute item.



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

def item
  @item
end

#output_index ⇒ Object

The index of the output item in the Response.



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

def output_index
  @output_index
end

#response_id ⇒ Object

The ID of the Response to which the item belongs.



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

def response_id
  @response_id
end

#type ⇒ Object

The event type, must be response.output_item.done.



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

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



67
68
69
 
# File 'lib/openapi_openai/models/realtime_server_event_response_output_item_done.rb', line 67

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



72
73
74
 
# File 'lib/openapi_openai/models/realtime_server_event_response_output_item_done.rb', line 72

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
 
# File 'lib/openapi_openai/models/realtime_server_event_response_output_item_done.rb', line 56

def self.attribute_map
  {
    :'event_id' => :'event_id',
    :'type' => :'type',
    :'response_id' => :'response_id',
    :'output_index' => :'output_index',
    :'item' => :'item'
  }
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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/openapi_openai/models/realtime_server_event_response_output_item_done.rb', line 259

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
 
# File 'lib/openapi_openai/models/realtime_server_event_response_output_item_done.rb', line 77

def self.openapi_types
  {
    :'event_id' => :'String',
    :'type' => :'String',
    :'response_id' => :'String',
    :'output_index' => :'Integer',
    :'item' => :'RealtimeConversationItem'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



234
235
236
237
238
239
240
241
242
 
# File 'lib/openapi_openai/models/realtime_server_event_response_output_item_done.rb', line 234

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      event_id == o.event_id &&
      type == o.type &&
      response_id == o.response_id &&
      output_index == o.output_index &&
      item == o.item
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


246
247
248
 
# File 'lib/openapi_openai/models/realtime_server_event_response_output_item_done.rb', line 246

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



252
253
254
 
# File 'lib/openapi_openai/models/realtime_server_event_response_output_item_done.rb', line 252

def hash
  [event_id, type, response_id, output_index, item].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



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

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

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

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

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

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



281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/openapi_openai/models/realtime_server_event_response_output_item_done.rb', line 281

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



170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/openapi_openai/models/realtime_server_event_response_output_item_done.rb', line 170

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @event_id.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["response.output_item.done"])
  return false unless type_validator.valid?(@type)
  return false if @response_id.nil?
  return false if @output_index.nil?
  return false if @item.nil?
  true
end