Class: OpenApiOpenAIClient::CreateThreadAndRunRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateThreadAndRunRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/openapi_openai/models/create_thread_and_run_request.rb', line 111

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#assistant_id ⇒ Object

The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run.



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

def assistant_id
  @assistant_id
end

#instructions ⇒ Object

Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.



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

def instructions
  @instructions
end

#max_completion_tokens ⇒ Object

The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status ‘incomplete`. See `incomplete_details` for more info.



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

def max_completion_tokens
  @max_completion_tokens
end

#max_prompt_tokens ⇒ Object

The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status ‘complete`. See `incomplete_details` for more info.



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

def max_prompt_tokens
  @max_prompt_tokens
end

#metadata ⇒ Object

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.



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

def metadata
  @metadata
end

#model ⇒ Object

Returns the value of attribute model.



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

def model
  @model
end

#response_format ⇒ Object

Returns the value of attribute response_format.



50
51
52
 
# File 'lib/openapi_openai/models/create_thread_and_run_request.rb', line 50

def response_format
  @response_format
end

#stream ⇒ Object

If ‘true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.



38
39
40
 
# File 'lib/openapi_openai/models/create_thread_and_run_request.rb', line 38

def stream
  @stream
end

#temperature ⇒ Object

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.



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

def temperature
  @temperature
end

#thread ⇒ Object

Returns the value of attribute thread.



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

def thread
  @thread
end

#tool_choice ⇒ Object

Returns the value of attribute tool_choice.



48
49
50
 
# File 'lib/openapi_openai/models/create_thread_and_run_request.rb', line 48

def tool_choice
  @tool_choice
end

#tools ⇒ Object

Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.



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

def tools
  @tools
end

#truncation_strategy ⇒ Object

Returns the value of attribute truncation_strategy.



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

def truncation_strategy
  @truncation_strategy
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



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/openapi_openai/models/create_thread_and_run_request.rb', line 331

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_attributes ⇒ Object

Returns all the JSON keys this model knows about



72
73
74
 
# File 'lib/openapi_openai/models/create_thread_and_run_request.rb', line 72

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/openapi_openai/models/create_thread_and_run_request.rb', line 53

def self.attribute_map
  {
    :'assistant_id' => :'assistant_id',
    :'thread' => :'thread',
    :'model' => :'model',
    :'instructions' => :'instructions',
    :'tools' => :'tools',
    :'metadata' => :'metadata',
    :'temperature' => :'temperature',
    :'stream' => :'stream',
    :'max_prompt_tokens' => :'max_prompt_tokens',
    :'max_completion_tokens' => :'max_completion_tokens',
    :'truncation_strategy' => :'truncation_strategy',
    :'tool_choice' => :'tool_choice',
    :'response_format' => :'response_format'
  }
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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/openapi_openai/models/create_thread_and_run_request.rb', line 307

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
104
105
106
107
 
# File 'lib/openapi_openai/models/create_thread_and_run_request.rb', line 96

def self.openapi_nullable
  Set.new([
    :'model',
    :'instructions',
    :'tools',
    :'metadata',
    :'temperature',
    :'stream',
    :'max_prompt_tokens',
    :'max_completion_tokens',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/openapi_openai/models/create_thread_and_run_request.rb', line 77

def self.openapi_types
  {
    :'assistant_id' => :'String',
    :'thread' => :'CreateThreadRequest',
    :'model' => :'CreateRunRequestModel',
    :'instructions' => :'String',
    :'tools' => :'Array<CreateThreadAndRunRequestToolsInner>',
    :'metadata' => :'Object',
    :'temperature' => :'Float',
    :'stream' => :'Boolean',
    :'max_prompt_tokens' => :'Integer',
    :'max_completion_tokens' => :'Integer',
    :'truncation_strategy' => :'TruncationObject',
    :'tool_choice' => :'AssistantsApiToolChoiceOption',
    :'response_format' => :'AssistantsApiResponseFormatOption'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/openapi_openai/models/create_thread_and_run_request.rb', line 274

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      assistant_id == o.assistant_id &&
      thread == o.thread &&
      model == o.model &&
      instructions == o.instructions &&
      tools == o.tools &&
      metadata == o.metadata &&
      temperature == o.temperature &&
      stream == o.stream &&
      max_prompt_tokens == o.max_prompt_tokens &&
      max_completion_tokens == o.max_completion_tokens &&
      truncation_strategy == o.truncation_strategy &&
      tool_choice == o.tool_choice &&
      response_format == o.response_format
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



402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/openapi_openai/models/create_thread_and_run_request.rb', line 402

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


294
295
296
 
# File 'lib/openapi_openai/models/create_thread_and_run_request.rb', line 294

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



300
301
302
 
# File 'lib/openapi_openai/models/create_thread_and_run_request.rb', line 300

def hash
  [assistant_id, thread, model, instructions, tools, metadata, temperature, stream, max_prompt_tokens, max_completion_tokens, truncation_strategy, tool_choice, response_format].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



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
 
# File 'lib/openapi_openai/models/create_thread_and_run_request.rb', line 185

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



378
379
380
 
# File 'lib/openapi_openai/models/create_thread_and_run_request.rb', line 378

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/openapi_openai/models/create_thread_and_run_request.rb', line 384

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



372
373
374
 
# File 'lib/openapi_openai/models/create_thread_and_run_request.rb', line 372

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @assistant_id.nil?
  return false if !@tools.nil? && @tools.length > 20
  return false if !@temperature.nil? && @temperature > 2
  return false if !@temperature.nil? && @temperature < 0
  return false if !@max_prompt_tokens.nil? && @max_prompt_tokens < 256
  return false if !@max_completion_tokens.nil? && @max_completion_tokens < 256
  true
end