openai 0.98.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.
Files changed (138) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/README.md +1 -1
  4. data/lib/openai/models/admin/organization/usage_audio_speeches_response.rb +16 -3
  5. data/lib/openai/models/admin/organization/usage_audio_transcriptions_response.rb +16 -3
  6. data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_response.rb +16 -3
  7. data/lib/openai/models/admin/organization/usage_completions_response.rb +16 -3
  8. data/lib/openai/models/admin/organization/usage_costs_response.rb +16 -3
  9. data/lib/openai/models/admin/organization/usage_embeddings_response.rb +16 -3
  10. data/lib/openai/models/admin/organization/usage_file_search_calls_response.rb +16 -3
  11. data/lib/openai/models/admin/organization/usage_images_response.rb +16 -3
  12. data/lib/openai/models/admin/organization/usage_moderations_response.rb +16 -3
  13. data/lib/openai/models/admin/organization/usage_vector_stores_response.rb +16 -3
  14. data/lib/openai/models/admin/organization/usage_web_search_calls_response.rb +16 -3
  15. data/lib/openai/models/all_models.rb +42 -0
  16. data/lib/openai/models/audio/speech_create_params.rb +6 -0
  17. data/lib/openai/models/audio/voice.rb +75 -0
  18. data/lib/openai/models/audio/voice_create_params.rb +217 -0
  19. data/lib/openai/models/beta/agent_create_params.rb +0 -3
  20. data/lib/openai/models/beta/agent_update_params.rb +0 -3
  21. data/lib/openai/models/beta/agents/session_create_params.rb +0 -3
  22. data/lib/openai/models/beta/agents/session_update_params.rb +0 -3
  23. data/lib/openai/models/beta/beta_response.rb +220 -0
  24. data/lib/openai/models/beta/beta_responses_client_event.rb +220 -0
  25. data/lib/openai/models/beta/beta_tool.rb +3 -9
  26. data/lib/openai/models/beta/response_compact_params.rb +220 -0
  27. data/lib/openai/models/beta/response_create_params.rb +220 -0
  28. data/lib/openai/models/chat/chat_completion_audio_param.rb +6 -3
  29. data/lib/openai/models/chat_model.rb +178 -0
  30. data/lib/openai/models/image.rb +14 -14
  31. data/lib/openai/models/image_create_variation_params.rb +7 -7
  32. data/lib/openai/models/image_edit_params.rb +76 -87
  33. data/lib/openai/models/image_generate_params.rb +51 -62
  34. data/lib/openai/models/image_model.rb +5 -3
  35. data/lib/openai/models/realtime/realtime_audio_config_output.rb +9 -6
  36. data/lib/openai/models/realtime/realtime_response_create_audio_output.rb +9 -6
  37. data/lib/openai/models/responses/response_compact_params.rb +220 -0
  38. data/lib/openai/models/responses/tool.rb +3 -9
  39. data/lib/openai/models/responses_model.rb +42 -0
  40. data/lib/openai/models/webhooks/agent_session_action_required_webhook_event.rb +109 -0
  41. data/lib/openai/models/webhooks/agent_session_created_webhook_event.rb +106 -0
  42. data/lib/openai/models/webhooks/agent_session_failed_webhook_event.rb +86 -0
  43. data/lib/openai/models/webhooks/agent_session_idle_webhook_event.rb +86 -0
  44. data/lib/openai/models/webhooks/agent_session_in_progress_webhook_event.rb +86 -0
  45. data/lib/openai/models/webhooks/unwrap_webhook_event.rb +18 -2
  46. data/lib/openai/models/webhooks/webhook_create_params.rb +5 -0
  47. data/lib/openai/models/webhooks/webhook_test_params.rb +5 -0
  48. data/lib/openai/models/webhooks/webhook_update_params.rb +5 -0
  49. data/lib/openai/resources/audio/speech.rb +2 -0
  50. data/lib/openai/resources/audio/voices.rb +53 -0
  51. data/lib/openai/resources/audio.rb +5 -0
  52. data/lib/openai/resources/images.rb +71 -103
  53. data/lib/openai/resources/webhooks.rb +1 -1
  54. data/lib/openai/version.rb +1 -1
  55. data/lib/openai.rb +8 -0
  56. data/rbi/openai/models/admin/organization/usage_audio_speeches_response.rbi +19 -2
  57. data/rbi/openai/models/admin/organization/usage_audio_transcriptions_response.rbi +19 -2
  58. data/rbi/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbi +19 -2
  59. data/rbi/openai/models/admin/organization/usage_completions_response.rbi +19 -2
  60. data/rbi/openai/models/admin/organization/usage_costs_response.rbi +19 -2
  61. data/rbi/openai/models/admin/organization/usage_embeddings_response.rbi +19 -2
  62. data/rbi/openai/models/admin/organization/usage_file_search_calls_response.rbi +19 -2
  63. data/rbi/openai/models/admin/organization/usage_images_response.rbi +19 -2
  64. data/rbi/openai/models/admin/organization/usage_moderations_response.rbi +19 -2
  65. data/rbi/openai/models/admin/organization/usage_vector_stores_response.rbi +19 -2
  66. data/rbi/openai/models/admin/organization/usage_web_search_calls_response.rbi +19 -2
  67. data/rbi/openai/models/audio/speech_create_params.rbi +6 -0
  68. data/rbi/openai/models/audio/voice.rbi +111 -0
  69. data/rbi/openai/models/audio/voice_create_params.rbi +321 -0
  70. data/rbi/openai/models/beta/agent_create_params.rbi +0 -3
  71. data/rbi/openai/models/beta/agent_update_params.rbi +0 -3
  72. data/rbi/openai/models/beta/agents/session_create_params.rbi +0 -3
  73. data/rbi/openai/models/beta/agents/session_update_params.rbi +0 -3
  74. data/rbi/openai/models/beta/beta_tool.rbi +3 -9
  75. data/rbi/openai/models/chat/chat_completion_audio_param.rbi +6 -3
  76. data/rbi/openai/models/image.rbi +14 -14
  77. data/rbi/openai/models/image_create_variation_params.rbi +6 -6
  78. data/rbi/openai/models/image_edit_params.rbi +61 -82
  79. data/rbi/openai/models/image_generate_params.rbi +30 -61
  80. data/rbi/openai/models/image_model.rbi +3 -3
  81. data/rbi/openai/models/realtime/realtime_audio_config_output.rbi +9 -6
  82. data/rbi/openai/models/realtime/realtime_response_create_audio_output.rbi +9 -6
  83. data/rbi/openai/models/responses/tool.rbi +3 -9
  84. data/rbi/openai/models/webhooks/agent_session_action_required_webhook_event.rbi +222 -0
  85. data/rbi/openai/models/webhooks/agent_session_created_webhook_event.rbi +202 -0
  86. data/rbi/openai/models/webhooks/agent_session_failed_webhook_event.rbi +151 -0
  87. data/rbi/openai/models/webhooks/agent_session_idle_webhook_event.rbi +151 -0
  88. data/rbi/openai/models/webhooks/agent_session_in_progress_webhook_event.rbi +151 -0
  89. data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +7 -1
  90. data/rbi/openai/models/webhooks/webhook_create_params.rbi +20 -0
  91. data/rbi/openai/models/webhooks/webhook_test_params.rbi +20 -0
  92. data/rbi/openai/models/webhooks/webhook_update_params.rbi +20 -0
  93. data/rbi/openai/resources/audio/speech.rbi +2 -0
  94. data/rbi/openai/resources/audio/voices.rbi +49 -0
  95. data/rbi/openai/resources/audio.rbi +4 -0
  96. data/rbi/openai/resources/images.rbi +69 -103
  97. data/rbi/openai/resources/webhooks.rbi +5 -0
  98. data/sig/openai/models/admin/organization/usage_audio_speeches_response.rbs +20 -3
  99. data/sig/openai/models/admin/organization/usage_audio_transcriptions_response.rbs +20 -3
  100. data/sig/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbs +20 -3
  101. data/sig/openai/models/admin/organization/usage_completions_response.rbs +20 -3
  102. data/sig/openai/models/admin/organization/usage_costs_response.rbs +20 -3
  103. data/sig/openai/models/admin/organization/usage_embeddings_response.rbs +20 -3
  104. data/sig/openai/models/admin/organization/usage_file_search_calls_response.rbs +20 -3
  105. data/sig/openai/models/admin/organization/usage_images_response.rbs +20 -3
  106. data/sig/openai/models/admin/organization/usage_moderations_response.rbs +20 -3
  107. data/sig/openai/models/admin/organization/usage_vector_stores_response.rbs +20 -3
  108. data/sig/openai/models/admin/organization/usage_web_search_calls_response.rbs +20 -3
  109. data/sig/openai/models/audio/speech_create_params.rbs +4 -0
  110. data/sig/openai/models/audio/voice.rbs +70 -0
  111. data/sig/openai/models/audio/voice_create_params.rbs +203 -0
  112. data/sig/openai/models/beta/agent_create_params.rbs +1 -5
  113. data/sig/openai/models/beta/agent_update_params.rbs +1 -5
  114. data/sig/openai/models/beta/agents/session_create_params.rbs +1 -5
  115. data/sig/openai/models/beta/agents/session_update_params.rbs +1 -5
  116. data/sig/openai/models/beta/beta_tool.rbs +3 -9
  117. data/sig/openai/models/chat/chat_completion_audio_param.rbs +4 -2
  118. data/sig/openai/models/image.rbs +21 -21
  119. data/sig/openai/models/image_create_variation_params.rbs +4 -4
  120. data/sig/openai/models/image_edit_params.rbs +46 -60
  121. data/sig/openai/models/image_generate_params.rbs +23 -45
  122. data/sig/openai/models/image_model.rbs +6 -6
  123. data/sig/openai/models/realtime/realtime_audio_config_output.rbs +9 -6
  124. data/sig/openai/models/realtime/realtime_response_create_audio_output.rbs +9 -6
  125. data/sig/openai/models/responses/tool.rbs +3 -9
  126. data/sig/openai/models/webhooks/agent_session_action_required_webhook_event.rbs +114 -0
  127. data/sig/openai/models/webhooks/agent_session_created_webhook_event.rbs +115 -0
  128. data/sig/openai/models/webhooks/agent_session_failed_webhook_event.rbs +89 -0
  129. data/sig/openai/models/webhooks/agent_session_idle_webhook_event.rbs +89 -0
  130. data/sig/openai/models/webhooks/agent_session_in_progress_webhook_event.rbs +89 -0
  131. data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +6 -1
  132. data/sig/openai/models/webhooks/webhook_create_params.rbs +10 -0
  133. data/sig/openai/models/webhooks/webhook_test_params.rbs +10 -0
  134. data/sig/openai/models/webhooks/webhook_update_params.rbs +10 -0
  135. data/sig/openai/resources/audio/voices.rbs +14 -0
  136. data/sig/openai/resources/audio.rbs +2 -0
  137. data/sig/openai/resources/webhooks.rbs +6 -1
  138. metadata +25 -1
@@ -19,9 +19,6 @@ module OpenAI
19
19
  # be a `png`, `webp`, or `jpg` file less than 50MB. You can provide up to 16
20
20
  # images.
21
21
  #
22
- # For `dall-e-2`, you can only provide one image, and it should be a square `png`
23
- # file less than 4MB.
24
- #
25
22
  # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
26
23
  # metadata. Use `OpenAI::FilePart` when you need to override the filename or
27
24
  # content type.
@@ -30,8 +27,8 @@ module OpenAI
30
27
  required :image, union: -> { OpenAI::ImageEditParams::Image }
31
28
 
32
29
  # @!attribute prompt
33
- # A text description of the desired image(s). The maximum length is 1000
34
- # characters for `dall-e-2`, and 32000 characters for the GPT image models.
30
+ # A text description of the desired image(s). The maximum length is 32000
31
+ # characters for the GPT image models.
35
32
  #
36
33
  # @return [String]
37
34
  required :prompt, String
@@ -72,12 +69,11 @@ module OpenAI
72
69
  optional :mask, OpenAI::Internal::Type::FileInput
73
70
 
74
71
  # @!attribute model
75
- # The model to use for image generation. One of `dall-e-2` or a GPT image model
76
- # (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
77
- # `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
78
- # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
79
- # `gpt-image-2.5-flare-2026-09-08`, or `chatgpt-image-latest`). Defaults to
80
- # `gpt-image-1.5`.
72
+ # The GPT image model to use for image editing (`gpt-image-1`, `gpt-image-1-mini`,
73
+ # `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`,
74
+ # `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
75
+ # `gpt-image-2.5-flare`, `gpt-image-2.5-flare-2026-09-08`, or
76
+ # `chatgpt-image-latest`).
81
77
  #
82
78
  # @return [String, Symbol, OpenAI::Models::ImageModel, nil]
83
79
  optional :model, union: -> { OpenAI::ImageEditParams::Model }, nil?: true
@@ -125,27 +121,26 @@ module OpenAI
125
121
  optional :quality, enum: -> { OpenAI::ImageEditParams::Quality }, nil?: true
126
122
 
127
123
  # @!attribute response_format
128
- # The format in which the generated images are returned. Must be one of `url` or
129
- # `b64_json`. URLs are only valid for 60 minutes after the image has been
130
- # generated. This parameter is only supported for `dall-e-2` (default is `url` for
131
- # `dall-e-2`), as GPT image models always return base64-encoded images.
124
+ # @deprecated
125
+ #
126
+ # Legacy response format parameter for retired image models. Unsupported for GPT
127
+ # image models, which always return base64-encoded images.
132
128
  #
133
129
  # @return [Symbol, OpenAI::Models::ImageEditParams::ResponseFormat, nil]
134
130
  optional :response_format, enum: -> { OpenAI::ImageEditParams::ResponseFormat }, nil?: true
135
131
 
136
132
  # @!attribute size
137
- # The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`,
138
- # `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
139
- # `gpt-image-2.5-flare`, and `gpt-image-2.5-flare-2026-09-08`, arbitrary
140
- # resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`.
141
- # Width and height must both be divisible by 16 and the requested aspect ratio
142
- # must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and
143
- # the maximum supported resolution is `3840x2160`. The requested size must also
144
- # satisfy the model's current pixel and edge limits. The standard sizes
145
- # `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
146
- # `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
147
- # one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
148
- # `1024x1024`, `1792x1024`, or `1024x1792`.
133
+ # The size of the generated images. Defaults to `auto`. For `gpt-image-2`,
134
+ # `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
135
+ # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, and
136
+ # `gpt-image-2.5-flare-2026-09-08`, arbitrary resolutions are supported as
137
+ # `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be
138
+ # divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1.
139
+ # Resolutions above `2560x1440` are experimental, and the maximum supported
140
+ # resolution is `3840x2160`. The requested size must also satisfy the model's
141
+ # current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and
142
+ # `1024x1536` are supported by the GPT image models; `auto` is supported for
143
+ # models that allow automatic sizing.
149
144
  #
150
145
  # @return [String, Symbol, OpenAI::Models::ImageEditParams::Size, nil]
151
146
  optional :size, union: -> { OpenAI::ImageEditParams::Size }, nil?: true
@@ -169,16 +164,13 @@ module OpenAI
169
164
  # be a `png`, `webp`, or `jpg` file less than 50MB. You can provide up to 16
170
165
  # images.
171
166
  #
172
- # For `dall-e-2`, you can only provide one image, and it should be a square `png`
173
- # file less than 4MB.
174
- #
175
167
  # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
176
168
  # metadata. Use `OpenAI::FilePart` when you need to override the filename or
177
169
  # content type.
178
170
  #
179
171
  # @param prompt [String]
180
- # A text description of the desired image(s). The maximum length is 1000
181
- # characters for `dall-e-2`, and 32000 characters for the GPT image models.
172
+ # A text description of the desired image(s). The maximum length is 32000
173
+ # characters for the GPT image models.
182
174
  #
183
175
  # @param background [Symbol, OpenAI::Models::ImageEditParams::Background, nil]
184
176
  # Allows to set transparency for the background of the generated image(s). Must be
@@ -207,12 +199,11 @@ module OpenAI
207
199
  # content type.
208
200
  #
209
201
  # @param model [String, Symbol, OpenAI::Models::ImageModel, nil]
210
- # The model to use for image generation. One of `dall-e-2` or a GPT image model
211
- # (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
212
- # `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
213
- # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
214
- # `gpt-image-2.5-flare-2026-09-08`, or `chatgpt-image-latest`). Defaults to
215
- # `gpt-image-1.5`.
202
+ # The GPT image model to use for image editing (`gpt-image-1`, `gpt-image-1-mini`,
203
+ # `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`,
204
+ # `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
205
+ # `gpt-image-2.5-flare`, `gpt-image-2.5-flare-2026-09-08`, or
206
+ # `chatgpt-image-latest`).
216
207
  #
217
208
  # @param n [Integer, nil]
218
209
  # The number of images to generate. Must be between 1 and 10.
@@ -242,24 +233,21 @@ module OpenAI
242
233
  # `xhigh` and `max`. Defaults to `auto`.
243
234
  #
244
235
  # @param response_format [Symbol, OpenAI::Models::ImageEditParams::ResponseFormat, nil]
245
- # The format in which the generated images are returned. Must be one of `url` or
246
- # `b64_json`. URLs are only valid for 60 minutes after the image has been
247
- # generated. This parameter is only supported for `dall-e-2` (default is `url` for
248
- # `dall-e-2`), as GPT image models always return base64-encoded images.
236
+ # Legacy response format parameter for retired image models. Unsupported for GPT
237
+ # image models, which always return base64-encoded images.
249
238
  #
250
239
  # @param size [String, Symbol, OpenAI::Models::ImageEditParams::Size, nil]
251
- # The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`,
252
- # `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
253
- # `gpt-image-2.5-flare`, and `gpt-image-2.5-flare-2026-09-08`, arbitrary
254
- # resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`.
255
- # Width and height must both be divisible by 16 and the requested aspect ratio
256
- # must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and
257
- # the maximum supported resolution is `3840x2160`. The requested size must also
258
- # satisfy the model's current pixel and edge limits. The standard sizes
259
- # `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
260
- # `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
261
- # one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
262
- # `1024x1024`, `1792x1024`, or `1024x1792`.
240
+ # The size of the generated images. Defaults to `auto`. For `gpt-image-2`,
241
+ # `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
242
+ # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, and
243
+ # `gpt-image-2.5-flare-2026-09-08`, arbitrary resolutions are supported as
244
+ # `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be
245
+ # divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1.
246
+ # Resolutions above `2560x1440` are experimental, and the maximum supported
247
+ # resolution is `3840x2160`. The requested size must also satisfy the model's
248
+ # current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and
249
+ # `1024x1536` are supported by the GPT image models; `auto` is supported for
250
+ # models that allow automatic sizing.
263
251
  #
264
252
  # @param user [String]
265
253
  # A unique identifier representing your end-user, which can help OpenAI to monitor
@@ -276,9 +264,6 @@ module OpenAI
276
264
  # `gpt-image-2.5-flare-2026-09-08`, and `chatgpt-image-latest`), each image should
277
265
  # be a `png`, `webp`, or `jpg` file less than 50MB. You can provide up to 16
278
266
  # images.
279
- #
280
- # For `dall-e-2`, you can only provide one image, and it should be a square `png`
281
- # file less than 4MB.
282
267
  module Image
283
268
  extend OpenAI::Internal::Type::Union
284
269
 
@@ -326,18 +311,17 @@ module OpenAI
326
311
  # @return [Array<Symbol>]
327
312
  end
328
313
 
329
- # The model to use for image generation. One of `dall-e-2` or a GPT image model
330
- # (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
331
- # `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
332
- # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
333
- # `gpt-image-2.5-flare-2026-09-08`, or `chatgpt-image-latest`). Defaults to
334
- # `gpt-image-1.5`.
314
+ # The GPT image model to use for image editing (`gpt-image-1`, `gpt-image-1-mini`,
315
+ # `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`,
316
+ # `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
317
+ # `gpt-image-2.5-flare`, `gpt-image-2.5-flare-2026-09-08`, or
318
+ # `chatgpt-image-latest`).
335
319
  module Model
336
320
  extend OpenAI::Internal::Type::Union
337
321
 
338
322
  variant String
339
323
 
340
- # The model to use for image generation. One of `dall-e-2` or a GPT image model (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, `gpt-image-2.5-flare-2026-09-08`, or `chatgpt-image-latest`). Defaults to `gpt-image-1.5`.
324
+ # The GPT image model to use for image editing (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, `gpt-image-2.5-flare-2026-09-08`, or `chatgpt-image-latest`).
341
325
  variant enum: -> { OpenAI::ImageModel }
342
326
 
343
327
  # @!method self.variants
@@ -365,22 +349,24 @@ module OpenAI
365
349
  module Quality
366
350
  extend OpenAI::Internal::Type::Enum
367
351
 
368
- STANDARD = :standard
369
352
  LOW = :low
370
353
  MEDIUM = :medium
371
354
  HIGH = :high
372
355
  XHIGH = :xhigh
373
356
  MAX = :max
374
357
  AUTO = :auto
358
+ # @deprecated This quality was only supported by retired DALL·E models. Use a GPT image
359
+ # quality instead.
360
+ STANDARD = :standard
375
361
 
376
362
  # @!method self.values
377
363
  # @return [Array<Symbol>]
378
364
  end
379
365
 
380
- # The format in which the generated images are returned. Must be one of `url` or
381
- # `b64_json`. URLs are only valid for 60 minutes after the image has been
382
- # generated. This parameter is only supported for `dall-e-2` (default is `url` for
383
- # `dall-e-2`), as GPT image models always return base64-encoded images.
366
+ # @deprecated
367
+ #
368
+ # Legacy response format parameter for retired image models. Unsupported for GPT
369
+ # image models, which always return base64-encoded images.
384
370
  module ResponseFormat
385
371
  extend OpenAI::Internal::Type::Enum
386
372
 
@@ -391,27 +377,22 @@ module OpenAI
391
377
  # @return [Array<Symbol>]
392
378
  end
393
379
 
394
- # The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`,
395
- # `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
396
- # `gpt-image-2.5-flare`, and `gpt-image-2.5-flare-2026-09-08`, arbitrary
397
- # resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`.
398
- # Width and height must both be divisible by 16 and the requested aspect ratio
399
- # must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and
400
- # the maximum supported resolution is `3840x2160`. The requested size must also
401
- # satisfy the model's current pixel and edge limits. The standard sizes
402
- # `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
403
- # `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
404
- # one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
405
- # `1024x1024`, `1792x1024`, or `1024x1792`.
380
+ # The size of the generated images. Defaults to `auto`. For `gpt-image-2`,
381
+ # `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
382
+ # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, and
383
+ # `gpt-image-2.5-flare-2026-09-08`, arbitrary resolutions are supported as
384
+ # `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be
385
+ # divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1.
386
+ # Resolutions above `2560x1440` are experimental, and the maximum supported
387
+ # resolution is `3840x2160`. The requested size must also satisfy the model's
388
+ # current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and
389
+ # `1024x1536` are supported by the GPT image models; `auto` is supported for
390
+ # models that allow automatic sizing.
406
391
  module Size
407
392
  extend OpenAI::Internal::Type::Union
408
393
 
409
394
  variant String
410
395
 
411
- variant const: -> { OpenAI::Models::ImageEditParams::Size::SIZE_256X256 }
412
-
413
- variant const: -> { OpenAI::Models::ImageEditParams::Size::SIZE_512X512 }
414
-
415
396
  variant const: -> { OpenAI::Models::ImageEditParams::Size::SIZE_1024X1024 }
416
397
 
417
398
  variant const: -> { OpenAI::Models::ImageEditParams::Size::SIZE_1536X1024 }
@@ -420,6 +401,10 @@ module OpenAI
420
401
 
421
402
  variant const: -> { OpenAI::Models::ImageEditParams::Size::AUTO }
422
403
 
404
+ variant const: -> { OpenAI::Models::ImageEditParams::Size::SIZE_256X256 }
405
+
406
+ variant const: -> { OpenAI::Models::ImageEditParams::Size::SIZE_512X512 }
407
+
423
408
  # @!method self.variants
424
409
  # @return [Array(String, Symbol)]
425
410
 
@@ -429,12 +414,16 @@ module OpenAI
429
414
 
430
415
  # @!group
431
416
 
432
- SIZE_256X256 = :"256x256"
433
- SIZE_512X512 = :"512x512"
434
417
  SIZE_1024X1024 = :"1024x1024"
435
418
  SIZE_1536X1024 = :"1536x1024"
436
419
  SIZE_1024X1536 = :"1024x1536"
437
420
  AUTO = :auto
421
+ # @deprecated This legacy size suggestion is retained for SDK compatibility. Check the
422
+ # selected GPT image model's supported sizes.
423
+ SIZE_256X256 = :"256x256"
424
+ # @deprecated This legacy size suggestion is retained for SDK compatibility. Check the
425
+ # selected GPT image model's supported sizes.
426
+ SIZE_512X512 = :"512x512"
438
427
 
439
428
  # @!endgroup
440
429
  end
@@ -11,8 +11,7 @@ module OpenAI
11
11
 
12
12
  # @!attribute prompt
13
13
  # A text description of the desired image(s). The maximum length is 32000
14
- # characters for the GPT image models, 1000 characters for `dall-e-2` and 4000
15
- # characters for `dall-e-3`.
14
+ # characters.
16
15
  #
17
16
  # @return [String]
18
17
  required :prompt, String
@@ -32,12 +31,11 @@ module OpenAI
32
31
  optional :background, enum: -> { OpenAI::ImageGenerateParams::Background }, nil?: true
33
32
 
34
33
  # @!attribute model
35
- # The model to use for image generation. One of `dall-e-2`, `dall-e-3`, or a GPT
36
- # image model (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
37
- # `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
34
+ # The GPT image model to use for image generation. Specify a model explicitly.
35
+ # Supported models include `gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`,
36
+ # `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
38
37
  # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
39
- # `gpt-image-2.5-flare-2026-09-08`). Defaults to `dall-e-2` unless a parameter
40
- # specific to the GPT image models is used.
38
+ # `gpt-image-2.5-flare-2026-09-08`, and `chatgpt-image-latest`.
41
39
  #
42
40
  # @return [String, Symbol, OpenAI::Models::ImageModel, nil]
43
41
  optional :model, union: -> { OpenAI::ImageGenerateParams::Model }, nil?: true
@@ -51,8 +49,7 @@ module OpenAI
51
49
  optional :moderation, enum: -> { OpenAI::ImageGenerateParams::Moderation }, nil?: true
52
50
 
53
51
  # @!attribute n
54
- # The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
55
- # `n=1` is supported.
52
+ # The number of images to generate. Must be between 1 and 10.
56
53
  #
57
54
  # @return [Integer, nil]
58
55
  optional :n, Integer, nil?: true
@@ -91,16 +88,14 @@ module OpenAI
91
88
  # - `high`, `medium` and `low` are supported for the GPT image models.
92
89
  # - `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`, including their
93
90
  # `2026-09-08` snapshots, also support `xhigh` and `max`.
94
- # - `hd` and `standard` are supported for `dall-e-3`.
95
- # - `standard` is the only option for `dall-e-2`.
96
91
  #
97
92
  # @return [Symbol, OpenAI::Models::ImageGenerateParams::Quality, nil]
98
93
  optional :quality, enum: -> { OpenAI::ImageGenerateParams::Quality }, nil?: true
99
94
 
100
95
  # @!attribute response_format
101
- # The format in which generated images with `dall-e-2` and `dall-e-3` are
102
- # returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes
103
- # after the image has been generated. This parameter isn't supported for the GPT
96
+ # @deprecated
97
+ #
98
+ # Legacy response format parameter for retired image models. Unsupported for GPT
104
99
  # image models, which always return base64-encoded images.
105
100
  #
106
101
  # @return [Symbol, OpenAI::Models::ImageGenerateParams::ResponseFormat, nil]
@@ -116,18 +111,16 @@ module OpenAI
116
111
  # the maximum supported resolution is `3840x2160`. The requested size must also
117
112
  # satisfy the model's current pixel and edge limits. The standard sizes
118
113
  # `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
119
- # `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
120
- # one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
121
- # `1024x1024`, `1792x1024`, or `1024x1792`.
114
+ # `auto` is supported for models that allow automatic sizing.
122
115
  #
123
116
  # @return [String, Symbol, OpenAI::Models::ImageGenerateParams::Size, nil]
124
117
  optional :size, union: -> { OpenAI::ImageGenerateParams::Size }, nil?: true
125
118
 
126
119
  # @!attribute style
127
- # The style of the generated images. This parameter is only supported for
128
- # `dall-e-3`. Must be one of `vivid` or `natural`. Vivid causes the model to lean
129
- # towards generating hyper-real and dramatic images. Natural causes the model to
130
- # produce more natural, less hyper-real looking images.
120
+ # @deprecated
121
+ #
122
+ # Legacy style parameter for retired image models. Unsupported for GPT image
123
+ # models; describe the desired style in the prompt instead.
131
124
  #
132
125
  # @return [Symbol, OpenAI::Models::ImageGenerateParams::Style, nil]
133
126
  optional :style, enum: -> { OpenAI::ImageGenerateParams::Style }, nil?: true
@@ -143,8 +136,7 @@ module OpenAI
143
136
  # @!method initialize(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, style: nil, user: nil, request_options: {})
144
137
  # @param prompt [String]
145
138
  # A text description of the desired image(s). The maximum length is 32000
146
- # characters for the GPT image models, 1000 characters for `dall-e-2` and 4000
147
- # characters for `dall-e-3`.
139
+ # characters.
148
140
  #
149
141
  # @param background [Symbol, OpenAI::Models::ImageGenerateParams::Background, nil]
150
142
  # Allows to set transparency for the background of the generated image(s). Must be
@@ -158,12 +150,11 @@ module OpenAI
158
150
  # set the output format to `png` or `webp`.
159
151
  #
160
152
  # @param model [String, Symbol, OpenAI::Models::ImageModel, nil]
161
- # The model to use for image generation. One of `dall-e-2`, `dall-e-3`, or a GPT
162
- # image model (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
163
- # `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
153
+ # The GPT image model to use for image generation. Specify a model explicitly.
154
+ # Supported models include `gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`,
155
+ # `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
164
156
  # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
165
- # `gpt-image-2.5-flare-2026-09-08`). Defaults to `dall-e-2` unless a parameter
166
- # specific to the GPT image models is used.
157
+ # `gpt-image-2.5-flare-2026-09-08`, and `chatgpt-image-latest`.
167
158
  #
168
159
  # @param moderation [Symbol, OpenAI::Models::ImageGenerateParams::Moderation, nil]
169
160
  # Control the content-moderation level for images generated by the GPT image
@@ -171,8 +162,7 @@ module OpenAI
171
162
  # value).
172
163
  #
173
164
  # @param n [Integer, nil]
174
- # The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
175
- # `n=1` is supported.
165
+ # The number of images to generate. Must be between 1 and 10.
176
166
  #
177
167
  # @param output_compression [Integer, nil]
178
168
  # The compression level (0-100%) for the generated images. This parameter is only
@@ -199,13 +189,9 @@ module OpenAI
199
189
  # - `high`, `medium` and `low` are supported for the GPT image models.
200
190
  # - `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`, including their
201
191
  # `2026-09-08` snapshots, also support `xhigh` and `max`.
202
- # - `hd` and `standard` are supported for `dall-e-3`.
203
- # - `standard` is the only option for `dall-e-2`.
204
192
  #
205
193
  # @param response_format [Symbol, OpenAI::Models::ImageGenerateParams::ResponseFormat, nil]
206
- # The format in which generated images with `dall-e-2` and `dall-e-3` are
207
- # returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes
208
- # after the image has been generated. This parameter isn't supported for the GPT
194
+ # Legacy response format parameter for retired image models. Unsupported for GPT
209
195
  # image models, which always return base64-encoded images.
210
196
  #
211
197
  # @param size [String, Symbol, OpenAI::Models::ImageGenerateParams::Size, nil]
@@ -218,15 +204,11 @@ module OpenAI
218
204
  # the maximum supported resolution is `3840x2160`. The requested size must also
219
205
  # satisfy the model's current pixel and edge limits. The standard sizes
220
206
  # `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
221
- # `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
222
- # one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
223
- # `1024x1024`, `1792x1024`, or `1024x1792`.
207
+ # `auto` is supported for models that allow automatic sizing.
224
208
  #
225
209
  # @param style [Symbol, OpenAI::Models::ImageGenerateParams::Style, nil]
226
- # The style of the generated images. This parameter is only supported for
227
- # `dall-e-3`. Must be one of `vivid` or `natural`. Vivid causes the model to lean
228
- # towards generating hyper-real and dramatic images. Natural causes the model to
229
- # produce more natural, less hyper-real looking images.
210
+ # Legacy style parameter for retired image models. Unsupported for GPT image
211
+ # models; describe the desired style in the prompt instead.
230
212
  #
231
213
  # @param user [String]
232
214
  # A unique identifier representing your end-user, which can help OpenAI to monitor
@@ -255,18 +237,17 @@ module OpenAI
255
237
  # @return [Array<Symbol>]
256
238
  end
257
239
 
258
- # The model to use for image generation. One of `dall-e-2`, `dall-e-3`, or a GPT
259
- # image model (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
260
- # `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
240
+ # The GPT image model to use for image generation. Specify a model explicitly.
241
+ # Supported models include `gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`,
242
+ # `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
261
243
  # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
262
- # `gpt-image-2.5-flare-2026-09-08`). Defaults to `dall-e-2` unless a parameter
263
- # specific to the GPT image models is used.
244
+ # `gpt-image-2.5-flare-2026-09-08`, and `chatgpt-image-latest`.
264
245
  module Model
265
246
  extend OpenAI::Internal::Type::Union
266
247
 
267
248
  variant String
268
249
 
269
- # The model to use for image generation. One of `dall-e-2`, `dall-e-3`, or a GPT image model (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, `gpt-image-2.5-flare-2026-09-08`). Defaults to `dall-e-2` unless a parameter specific to the GPT image models is used.
250
+ # The GPT image model to use for image generation. Specify a model explicitly. Supported models include `gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, `gpt-image-2.5-flare-2026-09-08`, and `chatgpt-image-latest`.
270
251
  variant enum: -> { OpenAI::ImageModel }
271
252
 
272
253
  # @!method self.variants
@@ -306,27 +287,29 @@ module OpenAI
306
287
  # - `high`, `medium` and `low` are supported for the GPT image models.
307
288
  # - `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`, including their
308
289
  # `2026-09-08` snapshots, also support `xhigh` and `max`.
309
- # - `hd` and `standard` are supported for `dall-e-3`.
310
- # - `standard` is the only option for `dall-e-2`.
311
290
  module Quality
312
291
  extend OpenAI::Internal::Type::Enum
313
292
 
314
- STANDARD = :standard
315
- HD = :hd
316
293
  LOW = :low
317
294
  MEDIUM = :medium
318
295
  HIGH = :high
319
296
  XHIGH = :xhigh
320
297
  MAX = :max
321
298
  AUTO = :auto
299
+ # @deprecated This quality was only supported by retired DALL·E models. Use a GPT image
300
+ # quality instead.
301
+ STANDARD = :standard
302
+ # @deprecated This quality was only supported by retired DALL·E models. Use a GPT image
303
+ # quality instead.
304
+ HD = :hd
322
305
 
323
306
  # @!method self.values
324
307
  # @return [Array<Symbol>]
325
308
  end
326
309
 
327
- # The format in which generated images with `dall-e-2` and `dall-e-3` are
328
- # returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes
329
- # after the image has been generated. This parameter isn't supported for the GPT
310
+ # @deprecated
311
+ #
312
+ # Legacy response format parameter for retired image models. Unsupported for GPT
330
313
  # image models, which always return base64-encoded images.
331
314
  module ResponseFormat
332
315
  extend OpenAI::Internal::Type::Enum
@@ -347,9 +330,7 @@ module OpenAI
347
330
  # the maximum supported resolution is `3840x2160`. The requested size must also
348
331
  # satisfy the model's current pixel and edge limits. The standard sizes
349
332
  # `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
350
- # `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
351
- # one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
352
- # `1024x1024`, `1792x1024`, or `1024x1792`.
333
+ # `auto` is supported for models that allow automatic sizing.
353
334
  module Size
354
335
  extend OpenAI::Internal::Type::Union
355
336
 
@@ -384,18 +365,26 @@ module OpenAI
384
365
  SIZE_1024X1024 = :"1024x1024"
385
366
  SIZE_1536X1024 = :"1536x1024"
386
367
  SIZE_1024X1536 = :"1024x1536"
368
+ # @deprecated This legacy size suggestion is retained for SDK compatibility. Check the
369
+ # selected GPT image model's supported sizes.
387
370
  SIZE_256X256 = :"256x256"
371
+ # @deprecated This legacy size suggestion is retained for SDK compatibility. Check the
372
+ # selected GPT image model's supported sizes.
388
373
  SIZE_512X512 = :"512x512"
374
+ # @deprecated This legacy size suggestion is retained for SDK compatibility. Check the
375
+ # selected GPT image model's supported sizes.
389
376
  SIZE_1792X1024 = :"1792x1024"
377
+ # @deprecated This legacy size suggestion is retained for SDK compatibility. Check the
378
+ # selected GPT image model's supported sizes.
390
379
  SIZE_1024X1792 = :"1024x1792"
391
380
 
392
381
  # @!endgroup
393
382
  end
394
383
 
395
- # The style of the generated images. This parameter is only supported for
396
- # `dall-e-3`. Must be one of `vivid` or `natural`. Vivid causes the model to lean
397
- # towards generating hyper-real and dramatic images. Natural causes the model to
398
- # produce more natural, less hyper-real looking images.
384
+ # @deprecated
385
+ #
386
+ # Legacy style parameter for retired image models. Unsupported for GPT image
387
+ # models; describe the desired style in the prompt instead.
399
388
  module Style
400
389
  extend OpenAI::Internal::Type::Enum
401
390
 
@@ -5,17 +5,19 @@ module OpenAI
5
5
  module ImageModel
6
6
  extend OpenAI::Internal::Type::Enum
7
7
 
8
- GPT_IMAGE_1 = :"gpt-image-1"
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
- GPT_IMAGE_1_5 = :"gpt-image-1.5"
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. We recommend `marin` and `cedar`
31
- # for best quality.
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. We recommend `marin` and `cedar`
55
- # for best quality.
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. We recommend `marin` and `cedar`
62
- # for best quality.
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