Class: OpenApiOpenAIClient::FineTuneChatRequestInput

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

Overview

The per-line training example of a fine-tuning input file for chat models using the supervised method.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/openapi_openai/models/fine_tune_chat_request_input.rb', line 68

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

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

  if attributes.key?(:'parallel_tool_calls')
    self.parallel_tool_calls = attributes[:'parallel_tool_calls']
  else
    self.parallel_tool_calls = true
  end

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

Instance Attribute Details

#functions ⇒ Object

A list of functions the model may generate JSON inputs for.



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

def functions
  @functions
end

#messages ⇒ Object

Returns the value of attribute messages.



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

def messages
  @messages
end

#parallel_tool_calls ⇒ Object

Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.



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

def parallel_tool_calls
  @parallel_tool_calls
end

#tools ⇒ Object

A list of tools the model may generate JSON inputs for.



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

def tools
  @tools
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



46
47
48
 
# File 'lib/openapi_openai/models/fine_tune_chat_request_input.rb', line 46

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
 
# File 'lib/openapi_openai/models/fine_tune_chat_request_input.rb', line 31

def self.attribute_map
  {
    :'messages' => :'messages',
    :'tools' => :'tools',
    :'parallel_tool_calls' => :'parallel_tool_calls',
    :'functions' => :'functions'
  }
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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/openapi_openai/models/fine_tune_chat_request_input.rb', line 195

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



61
62
63
64
 
# File 'lib/openapi_openai/models/fine_tune_chat_request_input.rb', line 61

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

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
 
# File 'lib/openapi_openai/models/fine_tune_chat_request_input.rb', line 51

def self.openapi_types
  {
    :'messages' => :'Array<FineTuneChatRequestInputMessagesInner>',
    :'tools' => :'Array<ChatCompletionTool>',
    :'parallel_tool_calls' => :'Boolean',
    :'functions' => :'Array<ChatCompletionFunctions>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      messages == o.messages &&
      tools == o.tools &&
      parallel_tool_calls == o.parallel_tool_calls &&
      functions == o.functions
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


182
183
184
 
# File 'lib/openapi_openai/models/fine_tune_chat_request_input.rb', line 182

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



188
189
190
 
# File 'lib/openapi_openai/models/fine_tune_chat_request_input.rb', line 188

def hash
  [messages, tools, parallel_tool_calls, functions].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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/openapi_openai/models/fine_tune_chat_request_input.rb', line 109

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@messages.nil? && @messages.length < 1
    invalid_properties.push('invalid value for "messages", number of items must be greater than or equal to 1.')
  end

  if !@functions.nil? && @functions.length > 128
    invalid_properties.push('invalid value for "functions", number of items must be less than or equal to 128.')
  end

  if !@functions.nil? && @functions.length < 1
    invalid_properties.push('invalid value for "functions", number of items must be greater than or equal to 1.')
  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



217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/openapi_openai/models/fine_tune_chat_request_input.rb', line 217

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



129
130
131
132
133
134
135
 
# File 'lib/openapi_openai/models/fine_tune_chat_request_input.rb', line 129

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@messages.nil? && @messages.length < 1
  return false if !@functions.nil? && @functions.length > 128
  return false if !@functions.nil? && @functions.length < 1
  true
end