Class: OpenApiOpenAIClient::RealtimeConversationItem

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

Overview

The item to add to the conversation.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/openapi_openai/models/realtime_conversation_item.rb', line 121

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#arguments ⇒ Object

The arguments of the function call (for function_call items).



44
45
46
 
# File 'lib/openapi_openai/models/realtime_conversation_item.rb', line 44

def arguments
  @arguments
end

#call_id ⇒ Object

The ID of the function call (for function_call and function_call_output items). If passed on a function_call_output item, the server will check that a function_call item with the same ID exists in the conversation history.



38
39
40
 
# File 'lib/openapi_openai/models/realtime_conversation_item.rb', line 38

def call_id
  @call_id
end

#content ⇒ Object

The content of the message, applicable for message items. - Message items of role system support only input_text content - Message items of role user support input_text and input_audio content - Message items of role assistant support text content.



35
36
37
 
# File 'lib/openapi_openai/models/realtime_conversation_item.rb', line 35

def content
  @content
end

#id ⇒ Object

The unique ID of the item, this can be generated by the client to help manage server-side context, but is not required because the server will generate one if not provided.



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

def id
  @id
end

#name ⇒ Object

The name of the function being called (for function_call items).



41
42
43
 
# File 'lib/openapi_openai/models/realtime_conversation_item.rb', line 41

def name
  @name
end

#object ⇒ Object

Identifier for the API object being returned - always realtime.item.



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

def object
  @object
end

#output ⇒ Object

The output of the function call (for function_call_output items).



47
48
49
 
# File 'lib/openapi_openai/models/realtime_conversation_item.rb', line 47

def output
  @output
end

#role ⇒ Object

The role of the message sender (user, assistant, system), only applicable for message items.



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

def role
  @role
end

#status ⇒ Object

The status of the item (completed, incomplete). These have no effect on the conversation, but are accepted for consistency with the conversation.item.created event.



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

def status
  @status
end

#type ⇒ Object

The type of the item (message, function_call, function_call_output).



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

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



93
94
95
 
# File 'lib/openapi_openai/models/realtime_conversation_item.rb', line 93

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/openapi_openai/models/realtime_conversation_item.rb', line 72

def self.attribute_map
  {
    :'id' => :'id',
    :'type' => :'type',
    :'object' => :'object',
    :'status' => :'status',
    :'role' => :'role',
    :'content' => :'content',
    :'call_id' => :'call_id',
    :'name' => :'name',
    :'arguments' => :'arguments',
    :'output' => :'output'
  }
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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/openapi_openai/models/realtime_conversation_item.rb', line 273

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



114
115
116
117
 
# File 'lib/openapi_openai/models/realtime_conversation_item.rb', line 114

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

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/openapi_openai/models/realtime_conversation_item.rb', line 98

def self.openapi_types
  {
    :'id' => :'String',
    :'type' => :'String',
    :'object' => :'String',
    :'status' => :'String',
    :'role' => :'String',
    :'content' => :'Array<RealtimeConversationItemContentInner>',
    :'call_id' => :'String',
    :'name' => :'String',
    :'arguments' => :'String',
    :'output' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/openapi_openai/models/realtime_conversation_item.rb', line 243

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      type == o.type &&
      object == o.object &&
      status == o.status &&
      role == o.role &&
      content == o.content &&
      call_id == o.call_id &&
      name == o.name &&
      arguments == o.arguments &&
      output == o.output
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


260
261
262
 
# File 'lib/openapi_openai/models/realtime_conversation_item.rb', line 260

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



266
267
268
 
# File 'lib/openapi_openai/models/realtime_conversation_item.rb', line 266

def hash
  [id, type, object, status, role, content, call_id, name, arguments, output].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



180
181
182
183
184
 
# File 'lib/openapi_openai/models/realtime_conversation_item.rb', line 180

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

Returns:

  • (Hash) —

    Returns the object in the form of hash



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/openapi_openai/models/realtime_conversation_item.rb', line 295

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



188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/openapi_openai/models/realtime_conversation_item.rb', line 188

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["message", "function_call", "function_call_output"])
  return false unless type_validator.valid?(@type)
  object_validator = EnumAttributeValidator.new('String', ["realtime.item"])
  return false unless object_validator.valid?(@object)
  status_validator = EnumAttributeValidator.new('String', ["completed", "incomplete"])
  return false unless status_validator.valid?(@status)
  role_validator = EnumAttributeValidator.new('String', ["user", "assistant", "system"])
  return false unless role_validator.valid?(@role)
  true
end