Class: OpenApiOpenAIClient::RealtimeServerEventInputAudioBufferCommitted

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

Overview

Returned when an input audio buffer is committed, either by the client or automatically in server VAD mode. The item_id property is the ID of the user message item that will be created, thus a conversation.item.created event will also be sent to the client.

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

Initializes the object



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/realtime_server_event_input_audio_buffer_committed.rb', line 91

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

  if attributes.key?(:'item_id')
    self.item_id = attributes[:'item_id']
  else
    self.item_id = 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_input_audio_buffer_committed.rb', line 20

def event_id
  @event_id
end

#item_id ⇒ Object

The ID of the user message item that will be created.



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

def item_id
  @item_id
end

#previous_item_id ⇒ Object

The ID of the preceding item after which the new item will be inserted.



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

def previous_item_id
  @previous_item_id
end

#type ⇒ Object

The event type, must be input_audio_buffer.committed.



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

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



64
65
66
 
# File 'lib/openapi_openai/models/realtime_server_event_input_audio_buffer_committed.rb', line 64

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



69
70
71
 
# File 'lib/openapi_openai/models/realtime_server_event_input_audio_buffer_committed.rb', line 69

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'event_id' => :'event_id',
    :'type' => :'type',
    :'previous_item_id' => :'previous_item_id',
    :'item_id' => :'item_id'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



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

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'event_id' => :'String',
    :'type' => :'String',
    :'previous_item_id' => :'String',
    :'item_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



209
210
211
212
213
214
215
216
 
# File 'lib/openapi_openai/models/realtime_server_event_input_audio_buffer_committed.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      event_id == o.event_id &&
      type == o.type &&
      previous_item_id == o.previous_item_id &&
      item_id == o.item_id
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


220
221
222
 
# File 'lib/openapi_openai/models/realtime_server_event_input_audio_buffer_committed.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



226
227
228
 
# File 'lib/openapi_openai/models/realtime_server_event_input_audio_buffer_committed.rb', line 226

def hash
  [event_id, type, previous_item_id, item_id].hash
end

#list_invalid_properties ⇒ Object

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



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

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 @previous_item_id.nil?
    invalid_properties.push('invalid value for "previous_item_id", previous_item_id cannot be nil.')
  end

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/openapi_openai/models/realtime_server_event_input_audio_buffer_committed.rb', line 255

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



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/openapi_openai/models/realtime_server_event_input_audio_buffer_committed.rb', line 156

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', ["input_audio_buffer.committed"])
  return false unless type_validator.valid?(@type)
  return false if @previous_item_id.nil?
  return false if @item_id.nil?
  true
end