openai 0.97.0 → 0.99.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 +31 -0
- data/README.md +76 -1
- data/lib/openai/helpers/agents/session_stream.rb +60 -3
- data/lib/openai/helpers/beta/agents/artifacts.rb +72 -0
- data/lib/openai/helpers/beta/agents/creation_stream.rb +69 -0
- data/lib/openai/helpers/beta/agents/files.rb +236 -0
- data/lib/openai/helpers/beta/agents/function_tool.rb +65 -0
- data/lib/openai/helpers/beta/agents/model_adapter.rb +27 -0
- data/lib/openai/helpers/beta/agents/result.rb +170 -0
- data/lib/openai/helpers/beta/agents/typed_output.rb +191 -0
- data/lib/openai/helpers/live/websocket.rb +7 -1
- data/lib/openai/helpers/realtime/conversation_item_variant_resolver.rb +1 -1
- data/lib/openai/helpers/responses_websocket/connection.rb +7 -1
- data/lib/openai/helpers/responses_websocket/session.rb +5 -1
- data/lib/openai/helpers/responses_websocket/transports/async_websocket.rb +12 -2
- data/lib/openai/internal/transport/base_client.rb +18 -0
- data/lib/openai/internal/type/array_of.rb +1 -1
- data/lib/openai/internal/type/base_model.rb +6 -3
- data/lib/openai/internal/type/converter.rb +50 -3
- data/lib/openai/internal/type/hash_of.rb +1 -1
- data/lib/openai/internal/type/union.rb +6 -6
- data/lib/openai/models/admin/organization/usage_audio_speeches_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_audio_transcriptions_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_completions_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_costs_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_embeddings_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_file_search_calls_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_images_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_moderations_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_vector_stores_response.rb +16 -3
- data/lib/openai/models/admin/organization/usage_web_search_calls_response.rb +16 -3
- 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/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/session_trace.rb +64 -0
- data/lib/openai/models/beta/agents/sessions/trace_list_params.rb +68 -0
- data/lib/openai/models/beta/agents/vaults/credential.rb +8 -4
- data/lib/openai/models/beta/beta_response.rb +220 -0
- data/lib/openai/models/beta/beta_response_output_text.rb +2 -2
- data/lib/openai/models/beta/beta_response_output_text_annotation_added_event.rb +2 -2
- data/lib/openai/models/beta/beta_responses_client_event.rb +220 -0
- data/lib/openai/models/beta/beta_tool.rb +3 -9
- data/lib/openai/models/beta/environment.rb +33 -1
- data/lib/openai/models/beta/environment_param.rb +24 -1
- 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 +3 -0
- data/lib/openai/models/chat/chat_completion_audio_param.rb +6 -3
- data/lib/openai/models/chat/chat_completion_content_part_image.rb +1 -0
- data/lib/openai/models/chat_model.rb +178 -0
- 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 +76 -87
- data/lib/openai/models/image_generate_params.rb +51 -62
- data/lib/openai/models/image_model.rb +5 -3
- data/lib/openai/models/live/fork_server_event.rb +14 -3
- data/lib/openai/models/live/server_event.rb +14 -3
- data/lib/openai/models/realtime/realtime_audio_config_output.rb +9 -6
- data/lib/openai/models/realtime/realtime_response_create_audio_output.rb +9 -6
- data/lib/openai/models/realtime/translations/client_secret_create_params.rb +28 -0
- data/lib/openai/models/responses/response_compact_params.rb +220 -0
- data/lib/openai/models/responses/response_output_text.rb +2 -2
- data/lib/openai/models/responses/response_output_text_annotation_added_event.rb +2 -2
- data/lib/openai/models/responses/tool.rb +3 -9
- data/lib/openai/models/responses_model.rb +42 -0
- 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/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/files.rb +31 -0
- data/lib/openai/resources/beta/agents/sessions/artifacts.rb +8 -0
- data/lib/openai/resources/beta/agents/sessions/events.rb +6 -5
- data/lib/openai/resources/beta/agents/sessions/traces.rb +58 -0
- data/lib/openai/resources/beta/agents/sessions.rb +18 -5
- data/lib/openai/resources/evals/runs.rb +1 -1
- data/lib/openai/resources/images.rb +71 -103
- data/lib/openai/resources/realtime/translations/client_secrets.rb +58 -0
- data/lib/openai/resources/realtime/translations.rb +20 -0
- data/lib/openai/resources/realtime.rb +4 -0
- data/lib/openai/resources/webhooks.rb +1 -1
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +17 -1
- data/rbi/openai/helpers/agents.rbi +20 -1
- data/rbi/openai/helpers/beta/agents/artifacts.rbi +29 -0
- data/rbi/openai/helpers/beta/agents/files.rbi +65 -0
- data/rbi/openai/helpers/beta/agents/function_tool.rbi +40 -0
- data/rbi/openai/helpers/beta/agents/model_adapter.rbi +22 -0
- data/rbi/openai/helpers/beta/agents.rbi +146 -0
- data/rbi/openai/internal/transport/base_client.rbi +12 -0
- data/rbi/openai/internal/type/base_model.rbi +2 -2
- data/rbi/openai/internal/type/converter.rbi +21 -3
- data/rbi/openai/internal/type/union.rbi +6 -2
- data/rbi/openai/models/admin/organization/usage_audio_speeches_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_audio_transcriptions_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_completions_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_costs_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_embeddings_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_file_search_calls_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_images_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_moderations_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_vector_stores_response.rbi +19 -2
- data/rbi/openai/models/admin/organization/usage_web_search_calls_response.rbi +19 -2
- 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/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/session_trace.rbi +97 -0
- data/rbi/openai/models/beta/agents/sessions/trace_list_params.rbi +121 -0
- data/rbi/openai/models/beta/agents/vaults/credential.rbi +5 -5
- data/rbi/openai/models/beta/beta_response_output_text.rbi +2 -2
- data/rbi/openai/models/beta/beta_response_output_text_annotation_added_event.rbi +2 -2
- data/rbi/openai/models/beta/beta_tool.rbi +3 -9
- data/rbi/openai/models/beta/environment.rbi +29 -0
- data/rbi/openai/models/beta/environment_param.rbi +31 -0
- data/rbi/openai/models/beta/session_turn_error.rbi +3 -0
- data/rbi/openai/models/chat/chat_completion_audio_param.rbi +6 -3
- data/rbi/openai/models/chat/chat_completion_content_part_image.rbi +1 -0
- 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 +61 -82
- data/rbi/openai/models/image_generate_params.rbi +30 -61
- data/rbi/openai/models/image_model.rbi +3 -3
- data/rbi/openai/models/live/fork_server_event.rbi +14 -2
- data/rbi/openai/models/live/server_event.rbi +14 -2
- 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/translations/client_secret_create_params.rbi +68 -0
- data/rbi/openai/models/responses/response_output_text.rbi +2 -2
- data/rbi/openai/models/responses/response_output_text_annotation_added_event.rbi +2 -2
- data/rbi/openai/models/responses/tool.rbi +3 -9
- 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/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/files.rbi +31 -0
- data/rbi/openai/resources/beta/agents/sessions/artifacts.rbi +8 -0
- data/rbi/openai/resources/beta/agents/sessions/events.rbi +6 -5
- data/rbi/openai/resources/beta/agents/sessions/traces.rbi +54 -0
- data/rbi/openai/resources/beta/agents/sessions.rbi +6 -1
- data/rbi/openai/resources/images.rbi +69 -103
- data/rbi/openai/resources/realtime/translations/client_secrets.rbi +54 -0
- data/rbi/openai/resources/realtime/translations.rbi +22 -0
- data/rbi/openai/resources/realtime.rbi +3 -0
- data/rbi/openai/resources/webhooks.rbi +5 -0
- data/sig/openai/helpers/agents.rbs +7 -0
- data/sig/openai/helpers/beta/agents/artifacts.rbs +20 -0
- data/sig/openai/helpers/beta/agents/files.rbs +41 -0
- data/sig/openai/helpers/beta/agents/function_tool.rbs +24 -0
- data/sig/openai/helpers/beta/agents/model_adapter.rbs +16 -0
- data/sig/openai/helpers/beta/agents.rbs +71 -0
- data/sig/openai/helpers/structured_output.rbs +12 -0
- data/sig/openai/internal/transport/base_client.rbs +8 -0
- data/sig/openai/internal/type/base_model.rbs +3 -1
- data/sig/openai/internal/type/converter.rbs +16 -2
- data/sig/openai/internal/type/union.rbs +2 -1
- data/sig/openai/models/admin/organization/usage_audio_speeches_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_audio_transcriptions_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_completions_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_costs_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_embeddings_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_file_search_calls_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_images_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_moderations_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_vector_stores_response.rbs +20 -3
- data/sig/openai/models/admin/organization/usage_web_search_calls_response.rbs +20 -3
- 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/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/session_trace.rbs +65 -0
- data/sig/openai/models/beta/agents/sessions/trace_list_params.rbs +81 -0
- data/sig/openai/models/beta/agents/vaults/credential.rbs +5 -5
- data/sig/openai/models/beta/beta_response_output_text.rbs +2 -2
- data/sig/openai/models/beta/beta_response_output_text_annotation_added_event.rbs +2 -2
- data/sig/openai/models/beta/beta_tool.rbs +3 -9
- data/sig/openai/models/beta/environment.rbs +22 -0
- data/sig/openai/models/beta/environment_param.rbs +25 -0
- data/sig/openai/models/beta/session_turn_error.rbs +4 -0
- data/sig/openai/models/chat/chat_completion_audio_param.rbs +4 -2
- data/sig/openai/models/chat/chat_completion_content_part_image.rbs +2 -1
- 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 +46 -60
- data/sig/openai/models/image_generate_params.rbs +23 -45
- data/sig/openai/models/image_model.rbs +6 -6
- data/sig/openai/models/live/fork_server_event.rbs +17 -2
- data/sig/openai/models/live/server_event.rbs +17 -2
- 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/realtime/translations/client_secret_create_params.rbs +39 -0
- data/sig/openai/models/responses/response_output_text.rbs +2 -2
- data/sig/openai/models/responses/response_output_text_annotation_added_event.rbs +2 -2
- data/sig/openai/models/responses/tool.rbs +3 -9
- 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/environments/files.rbs +17 -0
- data/sig/openai/resources/beta/agents/sessions/artifacts.rbs +4 -0
- data/sig/openai/resources/beta/agents/sessions/traces.rbs +21 -0
- data/sig/openai/resources/beta/agents/sessions.rbs +4 -1
- data/sig/openai/resources/realtime/translations/client_secrets.rbs +17 -0
- data/sig/openai/resources/realtime/translations.rbs +11 -0
- data/sig/openai/resources/realtime.rbs +2 -0
- data/sig/openai/resources/webhooks.rbs +6 -1
- metadata +61 -1
|
@@ -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
|
|
@@ -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
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Realtime
|
|
6
|
+
module Translations
|
|
7
|
+
# @see OpenAI::Resources::Realtime::Translations::ClientSecrets#create
|
|
8
|
+
class ClientSecretCreateParams < OpenAI::Models::Realtime::RealtimeTranslationClientSecretCreateRequest
|
|
9
|
+
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
10
|
+
include OpenAI::Internal::Type::RequestParameters
|
|
11
|
+
|
|
12
|
+
# @!method initialize(session:, expires_after: nil, request_options: {})
|
|
13
|
+
# @param session [OpenAI::Models::Realtime::RealtimeTranslationSessionCreateRequest]
|
|
14
|
+
# Realtime translation session configuration. Translation sessions stream source
|
|
15
|
+
# audio in and translated audio plus transcript deltas out continuously.
|
|
16
|
+
#
|
|
17
|
+
# @param expires_after [OpenAI::Models::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter]
|
|
18
|
+
# Configuration for the client secret expiration. Expiration refers to the time
|
|
19
|
+
# after which a client secret will no longer be valid for creating sessions. The
|
|
20
|
+
# session itself may continue after that time once started. A secret can be used
|
|
21
|
+
# to create multiple sessions until it expires.
|
|
22
|
+
#
|
|
23
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
@@ -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"
|
|
@@ -87,7 +87,7 @@ module OpenAI
|
|
|
87
87
|
required :filename, String
|
|
88
88
|
|
|
89
89
|
# @!attribute index
|
|
90
|
-
# The index
|
|
90
|
+
# The index in the output text at which to insert the file citation.
|
|
91
91
|
#
|
|
92
92
|
# @return [Integer]
|
|
93
93
|
required :index, Integer
|
|
@@ -108,7 +108,7 @@ module OpenAI
|
|
|
108
108
|
# The filename of the file cited.
|
|
109
109
|
#
|
|
110
110
|
# @param index [Integer]
|
|
111
|
-
# The index
|
|
111
|
+
# The index in the output text at which to insert the file citation.
|
|
112
112
|
#
|
|
113
113
|
# @param type [Symbol, :file_citation]
|
|
114
114
|
# The type of the file citation. Always `file_citation`.
|
|
@@ -117,7 +117,7 @@ module OpenAI
|
|
|
117
117
|
required :filename, String
|
|
118
118
|
|
|
119
119
|
# @!attribute index
|
|
120
|
-
# The index
|
|
120
|
+
# The index in the output text at which to insert the file citation.
|
|
121
121
|
#
|
|
122
122
|
# @return [Integer]
|
|
123
123
|
required :index, Integer
|
|
@@ -138,7 +138,7 @@ module OpenAI
|
|
|
138
138
|
# The filename of the file cited.
|
|
139
139
|
#
|
|
140
140
|
# @param index [Integer]
|
|
141
|
-
# The index
|
|
141
|
+
# The index in the output text at which to insert the file citation.
|
|
142
142
|
#
|
|
143
143
|
# @param type [Symbol, :file_citation]
|
|
144
144
|
# The type of the file citation. Always `file_citation`.
|
|
@@ -709,9 +709,7 @@ module OpenAI
|
|
|
709
709
|
# the maximum supported resolution is `3840x2160`. The requested size must also
|
|
710
710
|
# satisfy the model's current pixel and edge limits. The standard sizes
|
|
711
711
|
# `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`.
|
|
712
|
+
# `auto` is supported for models that allow automatic sizing.
|
|
715
713
|
#
|
|
716
714
|
# @return [String, Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::Size, nil]
|
|
717
715
|
optional :size, union: -> { OpenAI::Responses::Tool::ImageGeneration::Size }
|
|
@@ -779,9 +777,7 @@ module OpenAI
|
|
|
779
777
|
# the maximum supported resolution is `3840x2160`. The requested size must also
|
|
780
778
|
# satisfy the model's current pixel and edge limits. The standard sizes
|
|
781
779
|
# `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`.
|
|
780
|
+
# `auto` is supported for models that allow automatic sizing.
|
|
785
781
|
#
|
|
786
782
|
# @param type [Symbol, :image_generation]
|
|
787
783
|
# The type of the image generation tool. Always `image_generation`.
|
|
@@ -978,9 +974,7 @@ module OpenAI
|
|
|
978
974
|
# the maximum supported resolution is `3840x2160`. The requested size must also
|
|
979
975
|
# satisfy the model's current pixel and edge limits. The standard sizes
|
|
980
976
|
# `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`.
|
|
977
|
+
# `auto` is supported for models that allow automatic sizing.
|
|
984
978
|
#
|
|
985
979
|
# @see OpenAI::Models::Responses::Tool::ImageGeneration#size
|
|
986
980
|
module Size
|
|
@@ -14,21 +14,63 @@ module OpenAI
|
|
|
14
14
|
module ResponsesOnlyModel
|
|
15
15
|
extend OpenAI::Internal::Type::Enum
|
|
16
16
|
|
|
17
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
18
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
19
|
+
# replacements.
|
|
17
20
|
O1_PRO = :"o1-pro"
|
|
21
|
+
# @deprecated Announced shutdown date: 2026-10-23. See
|
|
22
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
23
|
+
# replacements.
|
|
18
24
|
O1_PRO_2025_03_19 = :"o1-pro-2025-03-19"
|
|
25
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
26
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
27
|
+
# replacements.
|
|
19
28
|
O3_PRO = :"o3-pro"
|
|
29
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
30
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
31
|
+
# replacements.
|
|
20
32
|
O3_PRO_2025_06_10 = :"o3-pro-2025-06-10"
|
|
33
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
34
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
35
|
+
# replacements.
|
|
21
36
|
O3_DEEP_RESEARCH = :"o3-deep-research"
|
|
37
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
38
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
39
|
+
# replacements.
|
|
22
40
|
O3_DEEP_RESEARCH_2025_06_26 = :"o3-deep-research-2025-06-26"
|
|
41
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
42
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
43
|
+
# replacements.
|
|
23
44
|
O4_MINI_DEEP_RESEARCH = :"o4-mini-deep-research"
|
|
45
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
46
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
47
|
+
# replacements.
|
|
24
48
|
O4_MINI_DEEP_RESEARCH_2025_06_26 = :"o4-mini-deep-research-2025-06-26"
|
|
49
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
50
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
51
|
+
# replacements.
|
|
25
52
|
COMPUTER_USE_PREVIEW = :"computer-use-preview"
|
|
53
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
54
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
55
|
+
# replacements.
|
|
26
56
|
COMPUTER_USE_PREVIEW_2025_03_11 = :"computer-use-preview-2025-03-11"
|
|
27
57
|
GPT_5_5_PRO = :"gpt-5.5-pro"
|
|
28
58
|
GPT_5_5_PRO_2026_04_23 = :"gpt-5.5-pro-2026-04-23"
|
|
59
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
60
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
61
|
+
# replacements.
|
|
29
62
|
GPT_5_CODEX = :"gpt-5-codex"
|
|
63
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
64
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
65
|
+
# replacements.
|
|
30
66
|
GPT_5_PRO = :"gpt-5-pro"
|
|
67
|
+
# @deprecated Announced shutdown date: 2026-12-11. See
|
|
68
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
69
|
+
# replacements.
|
|
31
70
|
GPT_5_PRO_2025_10_06 = :"gpt-5-pro-2025-10-06"
|
|
71
|
+
# @deprecated Announced shutdown date: 2026-07-23. See
|
|
72
|
+
# https://developers.openai.com/api/docs/deprecations for details and recommended
|
|
73
|
+
# replacements.
|
|
32
74
|
GPT_5_1_CODEX_MAX = :"gpt-5.1-codex-max"
|
|
33
75
|
GPT_DAYBREAK_BLUE_LATEST = :"gpt-daybreak-blue-latest"
|
|
34
76
|
GPT_DAYBREAK_RED_LATEST = :"gpt-daybreak-red-latest"
|