Class: OpenApiOpenAIClient::RealtimeClientEventConversationItemTruncate

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

Overview

Send this event to truncate a previous assistant message’s audio. The server will produce audio faster than realtime, so this event is useful when the user interrupts to truncate audio that has already been sent to the client but not yet played. This will synchronize the server’s understanding of the audio with the client’s playback. Truncating audio will delete the server-side text transcript to ensure there is not text in the context that hasn’t been heard by the user. If successful, the server will respond with a conversation.item.truncated event.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

Instance Attribute Details

#audio_end_ms ⇒ Object

Inclusive duration up to which audio is truncated, in milliseconds. If the audio_end_ms is greater than the actual audio duration, the server will respond with an error.



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

def audio_end_ms
  @audio_end_ms
end

#content_index ⇒ Object

The index of the content part to truncate. Set this to 0.



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

def content_index
  @content_index
end

#event_id ⇒ Object

Optional client-generated ID used to identify this event.



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

def event_id
  @event_id
end

#item_id ⇒ Object

The ID of the assistant message item to truncate. Only assistant message items can be truncated.



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

def item_id
  @item_id
end

#type ⇒ Object

The event type, must be conversation.item.truncate.



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

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/openapi_openai/models/realtime_client_event_conversation_item_truncate.rb', line 73

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'event_id' => :'event_id',
    :'type' => :'type',
    :'item_id' => :'item_id',
    :'content_index' => :'content_index',
    :'audio_end_ms' => :'audio_end_ms'
  }
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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/openapi_openai/models/realtime_client_event_conversation_item_truncate.rb', line 243

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



218
219
220
221
222
223
224
225
226
 
# File 'lib/openapi_openai/models/realtime_client_event_conversation_item_truncate.rb', line 218

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


230
231
232
 
# File 'lib/openapi_openai/models/realtime_client_event_conversation_item_truncate.rb', line 230

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



236
237
238
 
# File 'lib/openapi_openai/models/realtime_client_event_conversation_item_truncate.rb', line 236

def hash
  [event_id, type, item_id, content_index, audio_end_ms].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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/openapi_openai/models/realtime_client_event_conversation_item_truncate.rb', line 141

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

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

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

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



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/openapi_openai/models/realtime_client_event_conversation_item_truncate.rb', line 265

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



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/openapi_openai/models/realtime_client_event_conversation_item_truncate.rb', line 165

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["conversation.item.truncate"])
  return false unless type_validator.valid?(@type)
  return false if @item_id.nil?
  return false if @content_index.nil?
  return false if @audio_end_ms.nil?
  true
end