openai 0.98.0 → 0.100.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 +26 -0
- data/README.md +1 -1
- data/bedrock.md +17 -1
- data/lib/openai/client.rb +9 -0
- data/lib/openai/helpers/agents/session_stream.rb +11 -36
- data/lib/openai/helpers/agents/tools.rb +34 -4
- data/lib/openai/helpers/beta/agents/creation_stream.rb +26 -0
- data/lib/openai/helpers/beta/agents/function_tool.rb +11 -4
- data/lib/openai/helpers/beta/agents/tool_dispatcher.rb +74 -0
- data/lib/openai/helpers/beta/agents/tool_error.rb +28 -0
- data/lib/openai/models/admin/organization/usage_audio_speeches_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_audio_transcriptions_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_completions_params.rb +9 -4
- data/lib/openai/models/admin/organization/usage_completions_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_costs_params.rb +16 -4
- data/lib/openai/models/admin/organization/usage_costs_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_embeddings_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_file_search_calls_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_images_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_moderations_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_vector_stores_response.rb +140 -5
- data/lib/openai/models/admin/organization/usage_web_search_calls_params.rb +9 -4
- data/lib/openai/models/admin/organization/usage_web_search_calls_response.rb +140 -5
- data/lib/openai/models/all_models.rb +42 -0
- data/lib/openai/models/audio/speech_create_params.rb +6 -0
- data/lib/openai/models/audio/voice.rb +75 -0
- data/lib/openai/models/audio/voice_create_params.rb +217 -0
- data/lib/openai/models/beta/agent_create_params.rb +0 -3
- data/lib/openai/models/beta/agent_update_params.rb +0 -3
- data/lib/openai/models/beta/agents/environments/template_create_params.rb +6 -6
- data/lib/openai/models/beta/agents/environments/template_update_params.rb +3 -6
- data/lib/openai/models/beta/agents/session_create_params.rb +0 -3
- data/lib/openai/models/beta/agents/session_update_params.rb +0 -3
- data/lib/openai/models/beta/agents/sessions/turns/item_list_params.rb +79 -0
- data/lib/openai/models/beta/beta_response.rb +220 -0
- data/lib/openai/models/beta/beta_response_computer_tool_call_output_item.rb +2 -2
- data/lib/openai/models/beta/beta_response_error.rb +12 -1
- data/lib/openai/models/beta/beta_responses_client_event.rb +220 -0
- data/lib/openai/models/beta/beta_responses_server_event.rb +12 -1
- data/lib/openai/models/beta/beta_tool.rb +15 -18
- data/lib/openai/models/beta/environment_param.rb +6 -6
- data/lib/openai/models/beta/response_compact_params.rb +220 -0
- data/lib/openai/models/beta/response_create_params.rb +220 -0
- data/lib/openai/models/beta/session_turn_error.rb +9 -0
- data/lib/openai/models/chat/chat_completion_audio_param.rb +6 -3
- data/lib/openai/models/chat/chat_completion_chunk.rb +85 -18
- data/lib/openai/models/chat_model.rb +178 -0
- data/lib/openai/models/error_object.rb +12 -1
- data/lib/openai/models/eval_create_params.rb +1 -1
- data/lib/openai/models/eval_create_response.rb +1 -1
- data/lib/openai/models/eval_list_response.rb +1 -1
- data/lib/openai/models/eval_retrieve_response.rb +1 -1
- data/lib/openai/models/eval_update_response.rb +1 -1
- data/lib/openai/models/fine_tuning/job_list_params.rb +14 -4
- data/lib/openai/models/graders/score_model_grader.rb +2 -2
- data/lib/openai/models/image.rb +14 -14
- data/lib/openai/models/image_create_variation_params.rb +7 -7
- data/lib/openai/models/image_edit_params.rb +88 -96
- data/lib/openai/models/image_generate_params.rb +51 -62
- data/lib/openai/models/image_model.rb +5 -3
- data/lib/openai/models/realtime/realtime_audio_config_output.rb +9 -6
- data/lib/openai/models/realtime/realtime_client_event.rb +9 -0
- data/lib/openai/models/realtime/realtime_response_create_audio_output.rb +9 -6
- data/lib/openai/models/realtime/session_update_event.rb +16 -0
- data/lib/openai/models/responses/response_compact_params.rb +220 -0
- data/lib/openai/models/responses/response_computer_tool_call_output_item.rb +2 -2
- data/lib/openai/models/responses/response_error.rb +12 -1
- data/lib/openai/models/responses/responses_server_event.rb +12 -1
- data/lib/openai/models/responses/tool.rb +15 -18
- data/lib/openai/models/responses_model.rb +42 -0
- data/lib/openai/models/video_create_error.rb +12 -1
- data/lib/openai/models/webhooks/agent_session_action_required_webhook_event.rb +109 -0
- data/lib/openai/models/webhooks/agent_session_created_webhook_event.rb +106 -0
- data/lib/openai/models/webhooks/agent_session_failed_webhook_event.rb +86 -0
- data/lib/openai/models/webhooks/agent_session_idle_webhook_event.rb +86 -0
- data/lib/openai/models/webhooks/agent_session_in_progress_webhook_event.rb +86 -0
- data/lib/openai/models/webhooks/unwrap_webhook_event.rb +18 -2
- data/lib/openai/models/webhooks/webhook_create_params.rb +5 -0
- data/lib/openai/models/webhooks/webhook_test_params.rb +5 -0
- data/lib/openai/models/webhooks/webhook_update_params.rb +5 -0
- data/lib/openai/providers/bedrock.rb +20 -1
- data/lib/openai/resources/admin/organization/usage.rb +15 -6
- data/lib/openai/resources/audio/speech.rb +2 -0
- data/lib/openai/resources/audio/voices.rb +53 -0
- data/lib/openai/resources/audio.rb +5 -0
- data/lib/openai/resources/beta/agents/environments/templates.rb +3 -4
- data/lib/openai/resources/beta/agents/sessions/turns/items.rb +68 -0
- data/lib/openai/resources/beta/agents/sessions/turns.rb +4 -0
- data/lib/openai/resources/beta/agents/sessions.rb +22 -2
- data/lib/openai/resources/fine_tuning/jobs.rb +7 -2
- data/lib/openai/resources/images.rb +79 -109
- data/lib/openai/resources/webhooks.rb +1 -1
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +10 -0
- data/rbi/openai/helpers/agents.rbi +2 -0
- data/rbi/openai/helpers/beta/agents/function_tool.rbi +8 -3
- data/rbi/openai/helpers/beta/agents/tool_error.rbi +19 -0
- data/rbi/openai/helpers/beta/agents.rbi +12 -0
- data/rbi/openai/models/admin/organization/usage_audio_speeches_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_audio_transcriptions_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_completions_params.rbi +9 -4
- data/rbi/openai/models/admin/organization/usage_completions_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_costs_params.rbi +16 -4
- data/rbi/openai/models/admin/organization/usage_costs_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_embeddings_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_file_search_calls_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_images_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_moderations_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_vector_stores_response.rbi +213 -3
- data/rbi/openai/models/admin/organization/usage_web_search_calls_params.rbi +12 -4
- data/rbi/openai/models/admin/organization/usage_web_search_calls_response.rbi +213 -3
- data/rbi/openai/models/audio/speech_create_params.rbi +6 -0
- data/rbi/openai/models/audio/voice.rbi +111 -0
- data/rbi/openai/models/audio/voice_create_params.rbi +321 -0
- data/rbi/openai/models/beta/agent_create_params.rbi +0 -3
- data/rbi/openai/models/beta/agent_update_params.rbi +0 -3
- data/rbi/openai/models/beta/agents/environments/template_create_params.rbi +6 -6
- data/rbi/openai/models/beta/agents/environments/template_update_params.rbi +3 -6
- data/rbi/openai/models/beta/agents/session_create_params.rbi +0 -3
- data/rbi/openai/models/beta/agents/session_update_params.rbi +0 -3
- data/rbi/openai/models/beta/agents/sessions/turns/item_list_params.rbi +139 -0
- data/rbi/openai/models/beta/beta_response_computer_tool_call_output_item.rbi +2 -2
- data/rbi/openai/models/beta/beta_response_error.rbi +12 -0
- data/rbi/openai/models/beta/beta_responses_server_event.rbi +12 -0
- data/rbi/openai/models/beta/beta_tool.rbi +15 -18
- data/rbi/openai/models/beta/environment_param.rbi +6 -6
- data/rbi/openai/models/beta/session_turn_error.rbi +18 -0
- data/rbi/openai/models/chat/chat_completion_audio_param.rbi +6 -3
- data/rbi/openai/models/chat/chat_completion_chunk.rbi +123 -17
- data/rbi/openai/models/error_object.rbi +12 -0
- data/rbi/openai/models/eval_create_params.rbi +1 -1
- data/rbi/openai/models/eval_create_response.rbi +1 -1
- data/rbi/openai/models/eval_list_response.rbi +1 -1
- data/rbi/openai/models/eval_retrieve_response.rbi +1 -1
- data/rbi/openai/models/eval_update_response.rbi +1 -1
- data/rbi/openai/models/fine_tuning/job_list_params.rbi +14 -4
- data/rbi/openai/models/graders/score_model_grader.rbi +2 -2
- data/rbi/openai/models/image.rbi +14 -14
- data/rbi/openai/models/image_create_variation_params.rbi +6 -6
- data/rbi/openai/models/image_edit_params.rbi +73 -91
- data/rbi/openai/models/image_generate_params.rbi +30 -61
- data/rbi/openai/models/image_model.rbi +3 -3
- data/rbi/openai/models/realtime/realtime_audio_config_output.rbi +9 -6
- data/rbi/openai/models/realtime/realtime_response_create_audio_output.rbi +9 -6
- data/rbi/openai/models/realtime/session_update_event.rbi +16 -0
- data/rbi/openai/models/responses/response_computer_tool_call_output_item.rbi +2 -2
- data/rbi/openai/models/responses/response_error.rbi +12 -0
- data/rbi/openai/models/responses/responses_server_event.rbi +12 -0
- data/rbi/openai/models/responses/tool.rbi +15 -18
- data/rbi/openai/models/video_create_error.rbi +12 -0
- data/rbi/openai/models/webhooks/agent_session_action_required_webhook_event.rbi +222 -0
- data/rbi/openai/models/webhooks/agent_session_created_webhook_event.rbi +202 -0
- data/rbi/openai/models/webhooks/agent_session_failed_webhook_event.rbi +151 -0
- data/rbi/openai/models/webhooks/agent_session_idle_webhook_event.rbi +151 -0
- data/rbi/openai/models/webhooks/agent_session_in_progress_webhook_event.rbi +151 -0
- data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +7 -1
- data/rbi/openai/models/webhooks/webhook_create_params.rbi +20 -0
- data/rbi/openai/models/webhooks/webhook_test_params.rbi +20 -0
- data/rbi/openai/models/webhooks/webhook_update_params.rbi +20 -0
- data/rbi/openai/resources/admin/organization/usage.rbi +15 -6
- data/rbi/openai/resources/audio/speech.rbi +2 -0
- data/rbi/openai/resources/audio/voices.rbi +49 -0
- data/rbi/openai/resources/audio.rbi +4 -0
- data/rbi/openai/resources/beta/agents/environments/templates.rbi +3 -4
- data/rbi/openai/resources/beta/agents/sessions/turns/items.rbi +62 -0
- data/rbi/openai/resources/beta/agents/sessions/turns.rbi +3 -0
- data/rbi/openai/resources/beta/agents/sessions.rbi +2 -0
- data/rbi/openai/resources/fine_tuning/jobs.rbi +7 -2
- data/rbi/openai/resources/images.rbi +77 -109
- data/rbi/openai/resources/webhooks.rbi +5 -0
- data/sig/openai/helpers/agents.rbs +3 -0
- data/sig/openai/helpers/beta/agents/function_tool.rbs +5 -2
- data/sig/openai/helpers/beta/agents/tool_error.rbs +17 -0
- data/sig/openai/helpers/beta/agents.rbs +5 -0
- data/sig/openai/models/admin/organization/usage_audio_speeches_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_audio_transcriptions_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_completions_params.rbs +14 -6
- data/sig/openai/models/admin/organization/usage_completions_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_costs_params.rbs +25 -7
- data/sig/openai/models/admin/organization/usage_costs_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_embeddings_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_file_search_calls_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_images_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_moderations_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_vector_stores_response.rbs +107 -5
- data/sig/openai/models/admin/organization/usage_web_search_calls_params.rbs +19 -7
- data/sig/openai/models/admin/organization/usage_web_search_calls_response.rbs +107 -5
- data/sig/openai/models/audio/speech_create_params.rbs +4 -0
- data/sig/openai/models/audio/voice.rbs +70 -0
- data/sig/openai/models/audio/voice_create_params.rbs +203 -0
- data/sig/openai/models/beta/agent_create_params.rbs +1 -5
- data/sig/openai/models/beta/agent_update_params.rbs +1 -5
- data/sig/openai/models/beta/agents/environments/template_create_params.rbs +4 -4
- data/sig/openai/models/beta/agents/environments/template_update_params.rbs +2 -4
- data/sig/openai/models/beta/agents/session_create_params.rbs +1 -5
- data/sig/openai/models/beta/agents/session_update_params.rbs +1 -5
- data/sig/openai/models/beta/agents/sessions/turns/item_list_params.rbs +91 -0
- data/sig/openai/models/beta/beta_response_computer_tool_call_output_item.rbs +2 -2
- data/sig/openai/models/beta/beta_response_error.rbs +10 -0
- data/sig/openai/models/beta/beta_responses_server_event.rbs +10 -0
- data/sig/openai/models/beta/beta_tool.rbs +11 -15
- data/sig/openai/models/beta/environment_param.rbs +4 -4
- data/sig/openai/models/beta/session_turn_error.rbs +12 -0
- data/sig/openai/models/chat/chat_completion_audio_param.rbs +4 -2
- data/sig/openai/models/chat/chat_completion_chunk.rbs +96 -12
- data/sig/openai/models/error_object.rbs +10 -0
- data/sig/openai/models/eval_create_params.rbs +1 -1
- data/sig/openai/models/eval_create_response.rbs +1 -1
- data/sig/openai/models/eval_list_response.rbs +1 -1
- data/sig/openai/models/eval_retrieve_response.rbs +1 -1
- data/sig/openai/models/eval_update_response.rbs +1 -1
- data/sig/openai/models/fine_tuning/job_list_params.rbs +14 -4
- data/sig/openai/models/graders/score_model_grader.rbs +3 -3
- data/sig/openai/models/image.rbs +21 -21
- data/sig/openai/models/image_create_variation_params.rbs +4 -4
- data/sig/openai/models/image_edit_params.rbs +54 -66
- data/sig/openai/models/image_generate_params.rbs +23 -45
- data/sig/openai/models/image_model.rbs +6 -6
- data/sig/openai/models/realtime/realtime_audio_config_output.rbs +9 -6
- data/sig/openai/models/realtime/realtime_response_create_audio_output.rbs +9 -6
- data/sig/openai/models/responses/response_computer_tool_call_output_item.rbs +2 -2
- data/sig/openai/models/responses/response_error.rbs +10 -0
- data/sig/openai/models/responses/responses_server_event.rbs +10 -0
- data/sig/openai/models/responses/tool.rbs +11 -15
- data/sig/openai/models/video_create_error.rbs +10 -0
- data/sig/openai/models/webhooks/agent_session_action_required_webhook_event.rbs +114 -0
- data/sig/openai/models/webhooks/agent_session_created_webhook_event.rbs +115 -0
- data/sig/openai/models/webhooks/agent_session_failed_webhook_event.rbs +89 -0
- data/sig/openai/models/webhooks/agent_session_idle_webhook_event.rbs +89 -0
- data/sig/openai/models/webhooks/agent_session_in_progress_webhook_event.rbs +89 -0
- data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +6 -1
- data/sig/openai/models/webhooks/webhook_create_params.rbs +10 -0
- data/sig/openai/models/webhooks/webhook_test_params.rbs +10 -0
- data/sig/openai/models/webhooks/webhook_update_params.rbs +10 -0
- data/sig/openai/resources/audio/voices.rbs +14 -0
- data/sig/openai/resources/audio.rbs +2 -0
- data/sig/openai/resources/beta/agents/sessions/turns/items.rbs +24 -0
- data/sig/openai/resources/beta/agents/sessions/turns.rbs +2 -0
- data/sig/openai/resources/beta/agents/sessions.rbs +1 -0
- data/sig/openai/resources/webhooks.rbs +6 -1
- metadata +35 -1
|
@@ -5,17 +5,19 @@ module OpenAI
|
|
|
5
5
|
module ImageModel
|
|
6
6
|
extend OpenAI::Internal::Type::Enum
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
GPT_IMAGE_1_MINI = :"gpt-image-1-mini"
|
|
8
|
+
GPT_IMAGE_1_5 = :"gpt-image-1.5"
|
|
10
9
|
GPT_IMAGE_2 = :"gpt-image-2"
|
|
11
10
|
GPT_IMAGE_2_2026_04_21 = :"gpt-image-2-2026-04-21"
|
|
12
11
|
GPT_IMAGE_2_5_SUNBURST = :"gpt-image-2.5-sunburst"
|
|
13
12
|
GPT_IMAGE_2_5_SUNBURST_2026_09_08 = :"gpt-image-2.5-sunburst-2026-09-08"
|
|
14
13
|
GPT_IMAGE_2_5_FLARE = :"gpt-image-2.5-flare"
|
|
15
14
|
GPT_IMAGE_2_5_FLARE_2026_09_08 = :"gpt-image-2.5-flare-2026-09-08"
|
|
16
|
-
|
|
15
|
+
GPT_IMAGE_1 = :"gpt-image-1"
|
|
16
|
+
GPT_IMAGE_1_MINI = :"gpt-image-1-mini"
|
|
17
17
|
CHATGPT_IMAGE_LATEST = :"chatgpt-image-latest"
|
|
18
|
+
# @deprecated This model was retired on May 12, 2026. Use a GPT image model instead.
|
|
18
19
|
DALL_E_2 = :"dall-e-2"
|
|
20
|
+
# @deprecated This model was retired on May 12, 2026. Use a GPT image model instead.
|
|
19
21
|
DALL_E_3 = :"dall-e-3"
|
|
20
22
|
|
|
21
23
|
# @!method self.values
|
|
@@ -27,8 +27,9 @@ module OpenAI
|
|
|
27
27
|
# `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
|
|
28
28
|
# `cedar`. You may also provide a custom voice object with an `id`, for example
|
|
29
29
|
# `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
|
|
30
|
-
# model has responded with audio at least once.
|
|
31
|
-
#
|
|
30
|
+
# model has responded with audio at least once. Custom voices must be created from
|
|
31
|
+
# audio samples. Voices created from text prompts are supported only in Live. We
|
|
32
|
+
# recommend `marin` and `cedar` for best quality.
|
|
32
33
|
#
|
|
33
34
|
# @return [String, Symbol, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice::ID, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice, nil]
|
|
34
35
|
optional :voice, union: -> { OpenAI::Realtime::RealtimeAudioConfigOutput::Voice }
|
|
@@ -51,15 +52,17 @@ module OpenAI
|
|
|
51
52
|
# `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
|
|
52
53
|
# `cedar`. You may also provide a custom voice object with an `id`, for example
|
|
53
54
|
# `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
|
|
54
|
-
# model has responded with audio at least once.
|
|
55
|
-
#
|
|
55
|
+
# model has responded with audio at least once. Custom voices must be created from
|
|
56
|
+
# audio samples. Voices created from text prompts are supported only in Live. We
|
|
57
|
+
# recommend `marin` and `cedar` for best quality.
|
|
56
58
|
|
|
57
59
|
# The voice the model uses to respond. Supported built-in voices are `alloy`,
|
|
58
60
|
# `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
|
|
59
61
|
# `cedar`. You may also provide a custom voice object with an `id`, for example
|
|
60
62
|
# `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
|
|
61
|
-
# model has responded with audio at least once.
|
|
62
|
-
#
|
|
63
|
+
# model has responded with audio at least once. Custom voices must be created from
|
|
64
|
+
# audio samples. Voices created from text prompts are supported only in Live. We
|
|
65
|
+
# recommend `marin` and `cedar` for best quality.
|
|
63
66
|
#
|
|
64
67
|
# @see OpenAI::Models::Realtime::RealtimeAudioConfigOutput#voice
|
|
65
68
|
module Voice
|
|
@@ -118,6 +118,15 @@ module OpenAI
|
|
|
118
118
|
# Only the fields that are present in the `session.update` are updated. To clear a field like
|
|
119
119
|
# `instructions`, pass an empty string. To clear a field like `tools`, pass an empty array.
|
|
120
120
|
# To clear a field like `turn_detection`, pass `null`.
|
|
121
|
+
#
|
|
122
|
+
# To turn off input audio noise reduction, send this Realtime event:
|
|
123
|
+
#
|
|
124
|
+
# ```json
|
|
125
|
+
# {"type":"session.update","session":{"type":"realtime","audio":{"input":{"noise_reduction":null}}}}
|
|
126
|
+
# ```
|
|
127
|
+
#
|
|
128
|
+
# For a transcription session, use `"type":"transcription"` inside `session`.
|
|
129
|
+
# Omitting `audio.input.noise_reduction` from an update leaves its current setting unchanged.
|
|
121
130
|
variant :"session.update", -> { OpenAI::Realtime::SessionUpdateEvent }
|
|
122
131
|
|
|
123
132
|
# @!method self.variants
|
|
@@ -27,8 +27,9 @@ module OpenAI
|
|
|
27
27
|
# `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
|
|
28
28
|
# `cedar`. You may also provide a custom voice object with an `id`, for example
|
|
29
29
|
# `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
|
|
30
|
-
# model has responded with audio at least once.
|
|
31
|
-
#
|
|
30
|
+
# model has responded with audio at least once. Custom voices must be created from
|
|
31
|
+
# audio samples. Voices created from text prompts are supported only in Live. We
|
|
32
|
+
# recommend `marin` and `cedar` for best quality.
|
|
32
33
|
#
|
|
33
34
|
# @return [String, Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::ID, OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice, nil]
|
|
34
35
|
optional :voice, union: -> { OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice }
|
|
@@ -42,15 +43,17 @@ module OpenAI
|
|
|
42
43
|
# `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
|
|
43
44
|
# `cedar`. You may also provide a custom voice object with an `id`, for example
|
|
44
45
|
# `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
|
|
45
|
-
# model has responded with audio at least once.
|
|
46
|
-
#
|
|
46
|
+
# model has responded with audio at least once. Custom voices must be created from
|
|
47
|
+
# audio samples. Voices created from text prompts are supported only in Live. We
|
|
48
|
+
# recommend `marin` and `cedar` for best quality.
|
|
47
49
|
|
|
48
50
|
# The voice the model uses to respond. Supported built-in voices are `alloy`,
|
|
49
51
|
# `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
|
|
50
52
|
# `cedar`. You may also provide a custom voice object with an `id`, for example
|
|
51
53
|
# `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
|
|
52
|
-
# model has responded with audio at least once.
|
|
53
|
-
#
|
|
54
|
+
# model has responded with audio at least once. Custom voices must be created from
|
|
55
|
+
# audio samples. Voices created from text prompts are supported only in Live. We
|
|
56
|
+
# recommend `marin` and `cedar` for best quality.
|
|
54
57
|
#
|
|
55
58
|
# @see OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output#voice
|
|
56
59
|
module Voice
|
|
@@ -37,6 +37,22 @@ module OpenAI
|
|
|
37
37
|
# like `instructions`, pass an empty string. To clear a field like `tools`, pass
|
|
38
38
|
# an empty array. To clear a field like `turn_detection`, pass `null`.
|
|
39
39
|
#
|
|
40
|
+
# To turn off input audio noise reduction, send this Realtime event:
|
|
41
|
+
#
|
|
42
|
+
# ```json
|
|
43
|
+
# {
|
|
44
|
+
# "type": "session.update",
|
|
45
|
+
# "session": {
|
|
46
|
+
# "type": "realtime",
|
|
47
|
+
# "audio": { "input": { "noise_reduction": null } }
|
|
48
|
+
# }
|
|
49
|
+
# }
|
|
50
|
+
# ```
|
|
51
|
+
#
|
|
52
|
+
# For a transcription session, use `"type":"transcription"` inside `session`.
|
|
53
|
+
# Omitting `audio.input.noise_reduction` from an update leaves its current setting
|
|
54
|
+
# unchanged.
|
|
55
|
+
#
|
|
40
56
|
# @param session [OpenAI::Models::Realtime::RealtimeSessionCreateRequest, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest]
|
|
41
57
|
# Update the Realtime session. Choose either a realtime session or a transcription
|
|
42
58
|
# session.
|
|
@@ -428,96 +428,316 @@ module OpenAI
|
|
|
428
428
|
GPT_5_4_NANO = :"gpt-5.4-nano"
|
|
429
429
|
GPT_5_4_MINI_2026_03_17 = :"gpt-5.4-mini-2026-03-17"
|
|
430
430
|
GPT_5_4_NANO_2026_03_17 = :"gpt-5.4-nano-2026-03-17"
|
|
431
|
+
# @deprecated Announced shutdown date: 2026-08-10. See
|
|
432
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
433
|
+
# replacements.
|
|
431
434
|
GPT_5_3_CHAT_LATEST = :"gpt-5.3-chat-latest"
|
|
432
435
|
GPT_5_2 = :"gpt-5.2"
|
|
433
436
|
GPT_5_2_2025_12_11 = :"gpt-5.2-2025-12-11"
|
|
437
|
+
# @deprecated Announced shutdown date: 2026-08-10. See
|
|
438
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
439
|
+
# replacements.
|
|
434
440
|
GPT_5_2_CHAT_LATEST = :"gpt-5.2-chat-latest"
|
|
435
441
|
GPT_5_2_PRO = :"gpt-5.2-pro"
|
|
436
442
|
GPT_5_2_PRO_2025_12_11 = :"gpt-5.2-pro-2025-12-11"
|
|
437
443
|
GPT_5_1 = :"gpt-5.1"
|
|
438
444
|
GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
|
|
445
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
446
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
447
|
+
# replacements.
|
|
439
448
|
GPT_5_1_CODEX = :"gpt-5.1-codex"
|
|
449
|
+
# @deprecated Not a supported model ID. Retained for SDK compatibility.
|
|
440
450
|
GPT_5_1_MINI = :"gpt-5.1-mini"
|
|
451
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
452
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
453
|
+
# replacements.
|
|
441
454
|
GPT_5_1_CHAT_LATEST = :"gpt-5.1-chat-latest"
|
|
455
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
456
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
457
|
+
# replacements.
|
|
442
458
|
GPT_5 = :"gpt-5"
|
|
459
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
460
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
461
|
+
# replacements.
|
|
443
462
|
GPT_5_MINI = :"gpt-5-mini"
|
|
463
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
464
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
465
|
+
# replacements.
|
|
444
466
|
GPT_5_NANO = :"gpt-5-nano"
|
|
467
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
468
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
469
|
+
# replacements.
|
|
445
470
|
GPT_5_2025_08_07 = :"gpt-5-2025-08-07"
|
|
471
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
472
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
473
|
+
# replacements.
|
|
446
474
|
GPT_5_MINI_2025_08_07 = :"gpt-5-mini-2025-08-07"
|
|
475
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
476
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
477
|
+
# replacements.
|
|
447
478
|
GPT_5_NANO_2025_08_07 = :"gpt-5-nano-2025-08-07"
|
|
479
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
480
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
481
|
+
# replacements.
|
|
448
482
|
GPT_5_CHAT_LATEST = :"gpt-5-chat-latest"
|
|
449
483
|
GPT_4_1 = :"gpt-4.1"
|
|
450
484
|
GPT_4_1_MINI = :"gpt-4.1-mini"
|
|
485
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
486
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
487
|
+
# replacements.
|
|
451
488
|
GPT_4_1_NANO = :"gpt-4.1-nano"
|
|
452
489
|
GPT_4_1_2025_04_14 = :"gpt-4.1-2025-04-14"
|
|
453
490
|
GPT_4_1_MINI_2025_04_14 = :"gpt-4.1-mini-2025-04-14"
|
|
491
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
492
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
493
|
+
# replacements.
|
|
454
494
|
GPT_4_1_NANO_2025_04_14 = :"gpt-4.1-nano-2025-04-14"
|
|
495
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
496
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
497
|
+
# replacements.
|
|
455
498
|
O4_MINI = :"o4-mini"
|
|
499
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
500
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
501
|
+
# replacements.
|
|
456
502
|
O4_MINI_2025_04_16 = :"o4-mini-2025-04-16"
|
|
503
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
504
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
505
|
+
# replacements.
|
|
457
506
|
O3 = :o3
|
|
507
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
508
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
509
|
+
# replacements.
|
|
458
510
|
O3_2025_04_16 = :"o3-2025-04-16"
|
|
511
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
512
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
513
|
+
# replacements.
|
|
459
514
|
O3_MINI = :"o3-mini"
|
|
515
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
516
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
517
|
+
# replacements.
|
|
460
518
|
O3_MINI_2025_01_31 = :"o3-mini-2025-01-31"
|
|
519
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
520
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
521
|
+
# replacements.
|
|
461
522
|
O1 = :o1
|
|
523
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
524
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
525
|
+
# replacements.
|
|
462
526
|
O1_2024_12_17 = :"o1-2024-12-17"
|
|
527
|
+
# @deprecated Announced shutdown date: 2025-07-28. See
|
|
528
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
529
|
+
# replacements.
|
|
463
530
|
O1_PREVIEW = :"o1-preview"
|
|
531
|
+
# @deprecated Announced shutdown date: 2025-07-28. See
|
|
532
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
533
|
+
# replacements.
|
|
464
534
|
O1_PREVIEW_2024_09_12 = :"o1-preview-2024-09-12"
|
|
535
|
+
# @deprecated Announced shutdown date: 2025-10-27. See
|
|
536
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
537
|
+
# replacements.
|
|
465
538
|
O1_MINI = :"o1-mini"
|
|
539
|
+
# @deprecated Announced shutdown date: 2025-10-27. See
|
|
540
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
541
|
+
# replacements.
|
|
466
542
|
O1_MINI_2024_09_12 = :"o1-mini-2024-09-12"
|
|
467
543
|
GPT_4O = :"gpt-4o"
|
|
468
544
|
GPT_4O_2024_11_20 = :"gpt-4o-2024-11-20"
|
|
469
545
|
GPT_4O_2024_08_06 = :"gpt-4o-2024-08-06"
|
|
546
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
547
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
548
|
+
# replacements.
|
|
470
549
|
GPT_4O_2024_05_13 = :"gpt-4o-2024-05-13"
|
|
550
|
+
# @deprecated Announced shutdown date: 2027-01-20. See
|
|
551
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
552
|
+
# replacements.
|
|
471
553
|
GPT_AUDIO_MINI = :"gpt-audio-mini"
|
|
554
|
+
# @deprecated Announced shutdown date: 2027-01-20. See
|
|
555
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
556
|
+
# replacements.
|
|
472
557
|
GPT_AUDIO_MINI_2025_12_15 = :"gpt-audio-mini-2025-12-15"
|
|
558
|
+
# @deprecated Announced shutdown date: 2026-05-07. See
|
|
559
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
560
|
+
# replacements.
|
|
473
561
|
GPT_4O_AUDIO_PREVIEW = :"gpt-4o-audio-preview"
|
|
562
|
+
# @deprecated Announced shutdown date: 2025-10-10. See
|
|
563
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
564
|
+
# replacements.
|
|
474
565
|
GPT_4O_AUDIO_PREVIEW_2024_10_01 = :"gpt-4o-audio-preview-2024-10-01"
|
|
566
|
+
# @deprecated Announced shutdown date: 2026-05-07. See
|
|
567
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
568
|
+
# replacements.
|
|
475
569
|
GPT_4O_AUDIO_PREVIEW_2024_12_17 = :"gpt-4o-audio-preview-2024-12-17"
|
|
570
|
+
# @deprecated Announced shutdown date: 2026-05-07. See
|
|
571
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
572
|
+
# replacements.
|
|
476
573
|
GPT_4O_AUDIO_PREVIEW_2025_06_03 = :"gpt-4o-audio-preview-2025-06-03"
|
|
574
|
+
# @deprecated Announced shutdown date: 2026-05-07. See
|
|
575
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
576
|
+
# replacements.
|
|
477
577
|
GPT_4O_MINI_AUDIO_PREVIEW = :"gpt-4o-mini-audio-preview"
|
|
578
|
+
# @deprecated Announced shutdown date: 2026-05-07. See
|
|
579
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
580
|
+
# replacements.
|
|
478
581
|
GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17 = :"gpt-4o-mini-audio-preview-2024-12-17"
|
|
582
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
583
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
584
|
+
# replacements.
|
|
479
585
|
GPT_4O_SEARCH_PREVIEW = :"gpt-4o-search-preview"
|
|
586
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
587
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
588
|
+
# replacements.
|
|
480
589
|
GPT_4O_MINI_SEARCH_PREVIEW = :"gpt-4o-mini-search-preview"
|
|
590
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
591
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
592
|
+
# replacements.
|
|
481
593
|
GPT_4O_SEARCH_PREVIEW_2025_03_11 = :"gpt-4o-search-preview-2025-03-11"
|
|
594
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
595
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
596
|
+
# replacements.
|
|
482
597
|
GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11 = :"gpt-4o-mini-search-preview-2025-03-11"
|
|
598
|
+
# @deprecated Announced shutdown date: 2026-02-17. See
|
|
599
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
600
|
+
# replacements.
|
|
483
601
|
CHATGPT_4O_LATEST = :"chatgpt-4o-latest"
|
|
602
|
+
# @deprecated Announced shutdown date: 2026-02-12. See
|
|
603
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
604
|
+
# replacements.
|
|
484
605
|
CODEX_MINI_LATEST = :"codex-mini-latest"
|
|
485
606
|
GPT_4O_MINI = :"gpt-4o-mini"
|
|
486
607
|
GPT_4O_MINI_2024_07_18 = :"gpt-4o-mini-2024-07-18"
|
|
608
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
609
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
610
|
+
# replacements.
|
|
487
611
|
GPT_4_TURBO = :"gpt-4-turbo"
|
|
612
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
613
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
614
|
+
# replacements.
|
|
488
615
|
GPT_4_TURBO_2024_04_09 = :"gpt-4-turbo-2024-04-09"
|
|
616
|
+
# @deprecated Announced shutdown date: 2026-03-26. See
|
|
617
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
618
|
+
# replacements.
|
|
489
619
|
GPT_4_0125_PREVIEW = :"gpt-4-0125-preview"
|
|
620
|
+
# @deprecated Announced shutdown date: 2026-03-26. See
|
|
621
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
622
|
+
# replacements.
|
|
490
623
|
GPT_4_TURBO_PREVIEW = :"gpt-4-turbo-preview"
|
|
624
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
625
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
626
|
+
# replacements.
|
|
491
627
|
GPT_4_1106_PREVIEW = :"gpt-4-1106-preview"
|
|
628
|
+
# @deprecated Announced shutdown date: 2024-12-06. See
|
|
629
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
630
|
+
# replacements.
|
|
492
631
|
GPT_4_VISION_PREVIEW = :"gpt-4-vision-preview"
|
|
632
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
633
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
634
|
+
# replacements.
|
|
493
635
|
GPT_4 = :"gpt-4"
|
|
636
|
+
# @deprecated Announced shutdown date: 2026-03-26. See
|
|
637
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
638
|
+
# replacements.
|
|
494
639
|
GPT_4_0314 = :"gpt-4-0314"
|
|
640
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
641
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
642
|
+
# replacements.
|
|
495
643
|
GPT_4_0613 = :"gpt-4-0613"
|
|
644
|
+
# @deprecated Announced shutdown date: 2025-06-06. See
|
|
645
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
646
|
+
# replacements.
|
|
496
647
|
GPT_4_32K = :"gpt-4-32k"
|
|
648
|
+
# @deprecated Announced shutdown date: 2025-06-06. See
|
|
649
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
650
|
+
# replacements.
|
|
497
651
|
GPT_4_32K_0314 = :"gpt-4-32k-0314"
|
|
652
|
+
# @deprecated Announced shutdown date: 2025-06-06. See
|
|
653
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
654
|
+
# replacements.
|
|
498
655
|
GPT_4_32K_0613 = :"gpt-4-32k-0613"
|
|
656
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
657
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
658
|
+
# replacements.
|
|
499
659
|
GPT_3_5_TURBO = :"gpt-3.5-turbo"
|
|
660
|
+
# @deprecated Announced shutdown date: 2024-09-13. See
|
|
661
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
662
|
+
# replacements.
|
|
500
663
|
GPT_3_5_TURBO_16K = :"gpt-3.5-turbo-16k"
|
|
664
|
+
# @deprecated Announced shutdown date: 2024-09-13. See
|
|
665
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
666
|
+
# replacements.
|
|
501
667
|
GPT_3_5_TURBO_0301 = :"gpt-3.5-turbo-0301"
|
|
668
|
+
# @deprecated Announced shutdown date: 2024-09-13. See
|
|
669
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
670
|
+
# replacements.
|
|
502
671
|
GPT_3_5_TURBO_0613 = :"gpt-3.5-turbo-0613"
|
|
672
|
+
# @deprecated Announced shutdown date: 2026-09-28. See
|
|
673
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
674
|
+
# replacements.
|
|
503
675
|
GPT_3_5_TURBO_1106 = :"gpt-3.5-turbo-1106"
|
|
676
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
677
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
678
|
+
# replacements.
|
|
504
679
|
GPT_3_5_TURBO_0125 = :"gpt-3.5-turbo-0125"
|
|
680
|
+
# @deprecated Announced shutdown date: 2024-09-13. See
|
|
681
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
682
|
+
# replacements.
|
|
505
683
|
GPT_3_5_TURBO_16K_0613 = :"gpt-3.5-turbo-16k-0613"
|
|
684
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
685
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
686
|
+
# replacements.
|
|
506
687
|
O1_PRO = :"o1-pro"
|
|
688
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
689
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
690
|
+
# replacements.
|
|
507
691
|
O1_PRO_2025_03_19 = :"o1-pro-2025-03-19"
|
|
692
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
693
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
694
|
+
# replacements.
|
|
508
695
|
O3_PRO = :"o3-pro"
|
|
696
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
697
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
698
|
+
# replacements.
|
|
509
699
|
O3_PRO_2025_06_10 = :"o3-pro-2025-06-10"
|
|
700
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
701
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
702
|
+
# replacements.
|
|
510
703
|
O3_DEEP_RESEARCH = :"o3-deep-research"
|
|
704
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
705
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
706
|
+
# replacements.
|
|
511
707
|
O3_DEEP_RESEARCH_2025_06_26 = :"o3-deep-research-2025-06-26"
|
|
708
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
709
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
710
|
+
# replacements.
|
|
512
711
|
O4_MINI_DEEP_RESEARCH = :"o4-mini-deep-research"
|
|
712
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
713
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
714
|
+
# replacements.
|
|
513
715
|
O4_MINI_DEEP_RESEARCH_2025_06_26 = :"o4-mini-deep-research-2025-06-26"
|
|
716
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
717
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
718
|
+
# replacements.
|
|
514
719
|
COMPUTER_USE_PREVIEW = :"computer-use-preview"
|
|
720
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
721
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
722
|
+
# replacements.
|
|
515
723
|
COMPUTER_USE_PREVIEW_2025_03_11 = :"computer-use-preview-2025-03-11"
|
|
516
724
|
GPT_5_5_PRO = :"gpt-5.5-pro"
|
|
517
725
|
GPT_5_5_PRO_2026_04_23 = :"gpt-5.5-pro-2026-04-23"
|
|
726
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
727
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
728
|
+
# replacements.
|
|
518
729
|
GPT_5_CODEX = :"gpt-5-codex"
|
|
730
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
731
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
732
|
+
# replacements.
|
|
519
733
|
GPT_5_PRO = :"gpt-5-pro"
|
|
734
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
735
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
736
|
+
# replacements.
|
|
520
737
|
GPT_5_PRO_2025_10_06 = :"gpt-5-pro-2025-10-06"
|
|
738
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
739
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
740
|
+
# replacements.
|
|
521
741
|
GPT_5_1_CODEX_MAX = :"gpt-5.1-codex-max"
|
|
522
742
|
GPT_DAYBREAK_BLUE_LATEST = :"gpt-daybreak-blue-latest"
|
|
523
743
|
GPT_DAYBREAK_RED_LATEST = :"gpt-daybreak-red-latest"
|
|
@@ -5,7 +5,7 @@ module OpenAI
|
|
|
5
5
|
module Responses
|
|
6
6
|
class ResponseComputerToolCallOutputItem < OpenAI::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute id
|
|
8
|
-
# The
|
|
8
|
+
# The ID of the computer tool call output.
|
|
9
9
|
#
|
|
10
10
|
# @return [String]
|
|
11
11
|
required :id, String
|
|
@@ -57,7 +57,7 @@ module OpenAI
|
|
|
57
57
|
|
|
58
58
|
# @!method initialize(id:, call_id:, output:, status:, acknowledged_safety_checks: nil, created_by: nil, type: :computer_call_output)
|
|
59
59
|
# @param id [String]
|
|
60
|
-
# The
|
|
60
|
+
# The ID of the computer tool call output.
|
|
61
61
|
#
|
|
62
62
|
# @param call_id [String]
|
|
63
63
|
# The ID of the computer tool call that produced the output.
|
|
@@ -78,19 +78,30 @@ module OpenAI
|
|
|
78
78
|
# @return [String, Symbol, OpenAI::Models::Responses::ResponseError::Misalignment::ErrorType, nil]
|
|
79
79
|
optional :error_type, union: -> { OpenAI::Responses::ResponseError::Misalignment::ErrorType }
|
|
80
80
|
|
|
81
|
+
# @!attribute review_target
|
|
82
|
+
# An opaque target for explicitly continuing this review, or null when
|
|
83
|
+
# unavailable.
|
|
84
|
+
#
|
|
85
|
+
# @return [String, nil]
|
|
86
|
+
optional :review_target, String, nil?: true
|
|
87
|
+
|
|
81
88
|
# @!attribute steer
|
|
82
89
|
# An optional public continuation instruction.
|
|
83
90
|
#
|
|
84
91
|
# @return [OpenAI::Models::Responses::ResponseError::Misalignment::Steer, nil]
|
|
85
92
|
optional :steer, -> { OpenAI::Responses::ResponseError::Misalignment::Steer }
|
|
86
93
|
|
|
87
|
-
# @!method initialize(detailed_explanation: nil, error_type: nil, steer: nil)
|
|
94
|
+
# @!method initialize(detailed_explanation: nil, error_type: nil, review_target: nil, steer: nil)
|
|
88
95
|
# @param detailed_explanation [String]
|
|
89
96
|
# The public explanation for this block.
|
|
90
97
|
#
|
|
91
98
|
# @param error_type [String, Symbol, OpenAI::Models::Responses::ResponseError::Misalignment::ErrorType]
|
|
92
99
|
# An optional classification; clients must accept additional values.
|
|
93
100
|
#
|
|
101
|
+
# @param review_target [String, nil]
|
|
102
|
+
# An opaque target for explicitly continuing this review, or null when
|
|
103
|
+
# unavailable.
|
|
104
|
+
#
|
|
94
105
|
# @param steer [OpenAI::Models::Responses::ResponseError::Misalignment::Steer]
|
|
95
106
|
# An optional public continuation instruction.
|
|
96
107
|
|
|
@@ -2258,6 +2258,13 @@ module OpenAI
|
|
|
2258
2258
|
union: -> { OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::ErrorType }
|
|
2259
2259
|
)
|
|
2260
2260
|
|
|
2261
|
+
# @!attribute review_target
|
|
2262
|
+
# An opaque target for explicitly continuing this review, or null when
|
|
2263
|
+
# unavailable.
|
|
2264
|
+
#
|
|
2265
|
+
# @return [String, nil]
|
|
2266
|
+
optional :review_target, String, nil?: true
|
|
2267
|
+
|
|
2261
2268
|
# @!attribute steer
|
|
2262
2269
|
# An optional public continuation instruction.
|
|
2263
2270
|
#
|
|
@@ -2267,13 +2274,17 @@ module OpenAI
|
|
|
2267
2274
|
-> { OpenAI::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::Steer }
|
|
2268
2275
|
)
|
|
2269
2276
|
|
|
2270
|
-
# @!method initialize(detailed_explanation: nil, error_type: nil, steer: nil)
|
|
2277
|
+
# @!method initialize(detailed_explanation: nil, error_type: nil, review_target: nil, steer: nil)
|
|
2271
2278
|
# @param detailed_explanation [String]
|
|
2272
2279
|
# The public explanation for this block.
|
|
2273
2280
|
#
|
|
2274
2281
|
# @param error_type [String, Symbol, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::ErrorType]
|
|
2275
2282
|
# An optional classification; clients must accept additional values.
|
|
2276
2283
|
#
|
|
2284
|
+
# @param review_target [String, nil]
|
|
2285
|
+
# An opaque target for explicitly continuing this review, or null when
|
|
2286
|
+
# unavailable.
|
|
2287
|
+
#
|
|
2277
2288
|
# @param steer [OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError::Error::Misalignment::Steer]
|
|
2278
2289
|
# An optional public continuation instruction.
|
|
2279
2290
|
|
|
@@ -634,9 +634,10 @@ module OpenAI
|
|
|
634
634
|
optional :background, enum: -> { OpenAI::Responses::Tool::ImageGeneration::Background }
|
|
635
635
|
|
|
636
636
|
# @!attribute input_fidelity
|
|
637
|
-
#
|
|
638
|
-
#
|
|
639
|
-
# `gpt-image-
|
|
637
|
+
# Control how much effort the model will exert to match the style and features,
|
|
638
|
+
# especially facial features, of input images. Supports `high` and `low` on
|
|
639
|
+
# `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
|
|
640
|
+
# `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
|
|
640
641
|
#
|
|
641
642
|
# @return [Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::InputFidelity, nil]
|
|
642
643
|
optional(
|
|
@@ -709,9 +710,7 @@ module OpenAI
|
|
|
709
710
|
# the maximum supported resolution is `3840x2160`. The requested size must also
|
|
710
711
|
# satisfy the model's current pixel and edge limits. The standard sizes
|
|
711
712
|
# `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
|
|
712
|
-
# `auto` is supported for models that allow automatic sizing.
|
|
713
|
-
# one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
|
|
714
|
-
# `1024x1024`, `1792x1024`, or `1024x1792`.
|
|
713
|
+
# `auto` is supported for models that allow automatic sizing.
|
|
715
714
|
#
|
|
716
715
|
# @return [String, Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::Size, nil]
|
|
717
716
|
optional :size, union: -> { OpenAI::Responses::Tool::ImageGeneration::Size }
|
|
@@ -734,9 +733,10 @@ module OpenAI
|
|
|
734
733
|
# set the output format to `png` or `webp`.
|
|
735
734
|
#
|
|
736
735
|
# @param input_fidelity [Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::InputFidelity, nil]
|
|
737
|
-
#
|
|
738
|
-
#
|
|
739
|
-
# `gpt-image-
|
|
736
|
+
# Control how much effort the model will exert to match the style and features,
|
|
737
|
+
# especially facial features, of input images. Supports `high` and `low` on
|
|
738
|
+
# `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
|
|
739
|
+
# `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
|
|
740
740
|
#
|
|
741
741
|
# @param input_image_mask [OpenAI::Models::Responses::Tool::ImageGeneration::InputImageMask]
|
|
742
742
|
# Optional mask for inpainting. Contains `image_url` (string, optional) and
|
|
@@ -779,9 +779,7 @@ module OpenAI
|
|
|
779
779
|
# the maximum supported resolution is `3840x2160`. The requested size must also
|
|
780
780
|
# satisfy the model's current pixel and edge limits. The standard sizes
|
|
781
781
|
# `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
|
|
782
|
-
# `auto` is supported for models that allow automatic sizing.
|
|
783
|
-
# one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
|
|
784
|
-
# `1024x1024`, `1792x1024`, or `1024x1792`.
|
|
782
|
+
# `auto` is supported for models that allow automatic sizing.
|
|
785
783
|
#
|
|
786
784
|
# @param type [Symbol, :image_generation]
|
|
787
785
|
# The type of the image generation tool. Always `image_generation`.
|
|
@@ -822,9 +820,10 @@ module OpenAI
|
|
|
822
820
|
# @return [Array<Symbol>]
|
|
823
821
|
end
|
|
824
822
|
|
|
825
|
-
#
|
|
826
|
-
#
|
|
827
|
-
# `gpt-image-
|
|
823
|
+
# Control how much effort the model will exert to match the style and features,
|
|
824
|
+
# especially facial features, of input images. Supports `high` and `low` on
|
|
825
|
+
# `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
|
|
826
|
+
# `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
|
|
828
827
|
#
|
|
829
828
|
# @see OpenAI::Models::Responses::Tool::ImageGeneration#input_fidelity
|
|
830
829
|
module InputFidelity
|
|
@@ -978,9 +977,7 @@ module OpenAI
|
|
|
978
977
|
# the maximum supported resolution is `3840x2160`. The requested size must also
|
|
979
978
|
# satisfy the model's current pixel and edge limits. The standard sizes
|
|
980
979
|
# `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
|
|
981
|
-
# `auto` is supported for models that allow automatic sizing.
|
|
982
|
-
# one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
|
|
983
|
-
# `1024x1024`, `1792x1024`, or `1024x1792`.
|
|
980
|
+
# `auto` is supported for models that allow automatic sizing.
|
|
984
981
|
#
|
|
985
982
|
# @see OpenAI::Models::Responses::Tool::ImageGeneration#size
|
|
986
983
|
module Size
|