Class: OpenApiOpenAIClient::CreateRunRequest

Inherits:
ApiModelBase show all
Defined in:
lib/openapi_openai/models/create_run_request.rb

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

  if attributes.key?(:'additional_messages')
    if (value = attributes[:'additional_messages']).is_a?(Array)
      self.additional_messages = value
    end
  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?(:'top_p')
    self.top_p = attributes[:'top_p']
  else
    self.top_p = 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?(:'parallel_tool_calls')
    self.parallel_tool_calls = attributes[:'parallel_tool_calls']
  else
    self.parallel_tool_calls = true
  end

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

Instance Attribute Details

#additional_instructions ⇒ Object

Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.



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

def additional_instructions
  @additional_instructions
end

#additional_messages ⇒ Object

Adds additional messages to the thread before creating the run.



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

def additional_messages
  @additional_messages
end

#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_run_request.rb', line 19

def assistant_id
  @assistant_id
end

#instructions ⇒ Object

Overrides the [instructions](/docs/api-reference/assistants/createAssistant) of the assistant. This is useful for modifying the behavior on a per-run basis.



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

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.



51
52
53
 
# File 'lib/openapi_openai/models/create_run_request.rb', line 51

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 incomplete. See incomplete_details for more info.



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

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 maximum of 512 characters long.



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

def metadata
  @metadata
end

#model ⇒ Object

Returns the value of attribute model.



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

def model
  @model
end

#parallel_tool_calls ⇒ Object

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



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

def parallel_tool_calls
  @parallel_tool_calls
end

#response_format ⇒ Object

Returns the value of attribute response_format.



60
61
62
 
# File 'lib/openapi_openai/models/create_run_request.rb', line 60

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.



45
46
47
 
# File 'lib/openapi_openai/models/create_run_request.rb', line 45

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.



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

def temperature
  @temperature
end

#tool_choice ⇒ Object

Returns the value of attribute tool_choice.



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

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.



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

def tools
  @tools
end

#top_p ⇒ Object

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.



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

def top_p
  @top_p
end

#truncation_strategy ⇒ Object

Returns the value of attribute truncation_strategy.



53
54
55
 
# File 'lib/openapi_openai/models/create_run_request.rb', line 53

def truncation_strategy
  @truncation_strategy
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



85
86
87
 
# File 'lib/openapi_openai/models/create_run_request.rb', line 85

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/openapi_openai/models/create_run_request.rb', line 90

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/openapi_openai/models/create_run_request.rb', line 63

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



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/openapi_openai/models/create_run_request.rb', line 387

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/openapi_openai/models/create_run_request.rb', line 117

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

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/openapi_openai/models/create_run_request.rb', line 95

def self.openapi_types
  {
    :'assistant_id' => :'String',
    :'model' => :'CreateRunRequestModel',
    :'instructions' => :'String',
    :'additional_instructions' => :'String',
    :'additional_messages' => :'Array<CreateMessageRequest>',
    :'tools' => :'Array<AssistantObjectToolsInner>',
    :'metadata' => :'Object',
    :'temperature' => :'Float',
    :'top_p' => :'Float',
    :'stream' => :'Boolean',
    :'max_prompt_tokens' => :'Integer',
    :'max_completion_tokens' => :'Integer',
    :'truncation_strategy' => :'TruncationObject',
    :'tool_choice' => :'AssistantsApiToolChoiceOption',
    :'parallel_tool_calls' => :'Boolean',
    :'response_format' => :'AssistantsApiResponseFormatOption'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/openapi_openai/models/create_run_request.rb', line 351

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      assistant_id == o.assistant_id &&
      model == o.model &&
      instructions == o.instructions &&
      additional_instructions == o.additional_instructions &&
      additional_messages == o.additional_messages &&
      tools == o.tools &&
      metadata == o.metadata &&
      temperature == o.temperature &&
      top_p == o.top_p &&
      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 &&
      parallel_tool_calls == o.parallel_tool_calls &&
      response_format == o.response_format
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


374
375
376
 
# File 'lib/openapi_openai/models/create_run_request.rb', line 374

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



380
381
382
 
# File 'lib/openapi_openai/models/create_run_request.rb', line 380

def hash
  [assistant_id, model, instructions, additional_instructions, additional_messages, tools, metadata, temperature, top_p, stream, max_prompt_tokens, max_completion_tokens, truncation_strategy, tool_choice, parallel_tool_calls, 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



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

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 !@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 !@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_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/openapi_openai/models/create_run_request.rb', line 409

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



268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/openapi_openai/models/create_run_request.rb', line 268

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 !@top_p.nil? && @top_p > 1
  return false if !@top_p.nil? && @top_p < 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