openai 0.123.0 → 0.125.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 +15 -0
- data/README.md +1 -1
- data/lib/openai/internal/stream.rb +1 -1
- data/lib/openai/internal/transport/base_client.rb +11 -2
- data/lib/openai/internal/type/base_stream.rb +10 -0
- data/lib/openai/models/admin/organization/audit_log_list_response.rb +10 -1
- data/lib/openai/models/admin/organization/external_key.rb +25 -1
- data/lib/openai/models/admin/organization/external_key_create_params.rb +78 -3
- data/lib/openai/models/beta/agent.rb +2 -2
- data/lib/openai/models/beta/agent_create_params.rb +9 -9
- data/lib/openai/models/beta/agent_output_command_execution_output_delta_event.rb +10 -1
- data/lib/openai/models/beta/agent_session.rb +130 -6
- data/lib/openai/models/beta/agent_session_created_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_environment_connected_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_environment_disconnected_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_environment_expired_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_environment_failed_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_environment_pending_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_environment_ready_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_environment_reset_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_environment_suspended_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_error_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_failed_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_idle_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_in_progress_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_input_param.rb +87 -1
- data/lib/openai/models/beta/agent_session_requires_action_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_subagent_active_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_subagent_closed_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_subagent_created_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_turn_cancelled_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_turn_completed_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_turn_content_part_added_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_turn_content_part_done_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_turn_created_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_turn_failed_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_turn_in_progress_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_turn_item_added_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_turn_item_done_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_turn_output_text_delta_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_turn_output_text_done_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_turn_reasoning_summary_part_added_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_turn_reasoning_summary_part_done_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_turn_reasoning_summary_text_delta_event.rb +10 -1
- data/lib/openai/models/beta/agent_session_turn_reasoning_summary_text_done_event.rb +10 -1
- data/lib/openai/models/beta/agent_update_params.rb +9 -12
- data/lib/openai/models/beta/agents/automation_agent_config.rb +2 -2
- data/lib/openai/models/beta/agents/automation_target_param.rb +9 -12
- data/lib/openai/models/beta/agents/one_time_automation.rb +28 -1
- data/lib/openai/models/beta/agents/periodic_automation.rb +28 -1
- data/lib/openai/models/beta/agents/session_create_params.rb +78 -13
- data/lib/openai/models/beta/agents/session_update_params.rb +44 -1
- data/lib/openai/models/beta/agents/sessions/event_create_params.rb +2 -2
- data/lib/openai/models/beta/agents/sessions/event_stream_params.rb +13 -1
- data/lib/openai/models/beta/agents/sessions/turn.rb +41 -1
- data/lib/openai/models/beta/beta_response.rb +9 -3
- data/lib/openai/models/beta/beta_response_tool_search_output_item_param.rb +6 -3
- data/lib/openai/models/beta/beta_responses_client_event.rb +9 -3
- data/lib/openai/models/beta/beta_tool.rb +6 -3
- data/lib/openai/models/beta/response_compact_params.rb +2 -0
- data/lib/openai/models/beta/response_create_params.rb +9 -3
- data/lib/openai/models/beta/responses/input_token_count_params.rb +27 -15
- data/lib/openai/models/content_provenance_check_create_params.rb +2 -0
- data/lib/openai/models/image_edit_params.rb +84 -5
- data/lib/openai/models/image_generate_params.rb +4 -4
- data/lib/openai/models/images_response.rb +9 -12
- data/lib/openai/models/live/media_session_config.rb +12 -1
- data/lib/openai/models/live/session_accept_params.rb +12 -1
- data/lib/openai/models/live/session_config.rb +12 -1
- data/lib/openai/models/live/session_resource.rb +12 -1
- data/lib/openai/models/responses/input_token_count_params.rb +27 -15
- data/lib/openai/models/responses/response.rb +9 -3
- data/lib/openai/models/responses/response_compact_params.rb +2 -0
- data/lib/openai/models/responses/response_create_params.rb +9 -3
- data/lib/openai/models/responses/response_tool_search_output_item_param.rb +6 -3
- data/lib/openai/models/responses/responses_client_event.rb +9 -3
- data/lib/openai/models/responses/tool.rb +6 -3
- data/lib/openai/models/video_create_error.rb +6 -4
- data/lib/openai/models/webhooks/agent_session_action_required_webhook_event.rb +1 -0
- data/lib/openai/models/webhooks/live_transport_connected_webhook_event.rb +74 -0
- data/lib/openai/models/webhooks/unwrap_webhook_event.rb +4 -1
- data/lib/openai/resources/admin/organization/external_keys.rb +1 -1
- data/lib/openai/resources/beta/agents/sessions/events.rb +11 -3
- data/lib/openai/resources/beta/agents/sessions.rb +25 -5
- data/lib/openai/resources/beta/agents.rb +2 -3
- data/lib/openai/resources/beta/responses/input_tokens.rb +9 -6
- data/lib/openai/resources/beta/responses.rb +6 -2
- data/lib/openai/resources/content_provenance_checks.rb +1 -0
- data/lib/openai/resources/images.rb +20 -6
- data/lib/openai/resources/responses/input_tokens.rb +9 -5
- data/lib/openai/resources/responses.rb +6 -2
- data/lib/openai/resources/webhooks.rb +1 -1
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +1 -0
- data/rbi/openai/internal/transport/base_client.rbi +4 -1
- data/rbi/openai/internal/type/base_stream.rbi +5 -0
- data/rbi/openai/models/admin/organization/audit_log_list_response.rbi +13 -1
- data/rbi/openai/models/admin/organization/external_key.rbi +44 -0
- data/rbi/openai/models/admin/organization/external_key_create_params.rbi +137 -4
- data/rbi/openai/models/beta/agent.rbi +2 -2
- data/rbi/openai/models/beta/agent_create_params.rbi +9 -9
- data/rbi/openai/models/beta/agent_output_command_execution_output_delta_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session.rbi +209 -2
- data/rbi/openai/models/beta/agent_session_created_event.rbi +13 -1
- data/rbi/openai/models/beta/agent_session_environment_connected_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_environment_disconnected_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_environment_expired_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_environment_failed_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_environment_pending_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_environment_ready_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_environment_reset_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_environment_suspended_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_error_event.rbi +13 -1
- data/rbi/openai/models/beta/agent_session_failed_event.rbi +13 -1
- data/rbi/openai/models/beta/agent_session_idle_event.rbi +13 -1
- data/rbi/openai/models/beta/agent_session_in_progress_event.rbi +13 -1
- data/rbi/openai/models/beta/agent_session_input_param.rbi +159 -0
- data/rbi/openai/models/beta/agent_session_requires_action_event.rbi +13 -1
- data/rbi/openai/models/beta/agent_session_subagent_active_event.rbi +13 -1
- data/rbi/openai/models/beta/agent_session_subagent_closed_event.rbi +13 -1
- data/rbi/openai/models/beta/agent_session_subagent_created_event.rbi +13 -1
- data/rbi/openai/models/beta/agent_session_turn_cancelled_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_turn_completed_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_turn_content_part_added_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_turn_content_part_done_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_turn_created_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_turn_failed_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_turn_in_progress_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_turn_item_added_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_turn_item_done_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_turn_output_text_delta_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_turn_output_text_done_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_part_added_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_part_done_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_text_delta_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_text_done_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_update_params.rbi +9 -12
- data/rbi/openai/models/beta/agents/automation_agent_config.rbi +2 -2
- data/rbi/openai/models/beta/agents/automation_target_param.rbi +9 -12
- data/rbi/openai/models/beta/agents/one_time_automation.rbi +28 -1
- data/rbi/openai/models/beta/agents/periodic_automation.rbi +28 -1
- data/rbi/openai/models/beta/agents/session_create_params.rbi +147 -12
- data/rbi/openai/models/beta/agents/session_update_params.rbi +82 -0
- data/rbi/openai/models/beta/agents/sessions/event_create_params.rbi +3 -0
- data/rbi/openai/models/beta/agents/sessions/event_stream_params.rbi +15 -1
- data/rbi/openai/models/beta/agents/sessions/turn.rbi +74 -1
- data/rbi/openai/models/beta/beta_response.rbi +9 -3
- data/rbi/openai/models/beta/beta_response_tool_search_output_item_param.rbi +6 -3
- data/rbi/openai/models/beta/beta_responses_client_event.rbi +9 -3
- data/rbi/openai/models/beta/beta_tool.rbi +6 -3
- data/rbi/openai/models/beta/response_create_params.rbi +9 -3
- data/rbi/openai/models/beta/responses/input_token_count_params.rbi +27 -15
- data/rbi/openai/models/content_provenance_check_create_params.rbi +2 -0
- data/rbi/openai/models/image_edit_params.rbi +143 -4
- data/rbi/openai/models/image_generate_params.rbi +4 -4
- data/rbi/openai/models/images_response.rbi +9 -12
- data/rbi/openai/models/live/media_session_config.rbi +12 -0
- data/rbi/openai/models/live/session_accept_params.rbi +12 -0
- data/rbi/openai/models/live/session_config.rbi +12 -0
- data/rbi/openai/models/live/session_resource.rbi +12 -0
- data/rbi/openai/models/responses/input_token_count_params.rbi +27 -15
- data/rbi/openai/models/responses/response.rbi +9 -3
- data/rbi/openai/models/responses/response_create_params.rbi +9 -3
- data/rbi/openai/models/responses/response_tool_search_output_item_param.rbi +6 -3
- data/rbi/openai/models/responses/responses_client_event.rbi +9 -3
- data/rbi/openai/models/responses/tool.rbi +6 -3
- data/rbi/openai/models/video_create_error.rbi +6 -4
- data/rbi/openai/models/webhooks/agent_session_action_required_webhook_event.rbi +4 -0
- data/rbi/openai/models/webhooks/live_transport_connected_webhook_event.rbi +135 -0
- data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +1 -0
- data/rbi/openai/resources/admin/organization/external_keys.rbi +2 -1
- data/rbi/openai/resources/beta/agents/sessions/events.rbi +9 -2
- data/rbi/openai/resources/beta/agents/sessions.rbi +21 -2
- data/rbi/openai/resources/beta/agents.rbi +2 -3
- data/rbi/openai/resources/beta/responses/input_tokens.rbi +9 -6
- data/rbi/openai/resources/beta/responses.rbi +6 -2
- data/rbi/openai/resources/content_provenance_checks.rbi +1 -0
- data/rbi/openai/resources/images.rbi +18 -4
- data/rbi/openai/resources/responses/input_tokens.rbi +9 -5
- data/rbi/openai/resources/responses.rbi +6 -2
- data/rbi/openai/resources/webhooks.rbi +1 -0
- data/sig/openai/internal/transport/base_client.rbs +1 -0
- data/sig/openai/internal/type/base_stream.rbs +2 -0
- data/sig/openai/models/admin/organization/audit_log_list_response.rbs +18 -3
- data/sig/openai/models/admin/organization/external_key.rbs +28 -0
- data/sig/openai/models/admin/organization/external_key_create_params.rbs +108 -0
- data/sig/openai/models/beta/agent.rbs +2 -2
- data/sig/openai/models/beta/agent_create_params.rbs +8 -8
- data/sig/openai/models/beta/agent_output_command_execution_output_delta_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session.rbs +128 -3
- data/sig/openai/models/beta/agent_session_created_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_environment_connected_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_environment_disconnected_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_environment_expired_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_environment_failed_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_environment_pending_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_environment_ready_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_environment_reset_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_environment_suspended_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_error_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_failed_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_idle_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_in_progress_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_input_param.rbs +80 -1
- data/sig/openai/models/beta/agent_session_requires_action_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_subagent_active_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_subagent_closed_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_subagent_created_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_turn_cancelled_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_turn_completed_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_turn_content_part_added_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_turn_content_part_done_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_turn_created_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_turn_failed_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_turn_in_progress_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_turn_item_added_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_turn_item_done_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_turn_output_text_delta_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_turn_output_text_done_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_turn_reasoning_summary_part_added_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_turn_reasoning_summary_part_done_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_turn_reasoning_summary_text_delta_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session_turn_reasoning_summary_text_done_event.rbs +13 -2
- data/sig/openai/models/beta/agent_update_params.rbs +8 -10
- data/sig/openai/models/beta/agents/automation_agent_config.rbs +2 -2
- data/sig/openai/models/beta/agents/automation_target_param.rbs +8 -10
- data/sig/openai/models/beta/agents/one_time_automation.rbs +20 -2
- data/sig/openai/models/beta/agents/periodic_automation.rbs +20 -2
- data/sig/openai/models/beta/agents/session_create_params.rbs +86 -10
- data/sig/openai/models/beta/agents/session_update_params.rbs +46 -0
- data/sig/openai/models/beta/agents/sessions/event_stream_params.rbs +18 -1
- data/sig/openai/models/beta/agents/sessions/turn.rbs +40 -2
- data/sig/openai/models/beta/beta_response.rbs +6 -2
- data/sig/openai/models/beta/beta_response_tool_search_output_item_param.rbs +6 -3
- data/sig/openai/models/beta/beta_responses_client_event.rbs +6 -2
- data/sig/openai/models/beta/beta_tool.rbs +6 -3
- data/sig/openai/models/beta/response_create_params.rbs +6 -2
- data/sig/openai/models/beta/responses/input_token_count_params.rbs +27 -15
- data/sig/openai/models/content_provenance_check_create_params.rbs +2 -0
- data/sig/openai/models/image_edit_params.rbs +87 -4
- data/sig/openai/models/image_generate_params.rbs +4 -4
- data/sig/openai/models/images_response.rbs +9 -12
- data/sig/openai/models/live/media_session_config.rbs +10 -0
- data/sig/openai/models/live/session_accept_params.rbs +10 -0
- data/sig/openai/models/live/session_config.rbs +10 -0
- data/sig/openai/models/live/session_resource.rbs +10 -0
- data/sig/openai/models/responses/input_token_count_params.rbs +27 -15
- data/sig/openai/models/responses/response.rbs +6 -2
- data/sig/openai/models/responses/response_create_params.rbs +6 -2
- data/sig/openai/models/responses/response_tool_search_output_item_param.rbs +6 -3
- data/sig/openai/models/responses/responses_client_event.rbs +6 -2
- data/sig/openai/models/responses/tool.rbs +6 -3
- data/sig/openai/models/video_create_error.rbs +9 -6
- data/sig/openai/models/webhooks/agent_session_action_required_webhook_event.rbs +2 -0
- data/sig/openai/models/webhooks/live_transport_connected_webhook_event.rbs +66 -0
- data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +1 -0
- data/sig/openai/resources/admin/organization/external_keys.rbs +9 -0
- data/sig/openai/resources/beta/agents/sessions/events.rbs +1 -0
- data/sig/openai/resources/beta/agents/sessions.rbs +5 -0
- data/sig/openai/resources/images.rbs +2 -0
- data/sig/openai/resources/webhooks.rbs +1 -0
- metadata +4 -1
|
@@ -31,7 +31,7 @@ module OpenAI
|
|
|
31
31
|
sig { params(data: T::Array[OpenAI::Image::OrHash]).void }
|
|
32
32
|
attr_writer :data
|
|
33
33
|
|
|
34
|
-
# The output format of the generated image.
|
|
34
|
+
# The output format of the generated or edited image.
|
|
35
35
|
sig { returns(T.nilable(OpenAI::ImagesResponse::OutputFormat::TaggedSymbol)) }
|
|
36
36
|
attr_reader :output_format
|
|
37
37
|
|
|
@@ -59,15 +59,14 @@ module OpenAI
|
|
|
59
59
|
sig { params(size: T.any(String, OpenAI::ImagesResponse::Size::OrSymbol)).void }
|
|
60
60
|
attr_writer :size
|
|
61
61
|
|
|
62
|
-
# Token usage for
|
|
63
|
-
# usage.
|
|
62
|
+
# Token usage for SVG authoring, separate from image rendering usage.
|
|
64
63
|
sig { returns(T.nilable(OpenAI::ImagesResponse::SvgUsage)) }
|
|
65
64
|
attr_reader :svg_usage
|
|
66
65
|
|
|
67
66
|
sig { params(svg_usage: OpenAI::ImagesResponse::SvgUsage::OrHash).void }
|
|
68
67
|
attr_writer :svg_usage
|
|
69
68
|
|
|
70
|
-
#
|
|
69
|
+
# Token usage information for image generation with GPT Image models.
|
|
71
70
|
sig { returns(T.nilable(OpenAI::ImagesResponse::Usage)) }
|
|
72
71
|
attr_reader :usage
|
|
73
72
|
|
|
@@ -110,7 +109,7 @@ module OpenAI
|
|
|
110
109
|
# The list of generated images.
|
|
111
110
|
data: nil,
|
|
112
111
|
|
|
113
|
-
# The output format of the generated image.
|
|
112
|
+
# The output format of the generated or edited image.
|
|
114
113
|
output_format: nil,
|
|
115
114
|
|
|
116
115
|
# The quality of the image generated. One of `low`, `medium`, `high`, `xhigh`, or
|
|
@@ -125,11 +124,10 @@ module OpenAI
|
|
|
125
124
|
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
126
125
|
size: nil,
|
|
127
126
|
|
|
128
|
-
# Token usage for
|
|
129
|
-
# usage.
|
|
127
|
+
# Token usage for SVG authoring, separate from image rendering usage.
|
|
130
128
|
svg_usage: nil,
|
|
131
129
|
|
|
132
|
-
#
|
|
130
|
+
# Token usage information for image generation with GPT Image models.
|
|
133
131
|
|
|
134
132
|
usage: nil
|
|
135
133
|
)
|
|
@@ -169,7 +167,7 @@ module OpenAI
|
|
|
169
167
|
end
|
|
170
168
|
end
|
|
171
169
|
|
|
172
|
-
# The output format of the generated image.
|
|
170
|
+
# The output format of the generated or edited image.
|
|
173
171
|
module OutputFormat
|
|
174
172
|
extend OpenAI::Internal::Type::Enum
|
|
175
173
|
|
|
@@ -255,8 +253,7 @@ module OpenAI
|
|
|
255
253
|
sig { returns(Integer) }
|
|
256
254
|
attr_accessor :total_tokens
|
|
257
255
|
|
|
258
|
-
# Token usage for
|
|
259
|
-
# usage.
|
|
256
|
+
# Token usage for SVG authoring, separate from image rendering usage.
|
|
260
257
|
sig do
|
|
261
258
|
params(
|
|
262
259
|
|
|
@@ -336,7 +333,7 @@ module OpenAI
|
|
|
336
333
|
sig { params(output_tokens_details: OpenAI::ImagesResponse::Usage::OutputTokensDetails::OrHash).void }
|
|
337
334
|
attr_writer :output_tokens_details
|
|
338
335
|
|
|
339
|
-
#
|
|
336
|
+
# Token usage information for image generation with GPT Image models.
|
|
340
337
|
sig do
|
|
341
338
|
params(
|
|
342
339
|
|
|
@@ -93,6 +93,11 @@ module OpenAI
|
|
|
93
93
|
sig { returns(T.nilable(String)) }
|
|
94
94
|
attr_accessor :instructions
|
|
95
95
|
|
|
96
|
+
# A stable identifier for your end user, used for safety monitoring and abuse
|
|
97
|
+
# detection.
|
|
98
|
+
sig { returns(T.nilable(String)) }
|
|
99
|
+
attr_accessor :safety_identifier
|
|
100
|
+
|
|
96
101
|
# Whether to store the session for later forking and recording download. Defaults
|
|
97
102
|
# to false for new sessions.
|
|
98
103
|
sig { returns(T.nilable(T::Boolean)) }
|
|
@@ -142,6 +147,8 @@ module OpenAI
|
|
|
142
147
|
|
|
143
148
|
instructions: T.nilable(String),
|
|
144
149
|
|
|
150
|
+
safety_identifier: T.nilable(String),
|
|
151
|
+
|
|
145
152
|
store: T::Boolean,
|
|
146
153
|
|
|
147
154
|
triggers: T::Array[OpenAI::Live::DecisionTrigger::OrHash]
|
|
@@ -181,6 +188,10 @@ module OpenAI
|
|
|
181
188
|
# server defaults. Immutable after startup.
|
|
182
189
|
instructions: nil,
|
|
183
190
|
|
|
191
|
+
# A stable identifier for your end user, used for safety monitoring and abuse
|
|
192
|
+
# detection.
|
|
193
|
+
safety_identifier: nil,
|
|
194
|
+
|
|
184
195
|
# Whether to store the session for later forking and recording download. Defaults
|
|
185
196
|
# to false for new sessions.
|
|
186
197
|
store: nil,
|
|
@@ -215,6 +226,7 @@ module OpenAI
|
|
|
215
226
|
)
|
|
216
227
|
],
|
|
217
228
|
instructions: T.nilable(String),
|
|
229
|
+
safety_identifier: T.nilable(String),
|
|
218
230
|
store: T::Boolean,
|
|
219
231
|
triggers: T::Array[OpenAI::Live::DecisionTrigger]
|
|
220
232
|
}
|
|
@@ -146,6 +146,11 @@ module OpenAI
|
|
|
146
146
|
sig { returns(T.nilable(String)) }
|
|
147
147
|
attr_accessor :instructions
|
|
148
148
|
|
|
149
|
+
# A stable identifier for your end user, used for safety monitoring and abuse
|
|
150
|
+
# detection.
|
|
151
|
+
sig { returns(T.nilable(String)) }
|
|
152
|
+
attr_accessor :safety_identifier
|
|
153
|
+
|
|
149
154
|
# Whether to store the session for later forking and recording download. Defaults
|
|
150
155
|
# to false for new sessions.
|
|
151
156
|
sig { returns(T.nilable(T::Boolean)) }
|
|
@@ -191,6 +196,8 @@ module OpenAI
|
|
|
191
196
|
|
|
192
197
|
instructions: T.nilable(String),
|
|
193
198
|
|
|
199
|
+
safety_identifier: T.nilable(String),
|
|
200
|
+
|
|
194
201
|
store: T::Boolean,
|
|
195
202
|
|
|
196
203
|
triggers: T::Array[OpenAI::Live::DecisionTrigger::OrHash],
|
|
@@ -228,6 +235,10 @@ module OpenAI
|
|
|
228
235
|
# server defaults. Immutable after startup.
|
|
229
236
|
instructions: nil,
|
|
230
237
|
|
|
238
|
+
# A stable identifier for your end user, used for safety monitoring and abuse
|
|
239
|
+
# detection.
|
|
240
|
+
safety_identifier: nil,
|
|
241
|
+
|
|
231
242
|
# Whether to store the session for later forking and recording download. Defaults
|
|
232
243
|
# to false for new sessions.
|
|
233
244
|
store: nil,
|
|
@@ -265,6 +276,7 @@ module OpenAI
|
|
|
265
276
|
)
|
|
266
277
|
],
|
|
267
278
|
instructions: T.nilable(String),
|
|
279
|
+
safety_identifier: T.nilable(String),
|
|
268
280
|
store: T::Boolean,
|
|
269
281
|
triggers: T::Array[OpenAI::Live::DecisionTrigger]
|
|
270
282
|
}
|
|
@@ -94,6 +94,11 @@ module OpenAI
|
|
|
94
94
|
sig { returns(T.nilable(String)) }
|
|
95
95
|
attr_accessor :instructions
|
|
96
96
|
|
|
97
|
+
# A stable identifier for your end user, used for safety monitoring and abuse
|
|
98
|
+
# detection.
|
|
99
|
+
sig { returns(T.nilable(String)) }
|
|
100
|
+
attr_accessor :safety_identifier
|
|
101
|
+
|
|
97
102
|
# Whether to store the session for later forking and recording download. Defaults
|
|
98
103
|
# to false for new sessions.
|
|
99
104
|
sig { returns(T.nilable(T::Boolean)) }
|
|
@@ -141,6 +146,8 @@ module OpenAI
|
|
|
141
146
|
|
|
142
147
|
instructions: T.nilable(String),
|
|
143
148
|
|
|
149
|
+
safety_identifier: T.nilable(String),
|
|
150
|
+
|
|
144
151
|
store: T::Boolean,
|
|
145
152
|
|
|
146
153
|
triggers: T::Array[OpenAI::Live::DecisionTrigger::OrHash]
|
|
@@ -181,6 +188,10 @@ module OpenAI
|
|
|
181
188
|
# server defaults. Immutable after startup.
|
|
182
189
|
instructions: nil,
|
|
183
190
|
|
|
191
|
+
# A stable identifier for your end user, used for safety monitoring and abuse
|
|
192
|
+
# detection.
|
|
193
|
+
safety_identifier: nil,
|
|
194
|
+
|
|
184
195
|
# Whether to store the session for later forking and recording download. Defaults
|
|
185
196
|
# to false for new sessions.
|
|
186
197
|
store: nil,
|
|
@@ -215,6 +226,7 @@ module OpenAI
|
|
|
215
226
|
)
|
|
216
227
|
],
|
|
217
228
|
instructions: T.nilable(String),
|
|
229
|
+
safety_identifier: T.nilable(String),
|
|
218
230
|
store: T::Boolean,
|
|
219
231
|
triggers: T::Array[OpenAI::Live::DecisionTrigger]
|
|
220
232
|
}
|
|
@@ -99,6 +99,11 @@ module OpenAI
|
|
|
99
99
|
sig { returns(T.nilable(String)) }
|
|
100
100
|
attr_accessor :instructions
|
|
101
101
|
|
|
102
|
+
# A stable identifier for your end user, used for safety monitoring and abuse
|
|
103
|
+
# detection.
|
|
104
|
+
sig { returns(T.nilable(String)) }
|
|
105
|
+
attr_accessor :safety_identifier
|
|
106
|
+
|
|
102
107
|
# Whether to store the session for later forking and recording download. Defaults
|
|
103
108
|
# to false for new sessions.
|
|
104
109
|
sig { returns(T.nilable(T::Boolean)) }
|
|
@@ -149,6 +154,8 @@ module OpenAI
|
|
|
149
154
|
|
|
150
155
|
instructions: T.nilable(String),
|
|
151
156
|
|
|
157
|
+
safety_identifier: T.nilable(String),
|
|
158
|
+
|
|
152
159
|
store: T::Boolean,
|
|
153
160
|
|
|
154
161
|
triggers: T::Array[OpenAI::Live::DecisionTrigger::OrHash],
|
|
@@ -198,6 +205,10 @@ module OpenAI
|
|
|
198
205
|
# server defaults. Immutable after startup.
|
|
199
206
|
instructions: nil,
|
|
200
207
|
|
|
208
|
+
# A stable identifier for your end user, used for safety monitoring and abuse
|
|
209
|
+
# detection.
|
|
210
|
+
safety_identifier: nil,
|
|
211
|
+
|
|
201
212
|
# Whether to store the session for later forking and recording download. Defaults
|
|
202
213
|
# to false for new sessions.
|
|
203
214
|
store: nil,
|
|
@@ -234,6 +245,7 @@ module OpenAI
|
|
|
234
245
|
)
|
|
235
246
|
],
|
|
236
247
|
instructions: T.nilable(String),
|
|
248
|
+
safety_identifier: T.nilable(String),
|
|
237
249
|
store: T::Boolean,
|
|
238
250
|
triggers: T::Array[OpenAI::Live::DecisionTrigger]
|
|
239
251
|
}
|
|
@@ -134,11 +134,15 @@ module OpenAI
|
|
|
134
134
|
}
|
|
135
135
|
attr_accessor :tools
|
|
136
136
|
|
|
137
|
-
# The truncation strategy to use for the model response.
|
|
138
|
-
#
|
|
139
|
-
#
|
|
140
|
-
#
|
|
141
|
-
#
|
|
137
|
+
# The truncation strategy to use for the model response.
|
|
138
|
+
#
|
|
139
|
+
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
140
|
+
# the model will truncate the response to fit the context window by dropping
|
|
141
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
142
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
143
|
+
# from its input limit before counting tokens.
|
|
144
|
+
# - `disabled` (default): If the input size will exceed the context window size
|
|
145
|
+
# for a model, the request will fail with a 400 error.
|
|
142
146
|
sig { returns(T.nilable(OpenAI::Responses::InputTokenCountParams::Truncation::OrSymbol)) }
|
|
143
147
|
attr_reader :truncation
|
|
144
148
|
|
|
@@ -265,11 +269,15 @@ module OpenAI
|
|
|
265
269
|
# specify which tool to use by setting the `tool_choice` parameter.
|
|
266
270
|
tools: nil,
|
|
267
271
|
|
|
268
|
-
# The truncation strategy to use for the model response.
|
|
269
|
-
#
|
|
270
|
-
#
|
|
271
|
-
#
|
|
272
|
-
#
|
|
272
|
+
# The truncation strategy to use for the model response.
|
|
273
|
+
#
|
|
274
|
+
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
275
|
+
# the model will truncate the response to fit the context window by dropping
|
|
276
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
277
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
278
|
+
# from its input limit before counting tokens.
|
|
279
|
+
# - `disabled` (default): If the input size will exceed the context window size
|
|
280
|
+
# for a model, the request will fail with a 400 error.
|
|
273
281
|
truncation: nil,
|
|
274
282
|
|
|
275
283
|
request_options: {}
|
|
@@ -581,11 +589,15 @@ module OpenAI
|
|
|
581
589
|
|
|
582
590
|
end
|
|
583
591
|
|
|
584
|
-
# The truncation strategy to use for the model response.
|
|
585
|
-
#
|
|
586
|
-
#
|
|
587
|
-
#
|
|
588
|
-
#
|
|
592
|
+
# The truncation strategy to use for the model response.
|
|
593
|
+
#
|
|
594
|
+
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
595
|
+
# the model will truncate the response to fit the context window by dropping
|
|
596
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
597
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
598
|
+
# from its input limit before counting tokens.
|
|
599
|
+
# - `disabled` (default): If the input size will exceed the context window size
|
|
600
|
+
# for a model, the request will fail with a 400 error.
|
|
589
601
|
module Truncation
|
|
590
602
|
extend OpenAI::Internal::Type::Enum
|
|
591
603
|
|
|
@@ -340,7 +340,9 @@ module OpenAI
|
|
|
340
340
|
#
|
|
341
341
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
342
342
|
# the model will truncate the response to fit the context window by dropping
|
|
343
|
-
# items from the beginning of the conversation.
|
|
343
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
344
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
345
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
344
346
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
345
347
|
# for a model, the request will fail with a 400 error.
|
|
346
348
|
sig { returns(T.nilable(OpenAI::Responses::Response::Truncation::TaggedSymbol)) }
|
|
@@ -750,7 +752,9 @@ module OpenAI
|
|
|
750
752
|
#
|
|
751
753
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
752
754
|
# the model will truncate the response to fit the context window by dropping
|
|
753
|
-
# items from the beginning of the conversation.
|
|
755
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
756
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
757
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
754
758
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
755
759
|
# for a model, the request will fail with a 400 error.
|
|
756
760
|
truncation: nil,
|
|
@@ -2471,7 +2475,9 @@ module OpenAI
|
|
|
2471
2475
|
#
|
|
2472
2476
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
2473
2477
|
# the model will truncate the response to fit the context window by dropping
|
|
2474
|
-
# items from the beginning of the conversation.
|
|
2478
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
2479
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
2480
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
2475
2481
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
2476
2482
|
# for a model, the request will fail with a 400 error.
|
|
2477
2483
|
module Truncation
|
|
@@ -416,7 +416,9 @@ module OpenAI
|
|
|
416
416
|
#
|
|
417
417
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
418
418
|
# the model will truncate the response to fit the context window by dropping
|
|
419
|
-
# items from the beginning of the conversation.
|
|
419
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
420
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
421
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
420
422
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
421
423
|
# for a model, the request will fail with a 400 error.
|
|
422
424
|
sig { returns(T.nilable(OpenAI::Responses::ResponseCreateParams::Truncation::OrSymbol)) }
|
|
@@ -774,7 +776,9 @@ module OpenAI
|
|
|
774
776
|
#
|
|
775
777
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
776
778
|
# the model will truncate the response to fit the context window by dropping
|
|
777
|
-
# items from the beginning of the conversation.
|
|
779
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
780
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
781
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
778
782
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
779
783
|
# for a model, the request will fail with a 400 error.
|
|
780
784
|
truncation: nil,
|
|
@@ -1690,7 +1694,9 @@ module OpenAI
|
|
|
1690
1694
|
#
|
|
1691
1695
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
1692
1696
|
# the model will truncate the response to fit the context window by dropping
|
|
1693
|
-
# items from the beginning of the conversation.
|
|
1697
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
1698
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
1699
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
1694
1700
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
1695
1701
|
# for a model, the request will fail with a 400 error.
|
|
1696
1702
|
module Truncation
|
|
@@ -1365,7 +1365,8 @@ module OpenAI
|
|
|
1365
1365
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
1366
1366
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
1367
1367
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
1368
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1368
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1369
|
+
# `gpt-image-2.6-sunburst`.
|
|
1369
1370
|
#
|
|
1370
1371
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
1371
1372
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -1606,7 +1607,8 @@ module OpenAI
|
|
|
1606
1607
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
1607
1608
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
1608
1609
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
1609
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1610
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1611
|
+
# `gpt-image-2.6-sunburst`.
|
|
1610
1612
|
#
|
|
1611
1613
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
1612
1614
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -1897,7 +1899,8 @@ module OpenAI
|
|
|
1897
1899
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
1898
1900
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
1899
1901
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
1900
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1902
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1903
|
+
# `gpt-image-2.6-sunburst`.
|
|
1901
1904
|
#
|
|
1902
1905
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
1903
1906
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -473,7 +473,9 @@ module OpenAI
|
|
|
473
473
|
#
|
|
474
474
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
475
475
|
# the model will truncate the response to fit the context window by dropping
|
|
476
|
-
# items from the beginning of the conversation.
|
|
476
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
477
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
478
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
477
479
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
478
480
|
# for a model, the request will fail with a 400 error.
|
|
479
481
|
sig { returns(T.nilable(OpenAI::Responses::ResponsesClientEvent::ResponseCreate::Truncation::OrSymbol)) }
|
|
@@ -870,7 +872,9 @@ module OpenAI
|
|
|
870
872
|
#
|
|
871
873
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
872
874
|
# the model will truncate the response to fit the context window by dropping
|
|
873
|
-
# items from the beginning of the conversation.
|
|
875
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
876
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
877
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
874
878
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
875
879
|
# for a model, the request will fail with a 400 error.
|
|
876
880
|
truncation: nil,
|
|
@@ -1952,7 +1956,9 @@ module OpenAI
|
|
|
1952
1956
|
#
|
|
1953
1957
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
1954
1958
|
# the model will truncate the response to fit the context window by dropping
|
|
1955
|
-
# items from the beginning of the conversation.
|
|
1959
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
1960
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
1961
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
1956
1962
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
1957
1963
|
# for a model, the request will fail with a 400 error.
|
|
1958
1964
|
module Truncation
|
|
@@ -1022,7 +1022,8 @@ module OpenAI
|
|
|
1022
1022
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
1023
1023
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
1024
1024
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
1025
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1025
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1026
|
+
# `gpt-image-2.6-sunburst`.
|
|
1026
1027
|
#
|
|
1027
1028
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
1028
1029
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -1184,7 +1185,8 @@ module OpenAI
|
|
|
1184
1185
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
1185
1186
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
1186
1187
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
1187
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1188
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1189
|
+
# `gpt-image-2.6-sunburst`.
|
|
1188
1190
|
#
|
|
1189
1191
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
1190
1192
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -1399,7 +1401,8 @@ module OpenAI
|
|
|
1399
1401
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
1400
1402
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
1401
1403
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
1402
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1404
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1405
|
+
# `gpt-image-2.6-sunburst`.
|
|
1403
1406
|
#
|
|
1404
1407
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
1405
1408
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -20,8 +20,9 @@ module OpenAI
|
|
|
20
20
|
sig { returns(String) }
|
|
21
21
|
attr_accessor :message
|
|
22
22
|
|
|
23
|
-
#
|
|
24
|
-
#
|
|
23
|
+
# Headers returned with the original error. These can include Retry-After,
|
|
24
|
+
# Retry-After-Ms, and, on opted-in deployments,
|
|
25
|
+
# x-openai-inference-capacity-reason.
|
|
25
26
|
sig { returns(T.nilable(T::Hash[Symbol, String])) }
|
|
26
27
|
attr_reader :headers
|
|
27
28
|
|
|
@@ -68,8 +69,9 @@ module OpenAI
|
|
|
68
69
|
# A human-readable description of the error that was returned.
|
|
69
70
|
message:,
|
|
70
71
|
|
|
71
|
-
#
|
|
72
|
-
#
|
|
72
|
+
# Headers returned with the original error. These can include Retry-After,
|
|
73
|
+
# Retry-After-Ms, and, on opted-in deployments,
|
|
74
|
+
# x-openai-inference-capacity-reason.
|
|
73
75
|
headers: nil,
|
|
74
76
|
|
|
75
77
|
misalignment: nil,
|
|
@@ -192,6 +192,10 @@ module OpenAI
|
|
|
192
192
|
:computer_use_approval_request,
|
|
193
193
|
OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction::Type::TaggedSymbol
|
|
194
194
|
)
|
|
195
|
+
MCP_APPROVAL_REQUEST = T.let(
|
|
196
|
+
:mcp_approval_request,
|
|
197
|
+
OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction::Type::TaggedSymbol
|
|
198
|
+
)
|
|
195
199
|
FUNCTION_CALL = T.let(
|
|
196
200
|
:function_call,
|
|
197
201
|
OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent::Data::RequiredAction::Type::TaggedSymbol
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
|
|
6
|
+
module Webhooks
|
|
7
|
+
|
|
8
|
+
class LiveTransportConnectedWebhookEvent < OpenAI::Internal::Type::BaseModel
|
|
9
|
+
|
|
10
|
+
OrHash = T.type_alias do
|
|
11
|
+
T.any(
|
|
12
|
+
OpenAI::Webhooks::LiveTransportConnectedWebhookEvent,
|
|
13
|
+
OpenAI::Internal::AnyHash
|
|
14
|
+
)
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
# The webhook event ID.
|
|
18
|
+
sig { returns(String) }
|
|
19
|
+
attr_accessor :id
|
|
20
|
+
|
|
21
|
+
# Unix time in seconds when the event was created.
|
|
22
|
+
sig { returns(Integer) }
|
|
23
|
+
attr_accessor :created_at
|
|
24
|
+
|
|
25
|
+
sig { returns(OpenAI::Webhooks::LiveTransportConnectedWebhookEvent::Data) }
|
|
26
|
+
attr_reader :data
|
|
27
|
+
|
|
28
|
+
sig { params(data: OpenAI::Webhooks::LiveTransportConnectedWebhookEvent::Data::OrHash).void }
|
|
29
|
+
attr_writer :data
|
|
30
|
+
|
|
31
|
+
sig { returns(Symbol) }
|
|
32
|
+
attr_accessor :object
|
|
33
|
+
|
|
34
|
+
sig { returns(Symbol) }
|
|
35
|
+
attr_accessor :type
|
|
36
|
+
|
|
37
|
+
# Sent when a direct Live WebRTC session is created or an Instant Connect session
|
|
38
|
+
# activates. Use its session ID to attach a sideband observer.
|
|
39
|
+
sig do
|
|
40
|
+
params(
|
|
41
|
+
|
|
42
|
+
id: String,
|
|
43
|
+
|
|
44
|
+
created_at: Integer,
|
|
45
|
+
|
|
46
|
+
data: OpenAI::Webhooks::LiveTransportConnectedWebhookEvent::Data::OrHash,
|
|
47
|
+
|
|
48
|
+
object: Symbol,
|
|
49
|
+
|
|
50
|
+
type: Symbol
|
|
51
|
+
)
|
|
52
|
+
.returns(T.attached_class)
|
|
53
|
+
end
|
|
54
|
+
def self.new(
|
|
55
|
+
|
|
56
|
+
# The webhook event ID.
|
|
57
|
+
id:,
|
|
58
|
+
|
|
59
|
+
# Unix time in seconds when the event was created.
|
|
60
|
+
created_at:,
|
|
61
|
+
|
|
62
|
+
data:,
|
|
63
|
+
|
|
64
|
+
object: :event,
|
|
65
|
+
|
|
66
|
+
type: :"live.transport.connected"
|
|
67
|
+
)
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
sig do
|
|
71
|
+
override.returns(
|
|
72
|
+
{
|
|
73
|
+
id: String,
|
|
74
|
+
created_at: Integer,
|
|
75
|
+
data: OpenAI::Webhooks::LiveTransportConnectedWebhookEvent::Data,
|
|
76
|
+
object: Symbol,
|
|
77
|
+
type: Symbol
|
|
78
|
+
}
|
|
79
|
+
)
|
|
80
|
+
end
|
|
81
|
+
def to_hash
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
class Data < OpenAI::Internal::Type::BaseModel
|
|
85
|
+
OrHash = T.type_alias do
|
|
86
|
+
T.any(
|
|
87
|
+
OpenAI::Webhooks::LiveTransportConnectedWebhookEvent::Data,
|
|
88
|
+
OpenAI::Internal::AnyHash
|
|
89
|
+
)
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
# The Live session ID to use with the sideband attach endpoint.
|
|
93
|
+
sig { returns(String) }
|
|
94
|
+
attr_accessor :session_id
|
|
95
|
+
|
|
96
|
+
# The session transport.
|
|
97
|
+
sig { returns(Symbol) }
|
|
98
|
+
attr_accessor :type
|
|
99
|
+
|
|
100
|
+
sig do
|
|
101
|
+
params(
|
|
102
|
+
|
|
103
|
+
session_id: String,
|
|
104
|
+
|
|
105
|
+
type: Symbol
|
|
106
|
+
)
|
|
107
|
+
.returns(T.attached_class)
|
|
108
|
+
end
|
|
109
|
+
def self.new(
|
|
110
|
+
|
|
111
|
+
# The Live session ID to use with the sideband attach endpoint.
|
|
112
|
+
session_id:,
|
|
113
|
+
|
|
114
|
+
# The session transport.
|
|
115
|
+
|
|
116
|
+
type: :webrtc
|
|
117
|
+
)
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
sig do
|
|
121
|
+
override.returns(
|
|
122
|
+
{session_id: String, type: Symbol}
|
|
123
|
+
)
|
|
124
|
+
end
|
|
125
|
+
def to_hash
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
end
|
|
129
|
+
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
end
|
|
135
|
+
end
|
|
@@ -31,6 +31,7 @@ module OpenAI
|
|
|
31
31
|
OpenAI::Webhooks::FineTuningJobFailedWebhookEvent,
|
|
32
32
|
OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent,
|
|
33
33
|
OpenAI::Webhooks::LiveCallIncomingWebhookEvent,
|
|
34
|
+
OpenAI::Webhooks::LiveTransportConnectedWebhookEvent,
|
|
34
35
|
OpenAI::Webhooks::LiveTransportIncomingWebhookEvent,
|
|
35
36
|
OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent,
|
|
36
37
|
OpenAI::Webhooks::ResponseCancelledWebhookEvent,
|
|
@@ -15,7 +15,8 @@ module OpenAI
|
|
|
15
15
|
body: T.any(
|
|
16
16
|
OpenAI::Admin::Organization::ExternalKeyCreateParams::Body::Aws::OrHash,
|
|
17
17
|
OpenAI::Admin::Organization::ExternalKeyCreateParams::Body::Gcp::OrHash,
|
|
18
|
-
OpenAI::Admin::Organization::ExternalKeyCreateParams::Body::Azure::OrHash
|
|
18
|
+
OpenAI::Admin::Organization::ExternalKeyCreateParams::Body::Azure::OrHash,
|
|
19
|
+
OpenAI::Admin::Organization::ExternalKeyCreateParams::Body::Oci::OrHash
|
|
19
20
|
),
|
|
20
21
|
request_options: OpenAI::RequestOptions::OrHash
|
|
21
22
|
)
|