Class: OpenApiOpenAIClient::FineTuneChatCompletionRequestAssistantMessage

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

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/openapi_openai/models/fine_tune_chat_completion_request_assistant_message.rb', line 118

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

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

Instance Attribute Details

#audio ⇒ Object

Returns the value of attribute audio.



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

def audio
  @audio
end

#content ⇒ Object

Returns the value of attribute content.



18
19
20
 
# File 'lib/openapi_openai/models/fine_tune_chat_completion_request_assistant_message.rb', line 18

def content
  @content
end

#function_call ⇒ Object

Returns the value of attribute function_call.



34
35
36
 
# File 'lib/openapi_openai/models/fine_tune_chat_completion_request_assistant_message.rb', line 34

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.



27
28
29
 
# File 'lib/openapi_openai/models/fine_tune_chat_completion_request_assistant_message.rb', line 27

def name
  @name
end

#refusal ⇒ Object

The refusal message by the assistant.



21
22
23
 
# File 'lib/openapi_openai/models/fine_tune_chat_completion_request_assistant_message.rb', line 21

def refusal
  @refusal
end

#role ⇒ Object

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



24
25
26
 
# File 'lib/openapi_openai/models/fine_tune_chat_completion_request_assistant_message.rb', line 24

def role
  @role
end

#tool_calls ⇒ Object

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



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

def tool_calls
  @tool_calls
end

#weight ⇒ Object

Controls whether the assistant message is trained against (0 or 1)



37
38
39
 
# File 'lib/openapi_openai/models/fine_tune_chat_completion_request_assistant_message.rb', line 37

def weight
  @weight
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



76
77
78
 
# File 'lib/openapi_openai/models/fine_tune_chat_completion_request_assistant_message.rb', line 76

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/openapi_openai/models/fine_tune_chat_completion_request_assistant_message.rb', line 81

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/openapi_openai/models/fine_tune_chat_completion_request_assistant_message.rb', line 62

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

List of class defined in allOf (OpenAPI v3)



110
111
112
113
114
 
# File 'lib/openapi_openai/models/fine_tune_chat_completion_request_assistant_message.rb', line 110

def self.openapi_all_of
  [
  :'ChatCompletionRequestAssistantMessage'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
104
105
106
107
 
# File 'lib/openapi_openai/models/fine_tune_chat_completion_request_assistant_message.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/openapi_openai/models/fine_tune_chat_completion_request_assistant_message.rb', line 86

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


230
231
232
 
# File 'lib/openapi_openai/models/fine_tune_chat_completion_request_assistant_message.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/fine_tune_chat_completion_request_assistant_message.rb', line 236

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



171
172
173
174
175
176
177
178
179
 
# File 'lib/openapi_openai/models/fine_tune_chat_completion_request_assistant_message.rb', line 171

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



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/openapi_openai/models/fine_tune_chat_completion_request_assistant_message.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



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

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)
  weight_validator = EnumAttributeValidator.new('Integer', [0, 1])
  return false unless weight_validator.valid?(@weight)
  true
end