openai 0.18.1 → 0.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/README.md +1 -1
- data/lib/openai/client.rb +4 -0
- data/lib/openai/helpers/structured_output/boolean.rb +1 -0
- data/lib/openai/internal/conversation_cursor_page.rb +92 -0
- data/lib/openai/internal/transport/base_client.rb +1 -4
- data/lib/openai/internal/transport/pooled_net_requester.rb +1 -9
- data/lib/openai/internal/util.rb +1 -1
- data/lib/openai/models/audio/transcription.rb +1 -4
- data/lib/openai/models/audio/transcription_create_params.rb +2 -7
- data/lib/openai/models/audio/transcription_text_done_event.rb +1 -4
- data/lib/openai/models/beta/assistant_create_params.rb +6 -19
- data/lib/openai/models/beta/assistant_stream_event.rb +6 -24
- data/lib/openai/models/beta/assistant_update_params.rb +1 -4
- data/lib/openai/models/beta/message_stream_event.rb +1 -4
- data/lib/openai/models/beta/run_step_stream_event.rb +1 -4
- data/lib/openai/models/beta/thread_create_and_run_params.rb +10 -32
- data/lib/openai/models/beta/thread_create_params.rb +7 -22
- data/lib/openai/models/beta/threads/message.rb +3 -10
- data/lib/openai/models/beta/threads/message_create_params.rb +2 -7
- data/lib/openai/models/beta/threads/run.rb +2 -7
- data/lib/openai/models/beta/threads/run_create_params.rb +3 -10
- data/lib/openai/models/beta/threads/run_submit_tool_outputs_params.rb +1 -3
- data/lib/openai/models/beta/threads/runs/code_interpreter_tool_call.rb +5 -17
- data/lib/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rb +1 -3
- data/lib/openai/models/beta/threads/runs/file_search_tool_call.rb +4 -12
- data/lib/openai/models/beta/threads/runs/run_step_delta_message_delta.rb +1 -4
- data/lib/openai/models/beta/threads/runs/tool_calls_step_details.rb +1 -4
- data/lib/openai/models/beta/threads/text.rb +1 -4
- data/lib/openai/models/chat/chat_completion_chunk.rb +1 -3
- data/lib/openai/models/chat/chat_completion_custom_tool.rb +2 -7
- data/lib/openai/models/conversations/computer_screenshot_content.rb +38 -0
- data/lib/openai/models/conversations/container_file_citation_body.rb +58 -0
- data/lib/openai/models/conversations/conversation.rb +51 -0
- data/lib/openai/models/conversations/conversation_create_params.rb +39 -0
- data/lib/openai/models/conversations/conversation_delete_params.rb +16 -0
- data/lib/openai/models/conversations/conversation_deleted.rb +29 -0
- data/lib/openai/models/conversations/conversation_deleted_resource.rb +30 -0
- data/lib/openai/models/conversations/conversation_item.rb +568 -0
- data/lib/openai/models/conversations/conversation_item_list.rb +55 -0
- data/lib/openai/models/conversations/conversation_retrieve_params.rb +16 -0
- data/lib/openai/models/conversations/conversation_update_params.rb +31 -0
- data/lib/openai/models/conversations/file_citation_body.rb +42 -0
- data/lib/openai/models/conversations/input_file_content.rb +42 -0
- data/lib/openai/models/conversations/input_image_content.rb +62 -0
- data/lib/openai/models/conversations/input_text_content.rb +26 -0
- data/lib/openai/models/conversations/item_create_params.rb +37 -0
- data/lib/openai/models/conversations/item_delete_params.rb +22 -0
- data/lib/openai/models/conversations/item_list_params.rb +84 -0
- data/lib/openai/models/conversations/item_retrieve_params.rb +36 -0
- data/lib/openai/models/conversations/lob_prob.rb +35 -0
- data/lib/openai/models/conversations/message.rb +115 -0
- data/lib/openai/models/conversations/output_text_content.rb +57 -0
- data/lib/openai/models/conversations/refusal_content.rb +26 -0
- data/lib/openai/models/conversations/summary_text_content.rb +23 -0
- data/lib/openai/models/conversations/text_content.rb +23 -0
- data/lib/openai/models/conversations/top_log_prob.rb +29 -0
- data/lib/openai/models/conversations/url_citation_body.rb +50 -0
- data/lib/openai/models/eval_create_params.rb +6 -20
- data/lib/openai/models/evals/create_eval_completions_run_data_source.rb +29 -53
- data/lib/openai/models/evals/create_eval_jsonl_run_data_source.rb +1 -3
- data/lib/openai/models/evals/run_create_params.rb +18 -54
- data/lib/openai/models/fine_tuning/reinforcement_hyperparameters.rb +1 -4
- data/lib/openai/models/moderation.rb +5 -15
- data/lib/openai/models/responses/input_item_list_params.rb +1 -9
- data/lib/openai/models/responses/response.rb +26 -1
- data/lib/openai/models/responses/response_computer_tool_call.rb +2 -6
- data/lib/openai/models/responses/response_computer_tool_call_output_item.rb +1 -3
- data/lib/openai/models/responses/response_conversation_param.rb +20 -0
- data/lib/openai/models/responses/response_create_params.rb +34 -1
- data/lib/openai/models/responses/response_input_item.rb +2 -7
- data/lib/openai/models/responses/response_input_message_item.rb +1 -4
- data/lib/openai/models/responses/response_output_item.rb +1 -3
- data/lib/openai/models/responses/response_output_message.rb +1 -3
- data/lib/openai/models/responses/response_output_text.rb +3 -10
- data/lib/openai/models/responses/response_stream_event.rb +4 -16
- data/lib/openai/models/responses/response_text_delta_event.rb +1 -3
- data/lib/openai/models/responses/response_text_done_event.rb +1 -3
- data/lib/openai/models/responses/tool.rb +145 -34
- data/lib/openai/models.rb +2 -0
- data/lib/openai/resources/conversations/items.rb +141 -0
- data/lib/openai/resources/conversations.rb +112 -0
- data/lib/openai/resources/responses/input_items.rb +1 -3
- data/lib/openai/resources/responses.rb +6 -2
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +31 -0
- data/rbi/openai/client.rbi +3 -0
- data/rbi/openai/errors.rbi +5 -5
- data/rbi/openai/internal/conversation_cursor_page.rbi +25 -0
- data/rbi/openai/models/conversations/computer_screenshot_content.rbi +60 -0
- data/rbi/openai/models/conversations/container_file_citation_body.rbi +82 -0
- data/rbi/openai/models/conversations/conversation.rbi +76 -0
- data/rbi/openai/models/conversations/conversation_create_params.rbi +144 -0
- data/rbi/openai/models/conversations/conversation_delete_params.rbi +32 -0
- data/rbi/openai/models/conversations/conversation_deleted.rbi +40 -0
- data/rbi/openai/models/conversations/conversation_deleted_resource.rbi +40 -0
- data/rbi/openai/models/conversations/conversation_item.rbi +835 -0
- data/rbi/openai/models/conversations/conversation_item_list.rbi +101 -0
- data/rbi/openai/models/conversations/conversation_retrieve_params.rbi +32 -0
- data/rbi/openai/models/conversations/conversation_update_params.rbi +56 -0
- data/rbi/openai/models/conversations/file_citation_body.rbi +61 -0
- data/rbi/openai/models/conversations/input_file_content.rbi +72 -0
- data/rbi/openai/models/conversations/input_image_content.rbi +113 -0
- data/rbi/openai/models/conversations/input_text_content.rbi +38 -0
- data/rbi/openai/models/conversations/item_create_params.rbi +150 -0
- data/rbi/openai/models/conversations/item_delete_params.rbi +40 -0
- data/rbi/openai/models/conversations/item_list_params.rbi +174 -0
- data/rbi/openai/models/conversations/item_retrieve_params.rbi +70 -0
- data/rbi/openai/models/conversations/lob_prob.rbi +50 -0
- data/rbi/openai/models/conversations/message.rbi +196 -0
- data/rbi/openai/models/conversations/output_text_content.rbi +110 -0
- data/rbi/openai/models/conversations/refusal_content.rbi +38 -0
- data/rbi/openai/models/conversations/summary_text_content.rbi +31 -0
- data/rbi/openai/models/conversations/text_content.rbi +28 -0
- data/rbi/openai/models/conversations/top_log_prob.rbi +41 -0
- data/rbi/openai/models/conversations/url_citation_body.rbi +74 -0
- data/rbi/openai/models/evals/create_eval_completions_run_data_source.rbi +33 -33
- data/rbi/openai/models/responses/input_item_list_params.rbi +0 -11
- data/rbi/openai/models/responses/response.rbi +49 -0
- data/rbi/openai/models/responses/response_conversation_param.rbi +33 -0
- data/rbi/openai/models/responses/response_create_params.rbi +54 -0
- data/rbi/openai/models/responses/tool.rbi +243 -31
- data/rbi/openai/models.rbi +2 -0
- data/rbi/openai/resources/conversations/items.rbi +152 -0
- data/rbi/openai/resources/conversations.rbi +110 -0
- data/rbi/openai/resources/responses/input_items.rbi +0 -3
- data/rbi/openai/resources/responses.rbi +26 -0
- data/sig/openai/client.rbs +2 -0
- data/sig/openai/internal/conversation_cursor_page.rbs +15 -0
- data/sig/openai/models/conversations/computer_screenshot_content.rbs +28 -0
- data/sig/openai/models/conversations/container_file_citation_body.rbs +47 -0
- data/sig/openai/models/conversations/conversation.rbs +37 -0
- data/sig/openai/models/conversations/conversation_create_params.rbs +33 -0
- data/sig/openai/models/conversations/conversation_delete_params.rbs +17 -0
- data/sig/openai/models/conversations/conversation_deleted.rbs +28 -0
- data/sig/openai/models/conversations/conversation_deleted_resource.rbs +28 -0
- data/sig/openai/models/conversations/conversation_item.rbs +403 -0
- data/sig/openai/models/conversations/conversation_item_list.rbs +44 -0
- data/sig/openai/models/conversations/conversation_retrieve_params.rbs +17 -0
- data/sig/openai/models/conversations/conversation_update_params.rbs +26 -0
- data/sig/openai/models/conversations/file_citation_body.rbs +37 -0
- data/sig/openai/models/conversations/input_file_content.rbs +41 -0
- data/sig/openai/models/conversations/input_image_content.rbs +49 -0
- data/sig/openai/models/conversations/input_text_content.rbs +17 -0
- data/sig/openai/models/conversations/item_create_params.rbs +37 -0
- data/sig/openai/models/conversations/item_delete_params.rbs +25 -0
- data/sig/openai/models/conversations/item_list_params.rbs +66 -0
- data/sig/openai/models/conversations/item_retrieve_params.rbs +37 -0
- data/sig/openai/models/conversations/lob_prob.rbs +37 -0
- data/sig/openai/models/conversations/message.rbs +95 -0
- data/sig/openai/models/conversations/output_text_content.rbs +52 -0
- data/sig/openai/models/conversations/refusal_content.rbs +17 -0
- data/sig/openai/models/conversations/summary_text_content.rbs +17 -0
- data/sig/openai/models/conversations/text_content.rbs +17 -0
- data/sig/openai/models/conversations/top_log_prob.rbs +28 -0
- data/sig/openai/models/conversations/url_citation_body.rbs +42 -0
- data/sig/openai/models/evals/create_eval_completions_run_data_source.rbs +22 -22
- data/sig/openai/models/responses/input_item_list_params.rbs +0 -7
- data/sig/openai/models/responses/response.rbs +15 -0
- data/sig/openai/models/responses/response_conversation_param.rbs +15 -0
- data/sig/openai/models/responses/response_create_params.rbs +14 -0
- data/sig/openai/models/responses/tool.rbs +83 -18
- data/sig/openai/models.rbs +2 -0
- data/sig/openai/resources/conversations/items.rbs +38 -0
- data/sig/openai/resources/conversations.rbs +31 -0
- data/sig/openai/resources/responses/input_items.rbs +0 -1
- data/sig/openai/resources/responses.rbs +2 -0
- metadata +95 -2
@@ -0,0 +1,50 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module OpenAI
|
4
|
+
module Models
|
5
|
+
module Conversations
|
6
|
+
class URLCitationBody < OpenAI::Internal::Type::BaseModel
|
7
|
+
# @!attribute end_index
|
8
|
+
# The index of the last character of the URL citation in the message.
|
9
|
+
#
|
10
|
+
# @return [Integer]
|
11
|
+
required :end_index, Integer
|
12
|
+
|
13
|
+
# @!attribute start_index
|
14
|
+
# The index of the first character of the URL citation in the message.
|
15
|
+
#
|
16
|
+
# @return [Integer]
|
17
|
+
required :start_index, Integer
|
18
|
+
|
19
|
+
# @!attribute title
|
20
|
+
# The title of the web resource.
|
21
|
+
#
|
22
|
+
# @return [String]
|
23
|
+
required :title, String
|
24
|
+
|
25
|
+
# @!attribute type
|
26
|
+
# The type of the URL citation. Always `url_citation`.
|
27
|
+
#
|
28
|
+
# @return [Symbol, :url_citation]
|
29
|
+
required :type, const: :url_citation
|
30
|
+
|
31
|
+
# @!attribute url
|
32
|
+
# The URL of the web resource.
|
33
|
+
#
|
34
|
+
# @return [String]
|
35
|
+
required :url, String
|
36
|
+
|
37
|
+
# @!method initialize(end_index:, start_index:, title:, url:, type: :url_citation)
|
38
|
+
# @param end_index [Integer] The index of the last character of the URL citation in the message.
|
39
|
+
#
|
40
|
+
# @param start_index [Integer] The index of the first character of the URL citation in the message.
|
41
|
+
#
|
42
|
+
# @param title [String] The title of the web resource.
|
43
|
+
#
|
44
|
+
# @param url [String] The URL of the web resource.
|
45
|
+
#
|
46
|
+
# @param type [Symbol, :url_citation] The type of the URL citation. Always `url_citation`.
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
@@ -191,9 +191,7 @@ module OpenAI
|
|
191
191
|
#
|
192
192
|
# @return [Array<OpenAI::Models::EvalCreateParams::TestingCriterion::LabelModel::Input::SimpleInputMessage, OpenAI::Models::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem>]
|
193
193
|
required :input,
|
194
|
-
-> {
|
195
|
-
OpenAI::Internal::Type::ArrayOf[union: OpenAI::EvalCreateParams::TestingCriterion::LabelModel::Input]
|
196
|
-
}
|
194
|
+
-> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::EvalCreateParams::TestingCriterion::LabelModel::Input] }
|
197
195
|
|
198
196
|
# @!attribute labels
|
199
197
|
# The labels to classify to each item in the evaluation.
|
@@ -284,28 +282,20 @@ module OpenAI
|
|
284
282
|
#
|
285
283
|
# @return [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem::Content::OutputText, OpenAI::Models::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem::Content::InputImage, Array<Object>]
|
286
284
|
required :content,
|
287
|
-
union: -> {
|
288
|
-
OpenAI::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem::Content
|
289
|
-
}
|
285
|
+
union: -> { OpenAI::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem::Content }
|
290
286
|
|
291
287
|
# @!attribute role
|
292
288
|
# The role of the message input. One of `user`, `assistant`, `system`, or
|
293
289
|
# `developer`.
|
294
290
|
#
|
295
291
|
# @return [Symbol, OpenAI::Models::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem::Role]
|
296
|
-
required :role,
|
297
|
-
enum: -> {
|
298
|
-
OpenAI::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem::Role
|
299
|
-
}
|
292
|
+
required :role, enum: -> { OpenAI::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem::Role }
|
300
293
|
|
301
294
|
# @!attribute type
|
302
295
|
# The type of the message input. Always `message`.
|
303
296
|
#
|
304
297
|
# @return [Symbol, OpenAI::Models::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem::Type, nil]
|
305
|
-
optional :type,
|
306
|
-
enum: -> {
|
307
|
-
OpenAI::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem::Type
|
308
|
-
}
|
298
|
+
optional :type, enum: -> { OpenAI::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem::Type }
|
309
299
|
|
310
300
|
# @!method initialize(content:, role:, type: nil)
|
311
301
|
# Some parameter documentations has been truncated, see
|
@@ -337,14 +327,10 @@ module OpenAI
|
|
337
327
|
variant -> { OpenAI::Responses::ResponseInputText }
|
338
328
|
|
339
329
|
# A text output from the model.
|
340
|
-
variant -> {
|
341
|
-
OpenAI::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem::Content::OutputText
|
342
|
-
}
|
330
|
+
variant -> { OpenAI::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem::Content::OutputText }
|
343
331
|
|
344
332
|
# An image input to the model.
|
345
|
-
variant -> {
|
346
|
-
OpenAI::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem::Content::InputImage
|
347
|
-
}
|
333
|
+
variant -> { OpenAI::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem::Content::InputImage }
|
348
334
|
|
349
335
|
# A list of inputs, each of which may be either an input text or input image object.
|
350
336
|
variant -> { OpenAI::Models::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem::Content::AnArrayOfInputTextAndInputImageArray }
|
@@ -23,10 +23,7 @@ module OpenAI
|
|
23
23
|
# namespace.
|
24
24
|
#
|
25
25
|
# @return [OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::ItemReference, nil]
|
26
|
-
optional :input_messages,
|
27
|
-
union: -> {
|
28
|
-
OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages
|
29
|
-
}
|
26
|
+
optional :input_messages, union: -> { OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages }
|
30
27
|
|
31
28
|
# @!attribute model
|
32
29
|
# The name of the model to use for generating completions (e.g. "o3-mini").
|
@@ -77,9 +74,7 @@ module OpenAI
|
|
77
74
|
#
|
78
75
|
# @return [Array<OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::Source::FileContent::Content>]
|
79
76
|
required :content,
|
80
|
-
-> {
|
81
|
-
OpenAI::Internal::Type::ArrayOf[OpenAI::Evals::CreateEvalCompletionsRunDataSource::Source::FileContent::Content]
|
82
|
-
}
|
77
|
+
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Evals::CreateEvalCompletionsRunDataSource::Source::FileContent::Content] }
|
83
78
|
|
84
79
|
# @!attribute type
|
85
80
|
# The type of jsonl source. Always `file_content`.
|
@@ -227,11 +222,9 @@ module OpenAI
|
|
227
222
|
# A list of chat messages forming the prompt or context. May include variable
|
228
223
|
# references to the `item` namespace, ie {{item.name}}.
|
229
224
|
#
|
230
|
-
# @return [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::
|
225
|
+
# @return [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem>]
|
231
226
|
required :template,
|
232
|
-
-> {
|
233
|
-
OpenAI::Internal::Type::ArrayOf[union: OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template]
|
234
|
-
}
|
227
|
+
-> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template] }
|
235
228
|
|
236
229
|
# @!attribute type
|
237
230
|
# The type of input messages. Always `template`.
|
@@ -244,7 +237,7 @@ module OpenAI
|
|
244
237
|
# {OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template}
|
245
238
|
# for more details.
|
246
239
|
#
|
247
|
-
# @param template [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::
|
240
|
+
# @param template [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem>] A list of chat messages forming the prompt or context. May include variable refe
|
248
241
|
#
|
249
242
|
# @param type [Symbol, :template] The type of input messages. Always `template`.
|
250
243
|
|
@@ -256,57 +249,46 @@ module OpenAI
|
|
256
249
|
module Template
|
257
250
|
extend OpenAI::Internal::Type::Union
|
258
251
|
|
259
|
-
discriminator :type
|
260
|
-
|
261
252
|
# A message input to the model with a role indicating instruction following
|
262
253
|
# hierarchy. Instructions given with the `developer` or `system` role take
|
263
254
|
# precedence over instructions given with the `user` role. Messages with the
|
264
255
|
# `assistant` role are presumed to have been generated by the model in previous
|
265
256
|
# interactions.
|
266
|
-
variant
|
257
|
+
variant -> { OpenAI::Responses::EasyInputMessage }
|
267
258
|
|
268
259
|
# A message input to the model with a role indicating instruction following
|
269
260
|
# hierarchy. Instructions given with the `developer` or `system` role take
|
270
261
|
# precedence over instructions given with the `user` role. Messages with the
|
271
262
|
# `assistant` role are presumed to have been generated by the model in previous
|
272
263
|
# interactions.
|
273
|
-
variant
|
274
|
-
-> {
|
275
|
-
OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message
|
276
|
-
}
|
264
|
+
variant -> { OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem }
|
277
265
|
|
278
|
-
class
|
266
|
+
class EvalItem < OpenAI::Internal::Type::BaseModel
|
279
267
|
# @!attribute content
|
280
268
|
# Inputs to the model - can contain template strings.
|
281
269
|
#
|
282
|
-
# @return [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::
|
270
|
+
# @return [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::InputImage, Array<Object>]
|
283
271
|
required :content,
|
284
|
-
union: -> {
|
285
|
-
OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Content
|
286
|
-
}
|
272
|
+
union: -> { OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content }
|
287
273
|
|
288
274
|
# @!attribute role
|
289
275
|
# The role of the message input. One of `user`, `assistant`, `system`, or
|
290
276
|
# `developer`.
|
291
277
|
#
|
292
|
-
# @return [Symbol, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::
|
278
|
+
# @return [Symbol, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Role]
|
293
279
|
required :role,
|
294
|
-
enum: -> {
|
295
|
-
OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Role
|
296
|
-
}
|
280
|
+
enum: -> { OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Role }
|
297
281
|
|
298
282
|
# @!attribute type
|
299
283
|
# The type of the message input. Always `message`.
|
300
284
|
#
|
301
|
-
# @return [Symbol, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::
|
285
|
+
# @return [Symbol, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Type, nil]
|
302
286
|
optional :type,
|
303
|
-
enum: -> {
|
304
|
-
OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Type
|
305
|
-
}
|
287
|
+
enum: -> { OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Type }
|
306
288
|
|
307
289
|
# @!method initialize(content:, role:, type: nil)
|
308
290
|
# Some parameter documentations has been truncated, see
|
309
|
-
# {OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::
|
291
|
+
# {OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem}
|
310
292
|
# for more details.
|
311
293
|
#
|
312
294
|
# A message input to the model with a role indicating instruction following
|
@@ -315,15 +297,15 @@ module OpenAI
|
|
315
297
|
# `assistant` role are presumed to have been generated by the model in previous
|
316
298
|
# interactions.
|
317
299
|
#
|
318
|
-
# @param content [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::
|
300
|
+
# @param content [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::InputImage, Array<Object>] Inputs to the model - can contain template strings.
|
319
301
|
#
|
320
|
-
# @param role [Symbol, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::
|
302
|
+
# @param role [Symbol, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Role] The role of the message input. One of `user`, `assistant`, `system`, or
|
321
303
|
#
|
322
|
-
# @param type [Symbol, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::
|
304
|
+
# @param type [Symbol, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Type] The type of the message input. Always `message`.
|
323
305
|
|
324
306
|
# Inputs to the model - can contain template strings.
|
325
307
|
#
|
326
|
-
# @see OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::
|
308
|
+
# @see OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem#content
|
327
309
|
module Content
|
328
310
|
extend OpenAI::Internal::Type::Union
|
329
311
|
|
@@ -334,17 +316,13 @@ module OpenAI
|
|
334
316
|
variant -> { OpenAI::Responses::ResponseInputText }
|
335
317
|
|
336
318
|
# A text output from the model.
|
337
|
-
variant -> {
|
338
|
-
OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Content::OutputText
|
339
|
-
}
|
319
|
+
variant -> { OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::OutputText }
|
340
320
|
|
341
321
|
# An image input to the model.
|
342
|
-
variant -> {
|
343
|
-
OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Content::InputImage
|
344
|
-
}
|
322
|
+
variant -> { OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::InputImage }
|
345
323
|
|
346
324
|
# A list of inputs, each of which may be either an input text or input image object.
|
347
|
-
variant -> { OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::
|
325
|
+
variant -> { OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::AnArrayOfInputTextAndInputImageArray }
|
348
326
|
|
349
327
|
class OutputText < OpenAI::Internal::Type::BaseModel
|
350
328
|
# @!attribute text
|
@@ -361,7 +339,7 @@ module OpenAI
|
|
361
339
|
|
362
340
|
# @!method initialize(text:, type: :output_text)
|
363
341
|
# Some parameter documentations has been truncated, see
|
364
|
-
# {OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::
|
342
|
+
# {OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::OutputText}
|
365
343
|
# for more details.
|
366
344
|
#
|
367
345
|
# A text output from the model.
|
@@ -393,7 +371,7 @@ module OpenAI
|
|
393
371
|
|
394
372
|
# @!method initialize(image_url:, detail: nil, type: :input_image)
|
395
373
|
# Some parameter documentations has been truncated, see
|
396
|
-
# {OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::
|
374
|
+
# {OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::InputImage}
|
397
375
|
# for more details.
|
398
376
|
#
|
399
377
|
# An image input to the model.
|
@@ -406,7 +384,7 @@ module OpenAI
|
|
406
384
|
end
|
407
385
|
|
408
386
|
# @!method self.variants
|
409
|
-
# @return [Array(String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::
|
387
|
+
# @return [Array(String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::InputImage, Array<Object>)]
|
410
388
|
|
411
389
|
# @type [OpenAI::Internal::Type::Converter]
|
412
390
|
AnArrayOfInputTextAndInputImageArray = OpenAI::Internal::Type::ArrayOf[OpenAI::Internal::Type::Unknown]
|
@@ -415,7 +393,7 @@ module OpenAI
|
|
415
393
|
# The role of the message input. One of `user`, `assistant`, `system`, or
|
416
394
|
# `developer`.
|
417
395
|
#
|
418
|
-
# @see OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::
|
396
|
+
# @see OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem#role
|
419
397
|
module Role
|
420
398
|
extend OpenAI::Internal::Type::Enum
|
421
399
|
|
@@ -430,7 +408,7 @@ module OpenAI
|
|
430
408
|
|
431
409
|
# The type of the message input. Always `message`.
|
432
410
|
#
|
433
|
-
# @see OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::
|
411
|
+
# @see OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem#type
|
434
412
|
module Type
|
435
413
|
extend OpenAI::Internal::Type::Enum
|
436
414
|
|
@@ -442,7 +420,7 @@ module OpenAI
|
|
442
420
|
end
|
443
421
|
|
444
422
|
# @!method self.variants
|
445
|
-
# @return [Array(OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::
|
423
|
+
# @return [Array(OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem)]
|
446
424
|
end
|
447
425
|
end
|
448
426
|
|
@@ -491,9 +469,7 @@ module OpenAI
|
|
491
469
|
#
|
492
470
|
# @return [OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONSchema, OpenAI::Models::ResponseFormatJSONObject, nil]
|
493
471
|
optional :response_format,
|
494
|
-
union: -> {
|
495
|
-
OpenAI::Evals::CreateEvalCompletionsRunDataSource::SamplingParams::ResponseFormat
|
496
|
-
}
|
472
|
+
union: -> { OpenAI::Evals::CreateEvalCompletionsRunDataSource::SamplingParams::ResponseFormat }
|
497
473
|
|
498
474
|
# @!attribute seed
|
499
475
|
# A seed value to initialize the randomness, during sampling.
|
@@ -42,9 +42,7 @@ module OpenAI
|
|
42
42
|
#
|
43
43
|
# @return [Array<OpenAI::Models::Evals::CreateEvalJSONLRunDataSource::Source::FileContent::Content>]
|
44
44
|
required :content,
|
45
|
-
-> {
|
46
|
-
OpenAI::Internal::Type::ArrayOf[OpenAI::Evals::CreateEvalJSONLRunDataSource::Source::FileContent::Content]
|
47
|
-
}
|
45
|
+
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Evals::CreateEvalJSONLRunDataSource::Source::FileContent::Content] }
|
48
46
|
|
49
47
|
# @!attribute type
|
50
48
|
# The type of jsonl source. Always `file_content`.
|
@@ -62,18 +62,14 @@ module OpenAI
|
|
62
62
|
#
|
63
63
|
# @return [OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::Source::FileContent, OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::Source::FileID, OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::Source::Responses]
|
64
64
|
required :source,
|
65
|
-
union: -> {
|
66
|
-
OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::Source
|
67
|
-
}
|
65
|
+
union: -> { OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::Source }
|
68
66
|
|
69
67
|
# @!attribute type
|
70
68
|
# The type of run data source. Always `responses`.
|
71
69
|
#
|
72
70
|
# @return [Symbol, OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::Type]
|
73
71
|
required :type,
|
74
|
-
enum: -> {
|
75
|
-
OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::Type
|
76
|
-
}
|
72
|
+
enum: -> { OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::Type }
|
77
73
|
|
78
74
|
# @!attribute input_messages
|
79
75
|
# Used when sampling from a model. Dictates the structure of the messages passed
|
@@ -83,9 +79,7 @@ module OpenAI
|
|
83
79
|
#
|
84
80
|
# @return [OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template, OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::ItemReference, nil]
|
85
81
|
optional :input_messages,
|
86
|
-
union: -> {
|
87
|
-
OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages
|
88
|
-
}
|
82
|
+
union: -> { OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages }
|
89
83
|
|
90
84
|
# @!attribute model
|
91
85
|
# The name of the model to use for generating completions (e.g. "o3-mini").
|
@@ -97,9 +91,7 @@ module OpenAI
|
|
97
91
|
#
|
98
92
|
# @return [OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams, nil]
|
99
93
|
optional :sampling_params,
|
100
|
-
-> {
|
101
|
-
OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams
|
102
|
-
}
|
94
|
+
-> { OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams }
|
103
95
|
|
104
96
|
# @!method initialize(source:, type:, input_messages: nil, model: nil, sampling_params: nil)
|
105
97
|
# Some parameter documentations has been truncated, see
|
@@ -127,20 +119,14 @@ module OpenAI
|
|
127
119
|
discriminator :type
|
128
120
|
|
129
121
|
variant :file_content,
|
130
|
-
-> {
|
131
|
-
OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::Source::FileContent
|
132
|
-
}
|
122
|
+
-> { OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::Source::FileContent }
|
133
123
|
|
134
124
|
variant :file_id,
|
135
|
-
-> {
|
136
|
-
OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::Source::FileID
|
137
|
-
}
|
125
|
+
-> { OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::Source::FileID }
|
138
126
|
|
139
127
|
# A EvalResponsesSource object describing a run data source configuration.
|
140
128
|
variant :responses,
|
141
|
-
-> {
|
142
|
-
OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::Source::Responses
|
143
|
-
}
|
129
|
+
-> { OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::Source::Responses }
|
144
130
|
|
145
131
|
class FileContent < OpenAI::Internal::Type::BaseModel
|
146
132
|
# @!attribute content
|
@@ -148,9 +134,7 @@ module OpenAI
|
|
148
134
|
#
|
149
135
|
# @return [Array<OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::Source::FileContent::Content>]
|
150
136
|
required :content,
|
151
|
-
-> {
|
152
|
-
OpenAI::Internal::Type::ArrayOf[OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::Source::FileContent::Content]
|
153
|
-
}
|
137
|
+
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::Source::FileContent::Content] }
|
154
138
|
|
155
139
|
# @!attribute type
|
156
140
|
# The type of jsonl source. Always `file_content`.
|
@@ -330,14 +314,10 @@ module OpenAI
|
|
330
314
|
discriminator :type
|
331
315
|
|
332
316
|
variant :template,
|
333
|
-
-> {
|
334
|
-
OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template
|
335
|
-
}
|
317
|
+
-> { OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template }
|
336
318
|
|
337
319
|
variant :item_reference,
|
338
|
-
-> {
|
339
|
-
OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::ItemReference
|
340
|
-
}
|
320
|
+
-> { OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::ItemReference }
|
341
321
|
|
342
322
|
class Template < OpenAI::Internal::Type::BaseModel
|
343
323
|
# @!attribute template
|
@@ -375,18 +355,14 @@ module OpenAI
|
|
375
355
|
module Template
|
376
356
|
extend OpenAI::Internal::Type::Union
|
377
357
|
|
378
|
-
variant -> {
|
379
|
-
OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::ChatMessage
|
380
|
-
}
|
358
|
+
variant -> { OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::ChatMessage }
|
381
359
|
|
382
360
|
# A message input to the model with a role indicating instruction following
|
383
361
|
# hierarchy. Instructions given with the `developer` or `system` role take
|
384
362
|
# precedence over instructions given with the `user` role. Messages with the
|
385
363
|
# `assistant` role are presumed to have been generated by the model in previous
|
386
364
|
# interactions.
|
387
|
-
variant -> {
|
388
|
-
OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem
|
389
|
-
}
|
365
|
+
variant -> { OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem }
|
390
366
|
|
391
367
|
class ChatMessage < OpenAI::Internal::Type::BaseModel
|
392
368
|
# @!attribute content
|
@@ -413,9 +389,7 @@ module OpenAI
|
|
413
389
|
#
|
414
390
|
# @return [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem::Content::InputImage, Array<Object>]
|
415
391
|
required :content,
|
416
|
-
union: -> {
|
417
|
-
OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem::Content
|
418
|
-
}
|
392
|
+
union: -> { OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem::Content }
|
419
393
|
|
420
394
|
# @!attribute role
|
421
395
|
# The role of the message input. One of `user`, `assistant`, `system`, or
|
@@ -423,18 +397,14 @@ module OpenAI
|
|
423
397
|
#
|
424
398
|
# @return [Symbol, OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem::Role]
|
425
399
|
required :role,
|
426
|
-
enum: -> {
|
427
|
-
OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem::Role
|
428
|
-
}
|
400
|
+
enum: -> { OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem::Role }
|
429
401
|
|
430
402
|
# @!attribute type
|
431
403
|
# The type of the message input. Always `message`.
|
432
404
|
#
|
433
405
|
# @return [Symbol, OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem::Type, nil]
|
434
406
|
optional :type,
|
435
|
-
enum: -> {
|
436
|
-
OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem::Type
|
437
|
-
}
|
407
|
+
enum: -> { OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem::Type }
|
438
408
|
|
439
409
|
# @!method initialize(content:, role:, type: nil)
|
440
410
|
# Some parameter documentations has been truncated, see
|
@@ -466,14 +436,10 @@ module OpenAI
|
|
466
436
|
variant -> { OpenAI::Responses::ResponseInputText }
|
467
437
|
|
468
438
|
# A text output from the model.
|
469
|
-
variant -> {
|
470
|
-
OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem::Content::OutputText
|
471
|
-
}
|
439
|
+
variant -> { OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem::Content::OutputText }
|
472
440
|
|
473
441
|
# An image input to the model.
|
474
|
-
variant -> {
|
475
|
-
OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem::Content::InputImage
|
476
|
-
}
|
442
|
+
variant -> { OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem::Content::InputImage }
|
477
443
|
|
478
444
|
# A list of inputs, each of which may be either an input text or input image object.
|
479
445
|
variant -> { OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem::Content::AnArrayOfInputTextAndInputImageArray }
|
@@ -630,9 +596,7 @@ module OpenAI
|
|
630
596
|
#
|
631
597
|
# @return [OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text, nil]
|
632
598
|
optional :text,
|
633
|
-
-> {
|
634
|
-
OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text
|
635
|
-
}
|
599
|
+
-> { OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text }
|
636
600
|
|
637
601
|
# @!attribute tools
|
638
602
|
# An array of tools the model may call while generating a response. You can
|
@@ -49,10 +49,7 @@ module OpenAI
|
|
49
49
|
# Level of reasoning effort.
|
50
50
|
#
|
51
51
|
# @return [Symbol, OpenAI::Models::FineTuning::ReinforcementHyperparameters::ReasoningEffort, nil]
|
52
|
-
optional :reasoning_effort,
|
53
|
-
enum: -> {
|
54
|
-
OpenAI::FineTuning::ReinforcementHyperparameters::ReasoningEffort
|
55
|
-
}
|
52
|
+
optional :reasoning_effort, enum: -> { OpenAI::FineTuning::ReinforcementHyperparameters::ReasoningEffort }
|
56
53
|
|
57
54
|
# @!method initialize(batch_size: nil, compute_multiplier: nil, eval_interval: nil, eval_samples: nil, learning_rate_multiplier: nil, n_epochs: nil, reasoning_effort: nil)
|
58
55
|
# Some parameter documentations has been truncated, see
|
@@ -176,9 +176,7 @@ module OpenAI
|
|
176
176
|
#
|
177
177
|
# @return [Array<Symbol, OpenAI::Models::Moderation::CategoryAppliedInputTypes::Harassment>]
|
178
178
|
required :harassment,
|
179
|
-
-> {
|
180
|
-
OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Moderation::CategoryAppliedInputTypes::Harassment]
|
181
|
-
}
|
179
|
+
-> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Moderation::CategoryAppliedInputTypes::Harassment] }
|
182
180
|
|
183
181
|
# @!attribute harassment_threatening
|
184
182
|
# The applied input type(s) for the category 'harassment/threatening'.
|
@@ -195,9 +193,7 @@ module OpenAI
|
|
195
193
|
#
|
196
194
|
# @return [Array<Symbol, OpenAI::Models::Moderation::CategoryAppliedInputTypes::Hate>]
|
197
195
|
required :hate,
|
198
|
-
-> {
|
199
|
-
OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Moderation::CategoryAppliedInputTypes::Hate]
|
200
|
-
}
|
196
|
+
-> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Moderation::CategoryAppliedInputTypes::Hate] }
|
201
197
|
|
202
198
|
# @!attribute hate_threatening
|
203
199
|
# The applied input type(s) for the category 'hate/threatening'.
|
@@ -214,9 +210,7 @@ module OpenAI
|
|
214
210
|
#
|
215
211
|
# @return [Array<Symbol, OpenAI::Models::Moderation::CategoryAppliedInputTypes::Illicit>]
|
216
212
|
required :illicit,
|
217
|
-
-> {
|
218
|
-
OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Moderation::CategoryAppliedInputTypes::Illicit]
|
219
|
-
}
|
213
|
+
-> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Moderation::CategoryAppliedInputTypes::Illicit] }
|
220
214
|
|
221
215
|
# @!attribute illicit_violent
|
222
216
|
# The applied input type(s) for the category 'illicit/violent'.
|
@@ -263,9 +257,7 @@ module OpenAI
|
|
263
257
|
#
|
264
258
|
# @return [Array<Symbol, OpenAI::Models::Moderation::CategoryAppliedInputTypes::Sexual>]
|
265
259
|
required :sexual,
|
266
|
-
-> {
|
267
|
-
OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Moderation::CategoryAppliedInputTypes::Sexual]
|
268
|
-
}
|
260
|
+
-> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Moderation::CategoryAppliedInputTypes::Sexual] }
|
269
261
|
|
270
262
|
# @!attribute sexual_minors
|
271
263
|
# The applied input type(s) for the category 'sexual/minors'.
|
@@ -282,9 +274,7 @@ module OpenAI
|
|
282
274
|
#
|
283
275
|
# @return [Array<Symbol, OpenAI::Models::Moderation::CategoryAppliedInputTypes::Violence>]
|
284
276
|
required :violence,
|
285
|
-
-> {
|
286
|
-
OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Moderation::CategoryAppliedInputTypes::Violence]
|
287
|
-
}
|
277
|
+
-> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Moderation::CategoryAppliedInputTypes::Violence] }
|
288
278
|
|
289
279
|
# @!attribute violence_graphic
|
290
280
|
# The applied input type(s) for the category 'violence/graphic'.
|
@@ -14,12 +14,6 @@ module OpenAI
|
|
14
14
|
# @return [String, nil]
|
15
15
|
optional :after, String
|
16
16
|
|
17
|
-
# @!attribute before
|
18
|
-
# An item ID to list items before, used in pagination.
|
19
|
-
#
|
20
|
-
# @return [String, nil]
|
21
|
-
optional :before, String
|
22
|
-
|
23
17
|
# @!attribute include
|
24
18
|
# Additional fields to include in the response. See the `include` parameter for
|
25
19
|
# Response creation above for more information.
|
@@ -43,14 +37,12 @@ module OpenAI
|
|
43
37
|
# @return [Symbol, OpenAI::Models::Responses::InputItemListParams::Order, nil]
|
44
38
|
optional :order, enum: -> { OpenAI::Responses::InputItemListParams::Order }
|
45
39
|
|
46
|
-
# @!method initialize(after: nil,
|
40
|
+
# @!method initialize(after: nil, include: nil, limit: nil, order: nil, request_options: {})
|
47
41
|
# Some parameter documentations has been truncated, see
|
48
42
|
# {OpenAI::Models::Responses::InputItemListParams} for more details.
|
49
43
|
#
|
50
44
|
# @param after [String] An item ID to list items after, used in pagination.
|
51
45
|
#
|
52
|
-
# @param before [String] An item ID to list items before, used in pagination.
|
53
|
-
#
|
54
46
|
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Additional fields to include in the response. See the `include`
|
55
47
|
#
|
56
48
|
# @param limit [Integer] A limit on the number of objects to be returned. Limit can range between
|