openai 0.38.0 → 0.40.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 +22 -0
- data/README.md +9 -9
- data/lib/openai/internal/type/enum.rb +6 -6
- data/lib/openai/models/beta/assistant_create_params.rb +1 -1
- data/lib/openai/models/beta/assistant_update_params.rb +1 -1
- data/lib/openai/models/beta/threads/run_create_params.rb +1 -1
- data/lib/openai/models/chat/completion_create_params.rb +1 -1
- data/lib/openai/models/chat_model.rb +5 -0
- data/lib/openai/models/eval_create_params.rb +12 -13
- data/lib/openai/models/evals/create_eval_completions_run_data_source.rb +13 -14
- data/lib/openai/models/evals/run_cancel_response.rb +14 -15
- data/lib/openai/models/evals/run_create_params.rb +14 -15
- data/lib/openai/models/evals/run_create_response.rb +14 -15
- data/lib/openai/models/evals/run_list_response.rb +14 -15
- data/lib/openai/models/evals/run_retrieve_response.rb +14 -15
- data/lib/openai/models/graders/grader_inputs.rb +93 -0
- data/lib/openai/models/graders/label_model_grader.rb +12 -13
- data/lib/openai/models/graders/score_model_grader.rb +19 -16
- data/lib/openai/models/reasoning.rb +5 -3
- data/lib/openai/models/reasoning_effort.rb +1 -1
- data/lib/openai/models/responses/response_compact_params.rb +15 -0
- data/lib/openai/models/video_model.rb +3 -0
- data/lib/openai/resources/responses.rb +5 -5
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +1 -0
- data/rbi/openai/models/beta/assistant_create_params.rbi +2 -2
- data/rbi/openai/models/beta/assistant_update_params.rbi +2 -2
- data/rbi/openai/models/beta/threads/run_create_params.rbi +2 -2
- data/rbi/openai/models/chat/completion_create_params.rbi +2 -2
- data/rbi/openai/models/chat_model.rbi +8 -0
- data/rbi/openai/models/eval_create_params.rbi +35 -16
- data/rbi/openai/models/evals/create_eval_completions_run_data_source.rbi +37 -18
- data/rbi/openai/models/evals/run_cancel_response.rbi +21 -18
- data/rbi/openai/models/evals/run_create_params.rbi +39 -20
- data/rbi/openai/models/evals/run_create_response.rbi +21 -18
- data/rbi/openai/models/evals/run_list_response.rbi +21 -18
- data/rbi/openai/models/evals/run_retrieve_response.rbi +21 -18
- data/rbi/openai/models/graders/grader_inputs.rbi +123 -0
- data/rbi/openai/models/graders/label_model_grader.rbi +35 -16
- data/rbi/openai/models/graders/score_model_grader.rbi +41 -20
- data/rbi/openai/models/reasoning.rbi +8 -5
- data/rbi/openai/models/reasoning_effort.rbi +1 -1
- data/rbi/openai/models/responses/response_compact_params.rbi +25 -0
- data/rbi/openai/models/video_model.rbi +6 -0
- data/rbi/openai/resources/beta/assistants.rbi +2 -2
- data/rbi/openai/resources/beta/threads/runs.rbi +2 -2
- data/rbi/openai/resources/chat/completions.rbi +2 -2
- data/sig/openai/models/chat_model.rbs +11 -1
- data/sig/openai/models/eval_create_params.rbs +1 -3
- data/sig/openai/models/evals/create_eval_completions_run_data_source.rbs +1 -3
- data/sig/openai/models/evals/run_cancel_response.rbs +1 -3
- data/sig/openai/models/evals/run_create_params.rbs +1 -3
- data/sig/openai/models/evals/run_create_response.rbs +1 -3
- data/sig/openai/models/evals/run_list_response.rbs +1 -3
- data/sig/openai/models/evals/run_retrieve_response.rbs +1 -3
- data/sig/openai/models/graders/grader_inputs.rbs +61 -0
- data/sig/openai/models/graders/label_model_grader.rbs +1 -3
- data/sig/openai/models/graders/score_model_grader.rbs +1 -3
- data/sig/openai/models/responses/response_compact_params.rbs +11 -1
- data/sig/openai/models/video_model.rbs +9 -1
- metadata +5 -2
|
@@ -326,7 +326,7 @@ module OpenAI
|
|
|
326
326
|
# - All models before `gpt-5.1` default to `medium` reasoning effort, and do not
|
|
327
327
|
# support `none`.
|
|
328
328
|
# - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
329
|
-
# - `xhigh` is
|
|
329
|
+
# - `xhigh` is supported for all models after `gpt-5.1-codex-max`.
|
|
330
330
|
#
|
|
331
331
|
# @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
|
|
332
332
|
optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
|
|
@@ -468,9 +468,10 @@ module OpenAI
|
|
|
468
468
|
|
|
469
469
|
class EvalItem < OpenAI::Internal::Type::BaseModel
|
|
470
470
|
# @!attribute content
|
|
471
|
-
# Inputs to the model - can contain template strings.
|
|
471
|
+
# Inputs to the model - can contain template strings. Supports text, output text,
|
|
472
|
+
# input images, and input audio, either as a single item or an array of items.
|
|
472
473
|
#
|
|
473
|
-
# @return [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<
|
|
474
|
+
# @return [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>]
|
|
474
475
|
required :content,
|
|
475
476
|
union: -> { OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content }
|
|
476
477
|
|
|
@@ -500,13 +501,14 @@ module OpenAI
|
|
|
500
501
|
# `assistant` role are presumed to have been generated by the model in previous
|
|
501
502
|
# interactions.
|
|
502
503
|
#
|
|
503
|
-
# @param content [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<
|
|
504
|
+
# @param content [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>] Inputs to the model - can contain template strings. Supports text, output text,
|
|
504
505
|
#
|
|
505
506
|
# @param role [Symbol, OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Role] The role of the message input. One of `user`, `assistant`, `system`, or
|
|
506
507
|
#
|
|
507
508
|
# @param type [Symbol, OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Type] The type of the message input. Always `message`.
|
|
508
509
|
|
|
509
|
-
# Inputs to the model - can contain template strings.
|
|
510
|
+
# Inputs to the model - can contain template strings. Supports text, output text,
|
|
511
|
+
# input images, and input audio, either as a single item or an array of items.
|
|
510
512
|
#
|
|
511
513
|
# @see OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem#content
|
|
512
514
|
module Content
|
|
@@ -521,14 +523,15 @@ module OpenAI
|
|
|
521
523
|
# A text output from the model.
|
|
522
524
|
variant -> { OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText }
|
|
523
525
|
|
|
524
|
-
# An image input
|
|
526
|
+
# An image input block used within EvalItem content arrays.
|
|
525
527
|
variant -> { OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage }
|
|
526
528
|
|
|
527
529
|
# An audio input to the model.
|
|
528
530
|
variant -> { OpenAI::Responses::ResponseInputAudio }
|
|
529
531
|
|
|
530
|
-
# A list of inputs, each of which may be either an input text,
|
|
531
|
-
|
|
532
|
+
# A list of inputs, each of which may be either an input text, output text, input
|
|
533
|
+
# image, or input audio object.
|
|
534
|
+
variant -> { OpenAI::Graders::GraderInputs }
|
|
532
535
|
|
|
533
536
|
class OutputText < OpenAI::Internal::Type::BaseModel
|
|
534
537
|
# @!attribute text
|
|
@@ -580,7 +583,7 @@ module OpenAI
|
|
|
580
583
|
# {OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage}
|
|
581
584
|
# for more details.
|
|
582
585
|
#
|
|
583
|
-
# An image input
|
|
586
|
+
# An image input block used within EvalItem content arrays.
|
|
584
587
|
#
|
|
585
588
|
# @param image_url [String] The URL of the image input.
|
|
586
589
|
#
|
|
@@ -590,11 +593,7 @@ module OpenAI
|
|
|
590
593
|
end
|
|
591
594
|
|
|
592
595
|
# @!method self.variants
|
|
593
|
-
# @return [Array(String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<
|
|
594
|
-
|
|
595
|
-
# @type [OpenAI::Internal::Type::Converter]
|
|
596
|
-
AnArrayOfInputTextInputImageAndInputAudioArray =
|
|
597
|
-
OpenAI::Internal::Type::ArrayOf[OpenAI::Internal::Type::Unknown]
|
|
596
|
+
# @return [Array(String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>)]
|
|
598
597
|
end
|
|
599
598
|
|
|
600
599
|
# The role of the message input. One of `user`, `assistant`, `system`, or
|
|
@@ -675,7 +674,7 @@ module OpenAI
|
|
|
675
674
|
# - All models before `gpt-5.1` default to `medium` reasoning effort, and do not
|
|
676
675
|
# support `none`.
|
|
677
676
|
# - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
678
|
-
# - `xhigh` is
|
|
677
|
+
# - `xhigh` is supported for all models after `gpt-5.1-codex-max`.
|
|
679
678
|
#
|
|
680
679
|
# @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
|
|
681
680
|
optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
|
|
@@ -326,7 +326,7 @@ module OpenAI
|
|
|
326
326
|
# - All models before `gpt-5.1` default to `medium` reasoning effort, and do not
|
|
327
327
|
# support `none`.
|
|
328
328
|
# - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
329
|
-
# - `xhigh` is
|
|
329
|
+
# - `xhigh` is supported for all models after `gpt-5.1-codex-max`.
|
|
330
330
|
#
|
|
331
331
|
# @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
|
|
332
332
|
optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
|
|
@@ -468,9 +468,10 @@ module OpenAI
|
|
|
468
468
|
|
|
469
469
|
class EvalItem < OpenAI::Internal::Type::BaseModel
|
|
470
470
|
# @!attribute content
|
|
471
|
-
# Inputs to the model - can contain template strings.
|
|
471
|
+
# Inputs to the model - can contain template strings. Supports text, output text,
|
|
472
|
+
# input images, and input audio, either as a single item or an array of items.
|
|
472
473
|
#
|
|
473
|
-
# @return [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<
|
|
474
|
+
# @return [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>]
|
|
474
475
|
required :content,
|
|
475
476
|
union: -> { OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content }
|
|
476
477
|
|
|
@@ -500,13 +501,14 @@ module OpenAI
|
|
|
500
501
|
# `assistant` role are presumed to have been generated by the model in previous
|
|
501
502
|
# interactions.
|
|
502
503
|
#
|
|
503
|
-
# @param content [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<
|
|
504
|
+
# @param content [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>] Inputs to the model - can contain template strings. Supports text, output text,
|
|
504
505
|
#
|
|
505
506
|
# @param role [Symbol, OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Role] The role of the message input. One of `user`, `assistant`, `system`, or
|
|
506
507
|
#
|
|
507
508
|
# @param type [Symbol, OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Type] The type of the message input. Always `message`.
|
|
508
509
|
|
|
509
|
-
# Inputs to the model - can contain template strings.
|
|
510
|
+
# Inputs to the model - can contain template strings. Supports text, output text,
|
|
511
|
+
# input images, and input audio, either as a single item or an array of items.
|
|
510
512
|
#
|
|
511
513
|
# @see OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem#content
|
|
512
514
|
module Content
|
|
@@ -521,14 +523,15 @@ module OpenAI
|
|
|
521
523
|
# A text output from the model.
|
|
522
524
|
variant -> { OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText }
|
|
523
525
|
|
|
524
|
-
# An image input
|
|
526
|
+
# An image input block used within EvalItem content arrays.
|
|
525
527
|
variant -> { OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage }
|
|
526
528
|
|
|
527
529
|
# An audio input to the model.
|
|
528
530
|
variant -> { OpenAI::Responses::ResponseInputAudio }
|
|
529
531
|
|
|
530
|
-
# A list of inputs, each of which may be either an input text,
|
|
531
|
-
|
|
532
|
+
# A list of inputs, each of which may be either an input text, output text, input
|
|
533
|
+
# image, or input audio object.
|
|
534
|
+
variant -> { OpenAI::Graders::GraderInputs }
|
|
532
535
|
|
|
533
536
|
class OutputText < OpenAI::Internal::Type::BaseModel
|
|
534
537
|
# @!attribute text
|
|
@@ -580,7 +583,7 @@ module OpenAI
|
|
|
580
583
|
# {OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage}
|
|
581
584
|
# for more details.
|
|
582
585
|
#
|
|
583
|
-
# An image input
|
|
586
|
+
# An image input block used within EvalItem content arrays.
|
|
584
587
|
#
|
|
585
588
|
# @param image_url [String] The URL of the image input.
|
|
586
589
|
#
|
|
@@ -590,11 +593,7 @@ module OpenAI
|
|
|
590
593
|
end
|
|
591
594
|
|
|
592
595
|
# @!method self.variants
|
|
593
|
-
# @return [Array(String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<
|
|
594
|
-
|
|
595
|
-
# @type [OpenAI::Internal::Type::Converter]
|
|
596
|
-
AnArrayOfInputTextInputImageAndInputAudioArray =
|
|
597
|
-
OpenAI::Internal::Type::ArrayOf[OpenAI::Internal::Type::Unknown]
|
|
596
|
+
# @return [Array(String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>)]
|
|
598
597
|
end
|
|
599
598
|
|
|
600
599
|
# The role of the message input. One of `user`, `assistant`, `system`, or
|
|
@@ -675,7 +674,7 @@ module OpenAI
|
|
|
675
674
|
# - All models before `gpt-5.1` default to `medium` reasoning effort, and do not
|
|
676
675
|
# support `none`.
|
|
677
676
|
# - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
678
|
-
# - `xhigh` is
|
|
677
|
+
# - `xhigh` is supported for all models after `gpt-5.1-codex-max`.
|
|
679
678
|
#
|
|
680
679
|
# @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
|
|
681
680
|
optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
|
|
@@ -326,7 +326,7 @@ module OpenAI
|
|
|
326
326
|
# - All models before `gpt-5.1` default to `medium` reasoning effort, and do not
|
|
327
327
|
# support `none`.
|
|
328
328
|
# - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
329
|
-
# - `xhigh` is
|
|
329
|
+
# - `xhigh` is supported for all models after `gpt-5.1-codex-max`.
|
|
330
330
|
#
|
|
331
331
|
# @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
|
|
332
332
|
optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
|
|
@@ -472,9 +472,10 @@ module OpenAI
|
|
|
472
472
|
|
|
473
473
|
class EvalItem < OpenAI::Internal::Type::BaseModel
|
|
474
474
|
# @!attribute content
|
|
475
|
-
# Inputs to the model - can contain template strings.
|
|
475
|
+
# Inputs to the model - can contain template strings. Supports text, output text,
|
|
476
|
+
# input images, and input audio, either as a single item or an array of items.
|
|
476
477
|
#
|
|
477
|
-
# @return [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<
|
|
478
|
+
# @return [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>]
|
|
478
479
|
required :content,
|
|
479
480
|
union: -> { OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content }
|
|
480
481
|
|
|
@@ -504,13 +505,14 @@ module OpenAI
|
|
|
504
505
|
# `assistant` role are presumed to have been generated by the model in previous
|
|
505
506
|
# interactions.
|
|
506
507
|
#
|
|
507
|
-
# @param content [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<
|
|
508
|
+
# @param content [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>] Inputs to the model - can contain template strings. Supports text, output text,
|
|
508
509
|
#
|
|
509
510
|
# @param role [Symbol, OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Role] The role of the message input. One of `user`, `assistant`, `system`, or
|
|
510
511
|
#
|
|
511
512
|
# @param type [Symbol, OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Type] The type of the message input. Always `message`.
|
|
512
513
|
|
|
513
|
-
# Inputs to the model - can contain template strings.
|
|
514
|
+
# Inputs to the model - can contain template strings. Supports text, output text,
|
|
515
|
+
# input images, and input audio, either as a single item or an array of items.
|
|
514
516
|
#
|
|
515
517
|
# @see OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem#content
|
|
516
518
|
module Content
|
|
@@ -525,14 +527,15 @@ module OpenAI
|
|
|
525
527
|
# A text output from the model.
|
|
526
528
|
variant -> { OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText }
|
|
527
529
|
|
|
528
|
-
# An image input
|
|
530
|
+
# An image input block used within EvalItem content arrays.
|
|
529
531
|
variant -> { OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage }
|
|
530
532
|
|
|
531
533
|
# An audio input to the model.
|
|
532
534
|
variant -> { OpenAI::Responses::ResponseInputAudio }
|
|
533
535
|
|
|
534
|
-
# A list of inputs, each of which may be either an input text,
|
|
535
|
-
|
|
536
|
+
# A list of inputs, each of which may be either an input text, output text, input
|
|
537
|
+
# image, or input audio object.
|
|
538
|
+
variant -> { OpenAI::Graders::GraderInputs }
|
|
536
539
|
|
|
537
540
|
class OutputText < OpenAI::Internal::Type::BaseModel
|
|
538
541
|
# @!attribute text
|
|
@@ -584,7 +587,7 @@ module OpenAI
|
|
|
584
587
|
# {OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage}
|
|
585
588
|
# for more details.
|
|
586
589
|
#
|
|
587
|
-
# An image input
|
|
590
|
+
# An image input block used within EvalItem content arrays.
|
|
588
591
|
#
|
|
589
592
|
# @param image_url [String] The URL of the image input.
|
|
590
593
|
#
|
|
@@ -594,11 +597,7 @@ module OpenAI
|
|
|
594
597
|
end
|
|
595
598
|
|
|
596
599
|
# @!method self.variants
|
|
597
|
-
# @return [Array(String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<
|
|
598
|
-
|
|
599
|
-
# @type [OpenAI::Internal::Type::Converter]
|
|
600
|
-
AnArrayOfInputTextInputImageAndInputAudioArray =
|
|
601
|
-
OpenAI::Internal::Type::ArrayOf[OpenAI::Internal::Type::Unknown]
|
|
600
|
+
# @return [Array(String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::OutputText, OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>)]
|
|
602
601
|
end
|
|
603
602
|
|
|
604
603
|
# The role of the message input. One of `user`, `assistant`, `system`, or
|
|
@@ -679,7 +678,7 @@ module OpenAI
|
|
|
679
678
|
# - All models before `gpt-5.1` default to `medium` reasoning effort, and do not
|
|
680
679
|
# support `none`.
|
|
681
680
|
# - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
682
|
-
# - `xhigh` is
|
|
681
|
+
# - `xhigh` is supported for all models after `gpt-5.1-codex-max`.
|
|
683
682
|
#
|
|
684
683
|
# @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
|
|
685
684
|
optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Graders
|
|
6
|
+
# A single content item: input text, output text, input image, or input audio.
|
|
7
|
+
module GraderInputItem
|
|
8
|
+
extend OpenAI::Internal::Type::Union
|
|
9
|
+
|
|
10
|
+
# A text input to the model.
|
|
11
|
+
variant String
|
|
12
|
+
|
|
13
|
+
# A text input to the model.
|
|
14
|
+
variant -> { OpenAI::Responses::ResponseInputText }
|
|
15
|
+
|
|
16
|
+
# A text output from the model.
|
|
17
|
+
variant -> { OpenAI::Graders::GraderInputItem::OutputText }
|
|
18
|
+
|
|
19
|
+
# An image input block used within EvalItem content arrays.
|
|
20
|
+
variant -> { OpenAI::Graders::GraderInputItem::InputImage }
|
|
21
|
+
|
|
22
|
+
# An audio input to the model.
|
|
23
|
+
variant -> { OpenAI::Responses::ResponseInputAudio }
|
|
24
|
+
|
|
25
|
+
class OutputText < OpenAI::Internal::Type::BaseModel
|
|
26
|
+
# @!attribute text
|
|
27
|
+
# The text output from the model.
|
|
28
|
+
#
|
|
29
|
+
# @return [String]
|
|
30
|
+
required :text, String
|
|
31
|
+
|
|
32
|
+
# @!attribute type
|
|
33
|
+
# The type of the output text. Always `output_text`.
|
|
34
|
+
#
|
|
35
|
+
# @return [Symbol, :output_text]
|
|
36
|
+
required :type, const: :output_text
|
|
37
|
+
|
|
38
|
+
# @!method initialize(text:, type: :output_text)
|
|
39
|
+
# Some parameter documentations has been truncated, see
|
|
40
|
+
# {OpenAI::Models::Graders::GraderInputItem::OutputText} for more details.
|
|
41
|
+
#
|
|
42
|
+
# A text output from the model.
|
|
43
|
+
#
|
|
44
|
+
# @param text [String] The text output from the model.
|
|
45
|
+
#
|
|
46
|
+
# @param type [Symbol, :output_text] The type of the output text. Always `output_text`.
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
class InputImage < OpenAI::Internal::Type::BaseModel
|
|
50
|
+
# @!attribute image_url
|
|
51
|
+
# The URL of the image input.
|
|
52
|
+
#
|
|
53
|
+
# @return [String]
|
|
54
|
+
required :image_url, String
|
|
55
|
+
|
|
56
|
+
# @!attribute type
|
|
57
|
+
# The type of the image input. Always `input_image`.
|
|
58
|
+
#
|
|
59
|
+
# @return [Symbol, :input_image]
|
|
60
|
+
required :type, const: :input_image
|
|
61
|
+
|
|
62
|
+
# @!attribute detail
|
|
63
|
+
# The detail level of the image to be sent to the model. One of `high`, `low`, or
|
|
64
|
+
# `auto`. Defaults to `auto`.
|
|
65
|
+
#
|
|
66
|
+
# @return [String, nil]
|
|
67
|
+
optional :detail, String
|
|
68
|
+
|
|
69
|
+
# @!method initialize(image_url:, detail: nil, type: :input_image)
|
|
70
|
+
# Some parameter documentations has been truncated, see
|
|
71
|
+
# {OpenAI::Models::Graders::GraderInputItem::InputImage} for more details.
|
|
72
|
+
#
|
|
73
|
+
# An image input block used within EvalItem content arrays.
|
|
74
|
+
#
|
|
75
|
+
# @param image_url [String] The URL of the image input.
|
|
76
|
+
#
|
|
77
|
+
# @param detail [String] The detail level of the image to be sent to the model. One of `high`, `low`, or
|
|
78
|
+
#
|
|
79
|
+
# @param type [Symbol, :input_image] The type of the image input. Always `input_image`.
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
# @!method self.variants
|
|
83
|
+
# @return [Array(String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio)]
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# @type [OpenAI::Internal::Type::Converter]
|
|
87
|
+
GraderInputs = OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::Graders::GraderInputItem }]
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
# @type [OpenAI::Internal::Type::Converter]
|
|
91
|
+
GraderInputs = Graders::GraderInputs
|
|
92
|
+
end
|
|
93
|
+
end
|
|
@@ -57,9 +57,10 @@ module OpenAI
|
|
|
57
57
|
|
|
58
58
|
class Input < OpenAI::Internal::Type::BaseModel
|
|
59
59
|
# @!attribute content
|
|
60
|
-
# Inputs to the model - can contain template strings.
|
|
60
|
+
# Inputs to the model - can contain template strings. Supports text, output text,
|
|
61
|
+
# input images, and input audio, either as a single item or an array of items.
|
|
61
62
|
#
|
|
62
|
-
# @return [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::LabelModelGrader::Input::Content::OutputText, OpenAI::Models::Graders::LabelModelGrader::Input::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<
|
|
63
|
+
# @return [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::LabelModelGrader::Input::Content::OutputText, OpenAI::Models::Graders::LabelModelGrader::Input::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>]
|
|
63
64
|
required :content, union: -> { OpenAI::Graders::LabelModelGrader::Input::Content }
|
|
64
65
|
|
|
65
66
|
# @!attribute role
|
|
@@ -85,13 +86,14 @@ module OpenAI
|
|
|
85
86
|
# `assistant` role are presumed to have been generated by the model in previous
|
|
86
87
|
# interactions.
|
|
87
88
|
#
|
|
88
|
-
# @param content [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::LabelModelGrader::Input::Content::OutputText, OpenAI::Models::Graders::LabelModelGrader::Input::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<
|
|
89
|
+
# @param content [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::LabelModelGrader::Input::Content::OutputText, OpenAI::Models::Graders::LabelModelGrader::Input::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>] Inputs to the model - can contain template strings. Supports text, output text,
|
|
89
90
|
#
|
|
90
91
|
# @param role [Symbol, OpenAI::Models::Graders::LabelModelGrader::Input::Role] The role of the message input. One of `user`, `assistant`, `system`, or
|
|
91
92
|
#
|
|
92
93
|
# @param type [Symbol, OpenAI::Models::Graders::LabelModelGrader::Input::Type] The type of the message input. Always `message`.
|
|
93
94
|
|
|
94
|
-
# Inputs to the model - can contain template strings.
|
|
95
|
+
# Inputs to the model - can contain template strings. Supports text, output text,
|
|
96
|
+
# input images, and input audio, either as a single item or an array of items.
|
|
95
97
|
#
|
|
96
98
|
# @see OpenAI::Models::Graders::LabelModelGrader::Input#content
|
|
97
99
|
module Content
|
|
@@ -106,14 +108,15 @@ module OpenAI
|
|
|
106
108
|
# A text output from the model.
|
|
107
109
|
variant -> { OpenAI::Graders::LabelModelGrader::Input::Content::OutputText }
|
|
108
110
|
|
|
109
|
-
# An image input
|
|
111
|
+
# An image input block used within EvalItem content arrays.
|
|
110
112
|
variant -> { OpenAI::Graders::LabelModelGrader::Input::Content::InputImage }
|
|
111
113
|
|
|
112
114
|
# An audio input to the model.
|
|
113
115
|
variant -> { OpenAI::Responses::ResponseInputAudio }
|
|
114
116
|
|
|
115
|
-
# A list of inputs, each of which may be either an input text,
|
|
116
|
-
|
|
117
|
+
# A list of inputs, each of which may be either an input text, output text, input
|
|
118
|
+
# image, or input audio object.
|
|
119
|
+
variant -> { OpenAI::Graders::GraderInputs }
|
|
117
120
|
|
|
118
121
|
class OutputText < OpenAI::Internal::Type::BaseModel
|
|
119
122
|
# @!attribute text
|
|
@@ -165,7 +168,7 @@ module OpenAI
|
|
|
165
168
|
# {OpenAI::Models::Graders::LabelModelGrader::Input::Content::InputImage} for more
|
|
166
169
|
# details.
|
|
167
170
|
#
|
|
168
|
-
# An image input
|
|
171
|
+
# An image input block used within EvalItem content arrays.
|
|
169
172
|
#
|
|
170
173
|
# @param image_url [String] The URL of the image input.
|
|
171
174
|
#
|
|
@@ -175,11 +178,7 @@ module OpenAI
|
|
|
175
178
|
end
|
|
176
179
|
|
|
177
180
|
# @!method self.variants
|
|
178
|
-
# @return [Array(String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::LabelModelGrader::Input::Content::OutputText, OpenAI::Models::Graders::LabelModelGrader::Input::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<
|
|
179
|
-
|
|
180
|
-
# @type [OpenAI::Internal::Type::Converter]
|
|
181
|
-
AnArrayOfInputTextInputImageAndInputAudioArray =
|
|
182
|
-
OpenAI::Internal::Type::ArrayOf[OpenAI::Internal::Type::Unknown]
|
|
181
|
+
# @return [Array(String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::LabelModelGrader::Input::Content::OutputText, OpenAI::Models::Graders::LabelModelGrader::Input::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>)]
|
|
183
182
|
end
|
|
184
183
|
|
|
185
184
|
# The role of the message input. One of `user`, `assistant`, `system`, or
|
|
@@ -5,7 +5,8 @@ module OpenAI
|
|
|
5
5
|
module Graders
|
|
6
6
|
class ScoreModelGrader < OpenAI::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute input
|
|
8
|
-
# The input
|
|
8
|
+
# The input messages evaluated by the grader. Supports text, output text, input
|
|
9
|
+
# image, and input audio content blocks, and may include template strings.
|
|
9
10
|
#
|
|
10
11
|
# @return [Array<OpenAI::Models::Graders::ScoreModelGrader::Input>]
|
|
11
12
|
required :input, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Graders::ScoreModelGrader::Input] }
|
|
@@ -41,9 +42,12 @@ module OpenAI
|
|
|
41
42
|
optional :sampling_params, -> { OpenAI::Graders::ScoreModelGrader::SamplingParams }
|
|
42
43
|
|
|
43
44
|
# @!method initialize(input:, model:, name:, range: nil, sampling_params: nil, type: :score_model)
|
|
45
|
+
# Some parameter documentations has been truncated, see
|
|
46
|
+
# {OpenAI::Models::Graders::ScoreModelGrader} for more details.
|
|
47
|
+
#
|
|
44
48
|
# A ScoreModelGrader object that uses a model to assign a score to the input.
|
|
45
49
|
#
|
|
46
|
-
# @param input [Array<OpenAI::Models::Graders::ScoreModelGrader::Input>] The input
|
|
50
|
+
# @param input [Array<OpenAI::Models::Graders::ScoreModelGrader::Input>] The input messages evaluated by the grader. Supports text, output text, input im
|
|
47
51
|
#
|
|
48
52
|
# @param model [String] The model to use for the evaluation.
|
|
49
53
|
#
|
|
@@ -57,9 +61,10 @@ module OpenAI
|
|
|
57
61
|
|
|
58
62
|
class Input < OpenAI::Internal::Type::BaseModel
|
|
59
63
|
# @!attribute content
|
|
60
|
-
# Inputs to the model - can contain template strings.
|
|
64
|
+
# Inputs to the model - can contain template strings. Supports text, output text,
|
|
65
|
+
# input images, and input audio, either as a single item or an array of items.
|
|
61
66
|
#
|
|
62
|
-
# @return [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::OutputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<
|
|
67
|
+
# @return [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::OutputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>]
|
|
63
68
|
required :content, union: -> { OpenAI::Graders::ScoreModelGrader::Input::Content }
|
|
64
69
|
|
|
65
70
|
# @!attribute role
|
|
@@ -85,13 +90,14 @@ module OpenAI
|
|
|
85
90
|
# `assistant` role are presumed to have been generated by the model in previous
|
|
86
91
|
# interactions.
|
|
87
92
|
#
|
|
88
|
-
# @param content [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::OutputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<
|
|
93
|
+
# @param content [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::OutputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>] Inputs to the model - can contain template strings. Supports text, output text,
|
|
89
94
|
#
|
|
90
95
|
# @param role [Symbol, OpenAI::Models::Graders::ScoreModelGrader::Input::Role] The role of the message input. One of `user`, `assistant`, `system`, or
|
|
91
96
|
#
|
|
92
97
|
# @param type [Symbol, OpenAI::Models::Graders::ScoreModelGrader::Input::Type] The type of the message input. Always `message`.
|
|
93
98
|
|
|
94
|
-
# Inputs to the model - can contain template strings.
|
|
99
|
+
# Inputs to the model - can contain template strings. Supports text, output text,
|
|
100
|
+
# input images, and input audio, either as a single item or an array of items.
|
|
95
101
|
#
|
|
96
102
|
# @see OpenAI::Models::Graders::ScoreModelGrader::Input#content
|
|
97
103
|
module Content
|
|
@@ -106,14 +112,15 @@ module OpenAI
|
|
|
106
112
|
# A text output from the model.
|
|
107
113
|
variant -> { OpenAI::Graders::ScoreModelGrader::Input::Content::OutputText }
|
|
108
114
|
|
|
109
|
-
# An image input
|
|
115
|
+
# An image input block used within EvalItem content arrays.
|
|
110
116
|
variant -> { OpenAI::Graders::ScoreModelGrader::Input::Content::InputImage }
|
|
111
117
|
|
|
112
118
|
# An audio input to the model.
|
|
113
119
|
variant -> { OpenAI::Responses::ResponseInputAudio }
|
|
114
120
|
|
|
115
|
-
# A list of inputs, each of which may be either an input text,
|
|
116
|
-
|
|
121
|
+
# A list of inputs, each of which may be either an input text, output text, input
|
|
122
|
+
# image, or input audio object.
|
|
123
|
+
variant -> { OpenAI::Graders::GraderInputs }
|
|
117
124
|
|
|
118
125
|
class OutputText < OpenAI::Internal::Type::BaseModel
|
|
119
126
|
# @!attribute text
|
|
@@ -165,7 +172,7 @@ module OpenAI
|
|
|
165
172
|
# {OpenAI::Models::Graders::ScoreModelGrader::Input::Content::InputImage} for more
|
|
166
173
|
# details.
|
|
167
174
|
#
|
|
168
|
-
# An image input
|
|
175
|
+
# An image input block used within EvalItem content arrays.
|
|
169
176
|
#
|
|
170
177
|
# @param image_url [String] The URL of the image input.
|
|
171
178
|
#
|
|
@@ -175,11 +182,7 @@ module OpenAI
|
|
|
175
182
|
end
|
|
176
183
|
|
|
177
184
|
# @!method self.variants
|
|
178
|
-
# @return [Array(String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::OutputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<
|
|
179
|
-
|
|
180
|
-
# @type [OpenAI::Internal::Type::Converter]
|
|
181
|
-
AnArrayOfInputTextInputImageAndInputAudioArray =
|
|
182
|
-
OpenAI::Internal::Type::ArrayOf[OpenAI::Internal::Type::Unknown]
|
|
185
|
+
# @return [Array(String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::OutputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::InputImage, OpenAI::Models::Responses::ResponseInputAudio, Array<String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::GraderInputItem::OutputText, OpenAI::Models::Graders::GraderInputItem::InputImage, OpenAI::Models::Responses::ResponseInputAudio>)]
|
|
183
186
|
end
|
|
184
187
|
|
|
185
188
|
# The role of the message input. One of `user`, `assistant`, `system`, or
|
|
@@ -232,7 +235,7 @@ module OpenAI
|
|
|
232
235
|
# - All models before `gpt-5.1` default to `medium` reasoning effort, and do not
|
|
233
236
|
# support `none`.
|
|
234
237
|
# - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
235
|
-
# - `xhigh` is
|
|
238
|
+
# - `xhigh` is supported for all models after `gpt-5.1-codex-max`.
|
|
236
239
|
#
|
|
237
240
|
# @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
|
|
238
241
|
optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
|
|
@@ -16,7 +16,7 @@ module OpenAI
|
|
|
16
16
|
# - All models before `gpt-5.1` default to `medium` reasoning effort, and do not
|
|
17
17
|
# support `none`.
|
|
18
18
|
# - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
19
|
-
# - `xhigh` is
|
|
19
|
+
# - `xhigh` is supported for all models after `gpt-5.1-codex-max`.
|
|
20
20
|
#
|
|
21
21
|
# @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
|
|
22
22
|
optional :effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
|
|
@@ -38,7 +38,8 @@ module OpenAI
|
|
|
38
38
|
# debugging and understanding the model's reasoning process. One of `auto`,
|
|
39
39
|
# `concise`, or `detailed`.
|
|
40
40
|
#
|
|
41
|
-
# `concise` is
|
|
41
|
+
# `concise` is supported for `computer-use-preview` models and all reasoning
|
|
42
|
+
# models after `gpt-5`.
|
|
42
43
|
#
|
|
43
44
|
# @return [Symbol, OpenAI::Models::Reasoning::Summary, nil]
|
|
44
45
|
optional :summary, enum: -> { OpenAI::Reasoning::Summary }, nil?: true
|
|
@@ -82,7 +83,8 @@ module OpenAI
|
|
|
82
83
|
# debugging and understanding the model's reasoning process. One of `auto`,
|
|
83
84
|
# `concise`, or `detailed`.
|
|
84
85
|
#
|
|
85
|
-
# `concise` is
|
|
86
|
+
# `concise` is supported for `computer-use-preview` models and all reasoning
|
|
87
|
+
# models after `gpt-5`.
|
|
86
88
|
#
|
|
87
89
|
# @see OpenAI::Models::Reasoning#summary
|
|
88
90
|
module Summary
|
|
@@ -14,7 +14,7 @@ module OpenAI
|
|
|
14
14
|
# - All models before `gpt-5.1` default to `medium` reasoning effort, and do not
|
|
15
15
|
# support `none`.
|
|
16
16
|
# - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
17
|
-
# - `xhigh` is
|
|
17
|
+
# - `xhigh` is supported for all models after `gpt-5.1-codex-max`.
|
|
18
18
|
module ReasoningEffort
|
|
19
19
|
extend OpenAI::Internal::Type::Enum
|
|
20
20
|
|
|
@@ -64,6 +64,16 @@ module OpenAI
|
|
|
64
64
|
module Model
|
|
65
65
|
extend OpenAI::Internal::Type::Union
|
|
66
66
|
|
|
67
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_2 }
|
|
68
|
+
|
|
69
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_2_2025_12_11 }
|
|
70
|
+
|
|
71
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_2_CHAT_LATEST }
|
|
72
|
+
|
|
73
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_2_PRO }
|
|
74
|
+
|
|
75
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_2_PRO_2025_12_11 }
|
|
76
|
+
|
|
67
77
|
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_1 }
|
|
68
78
|
|
|
69
79
|
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_1_2025_11_13 }
|
|
@@ -237,6 +247,11 @@ module OpenAI
|
|
|
237
247
|
|
|
238
248
|
# @!group
|
|
239
249
|
|
|
250
|
+
GPT_5_2 = :"gpt-5.2"
|
|
251
|
+
GPT_5_2_2025_12_11 = :"gpt-5.2-2025-12-11"
|
|
252
|
+
GPT_5_2_CHAT_LATEST = :"gpt-5.2-chat-latest"
|
|
253
|
+
GPT_5_2_PRO = :"gpt-5.2-pro"
|
|
254
|
+
GPT_5_2_PRO_2025_12_11 = :"gpt-5.2-pro-2025-12-11"
|
|
240
255
|
GPT_5_1 = :"gpt-5.1"
|
|
241
256
|
GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
|
|
242
257
|
GPT_5_1_CODEX = :"gpt-5.1-codex"
|
|
@@ -7,6 +7,9 @@ module OpenAI
|
|
|
7
7
|
|
|
8
8
|
SORA_2 = :"sora-2"
|
|
9
9
|
SORA_2_PRO = :"sora-2-pro"
|
|
10
|
+
SORA_2_2025_10_06 = :"sora-2-2025-10-06"
|
|
11
|
+
SORA_2_PRO_2025_10_06 = :"sora-2-pro-2025-10-06"
|
|
12
|
+
SORA_2_2025_12_08 = :"sora-2-2025-12-08"
|
|
10
13
|
|
|
11
14
|
# @!method self.values
|
|
12
15
|
# @return [Array<Symbol>]
|