Class: OpenApiOpenAIClient::CreateChatCompletionRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateChatCompletionRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 149

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::CreateChatCompletionRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenApiOpenAIClient::CreateChatCompletionRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.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
  else
    self.messages = nil
  end

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

  if attributes.key?(:'frequency_penalty')
    self.frequency_penalty = attributes[:'frequency_penalty']
  else
    self.frequency_penalty = 0
  end

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

  if attributes.key?(:'logprobs')
    self.logprobs = attributes[:'logprobs']
  else
    self.logprobs = false
  end

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

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

  if attributes.key?(:'n')
    self.n = attributes[:'n']
  else
    self.n = 1
  end

  if attributes.key?(:'presence_penalty')
    self.presence_penalty = attributes[:'presence_penalty']
  else
    self.presence_penalty = 0
  end

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

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

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

  if attributes.key?(:'stream')
    self.stream = attributes[:'stream']
  else
    self.stream = false
  end

  if attributes.key?(:'temperature')
    self.temperature = attributes[:'temperature']
  else
    self.temperature = 1
  end

  if attributes.key?(:'top_p')
    self.top_p = attributes[:'top_p']
  else
    self.top_p = 1
  end

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

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

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

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

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

Instance Attribute Details

#frequency_penaltyObject

Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model’s likelihood to repeat the same line verbatim. [See more information about frequency and presence penalties.](/docs/guides/text-generation/parameter-details)



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

def frequency_penalty
  @frequency_penalty
end

#function_callObject

Returns the value of attribute function_call.



68
69
70
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 68

def function_call
  @function_call
end

#functionsObject

Deprecated in favor of ‘tools`. A list of functions the model may generate JSON inputs for.



71
72
73
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 71

def functions
  @functions
end

#logit_biasObject

Modify the likelihood of specified tokens appearing in the completion. Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.



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

def logit_bias
  @logit_bias
end

#logprobsObject

Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the ‘content` of `message`.



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

def logprobs
  @logprobs
end

#max_tokensObject

The maximum number of [tokens](/tokenizer) that can be generated in the chat completion. The total length of input tokens and generated tokens is limited by the model’s context length. [Example Python code](cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.



36
37
38
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 36

def max_tokens
  @max_tokens
end

#messagesObject

A list of messages comprising the conversation so far. [Example Python code](cookbook.openai.com/examples/how_to_format_inputs_to_chatgpt_models).



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

def messages
  @messages
end

#modelObject

Returns the value of attribute model.



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

def model
  @model
end

#nObject

How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep ‘n` as `1` to minimize costs.



39
40
41
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 39

def n
  @n
end

#presence_penaltyObject

Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model’s likelihood to talk about new topics. [See more information about frequency and presence penalties.](/docs/guides/text-generation/parameter-details)



42
43
44
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 42

def presence_penalty
  @presence_penalty
end

#response_formatObject

Returns the value of attribute response_format.



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

def response_format
  @response_format
end

#seedObject

This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same ‘seed` and parameters should return the same result. Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.



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

def seed
  @seed
end

#stopObject

Returns the value of attribute stop.



49
50
51
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 49

def stop
  @stop
end

#streamObject

If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a ‘data: [DONE]` message. [Example Python code](cookbook.openai.com/examples/how_to_stream_completions).



52
53
54
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 52

def stream
  @stream
end

#temperatureObject

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or ‘top_p` but not both.



55
56
57
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 55

def temperature
  @temperature
end

#tool_choiceObject

Returns the value of attribute tool_choice.



63
64
65
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 63

def tool_choice
  @tool_choice
end

#toolsObject

A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.



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

def tools
  @tools
end

#top_logprobsObject

An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. ‘logprobs` must be set to `true` if this parameter is used.



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

def top_logprobs
  @top_logprobs
end

#top_pObject

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or ‘temperature` but not both.



58
59
60
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 58

def top_p
  @top_p
end

#userObject

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).



66
67
68
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 66

def user
  @user
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 575

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = OpenApiOpenAIClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



100
101
102
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 100

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 74

def self.attribute_map
  {
    :'messages' => :'messages',
    :'model' => :'model',
    :'frequency_penalty' => :'frequency_penalty',
    :'logit_bias' => :'logit_bias',
    :'logprobs' => :'logprobs',
    :'top_logprobs' => :'top_logprobs',
    :'max_tokens' => :'max_tokens',
    :'n' => :'n',
    :'presence_penalty' => :'presence_penalty',
    :'response_format' => :'response_format',
    :'seed' => :'seed',
    :'stop' => :'stop',
    :'stream' => :'stream',
    :'temperature' => :'temperature',
    :'top_p' => :'top_p',
    :'tools' => :'tools',
    :'tool_choice' => :'tool_choice',
    :'user' => :'user',
    :'function_call' => :'function_call',
    :'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



551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 551

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_nullableObject

List of attributes with nullable: true



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 131

def self.openapi_nullable
  Set.new([
    :'frequency_penalty',
    :'logit_bias',
    :'logprobs',
    :'top_logprobs',
    :'max_tokens',
    :'n',
    :'presence_penalty',
    :'seed',
    :'stream',
    :'temperature',
    :'top_p',
  ])
end

.openapi_typesObject

Attribute type mapping.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 105

def self.openapi_types
  {
    :'messages' => :'Array<ChatCompletionRequestMessage>',
    :'model' => :'CreateChatCompletionRequestModel',
    :'frequency_penalty' => :'Float',
    :'logit_bias' => :'Hash<String, Integer>',
    :'logprobs' => :'Boolean',
    :'top_logprobs' => :'Integer',
    :'max_tokens' => :'Integer',
    :'n' => :'Integer',
    :'presence_penalty' => :'Float',
    :'response_format' => :'CreateChatCompletionRequestResponseFormat',
    :'seed' => :'Integer',
    :'stop' => :'CreateChatCompletionRequestStop',
    :'stream' => :'Boolean',
    :'temperature' => :'Float',
    :'top_p' => :'Float',
    :'tools' => :'Array<ChatCompletionTool>',
    :'tool_choice' => :'ChatCompletionToolChoiceOption',
    :'user' => :'String',
    :'function_call' => :'CreateChatCompletionRequestFunctionCall',
    :'functions' => :'Array<ChatCompletionFunctions>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 511

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      messages == o.messages &&
      model == o.model &&
      frequency_penalty == o.frequency_penalty &&
      logit_bias == o.logit_bias &&
      logprobs == o.logprobs &&
      top_logprobs == o.top_logprobs &&
      max_tokens == o.max_tokens &&
      n == o.n &&
      presence_penalty == o.presence_penalty &&
      response_format == o.response_format &&
      seed == o.seed &&
      stop == o.stop &&
      stream == o.stream &&
      temperature == o.temperature &&
      top_p == o.top_p &&
      tools == o.tools &&
      tool_choice == o.tool_choice &&
      user == o.user &&
      function_call == o.function_call &&
      functions == o.functions
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



646
647
648
649
650
651
652
653
654
655
656
657
658
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 646

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


538
539
540
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 538

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



544
545
546
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 544

def hash
  [messages, model, frequency_penalty, logit_bias, logprobs, top_logprobs, max_tokens, n, presence_penalty, response_format, seed, stop, stream, temperature, top_p, tools, tool_choice, user, function_call, functions].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 271

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @messages.nil?
    invalid_properties.push('invalid value for "messages", messages cannot be nil.')
  end

  if @messages.length < 1
    invalid_properties.push('invalid value for "messages", number of items must be greater than or equal to 1.')
  end

  if @model.nil?
    invalid_properties.push('invalid value for "model", model cannot be nil.')
  end

  if !@frequency_penalty.nil? && @frequency_penalty > 2
    invalid_properties.push('invalid value for "frequency_penalty", must be smaller than or equal to 2.')
  end

  if !@frequency_penalty.nil? && @frequency_penalty < -2
    invalid_properties.push('invalid value for "frequency_penalty", must be greater than or equal to -2.')
  end

  if !@top_logprobs.nil? && @top_logprobs > 20
    invalid_properties.push('invalid value for "top_logprobs", must be smaller than or equal to 20.')
  end

  if !@top_logprobs.nil? && @top_logprobs < 0
    invalid_properties.push('invalid value for "top_logprobs", must be greater than or equal to 0.')
  end

  if !@n.nil? && @n > 128
    invalid_properties.push('invalid value for "n", must be smaller than or equal to 128.')
  end

  if !@n.nil? && @n < 1
    invalid_properties.push('invalid value for "n", must be greater than or equal to 1.')
  end

  if !@presence_penalty.nil? && @presence_penalty > 2
    invalid_properties.push('invalid value for "presence_penalty", must be smaller than or equal to 2.')
  end

  if !@presence_penalty.nil? && @presence_penalty < -2
    invalid_properties.push('invalid value for "presence_penalty", must be greater than or equal to -2.')
  end

  if !@seed.nil? && @seed > 9223372036854775807
    invalid_properties.push('invalid value for "seed", must be smaller than or equal to 9223372036854775807.')
  end

  if !@seed.nil? && @seed < -9223372036854775808
    invalid_properties.push('invalid value for "seed", must be greater than or equal to -9223372036854775808.')
  end

  if !@temperature.nil? && @temperature > 2
    invalid_properties.push('invalid value for "temperature", must be smaller than or equal to 2.')
  end

  if !@temperature.nil? && @temperature < 0
    invalid_properties.push('invalid value for "temperature", must be greater than or equal to 0.')
  end

  if !@top_p.nil? && @top_p > 1
    invalid_properties.push('invalid value for "top_p", must be smaller than or equal to 1.')
  end

  if !@top_p.nil? && @top_p < 0
    invalid_properties.push('invalid value for "top_p", must be greater than or equal to 0.')
  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_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



622
623
624
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 622

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



628
629
630
631
632
633
634
635
636
637
638
639
640
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 628

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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



616
617
618
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 616

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
# File 'lib/openapi_openai/models/create_chat_completion_request.rb', line 355

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @messages.nil?
  return false if @messages.length < 1
  return false if @model.nil?
  return false if !@frequency_penalty.nil? && @frequency_penalty > 2
  return false if !@frequency_penalty.nil? && @frequency_penalty < -2
  return false if !@top_logprobs.nil? && @top_logprobs > 20
  return false if !@top_logprobs.nil? && @top_logprobs < 0
  return false if !@n.nil? && @n > 128
  return false if !@n.nil? && @n < 1
  return false if !@presence_penalty.nil? && @presence_penalty > 2
  return false if !@presence_penalty.nil? && @presence_penalty < -2
  return false if !@seed.nil? && @seed > 9223372036854775807
  return false if !@seed.nil? && @seed < -9223372036854775808
  return false if !@temperature.nil? && @temperature > 2
  return false if !@temperature.nil? && @temperature < 0
  return false if !@top_p.nil? && @top_p > 1
  return false if !@top_p.nil? && @top_p < 0
  return false if !@functions.nil? && @functions.length > 128
  return false if !@functions.nil? && @functions.length < 1
  true
end