Class: OpenApiOpenAIClient::ChatCompletionResponseMessage

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

Overview

A chat completion message generated by the model.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
139
140
141
142
143
144
145
146
147
 
# File 'lib/openapi_openai/models/chat_completion_response_message.rb', line 102

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

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

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

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

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

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

Instance Attribute Details

#audio ⇒ Object

Returns the value of attribute audio.



33
34
35
 
# File 'lib/openapi_openai/models/chat_completion_response_message.rb', line 33

def audio
  @audio
end

#content ⇒ Object

The contents of the message.



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

def content
  @content
end

#function_call ⇒ Object

Returns the value of attribute function_call.



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

def function_call
  @function_call
end

#refusal ⇒ Object

The refusal message generated by the model.



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

def refusal
  @refusal
end

#role ⇒ Object

The role of the author of this message.



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

def role
  @role
end

#tool_calls ⇒ Object

The tool calls generated by the model, such as function calls.



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

def tool_calls
  @tool_calls
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



70
71
72
 
# File 'lib/openapi_openai/models/chat_completion_response_message.rb', line 70

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/openapi_openai/models/chat_completion_response_message.rb', line 75

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/openapi_openai/models/chat_completion_response_message.rb', line 58

def self.attribute_map
  {
    :'content' => :'content',
    :'refusal' => :'refusal',
    :'tool_calls' => :'tool_calls',
    :'role' => :'role',
    :'function_call' => :'function_call',
    :'audio' => :'audio'
  }
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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/openapi_openai/models/chat_completion_response_message.rb', line 209

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



92
93
94
95
96
97
98
 
# File 'lib/openapi_openai/models/chat_completion_response_message.rb', line 92

def self.openapi_nullable
  Set.new([
    :'content',
    :'refusal',
    :'audio'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/openapi_openai/models/chat_completion_response_message.rb', line 80

def self.openapi_types
  {
    :'content' => :'String',
    :'refusal' => :'String',
    :'tool_calls' => :'Array<ChatCompletionMessageToolCall>',
    :'role' => :'String',
    :'function_call' => :'ChatCompletionResponseMessageFunctionCall',
    :'audio' => :'ChatCompletionResponseMessageAudio'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



183
184
185
186
187
188
189
190
191
192
 
# File 'lib/openapi_openai/models/chat_completion_response_message.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      content == o.content &&
      refusal == o.refusal &&
      tool_calls == o.tool_calls &&
      role == o.role &&
      function_call == o.function_call &&
      audio == o.audio
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


196
197
198
 
# File 'lib/openapi_openai/models/chat_completion_response_message.rb', line 196

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



202
203
204
 
# File 'lib/openapi_openai/models/chat_completion_response_message.rb', line 202

def hash
  [content, refusal, tool_calls, role, function_call, audio].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



151
152
153
154
155
156
157
158
159
 
# File 'lib/openapi_openai/models/chat_completion_response_message.rb', line 151

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @role.nil?
    invalid_properties.push('invalid value for "role", role 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



231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/openapi_openai/models/chat_completion_response_message.rb', line 231

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



163
164
165
166
167
168
169
 
# File 'lib/openapi_openai/models/chat_completion_response_message.rb', line 163

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @role.nil?
  role_validator = EnumAttributeValidator.new('String', ["assistant"])
  return false unless role_validator.valid?(@role)
  true
end