Class: OpenApiOpenAIClient::RealtimeClientEventConversationItemCreate

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

Overview

Add a new Item to the Conversation’s context, including messages, function calls, and function call responses. This event can be used both to populate a "history" of the conversation and to add new items mid-stream, but has the current limitation that it cannot populate assistant audio messages. If successful, the server will respond with a conversation.item.created event, otherwise an error event will be sent.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

Instance Attribute Details

#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_create.rb', line 20

def event_id
  @event_id
end

#item ⇒ Object

Returns the value of attribute item.



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

def item
  @item
end

#previous_item_id ⇒ Object

The ID of the preceding item after which the new item will be inserted. If not set, the new item will be appended to the end of the conversation. If set, it allows an item to be inserted mid-conversation. If the ID cannot be found, an error will be returned and the item will not be added.



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

def previous_item_id
  @previous_item_id
end

#type ⇒ Object

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



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

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



63
64
65
 
# File 'lib/openapi_openai/models/realtime_client_event_conversation_item_create.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/realtime_client_event_conversation_item_create.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/realtime_client_event_conversation_item_create.rb', line 53

def self.attribute_map
  {
    :'event_id' => :'event_id',
    :'type' => :'type',
    :'previous_item_id' => :'previous_item_id',
    :'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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/openapi_openai/models/realtime_client_event_conversation_item_create.rb', line 198

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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



174
175
176
177
178
179
180
181
 
# File 'lib/openapi_openai/models/realtime_client_event_conversation_item_create.rb', line 174

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 == o.item
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


185
186
187
 
# File 'lib/openapi_openai/models/realtime_client_event_conversation_item_create.rb', line 185

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



191
192
193
 
# File 'lib/openapi_openai/models/realtime_client_event_conversation_item_create.rb', line 191

def hash
  [event_id, type, previous_item_id, 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



127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/openapi_openai/models/realtime_client_event_conversation_item_create.rb', line 127

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.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



220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/openapi_openai/models/realtime_client_event_conversation_item_create.rb', line 220

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



143
144
145
146
147
148
149
150
 
# File 'lib/openapi_openai/models/realtime_client_event_conversation_item_create.rb', line 143

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