openai 0.88.0 → 0.89.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 +12 -0
- data/README.md +1 -1
- data/lib/openai/client.rb +4 -0
- data/lib/openai/models/beta/beta_response_input_item.rb +91 -1
- data/lib/openai/models/beta/beta_response_item.rb +93 -1
- data/lib/openai/models/beta/beta_response_output_item.rb +91 -1
- data/lib/openai/models/conversations/conversation_item.rb +91 -1
- data/lib/openai/models/live/audio_format.rb +109 -0
- data/lib/openai/models/live/built_in_voice.rb +38 -0
- data/lib/openai/models/live/client_config.rb +22 -0
- data/lib/openai/models/live/client_delegation.rb +22 -0
- data/lib/openai/models/live/client_event.rb +54 -0
- data/lib/openai/models/live/commentary_append_event.rb +59 -0
- data/lib/openai/models/live/commentary_appended_event.rb +65 -0
- data/lib/openai/models/live/custom_voice.rb +17 -0
- data/lib/openai/models/live/data_channel_config.rb +81 -0
- data/lib/openai/models/live/delegation_created_event.rb +140 -0
- data/lib/openai/models/live/error.rb +60 -0
- data/lib/openai/models/live/error_event.rb +52 -0
- data/lib/openai/models/live/fork_client_event.rb +53 -0
- data/lib/openai/models/live/fork_server_event.rb +295 -0
- data/lib/openai/models/live/fork_session_config.rb +107 -0
- data/lib/openai/models/live/fork_session_start_event.rb +48 -0
- data/lib/openai/models/live/function_tool.rb +60 -0
- data/lib/openai/models/live/info_event.rb +60 -0
- data/lib/openai/models/live/initial_item.rb +419 -0
- data/lib/openai/models/live/input_audio_append_event.rb +50 -0
- data/lib/openai/models/live/input_audio_mute_event.rb +33 -0
- data/lib/openai/models/live/input_audio_muted_event.rb +42 -0
- data/lib/openai/models/live/input_audio_unmute_event.rb +33 -0
- data/lib/openai/models/live/input_audio_unmuted_event.rb +42 -0
- data/lib/openai/models/live/input_transcript_delta_event.rb +76 -0
- data/lib/openai/models/live/instructions_append_event.rb +57 -0
- data/lib/openai/models/live/instructions_appended_event.rb +65 -0
- data/lib/openai/models/live/live_create_params.rb +57 -0
- data/lib/openai/models/live/live_create_response.rb +77 -0
- data/lib/openai/models/live/media_session_config.rb +227 -0
- data/lib/openai/models/live/media_session_fork_config.rb +75 -0
- data/lib/openai/models/live/output_audio_delta_event.rb +58 -0
- data/lib/openai/models/live/output_transcript_delta_event.rb +76 -0
- data/lib/openai/models/live/response_create_event.rb +33 -0
- data/lib/openai/models/live/response_event.rb +67 -0
- data/lib/openai/models/live/response_item_create_event.rb +44 -0
- data/lib/openai/models/live/responses_delegation_config.rb +332 -0
- data/lib/openai/models/live/responses_delegation_update_config.rb +332 -0
- data/lib/openai/models/live/server_event.rb +295 -0
- data/lib/openai/models/live/server_event_selector.rb +32 -0
- data/lib/openai/models/live/session_accept_params.rb +257 -0
- data/lib/openai/models/live/session_close_event.rb +33 -0
- data/lib/openai/models/live/session_closed_event.rb +113 -0
- data/lib/openai/models/live/session_config.rb +236 -0
- data/lib/openai/models/live/session_download_recording_params.rb +27 -0
- data/lib/openai/models/live/session_fork_params.rb +66 -0
- data/lib/openai/models/live/session_fork_response.rb +77 -0
- data/lib/openai/models/live/session_hangup_params.rb +22 -0
- data/lib/openai/models/live/session_refer_params.rb +34 -0
- data/lib/openai/models/live/session_reject_params.rb +32 -0
- data/lib/openai/models/live/session_resource.rb +268 -0
- data/lib/openai/models/live/session_start_event.rb +46 -0
- data/lib/openai/models/live/session_started_event.rb +51 -0
- data/lib/openai/models/live/session_update_config.rb +69 -0
- data/lib/openai/models/live/session_update_event.rb +46 -0
- data/lib/openai/models/live/session_updated_event.rb +51 -0
- data/lib/openai/models/live/session_usage.rb +24 -0
- data/lib/openai/models/live/session_usage_updated_event.rb +81 -0
- data/lib/openai/models/live/thinking_append_event.rb +59 -0
- data/lib/openai/models/live/thinking_appended_event.rb +65 -0
- data/lib/openai/models/responses/response_input_item.rb +91 -1
- data/lib/openai/models/responses/response_item.rb +93 -1
- data/lib/openai/models/responses/response_output_item.rb +91 -1
- data/lib/openai/models/webhooks/live_call_incoming_webhook_event.rb +12 -7
- data/lib/openai/models/webhooks/live_transport_incoming_webhook_event.rb +137 -0
- data/lib/openai/models/webhooks/realtime_call_incoming_webhook_event.rb +4 -4
- data/lib/openai/models/webhooks/unwrap_webhook_event.rb +9 -2
- data/lib/openai/models.rb +2 -0
- data/lib/openai/resources/live/forks.rb +16 -0
- data/lib/openai/resources/live/sessions.rb +180 -0
- data/lib/openai/resources/live/sideband.rb +16 -0
- data/lib/openai/resources/live.rb +54 -0
- data/lib/openai/resources/webhooks.rb +1 -1
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +65 -0
- data/rbi/openai/client.rbi +3 -0
- data/rbi/openai/models/beta/beta_response_input_item.rbi +109 -0
- data/rbi/openai/models/beta/beta_response_item.rbi +105 -0
- data/rbi/openai/models/beta/beta_response_output_item.rbi +119 -0
- data/rbi/openai/models/conversations/conversation_item.rbi +133 -0
- data/rbi/openai/models/live/audio_format.rbi +185 -0
- data/rbi/openai/models/live/built_in_voice.rbi +46 -0
- data/rbi/openai/models/live/client_config.rbi +54 -0
- data/rbi/openai/models/live/client_delegation.rbi +51 -0
- data/rbi/openai/models/live/client_event.rbi +41 -0
- data/rbi/openai/models/live/commentary_append_event.rbi +88 -0
- data/rbi/openai/models/live/commentary_appended_event.rbi +97 -0
- data/rbi/openai/models/live/custom_voice.rbi +46 -0
- data/rbi/openai/models/live/data_channel_config.rbi +119 -0
- data/rbi/openai/models/live/delegation_created_event.rbi +207 -0
- data/rbi/openai/models/live/error.rbi +95 -0
- data/rbi/openai/models/live/error_event.rbi +87 -0
- data/rbi/openai/models/live/fork_client_event.rbi +40 -0
- data/rbi/openai/models/live/fork_server_event.rbi +436 -0
- data/rbi/openai/models/live/fork_session_config.rbi +234 -0
- data/rbi/openai/models/live/fork_session_start_event.rbi +80 -0
- data/rbi/openai/models/live/function_tool.rbi +95 -0
- data/rbi/openai/models/live/info_event.rbi +92 -0
- data/rbi/openai/models/live/initial_item.rbi +661 -0
- data/rbi/openai/models/live/input_audio_append_event.rbi +79 -0
- data/rbi/openai/models/live/input_audio_mute_event.rbi +62 -0
- data/rbi/openai/models/live/input_audio_muted_event.rbi +74 -0
- data/rbi/openai/models/live/input_audio_unmute_event.rbi +62 -0
- data/rbi/openai/models/live/input_audio_unmuted_event.rbi +74 -0
- data/rbi/openai/models/live/input_transcript_delta_event.rbi +115 -0
- data/rbi/openai/models/live/instructions_append_event.rbi +86 -0
- data/rbi/openai/models/live/instructions_appended_event.rbi +97 -0
- data/rbi/openai/models/live/live_create_params.rbi +121 -0
- data/rbi/openai/models/live/live_create_response.rbi +160 -0
- data/rbi/openai/models/live/media_session_config.rbi +390 -0
- data/rbi/openai/models/live/media_session_fork_config.rbi +143 -0
- data/rbi/openai/models/live/output_audio_delta_event.rbi +93 -0
- data/rbi/openai/models/live/output_transcript_delta_event.rbi +115 -0
- data/rbi/openai/models/live/response_create_event.rbi +62 -0
- data/rbi/openai/models/live/response_event.rbi +105 -0
- data/rbi/openai/models/live/response_item_create_event.rbi +183 -0
- data/rbi/openai/models/live/responses_delegation_config.rbi +562 -0
- data/rbi/openai/models/live/responses_delegation_update_config.rbi +585 -0
- data/rbi/openai/models/live/server_event.rbi +436 -0
- data/rbi/openai/models/live/server_event_selector.rbi +64 -0
- data/rbi/openai/models/live/session_accept_params.rbi +451 -0
- data/rbi/openai/models/live/session_close_event.rbi +62 -0
- data/rbi/openai/models/live/session_closed_event.rbi +148 -0
- data/rbi/openai/models/live/session_config.rbi +427 -0
- data/rbi/openai/models/live/session_download_recording_params.rbi +57 -0
- data/rbi/openai/models/live/session_fork_params.rbi +131 -0
- data/rbi/openai/models/live/session_fork_response.rbi +160 -0
- data/rbi/openai/models/live/session_hangup_params.rbi +53 -0
- data/rbi/openai/models/live/session_refer_params.rbi +64 -0
- data/rbi/openai/models/live/session_reject_params.rbi +62 -0
- data/rbi/openai/models/live/session_resource.rbi +461 -0
- data/rbi/openai/models/live/session_start_event.rbi +78 -0
- data/rbi/openai/models/live/session_started_event.rbi +86 -0
- data/rbi/openai/models/live/session_update_config.rbi +134 -0
- data/rbi/openai/models/live/session_update_event.rbi +78 -0
- data/rbi/openai/models/live/session_updated_event.rbi +86 -0
- data/rbi/openai/models/live/session_usage.rbi +53 -0
- data/rbi/openai/models/live/session_usage_updated_event.rbi +148 -0
- data/rbi/openai/models/live/thinking_append_event.rbi +88 -0
- data/rbi/openai/models/live/thinking_appended_event.rbi +97 -0
- data/rbi/openai/models/responses/response_input_item.rbi +113 -0
- data/rbi/openai/models/responses/response_item.rbi +105 -0
- data/rbi/openai/models/responses/response_output_item.rbi +125 -0
- data/rbi/openai/models/webhooks/live_call_incoming_webhook_event.rbi +11 -7
- data/rbi/openai/models/webhooks/live_transport_incoming_webhook_event.rbi +226 -0
- data/rbi/openai/models/webhooks/realtime_call_incoming_webhook_event.rbi +4 -4
- data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +1 -0
- data/rbi/openai/models.rbi +2 -0
- data/rbi/openai/resources/live/forks.rbi +19 -0
- data/rbi/openai/resources/live/sessions.rbi +110 -0
- data/rbi/openai/resources/live/sideband.rbi +19 -0
- data/rbi/openai/resources/live.rbi +43 -0
- data/rbi/openai/resources/responses.rbi +75 -38
- data/rbi/openai/resources/webhooks.rbi +1 -0
- data/sig/openai/client.rbs +2 -0
- data/sig/openai/models/beta/beta_response_input_item.rbs +56 -0
- data/sig/openai/models/beta/beta_response_item.rbs +56 -0
- data/sig/openai/models/beta/beta_response_output_item.rbs +56 -0
- data/sig/openai/models/conversations/conversation_item.rbs +56 -0
- data/sig/openai/models/live/audio_format.rbs +73 -0
- data/sig/openai/models/live/built_in_voice.rbs +58 -0
- data/sig/openai/models/live/client_config.rbs +15 -0
- data/sig/openai/models/live/client_delegation.rbs +15 -0
- data/sig/openai/models/live/client_event.rbs +24 -0
- data/sig/openai/models/live/commentary_append_event.rbs +37 -0
- data/sig/openai/models/live/commentary_appended_event.rbs +44 -0
- data/sig/openai/models/live/custom_voice.rbs +15 -0
- data/sig/openai/models/live/data_channel_config.rbs +56 -0
- data/sig/openai/models/live/delegation_created_event.rbs +89 -0
- data/sig/openai/models/live/error.rbs +46 -0
- data/sig/openai/models/live/error_event.rbs +39 -0
- data/sig/openai/models/live/fork_client_event.rbs +24 -0
- data/sig/openai/models/live/fork_server_event.rbs +212 -0
- data/sig/openai/models/live/fork_session_config.rbs +89 -0
- data/sig/openai/models/live/fork_session_start_event.rbs +32 -0
- data/sig/openai/models/live/function_tool.rbs +42 -0
- data/sig/openai/models/live/info_event.rbs +44 -0
- data/sig/openai/models/live/initial_item.rbs +332 -0
- data/sig/openai/models/live/input_audio_append_event.rbs +32 -0
- data/sig/openai/models/live/input_audio_mute_event.rbs +24 -0
- data/sig/openai/models/live/input_audio_muted_event.rbs +34 -0
- data/sig/openai/models/live/input_audio_unmute_event.rbs +24 -0
- data/sig/openai/models/live/input_audio_unmuted_event.rbs +34 -0
- data/sig/openai/models/live/input_transcript_delta_event.rbs +49 -0
- data/sig/openai/models/live/instructions_append_event.rbs +37 -0
- data/sig/openai/models/live/instructions_appended_event.rbs +44 -0
- data/sig/openai/models/live/live_create_params.rbs +45 -0
- data/sig/openai/models/live/live_create_response.rbs +49 -0
- data/sig/openai/models/live/media_session_config.rbs +157 -0
- data/sig/openai/models/live/media_session_fork_config.rbs +66 -0
- data/sig/openai/models/live/output_audio_delta_event.rbs +41 -0
- data/sig/openai/models/live/output_transcript_delta_event.rbs +49 -0
- data/sig/openai/models/live/response_create_event.rbs +18 -0
- data/sig/openai/models/live/response_event.rbs +44 -0
- data/sig/openai/models/live/response_item_create_event.rbs +32 -0
- data/sig/openai/models/live/responses_delegation_config.rbs +244 -0
- data/sig/openai/models/live/responses_delegation_update_config.rbs +246 -0
- data/sig/openai/models/live/server_event.rbs +212 -0
- data/sig/openai/models/live/server_event_selector.rbs +19 -0
- data/sig/openai/models/live/session_accept_params.rbs +185 -0
- data/sig/openai/models/live/session_close_event.rbs +17 -0
- data/sig/openai/models/live/session_closed_event.rbs +68 -0
- data/sig/openai/models/live/session_config.rbs +168 -0
- data/sig/openai/models/live/session_download_recording_params.rbs +25 -0
- data/sig/openai/models/live/session_fork_params.rbs +54 -0
- data/sig/openai/models/live/session_fork_response.rbs +49 -0
- data/sig/openai/models/live/session_hangup_params.rbs +25 -0
- data/sig/openai/models/live/session_refer_params.rbs +33 -0
- data/sig/openai/models/live/session_reject_params.rbs +33 -0
- data/sig/openai/models/live/session_resource.rbs +183 -0
- data/sig/openai/models/live/session_start_event.rbs +32 -0
- data/sig/openai/models/live/session_started_event.rbs +39 -0
- data/sig/openai/models/live/session_update_config.rbs +56 -0
- data/sig/openai/models/live/session_update_event.rbs +32 -0
- data/sig/openai/models/live/session_updated_event.rbs +39 -0
- data/sig/openai/models/live/session_usage.rbs +15 -0
- data/sig/openai/models/live/session_usage_updated_event.rbs +58 -0
- data/sig/openai/models/live/thinking_append_event.rbs +37 -0
- data/sig/openai/models/live/thinking_appended_event.rbs +44 -0
- data/sig/openai/models/responses/response_input_item.rbs +56 -0
- data/sig/openai/models/responses/response_item.rbs +56 -0
- data/sig/openai/models/responses/response_output_item.rbs +56 -0
- data/sig/openai/models/webhooks/live_transport_incoming_webhook_event.rbs +95 -0
- data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +1 -0
- data/sig/openai/models.rbs +2 -0
- data/sig/openai/resources/live/forks.rbs +9 -0
- data/sig/openai/resources/live/sessions.rbs +44 -0
- data/sig/openai/resources/live/sideband.rbs +9 -0
- data/sig/openai/resources/live.rbs +19 -0
- data/sig/openai/resources/webhooks.rbs +1 -0
- metadata +196 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 22667eb3ef088a2e9b2e2f6c0e50c55e11f490e51be0ba1b2281259585eb6334
|
|
4
|
+
data.tar.gz: 01dad883b9f759c0bc04b6dea9cb842beb86d8d0f85a1d6761da19695288d5ad
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 49fbf5ecac0836f16994255c07cefcb7c1f5380447a381f37af18e9434cd61780c4a688573f0ebd4c166d7a343dc08577dc7348a94efe6d57b082a453a2ca68c
|
|
7
|
+
data.tar.gz: 9822b12136cf3322ade3babbbec1b2556d9bc3fa884aaa65277533c46eab7cc6d8abcd9bc82ca9e7264238576ccd34181cf8b4b0f0aa143c7d959b7ca7b06675
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.89.0](https://github.com/openai/openai-ruby/compare/v0.88.0...v0.89.0) (2026-09-10)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **api:** Add Live API ([3fde020](https://github.com/openai/openai-ruby/commit/3fde0201bc4f75af36a87acb3d71c8136c0df9c0))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Chores
|
|
12
|
+
|
|
13
|
+
* **deps:** bump the codeql group with 2 updates ([#692](https://github.com/openai/openai-ruby/issues/692)) ([7f19b93](https://github.com/openai/openai-ruby/commit/7f19b932549bd7d4376e6ca91c7c75f9b856ae83))
|
|
14
|
+
|
|
3
15
|
## [0.88.0](https://github.com/openai/openai-ruby/compare/v0.87.0...v0.88.0) (2026-09-09)
|
|
4
16
|
|
|
5
17
|
|
data/README.md
CHANGED
data/lib/openai/client.rb
CHANGED
|
@@ -109,6 +109,9 @@ module OpenAI
|
|
|
109
109
|
# @return [OpenAI::Resources::Responses]
|
|
110
110
|
attr_reader :responses
|
|
111
111
|
|
|
112
|
+
# @return [OpenAI::Resources::Live]
|
|
113
|
+
attr_reader :live
|
|
114
|
+
|
|
112
115
|
# @return [OpenAI::Resources::Realtime]
|
|
113
116
|
attr_reader :realtime
|
|
114
117
|
|
|
@@ -818,6 +821,7 @@ module OpenAI
|
|
|
818
821
|
@uploads = OpenAI::Resources::Uploads.new(client: self)
|
|
819
822
|
@admin = OpenAI::Resources::Admin.new(client: self)
|
|
820
823
|
@responses = OpenAI::Resources::Responses.new(client: self)
|
|
824
|
+
@live = OpenAI::Resources::Live.new(client: self)
|
|
821
825
|
@realtime = OpenAI::Resources::Realtime.new(client: self)
|
|
822
826
|
@conversations = OpenAI::Resources::Conversations.new(client: self)
|
|
823
827
|
@evals = OpenAI::Resources::Evals.new(client: self)
|
|
@@ -1296,12 +1296,42 @@ module OpenAI
|
|
|
1296
1296
|
# @return [Symbol, :image_generation_call]
|
|
1297
1297
|
required :type, const: :image_generation_call
|
|
1298
1298
|
|
|
1299
|
+
# @!attribute action
|
|
1300
|
+
# The action used for image generation.
|
|
1301
|
+
#
|
|
1302
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Action, nil]
|
|
1303
|
+
optional(
|
|
1304
|
+
:action,
|
|
1305
|
+
enum: -> { OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Action },
|
|
1306
|
+
nil?: true
|
|
1307
|
+
)
|
|
1308
|
+
|
|
1299
1309
|
# @!attribute agent
|
|
1300
1310
|
# The agent that produced this item.
|
|
1301
1311
|
#
|
|
1302
1312
|
# @return [OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Agent, nil]
|
|
1303
1313
|
optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Agent }, nil?: true
|
|
1304
1314
|
|
|
1315
|
+
# @!attribute background
|
|
1316
|
+
# The background setting used for generation.
|
|
1317
|
+
#
|
|
1318
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Background, nil]
|
|
1319
|
+
optional(
|
|
1320
|
+
:background,
|
|
1321
|
+
enum: -> { OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Background },
|
|
1322
|
+
nil?: true
|
|
1323
|
+
)
|
|
1324
|
+
|
|
1325
|
+
# @!attribute output_format
|
|
1326
|
+
# The output format used for generation.
|
|
1327
|
+
#
|
|
1328
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::OutputFormat, nil]
|
|
1329
|
+
optional(
|
|
1330
|
+
:output_format,
|
|
1331
|
+
enum: -> { OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::OutputFormat },
|
|
1332
|
+
nil?: true
|
|
1333
|
+
)
|
|
1334
|
+
|
|
1305
1335
|
# @!attribute quality
|
|
1306
1336
|
# The quality of the image generated by the image generation tool call. One of
|
|
1307
1337
|
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
@@ -1313,6 +1343,12 @@ module OpenAI
|
|
|
1313
1343
|
nil?: true
|
|
1314
1344
|
)
|
|
1315
1345
|
|
|
1346
|
+
# @!attribute revised_prompt
|
|
1347
|
+
# The prompt that was used after any model prompt rewriting.
|
|
1348
|
+
#
|
|
1349
|
+
# @return [String, nil]
|
|
1350
|
+
optional :revised_prompt, String, nil?: true
|
|
1351
|
+
|
|
1316
1352
|
# @!attribute size
|
|
1317
1353
|
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
1318
1354
|
#
|
|
@@ -1325,7 +1361,7 @@ module OpenAI
|
|
|
1325
1361
|
nil?: true
|
|
1326
1362
|
)
|
|
1327
1363
|
|
|
1328
|
-
# @!method initialize(id:, result:, status:, agent: nil, quality: nil, size: nil, type: :image_generation_call)
|
|
1364
|
+
# @!method initialize(id:, result:, status:, action: nil, agent: nil, background: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
|
|
1329
1365
|
# An image generation request made by the model.
|
|
1330
1366
|
#
|
|
1331
1367
|
# @param id [String]
|
|
@@ -1337,13 +1373,25 @@ module OpenAI
|
|
|
1337
1373
|
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Status]
|
|
1338
1374
|
# The status of the image generation call.
|
|
1339
1375
|
#
|
|
1376
|
+
# @param action [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Action, nil]
|
|
1377
|
+
# The action used for image generation.
|
|
1378
|
+
#
|
|
1340
1379
|
# @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Agent, nil]
|
|
1341
1380
|
# The agent that produced this item.
|
|
1342
1381
|
#
|
|
1382
|
+
# @param background [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Background, nil]
|
|
1383
|
+
# The background setting used for generation.
|
|
1384
|
+
#
|
|
1385
|
+
# @param output_format [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::OutputFormat, nil]
|
|
1386
|
+
# The output format used for generation.
|
|
1387
|
+
#
|
|
1343
1388
|
# @param quality [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Quality, nil]
|
|
1344
1389
|
# The quality of the image generated by the image generation tool call. One of
|
|
1345
1390
|
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
1346
1391
|
#
|
|
1392
|
+
# @param revised_prompt [String, nil]
|
|
1393
|
+
# The prompt that was used after any model prompt rewriting.
|
|
1394
|
+
#
|
|
1347
1395
|
# @param size [String, Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Size, nil]
|
|
1348
1396
|
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
1349
1397
|
#
|
|
@@ -1365,6 +1413,20 @@ module OpenAI
|
|
|
1365
1413
|
# @return [Array<Symbol>]
|
|
1366
1414
|
end
|
|
1367
1415
|
|
|
1416
|
+
# The action used for image generation.
|
|
1417
|
+
#
|
|
1418
|
+
# @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall#action
|
|
1419
|
+
module Action
|
|
1420
|
+
extend OpenAI::Internal::Type::Enum
|
|
1421
|
+
|
|
1422
|
+
GENERATE = :generate
|
|
1423
|
+
EDIT = :edit
|
|
1424
|
+
AUTO = :auto
|
|
1425
|
+
|
|
1426
|
+
# @!method self.values
|
|
1427
|
+
# @return [Array<Symbol>]
|
|
1428
|
+
end
|
|
1429
|
+
|
|
1368
1430
|
# @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall#agent
|
|
1369
1431
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
1370
1432
|
# @!attribute agent_name
|
|
@@ -1380,6 +1442,34 @@ module OpenAI
|
|
|
1380
1442
|
# The canonical name of the agent that produced this item.
|
|
1381
1443
|
end
|
|
1382
1444
|
|
|
1445
|
+
# The background setting used for generation.
|
|
1446
|
+
#
|
|
1447
|
+
# @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall#background
|
|
1448
|
+
module Background
|
|
1449
|
+
extend OpenAI::Internal::Type::Enum
|
|
1450
|
+
|
|
1451
|
+
TRANSPARENT = :transparent
|
|
1452
|
+
OPAQUE = :opaque
|
|
1453
|
+
AUTO = :auto
|
|
1454
|
+
|
|
1455
|
+
# @!method self.values
|
|
1456
|
+
# @return [Array<Symbol>]
|
|
1457
|
+
end
|
|
1458
|
+
|
|
1459
|
+
# The output format used for generation.
|
|
1460
|
+
#
|
|
1461
|
+
# @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall#output_format
|
|
1462
|
+
module OutputFormat
|
|
1463
|
+
extend OpenAI::Internal::Type::Enum
|
|
1464
|
+
|
|
1465
|
+
PNG = :png
|
|
1466
|
+
WEBP = :webp
|
|
1467
|
+
JPEG = :jpeg
|
|
1468
|
+
|
|
1469
|
+
# @!method self.values
|
|
1470
|
+
# @return [Array<Symbol>]
|
|
1471
|
+
end
|
|
1472
|
+
|
|
1383
1473
|
# The quality of the image generated by the image generation tool call. One of
|
|
1384
1474
|
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
1385
1475
|
#
|
|
@@ -850,12 +850,44 @@ module OpenAI
|
|
|
850
850
|
# @return [Symbol, :image_generation_call]
|
|
851
851
|
required :type, const: :image_generation_call
|
|
852
852
|
|
|
853
|
+
# @!attribute action
|
|
854
|
+
# The action used for image generation.
|
|
855
|
+
#
|
|
856
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Action, nil]
|
|
857
|
+
optional(
|
|
858
|
+
:action,
|
|
859
|
+
enum: -> {
|
|
860
|
+
OpenAI::Beta::BetaResponseItem::ImageGenerationCall::Action
|
|
861
|
+
},
|
|
862
|
+
nil?: true
|
|
863
|
+
)
|
|
864
|
+
|
|
853
865
|
# @!attribute agent
|
|
854
866
|
# The agent that produced this item.
|
|
855
867
|
#
|
|
856
868
|
# @return [OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Agent, nil]
|
|
857
869
|
optional :agent, -> { OpenAI::Beta::BetaResponseItem::ImageGenerationCall::Agent }, nil?: true
|
|
858
870
|
|
|
871
|
+
# @!attribute background
|
|
872
|
+
# The background setting used for generation.
|
|
873
|
+
#
|
|
874
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Background, nil]
|
|
875
|
+
optional(
|
|
876
|
+
:background,
|
|
877
|
+
enum: -> { OpenAI::Beta::BetaResponseItem::ImageGenerationCall::Background },
|
|
878
|
+
nil?: true
|
|
879
|
+
)
|
|
880
|
+
|
|
881
|
+
# @!attribute output_format
|
|
882
|
+
# The output format used for generation.
|
|
883
|
+
#
|
|
884
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::OutputFormat, nil]
|
|
885
|
+
optional(
|
|
886
|
+
:output_format,
|
|
887
|
+
enum: -> { OpenAI::Beta::BetaResponseItem::ImageGenerationCall::OutputFormat },
|
|
888
|
+
nil?: true
|
|
889
|
+
)
|
|
890
|
+
|
|
859
891
|
# @!attribute quality
|
|
860
892
|
# The quality of the image generated by the image generation tool call. One of
|
|
861
893
|
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
@@ -869,13 +901,19 @@ module OpenAI
|
|
|
869
901
|
nil?: true
|
|
870
902
|
)
|
|
871
903
|
|
|
904
|
+
# @!attribute revised_prompt
|
|
905
|
+
# The prompt that was used after any model prompt rewriting.
|
|
906
|
+
#
|
|
907
|
+
# @return [String, nil]
|
|
908
|
+
optional :revised_prompt, String, nil?: true
|
|
909
|
+
|
|
872
910
|
# @!attribute size
|
|
873
911
|
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
874
912
|
#
|
|
875
913
|
# @return [String, Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Size, nil]
|
|
876
914
|
optional :size, union: -> { OpenAI::Beta::BetaResponseItem::ImageGenerationCall::Size }, nil?: true
|
|
877
915
|
|
|
878
|
-
# @!method initialize(id:, result:, status:, agent: nil, quality: nil, size: nil, type: :image_generation_call)
|
|
916
|
+
# @!method initialize(id:, result:, status:, action: nil, agent: nil, background: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
|
|
879
917
|
# An image generation request made by the model.
|
|
880
918
|
#
|
|
881
919
|
# @param id [String]
|
|
@@ -887,13 +925,25 @@ module OpenAI
|
|
|
887
925
|
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Status]
|
|
888
926
|
# The status of the image generation call.
|
|
889
927
|
#
|
|
928
|
+
# @param action [Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Action, nil]
|
|
929
|
+
# The action used for image generation.
|
|
930
|
+
#
|
|
890
931
|
# @param agent [OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Agent, nil]
|
|
891
932
|
# The agent that produced this item.
|
|
892
933
|
#
|
|
934
|
+
# @param background [Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Background, nil]
|
|
935
|
+
# The background setting used for generation.
|
|
936
|
+
#
|
|
937
|
+
# @param output_format [Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::OutputFormat, nil]
|
|
938
|
+
# The output format used for generation.
|
|
939
|
+
#
|
|
893
940
|
# @param quality [Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Quality, nil]
|
|
894
941
|
# The quality of the image generated by the image generation tool call. One of
|
|
895
942
|
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
896
943
|
#
|
|
944
|
+
# @param revised_prompt [String, nil]
|
|
945
|
+
# The prompt that was used after any model prompt rewriting.
|
|
946
|
+
#
|
|
897
947
|
# @param size [String, Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Size, nil]
|
|
898
948
|
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
899
949
|
#
|
|
@@ -915,6 +965,20 @@ module OpenAI
|
|
|
915
965
|
# @return [Array<Symbol>]
|
|
916
966
|
end
|
|
917
967
|
|
|
968
|
+
# The action used for image generation.
|
|
969
|
+
#
|
|
970
|
+
# @see OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall#action
|
|
971
|
+
module Action
|
|
972
|
+
extend OpenAI::Internal::Type::Enum
|
|
973
|
+
|
|
974
|
+
GENERATE = :generate
|
|
975
|
+
EDIT = :edit
|
|
976
|
+
AUTO = :auto
|
|
977
|
+
|
|
978
|
+
# @!method self.values
|
|
979
|
+
# @return [Array<Symbol>]
|
|
980
|
+
end
|
|
981
|
+
|
|
918
982
|
# @see OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall#agent
|
|
919
983
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
920
984
|
# @!attribute agent_name
|
|
@@ -930,6 +994,34 @@ module OpenAI
|
|
|
930
994
|
# The canonical name of the agent that produced this item.
|
|
931
995
|
end
|
|
932
996
|
|
|
997
|
+
# The background setting used for generation.
|
|
998
|
+
#
|
|
999
|
+
# @see OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall#background
|
|
1000
|
+
module Background
|
|
1001
|
+
extend OpenAI::Internal::Type::Enum
|
|
1002
|
+
|
|
1003
|
+
TRANSPARENT = :transparent
|
|
1004
|
+
OPAQUE = :opaque
|
|
1005
|
+
AUTO = :auto
|
|
1006
|
+
|
|
1007
|
+
# @!method self.values
|
|
1008
|
+
# @return [Array<Symbol>]
|
|
1009
|
+
end
|
|
1010
|
+
|
|
1011
|
+
# The output format used for generation.
|
|
1012
|
+
#
|
|
1013
|
+
# @see OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall#output_format
|
|
1014
|
+
module OutputFormat
|
|
1015
|
+
extend OpenAI::Internal::Type::Enum
|
|
1016
|
+
|
|
1017
|
+
PNG = :png
|
|
1018
|
+
WEBP = :webp
|
|
1019
|
+
JPEG = :jpeg
|
|
1020
|
+
|
|
1021
|
+
# @!method self.values
|
|
1022
|
+
# @return [Array<Symbol>]
|
|
1023
|
+
end
|
|
1024
|
+
|
|
933
1025
|
# The quality of the image generated by the image generation tool call. One of
|
|
934
1026
|
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
935
1027
|
#
|
|
@@ -849,12 +849,42 @@ module OpenAI
|
|
|
849
849
|
# @return [Symbol, :image_generation_call]
|
|
850
850
|
required :type, const: :image_generation_call
|
|
851
851
|
|
|
852
|
+
# @!attribute action
|
|
853
|
+
# The action used for image generation.
|
|
854
|
+
#
|
|
855
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Action, nil]
|
|
856
|
+
optional(
|
|
857
|
+
:action,
|
|
858
|
+
enum: -> { OpenAI::Beta::BetaResponseOutputItem::ImageGenerationCall::Action },
|
|
859
|
+
nil?: true
|
|
860
|
+
)
|
|
861
|
+
|
|
852
862
|
# @!attribute agent
|
|
853
863
|
# The agent that produced this item.
|
|
854
864
|
#
|
|
855
865
|
# @return [OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Agent, nil]
|
|
856
866
|
optional :agent, -> { OpenAI::Beta::BetaResponseOutputItem::ImageGenerationCall::Agent }, nil?: true
|
|
857
867
|
|
|
868
|
+
# @!attribute background
|
|
869
|
+
# The background setting used for generation.
|
|
870
|
+
#
|
|
871
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Background, nil]
|
|
872
|
+
optional(
|
|
873
|
+
:background,
|
|
874
|
+
enum: -> { OpenAI::Beta::BetaResponseOutputItem::ImageGenerationCall::Background },
|
|
875
|
+
nil?: true
|
|
876
|
+
)
|
|
877
|
+
|
|
878
|
+
# @!attribute output_format
|
|
879
|
+
# The output format used for generation.
|
|
880
|
+
#
|
|
881
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::OutputFormat, nil]
|
|
882
|
+
optional(
|
|
883
|
+
:output_format,
|
|
884
|
+
enum: -> { OpenAI::Beta::BetaResponseOutputItem::ImageGenerationCall::OutputFormat },
|
|
885
|
+
nil?: true
|
|
886
|
+
)
|
|
887
|
+
|
|
858
888
|
# @!attribute quality
|
|
859
889
|
# The quality of the image generated by the image generation tool call. One of
|
|
860
890
|
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
@@ -866,6 +896,12 @@ module OpenAI
|
|
|
866
896
|
nil?: true
|
|
867
897
|
)
|
|
868
898
|
|
|
899
|
+
# @!attribute revised_prompt
|
|
900
|
+
# The prompt that was used after any model prompt rewriting.
|
|
901
|
+
#
|
|
902
|
+
# @return [String, nil]
|
|
903
|
+
optional :revised_prompt, String, nil?: true
|
|
904
|
+
|
|
869
905
|
# @!attribute size
|
|
870
906
|
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
871
907
|
#
|
|
@@ -878,7 +914,7 @@ module OpenAI
|
|
|
878
914
|
nil?: true
|
|
879
915
|
)
|
|
880
916
|
|
|
881
|
-
# @!method initialize(id:, result:, status:, agent: nil, quality: nil, size: nil, type: :image_generation_call)
|
|
917
|
+
# @!method initialize(id:, result:, status:, action: nil, agent: nil, background: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
|
|
882
918
|
# An image generation request made by the model.
|
|
883
919
|
#
|
|
884
920
|
# @param id [String]
|
|
@@ -890,13 +926,25 @@ module OpenAI
|
|
|
890
926
|
# @param status [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Status]
|
|
891
927
|
# The status of the image generation call.
|
|
892
928
|
#
|
|
929
|
+
# @param action [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Action, nil]
|
|
930
|
+
# The action used for image generation.
|
|
931
|
+
#
|
|
893
932
|
# @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Agent, nil]
|
|
894
933
|
# The agent that produced this item.
|
|
895
934
|
#
|
|
935
|
+
# @param background [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Background, nil]
|
|
936
|
+
# The background setting used for generation.
|
|
937
|
+
#
|
|
938
|
+
# @param output_format [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::OutputFormat, nil]
|
|
939
|
+
# The output format used for generation.
|
|
940
|
+
#
|
|
896
941
|
# @param quality [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Quality, nil]
|
|
897
942
|
# The quality of the image generated by the image generation tool call. One of
|
|
898
943
|
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
899
944
|
#
|
|
945
|
+
# @param revised_prompt [String, nil]
|
|
946
|
+
# The prompt that was used after any model prompt rewriting.
|
|
947
|
+
#
|
|
900
948
|
# @param size [String, Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Size, nil]
|
|
901
949
|
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
902
950
|
#
|
|
@@ -918,6 +966,20 @@ module OpenAI
|
|
|
918
966
|
# @return [Array<Symbol>]
|
|
919
967
|
end
|
|
920
968
|
|
|
969
|
+
# The action used for image generation.
|
|
970
|
+
#
|
|
971
|
+
# @see OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall#action
|
|
972
|
+
module Action
|
|
973
|
+
extend OpenAI::Internal::Type::Enum
|
|
974
|
+
|
|
975
|
+
GENERATE = :generate
|
|
976
|
+
EDIT = :edit
|
|
977
|
+
AUTO = :auto
|
|
978
|
+
|
|
979
|
+
# @!method self.values
|
|
980
|
+
# @return [Array<Symbol>]
|
|
981
|
+
end
|
|
982
|
+
|
|
921
983
|
# @see OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall#agent
|
|
922
984
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
923
985
|
# @!attribute agent_name
|
|
@@ -933,6 +995,34 @@ module OpenAI
|
|
|
933
995
|
# The canonical name of the agent that produced this item.
|
|
934
996
|
end
|
|
935
997
|
|
|
998
|
+
# The background setting used for generation.
|
|
999
|
+
#
|
|
1000
|
+
# @see OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall#background
|
|
1001
|
+
module Background
|
|
1002
|
+
extend OpenAI::Internal::Type::Enum
|
|
1003
|
+
|
|
1004
|
+
TRANSPARENT = :transparent
|
|
1005
|
+
OPAQUE = :opaque
|
|
1006
|
+
AUTO = :auto
|
|
1007
|
+
|
|
1008
|
+
# @!method self.values
|
|
1009
|
+
# @return [Array<Symbol>]
|
|
1010
|
+
end
|
|
1011
|
+
|
|
1012
|
+
# The output format used for generation.
|
|
1013
|
+
#
|
|
1014
|
+
# @see OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall#output_format
|
|
1015
|
+
module OutputFormat
|
|
1016
|
+
extend OpenAI::Internal::Type::Enum
|
|
1017
|
+
|
|
1018
|
+
PNG = :png
|
|
1019
|
+
WEBP = :webp
|
|
1020
|
+
JPEG = :jpeg
|
|
1021
|
+
|
|
1022
|
+
# @!method self.values
|
|
1023
|
+
# @return [Array<Symbol>]
|
|
1024
|
+
end
|
|
1025
|
+
|
|
936
1026
|
# The quality of the image generated by the image generation tool call. One of
|
|
937
1027
|
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
938
1028
|
#
|
|
@@ -126,6 +126,36 @@ module OpenAI
|
|
|
126
126
|
# @return [Symbol, :image_generation_call]
|
|
127
127
|
required :type, const: :image_generation_call
|
|
128
128
|
|
|
129
|
+
# @!attribute action
|
|
130
|
+
# The action used for image generation.
|
|
131
|
+
#
|
|
132
|
+
# @return [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Action, nil]
|
|
133
|
+
optional(
|
|
134
|
+
:action,
|
|
135
|
+
enum: -> { OpenAI::Conversations::ConversationItem::ImageGenerationCall::Action },
|
|
136
|
+
nil?: true
|
|
137
|
+
)
|
|
138
|
+
|
|
139
|
+
# @!attribute background
|
|
140
|
+
# The background setting used for generation.
|
|
141
|
+
#
|
|
142
|
+
# @return [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Background, nil]
|
|
143
|
+
optional(
|
|
144
|
+
:background,
|
|
145
|
+
enum: -> { OpenAI::Conversations::ConversationItem::ImageGenerationCall::Background },
|
|
146
|
+
nil?: true
|
|
147
|
+
)
|
|
148
|
+
|
|
149
|
+
# @!attribute output_format
|
|
150
|
+
# The output format used for generation.
|
|
151
|
+
#
|
|
152
|
+
# @return [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::OutputFormat, nil]
|
|
153
|
+
optional(
|
|
154
|
+
:output_format,
|
|
155
|
+
enum: -> { OpenAI::Conversations::ConversationItem::ImageGenerationCall::OutputFormat },
|
|
156
|
+
nil?: true
|
|
157
|
+
)
|
|
158
|
+
|
|
129
159
|
# @!attribute quality
|
|
130
160
|
# The quality of the image generated by the image generation tool call. One of
|
|
131
161
|
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
@@ -137,6 +167,12 @@ module OpenAI
|
|
|
137
167
|
nil?: true
|
|
138
168
|
)
|
|
139
169
|
|
|
170
|
+
# @!attribute revised_prompt
|
|
171
|
+
# The prompt that was used after any model prompt rewriting.
|
|
172
|
+
#
|
|
173
|
+
# @return [String, nil]
|
|
174
|
+
optional :revised_prompt, String, nil?: true
|
|
175
|
+
|
|
140
176
|
# @!attribute size
|
|
141
177
|
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
142
178
|
#
|
|
@@ -147,7 +183,7 @@ module OpenAI
|
|
|
147
183
|
nil?: true
|
|
148
184
|
)
|
|
149
185
|
|
|
150
|
-
# @!method initialize(id:, result:, status:, quality: nil, size: nil, type: :image_generation_call)
|
|
186
|
+
# @!method initialize(id:, result:, status:, action: nil, background: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
|
|
151
187
|
# An image generation request made by the model.
|
|
152
188
|
#
|
|
153
189
|
# @param id [String]
|
|
@@ -159,10 +195,22 @@ module OpenAI
|
|
|
159
195
|
# @param status [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Status]
|
|
160
196
|
# The status of the image generation call.
|
|
161
197
|
#
|
|
198
|
+
# @param action [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Action, nil]
|
|
199
|
+
# The action used for image generation.
|
|
200
|
+
#
|
|
201
|
+
# @param background [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Background, nil]
|
|
202
|
+
# The background setting used for generation.
|
|
203
|
+
#
|
|
204
|
+
# @param output_format [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::OutputFormat, nil]
|
|
205
|
+
# The output format used for generation.
|
|
206
|
+
#
|
|
162
207
|
# @param quality [Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Quality, nil]
|
|
163
208
|
# The quality of the image generated by the image generation tool call. One of
|
|
164
209
|
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
165
210
|
#
|
|
211
|
+
# @param revised_prompt [String, nil]
|
|
212
|
+
# The prompt that was used after any model prompt rewriting.
|
|
213
|
+
#
|
|
166
214
|
# @param size [String, Symbol, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall::Size, nil]
|
|
167
215
|
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
168
216
|
#
|
|
@@ -184,6 +232,48 @@ module OpenAI
|
|
|
184
232
|
# @return [Array<Symbol>]
|
|
185
233
|
end
|
|
186
234
|
|
|
235
|
+
# The action used for image generation.
|
|
236
|
+
#
|
|
237
|
+
# @see OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall#action
|
|
238
|
+
module Action
|
|
239
|
+
extend OpenAI::Internal::Type::Enum
|
|
240
|
+
|
|
241
|
+
GENERATE = :generate
|
|
242
|
+
EDIT = :edit
|
|
243
|
+
AUTO = :auto
|
|
244
|
+
|
|
245
|
+
# @!method self.values
|
|
246
|
+
# @return [Array<Symbol>]
|
|
247
|
+
end
|
|
248
|
+
|
|
249
|
+
# The background setting used for generation.
|
|
250
|
+
#
|
|
251
|
+
# @see OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall#background
|
|
252
|
+
module Background
|
|
253
|
+
extend OpenAI::Internal::Type::Enum
|
|
254
|
+
|
|
255
|
+
TRANSPARENT = :transparent
|
|
256
|
+
OPAQUE = :opaque
|
|
257
|
+
AUTO = :auto
|
|
258
|
+
|
|
259
|
+
# @!method self.values
|
|
260
|
+
# @return [Array<Symbol>]
|
|
261
|
+
end
|
|
262
|
+
|
|
263
|
+
# The output format used for generation.
|
|
264
|
+
#
|
|
265
|
+
# @see OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall#output_format
|
|
266
|
+
module OutputFormat
|
|
267
|
+
extend OpenAI::Internal::Type::Enum
|
|
268
|
+
|
|
269
|
+
PNG = :png
|
|
270
|
+
WEBP = :webp
|
|
271
|
+
JPEG = :jpeg
|
|
272
|
+
|
|
273
|
+
# @!method self.values
|
|
274
|
+
# @return [Array<Symbol>]
|
|
275
|
+
end
|
|
276
|
+
|
|
187
277
|
# The quality of the image generated by the image generation tool call. One of
|
|
188
278
|
# `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
|
|
189
279
|
#
|