Class: OpenApiOpenAIClient::ChatCompletionRequestAssistantMessage

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

Overview

Messages sent by the model in response to user messages.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
148
149
150
151
152
 
# File 'lib/openapi_openai/models/chat_completion_request_assistant_message.rb', line 107

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

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

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

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

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

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

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

Instance Attribute Details

#audio ⇒ Object

Returns the value of attribute audio.



30
31
32
 
# File 'lib/openapi_openai/models/chat_completion_request_assistant_message.rb', line 30

def audio
  @audio
end

#content ⇒ Object

Returns the value of attribute content.



19
20
21
 
# File 'lib/openapi_openai/models/chat_completion_request_assistant_message.rb', line 19

def content
  @content
end

#function_call ⇒ Object

Returns the value of attribute function_call.



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

def function_call
  @function_call
end

#name ⇒ Object

An optional name for the participant. Provides the model information to differentiate between participants of the same role.



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

def name
  @name
end

#refusal ⇒ Object

The refusal message by the assistant.



22
23
24
 
# File 'lib/openapi_openai/models/chat_completion_request_assistant_message.rb', line 22

def refusal
  @refusal
end

#role ⇒ Object

The role of the messages author, in this case assistant.



25
26
27
 
# File 'lib/openapi_openai/models/chat_completion_request_assistant_message.rb', line 25

def role
  @role
end

#tool_calls ⇒ Object

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



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

def tool_calls
  @tool_calls
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/openapi_openai/models/chat_completion_request_assistant_message.rb', line 78

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/openapi_openai/models/chat_completion_request_assistant_message.rb', line 60

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/openapi_openai/models/chat_completion_request_assistant_message.rb', line 215

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



96
97
98
99
100
101
102
103
 
# File 'lib/openapi_openai/models/chat_completion_request_assistant_message.rb', line 96

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/openapi_openai/models/chat_completion_request_assistant_message.rb', line 83

def self.openapi_types
  {
    :'content' => :'ChatCompletionRequestAssistantMessageContent',
    :'refusal' => :'String',
    :'role' => :'String',
    :'name' => :'String',
    :'audio' => :'ChatCompletionRequestAssistantMessageAudio',
    :'tool_calls' => :'Array<ChatCompletionMessageToolCall>',
    :'function_call' => :'ChatCompletionRequestAssistantMessageFunctionCall'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



208
209
210
 
# File 'lib/openapi_openai/models/chat_completion_request_assistant_message.rb', line 208

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



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

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



237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/openapi_openai/models/chat_completion_request_assistant_message.rb', line 237

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



168
169
170
171
172
173
174
 
# File 'lib/openapi_openai/models/chat_completion_request_assistant_message.rb', line 168

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