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
|
@@ -24,7 +24,7 @@ module OpenAI
|
|
|
24
24
|
optional :data, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Image] }
|
|
25
25
|
|
|
26
26
|
# @!attribute output_format
|
|
27
|
-
# The output format of the generated image.
|
|
27
|
+
# The output format of the generated or edited image.
|
|
28
28
|
#
|
|
29
29
|
# @return [Symbol, OpenAI::Models::ImagesResponse::OutputFormat, nil]
|
|
30
30
|
optional :output_format, enum: -> { OpenAI::ImagesResponse::OutputFormat }
|
|
@@ -51,14 +51,13 @@ module OpenAI
|
|
|
51
51
|
optional :size, union: -> { OpenAI::ImagesResponse::Size }
|
|
52
52
|
|
|
53
53
|
# @!attribute svg_usage
|
|
54
|
-
# Token usage for
|
|
55
|
-
# usage.
|
|
54
|
+
# Token usage for SVG authoring, separate from image rendering usage.
|
|
56
55
|
#
|
|
57
56
|
# @return [OpenAI::Models::ImagesResponse::SvgUsage, nil]
|
|
58
57
|
optional :svg_usage, -> { OpenAI::ImagesResponse::SvgUsage }
|
|
59
58
|
|
|
60
59
|
# @!attribute usage
|
|
61
|
-
#
|
|
60
|
+
# Token usage information for image generation with GPT Image models.
|
|
62
61
|
#
|
|
63
62
|
# @return [OpenAI::Models::ImagesResponse::Usage, nil]
|
|
64
63
|
optional :usage, -> { OpenAI::ImagesResponse::Usage }
|
|
@@ -77,7 +76,7 @@ module OpenAI
|
|
|
77
76
|
# The list of generated images.
|
|
78
77
|
#
|
|
79
78
|
# @param output_format [Symbol, OpenAI::Models::ImagesResponse::OutputFormat]
|
|
80
|
-
# The output format of the generated image.
|
|
79
|
+
# The output format of the generated or edited image.
|
|
81
80
|
#
|
|
82
81
|
# @param quality [Symbol, OpenAI::Models::ImagesResponse::Quality]
|
|
83
82
|
# The quality of the image generated. One of `low`, `medium`, `high`, `xhigh`, or
|
|
@@ -92,11 +91,10 @@ module OpenAI
|
|
|
92
91
|
# The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
|
|
93
92
|
#
|
|
94
93
|
# @param svg_usage [OpenAI::Models::ImagesResponse::SvgUsage]
|
|
95
|
-
# Token usage for
|
|
96
|
-
# usage.
|
|
94
|
+
# Token usage for SVG authoring, separate from image rendering usage.
|
|
97
95
|
#
|
|
98
96
|
# @param usage [OpenAI::Models::ImagesResponse::Usage]
|
|
99
|
-
#
|
|
97
|
+
# Token usage information for image generation with GPT Image models.
|
|
100
98
|
|
|
101
99
|
# The background parameter used for the image generation. Either `transparent` or
|
|
102
100
|
# `opaque`.
|
|
@@ -112,7 +110,7 @@ module OpenAI
|
|
|
112
110
|
# @return [Array<Symbol>]
|
|
113
111
|
end
|
|
114
112
|
|
|
115
|
-
# The output format of the generated image.
|
|
113
|
+
# The output format of the generated or edited image.
|
|
116
114
|
#
|
|
117
115
|
# @see OpenAI::Models::ImagesResponse#output_format
|
|
118
116
|
module OutputFormat
|
|
@@ -208,8 +206,7 @@ module OpenAI
|
|
|
208
206
|
required :total_tokens, Integer
|
|
209
207
|
|
|
210
208
|
# @!method initialize(input_tokens:, model:, output_tokens:, reasoning_tokens:, total_tokens:)
|
|
211
|
-
# Token usage for
|
|
212
|
-
# usage.
|
|
209
|
+
# Token usage for SVG authoring, separate from image rendering usage.
|
|
213
210
|
#
|
|
214
211
|
# @param input_tokens [Integer]
|
|
215
212
|
# @param model [String]
|
|
@@ -251,7 +248,7 @@ module OpenAI
|
|
|
251
248
|
optional :output_tokens_details, -> { OpenAI::ImagesResponse::Usage::OutputTokensDetails }
|
|
252
249
|
|
|
253
250
|
# @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, total_tokens:, output_tokens_details: nil)
|
|
254
|
-
#
|
|
251
|
+
# Token usage information for image generation with GPT Image models.
|
|
255
252
|
#
|
|
256
253
|
# @param input_tokens [Integer]
|
|
257
254
|
# The number of tokens (images and text) in the input prompt.
|
|
@@ -53,6 +53,13 @@ module OpenAI
|
|
|
53
53
|
# @return [String, nil]
|
|
54
54
|
optional :instructions, String, nil?: true
|
|
55
55
|
|
|
56
|
+
# @!attribute safety_identifier
|
|
57
|
+
# A stable identifier for your end user, used for safety monitoring and abuse
|
|
58
|
+
# detection.
|
|
59
|
+
#
|
|
60
|
+
# @return [String, nil]
|
|
61
|
+
optional :safety_identifier, String, nil?: true
|
|
62
|
+
|
|
56
63
|
# @!attribute store
|
|
57
64
|
# Whether to store the session for later forking and recording download. Defaults
|
|
58
65
|
# to false for new sessions.
|
|
@@ -69,7 +76,7 @@ module OpenAI
|
|
|
69
76
|
# @return [Array<OpenAI::Models::Live::DecisionTrigger>, nil]
|
|
70
77
|
optional :triggers, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Live::DecisionTrigger] }
|
|
71
78
|
|
|
72
|
-
# @!method initialize(model:, audio: nil, client: nil, delegation: nil, input: nil, instructions: nil, store: nil, triggers: nil)
|
|
79
|
+
# @!method initialize(model:, audio: nil, client: nil, delegation: nil, input: nil, instructions: nil, safety_identifier: nil, store: nil, triggers: nil)
|
|
73
80
|
# Startup configuration for a Live media session. Follow the
|
|
74
81
|
# [Live prompting guide](https://developers.openai.com/api/docs/guides/live-prompting)
|
|
75
82
|
# when writing frontend instructions and the backend prompt under
|
|
@@ -106,6 +113,10 @@ module OpenAI
|
|
|
106
113
|
# Limited to 16,384 client-supplied tokens. Omitted or blank instructions use
|
|
107
114
|
# server defaults. Immutable after startup.
|
|
108
115
|
#
|
|
116
|
+
# @param safety_identifier [String, nil]
|
|
117
|
+
# A stable identifier for your end user, used for safety monitoring and abuse
|
|
118
|
+
# detection.
|
|
119
|
+
#
|
|
109
120
|
# @param store [Boolean]
|
|
110
121
|
# Whether to store the session for later forking and recording download. Defaults
|
|
111
122
|
# to false for new sessions.
|
|
@@ -84,6 +84,13 @@ module OpenAI
|
|
|
84
84
|
# @return [String, nil]
|
|
85
85
|
optional :instructions, String, nil?: true
|
|
86
86
|
|
|
87
|
+
# @!attribute safety_identifier
|
|
88
|
+
# A stable identifier for your end user, used for safety monitoring and abuse
|
|
89
|
+
# detection.
|
|
90
|
+
#
|
|
91
|
+
# @return [String, nil]
|
|
92
|
+
optional :safety_identifier, String, nil?: true
|
|
93
|
+
|
|
87
94
|
# @!attribute store
|
|
88
95
|
# Whether to store the session for later forking and recording download. Defaults
|
|
89
96
|
# to false for new sessions.
|
|
@@ -100,7 +107,7 @@ module OpenAI
|
|
|
100
107
|
# @return [Array<OpenAI::Models::Live::DecisionTrigger>, nil]
|
|
101
108
|
optional :triggers, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Live::DecisionTrigger] }
|
|
102
109
|
|
|
103
|
-
# @!method initialize(model:, audio: nil, delegation: nil, input: nil, instructions: nil, store: nil, triggers: nil, type: :live)
|
|
110
|
+
# @!method initialize(model:, audio: nil, delegation: nil, input: nil, instructions: nil, safety_identifier: nil, store: nil, triggers: nil, type: :live)
|
|
104
111
|
# Model and startup configuration for the Live session that answers the incoming
|
|
105
112
|
# SIP call.
|
|
106
113
|
#
|
|
@@ -131,6 +138,10 @@ module OpenAI
|
|
|
131
138
|
# Limited to 16,384 client-supplied tokens. Omitted or blank instructions use
|
|
132
139
|
# server defaults. Immutable after startup.
|
|
133
140
|
#
|
|
141
|
+
# @param safety_identifier [String, nil]
|
|
142
|
+
# A stable identifier for your end user, used for safety monitoring and abuse
|
|
143
|
+
# detection.
|
|
144
|
+
#
|
|
134
145
|
# @param store [Boolean]
|
|
135
146
|
# Whether to store the session for later forking and recording download. Defaults
|
|
136
147
|
# to false for new sessions.
|
|
@@ -54,6 +54,13 @@ module OpenAI
|
|
|
54
54
|
# @return [String, nil]
|
|
55
55
|
optional :instructions, String, nil?: true
|
|
56
56
|
|
|
57
|
+
# @!attribute safety_identifier
|
|
58
|
+
# A stable identifier for your end user, used for safety monitoring and abuse
|
|
59
|
+
# detection.
|
|
60
|
+
#
|
|
61
|
+
# @return [String, nil]
|
|
62
|
+
optional :safety_identifier, String, nil?: true
|
|
63
|
+
|
|
57
64
|
# @!attribute store
|
|
58
65
|
# Whether to store the session for later forking and recording download. Defaults
|
|
59
66
|
# to false for new sessions.
|
|
@@ -70,7 +77,7 @@ module OpenAI
|
|
|
70
77
|
# @return [Array<OpenAI::Models::Live::DecisionTrigger>, nil]
|
|
71
78
|
optional :triggers, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Live::DecisionTrigger] }
|
|
72
79
|
|
|
73
|
-
# @!method initialize(model:, audio: nil, client: nil, delegation: nil, input: nil, instructions: nil, store: nil, triggers: nil)
|
|
80
|
+
# @!method initialize(model:, audio: nil, client: nil, delegation: nil, input: nil, instructions: nil, safety_identifier: nil, store: nil, triggers: nil)
|
|
74
81
|
# Initial configuration for a Live session, including its model, conversation
|
|
75
82
|
# instructions, audio, and delegated task handling.
|
|
76
83
|
#
|
|
@@ -106,6 +113,10 @@ module OpenAI
|
|
|
106
113
|
# Limited to 16,384 client-supplied tokens. Omitted or blank instructions use
|
|
107
114
|
# server defaults. Immutable after startup.
|
|
108
115
|
#
|
|
116
|
+
# @param safety_identifier [String, nil]
|
|
117
|
+
# A stable identifier for your end user, used for safety monitoring and abuse
|
|
118
|
+
# detection.
|
|
119
|
+
#
|
|
109
120
|
# @param store [Boolean]
|
|
110
121
|
# Whether to store the session for later forking and recording download. Defaults
|
|
111
122
|
# to false for new sessions.
|
|
@@ -75,6 +75,13 @@ module OpenAI
|
|
|
75
75
|
# @return [String, nil]
|
|
76
76
|
optional :instructions, String, nil?: true
|
|
77
77
|
|
|
78
|
+
# @!attribute safety_identifier
|
|
79
|
+
# A stable identifier for your end user, used for safety monitoring and abuse
|
|
80
|
+
# detection.
|
|
81
|
+
#
|
|
82
|
+
# @return [String, nil]
|
|
83
|
+
optional :safety_identifier, String, nil?: true
|
|
84
|
+
|
|
78
85
|
# @!attribute store
|
|
79
86
|
# Whether to store the session for later forking and recording download. Defaults
|
|
80
87
|
# to false for new sessions.
|
|
@@ -91,7 +98,7 @@ module OpenAI
|
|
|
91
98
|
# @return [Array<OpenAI::Models::Live::DecisionTrigger>, nil]
|
|
92
99
|
optional :triggers, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Live::DecisionTrigger] }
|
|
93
100
|
|
|
94
|
-
# @!method initialize(id:, expires_at:, model:, audio: nil, client: nil, delegation: nil, input: nil, instructions: nil, store: nil, triggers: nil, status: :active)
|
|
101
|
+
# @!method initialize(id:, expires_at:, model:, audio: nil, client: nil, delegation: nil, input: nil, instructions: nil, safety_identifier: nil, store: nil, triggers: nil, status: :active)
|
|
95
102
|
# The resolved Live session configuration and server-assigned session metadata.
|
|
96
103
|
#
|
|
97
104
|
# @param id [String]
|
|
@@ -133,6 +140,10 @@ module OpenAI
|
|
|
133
140
|
# Limited to 16,384 client-supplied tokens. Omitted or blank instructions use
|
|
134
141
|
# server defaults. Immutable after startup.
|
|
135
142
|
#
|
|
143
|
+
# @param safety_identifier [String, nil]
|
|
144
|
+
# A stable identifier for your end user, used for safety monitoring and abuse
|
|
145
|
+
# detection.
|
|
146
|
+
#
|
|
136
147
|
# @param store [Boolean]
|
|
137
148
|
# Whether to store the session for later forking and recording download. Defaults
|
|
138
149
|
# to false for new sessions.
|
|
@@ -104,11 +104,15 @@ module OpenAI
|
|
|
104
104
|
# @!attribute truncation
|
|
105
105
|
# @deprecated
|
|
106
106
|
#
|
|
107
|
-
# The truncation strategy to use for the model response.
|
|
108
|
-
#
|
|
109
|
-
#
|
|
110
|
-
#
|
|
111
|
-
#
|
|
107
|
+
# The truncation strategy to use for the model response.
|
|
108
|
+
#
|
|
109
|
+
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
110
|
+
# the model will truncate the response to fit the context window by dropping
|
|
111
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
112
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
113
|
+
# from its input limit before counting tokens.
|
|
114
|
+
# - `disabled` (default): If the input size will exceed the context window size
|
|
115
|
+
# for a model, the request will fail with a 400 error.
|
|
112
116
|
#
|
|
113
117
|
# @return [Symbol, OpenAI::Models::Responses::InputTokenCountParams::Truncation, nil]
|
|
114
118
|
optional :truncation, enum: -> { OpenAI::Responses::InputTokenCountParams::Truncation }
|
|
@@ -169,11 +173,15 @@ module OpenAI
|
|
|
169
173
|
# specify which tool to use by setting the `tool_choice` parameter.
|
|
170
174
|
#
|
|
171
175
|
# @param truncation [Symbol, OpenAI::Models::Responses::InputTokenCountParams::Truncation]
|
|
172
|
-
# The truncation strategy to use for the model response.
|
|
173
|
-
#
|
|
174
|
-
#
|
|
175
|
-
#
|
|
176
|
-
#
|
|
176
|
+
# The truncation strategy to use for the model response.
|
|
177
|
+
#
|
|
178
|
+
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
179
|
+
# the model will truncate the response to fit the context window by dropping
|
|
180
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
181
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
182
|
+
# from its input limit before counting tokens.
|
|
183
|
+
# - `disabled` (default): If the input size will exceed the context window size
|
|
184
|
+
# for a model, the request will fail with a 400 error.
|
|
177
185
|
#
|
|
178
186
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
179
187
|
|
|
@@ -374,11 +382,15 @@ module OpenAI
|
|
|
374
382
|
|
|
375
383
|
# @deprecated
|
|
376
384
|
#
|
|
377
|
-
# The truncation strategy to use for the model response.
|
|
378
|
-
#
|
|
379
|
-
#
|
|
380
|
-
#
|
|
381
|
-
#
|
|
385
|
+
# The truncation strategy to use for the model response.
|
|
386
|
+
#
|
|
387
|
+
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
388
|
+
# the model will truncate the response to fit the context window by dropping
|
|
389
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
390
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
391
|
+
# from its input limit before counting tokens.
|
|
392
|
+
# - `disabled` (default): If the input size will exceed the context window size
|
|
393
|
+
# for a model, the request will fail with a 400 error.
|
|
382
394
|
module Truncation
|
|
383
395
|
extend OpenAI::Internal::Type::Enum
|
|
384
396
|
|
|
@@ -363,7 +363,9 @@ module OpenAI
|
|
|
363
363
|
#
|
|
364
364
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
365
365
|
# the model will truncate the response to fit the context window by dropping
|
|
366
|
-
# items from the beginning of the conversation.
|
|
366
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
367
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
368
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
367
369
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
368
370
|
# for a model, the request will fail with a 400 error.
|
|
369
371
|
#
|
|
@@ -626,7 +628,9 @@ module OpenAI
|
|
|
626
628
|
#
|
|
627
629
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
628
630
|
# the model will truncate the response to fit the context window by dropping
|
|
629
|
-
# items from the beginning of the conversation.
|
|
631
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
632
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
633
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
630
634
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
631
635
|
# for a model, the request will fail with a 400 error.
|
|
632
636
|
#
|
|
@@ -1605,7 +1609,9 @@ module OpenAI
|
|
|
1605
1609
|
#
|
|
1606
1610
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
1607
1611
|
# the model will truncate the response to fit the context window by dropping
|
|
1608
|
-
# items from the beginning of the conversation.
|
|
1612
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
1613
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
1614
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
1609
1615
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
1610
1616
|
# for a model, the request will fail with a 400 error.
|
|
1611
1617
|
#
|
|
@@ -31,6 +31,8 @@ module OpenAI
|
|
|
31
31
|
optional :input, union: -> { OpenAI::Responses::ResponseCompactParams::Input }, nil?: true
|
|
32
32
|
|
|
33
33
|
# @!attribute instructions
|
|
34
|
+
# @deprecated
|
|
35
|
+
#
|
|
34
36
|
# A system (or developer) message inserted into the model's context. When used
|
|
35
37
|
# along with `previous_response_id`, the instructions from a previous response
|
|
36
38
|
# will not be carried over to the next response. This makes it simple to swap out
|
|
@@ -369,7 +369,9 @@ module OpenAI
|
|
|
369
369
|
#
|
|
370
370
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
371
371
|
# the model will truncate the response to fit the context window by dropping
|
|
372
|
-
# items from the beginning of the conversation.
|
|
372
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
373
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
374
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
373
375
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
374
376
|
# for a model, the request will fail with a 400 error.
|
|
375
377
|
#
|
|
@@ -629,7 +631,9 @@ module OpenAI
|
|
|
629
631
|
#
|
|
630
632
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
631
633
|
# the model will truncate the response to fit the context window by dropping
|
|
632
|
-
# items from the beginning of the conversation.
|
|
634
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
635
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
636
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
633
637
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
634
638
|
# for a model, the request will fail with a 400 error.
|
|
635
639
|
#
|
|
@@ -1161,7 +1165,9 @@ module OpenAI
|
|
|
1161
1165
|
#
|
|
1162
1166
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
1163
1167
|
# the model will truncate the response to fit the context window by dropping
|
|
1164
|
-
# items from the beginning of the conversation.
|
|
1168
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
1169
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
1170
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
1165
1171
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
1166
1172
|
# for a model, the request will fail with a 400 error.
|
|
1167
1173
|
module Truncation
|
|
@@ -808,7 +808,8 @@ module OpenAI
|
|
|
808
808
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
809
809
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
810
810
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
811
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
811
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
812
|
+
# `gpt-image-2.6-sunburst`.
|
|
812
813
|
#
|
|
813
814
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
814
815
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -940,7 +941,8 @@ module OpenAI
|
|
|
940
941
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
941
942
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
942
943
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
943
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
944
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
945
|
+
# `gpt-image-2.6-sunburst`.
|
|
944
946
|
#
|
|
945
947
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
946
948
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -1089,7 +1091,8 @@ module OpenAI
|
|
|
1089
1091
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
1090
1092
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
1091
1093
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
1092
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1094
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1095
|
+
# `gpt-image-2.6-sunburst`.
|
|
1093
1096
|
#
|
|
1094
1097
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
1095
1098
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -454,7 +454,9 @@ module OpenAI
|
|
|
454
454
|
#
|
|
455
455
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
456
456
|
# the model will truncate the response to fit the context window by dropping
|
|
457
|
-
# items from the beginning of the conversation.
|
|
457
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
458
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
459
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
458
460
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
459
461
|
# for a model, the request will fail with a 400 error.
|
|
460
462
|
#
|
|
@@ -748,7 +750,9 @@ module OpenAI
|
|
|
748
750
|
#
|
|
749
751
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
750
752
|
# the model will truncate the response to fit the context window by dropping
|
|
751
|
-
# items from the beginning of the conversation.
|
|
753
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
754
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
755
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
752
756
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
753
757
|
# for a model, the request will fail with a 400 error.
|
|
754
758
|
#
|
|
@@ -1321,7 +1325,9 @@ module OpenAI
|
|
|
1321
1325
|
#
|
|
1322
1326
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
1323
1327
|
# the model will truncate the response to fit the context window by dropping
|
|
1324
|
-
# items from the beginning of the conversation.
|
|
1328
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
1329
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
1330
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
1325
1331
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
1326
1332
|
# for a model, the request will fail with a 400 error.
|
|
1327
1333
|
#
|
|
@@ -683,7 +683,8 @@ module OpenAI
|
|
|
683
683
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
684
684
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
685
685
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
686
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
686
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
687
|
+
# `gpt-image-2.6-sunburst`.
|
|
687
688
|
#
|
|
688
689
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
689
690
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -800,7 +801,8 @@ module OpenAI
|
|
|
800
801
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
801
802
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
802
803
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
803
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
804
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
805
|
+
# `gpt-image-2.6-sunburst`.
|
|
804
806
|
#
|
|
805
807
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
806
808
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -949,7 +951,8 @@ module OpenAI
|
|
|
949
951
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
950
952
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
951
953
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
952
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
954
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
955
|
+
# `gpt-image-2.6-sunburst`.
|
|
953
956
|
#
|
|
954
957
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
955
958
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -16,8 +16,9 @@ module OpenAI
|
|
|
16
16
|
required :message, String
|
|
17
17
|
|
|
18
18
|
# @!attribute headers
|
|
19
|
-
#
|
|
20
|
-
#
|
|
19
|
+
# Headers returned with the original error. These can include Retry-After,
|
|
20
|
+
# Retry-After-Ms, and, on opted-in deployments,
|
|
21
|
+
# x-openai-inference-capacity-reason.
|
|
21
22
|
#
|
|
22
23
|
# @return [Hash{Symbol=>String}, nil]
|
|
23
24
|
optional :headers, OpenAI::Internal::Type::HashOf[String]
|
|
@@ -49,8 +50,9 @@ module OpenAI
|
|
|
49
50
|
# A human-readable description of the error that was returned.
|
|
50
51
|
#
|
|
51
52
|
# @param headers [Hash{Symbol=>String}]
|
|
52
|
-
#
|
|
53
|
-
#
|
|
53
|
+
# Headers returned with the original error. These can include Retry-After,
|
|
54
|
+
# Retry-After-Ms, and, on opted-in deployments,
|
|
55
|
+
# x-openai-inference-capacity-reason.
|
|
54
56
|
#
|
|
55
57
|
# @param misalignment [OpenAI::Models::VideoCreateError::Misalignment]
|
|
56
58
|
#
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
class LiveTransportConnectedWebhookEvent < OpenAI::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The webhook event ID.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute created_at
|
|
14
|
+
# Unix time in seconds when the event was created.
|
|
15
|
+
#
|
|
16
|
+
# @return [Integer]
|
|
17
|
+
required :created_at, Integer
|
|
18
|
+
|
|
19
|
+
# @!attribute data
|
|
20
|
+
#
|
|
21
|
+
# @return [OpenAI::Models::Webhooks::LiveTransportConnectedWebhookEvent::Data]
|
|
22
|
+
required :data, -> { OpenAI::Webhooks::LiveTransportConnectedWebhookEvent::Data }
|
|
23
|
+
|
|
24
|
+
# @!attribute object
|
|
25
|
+
#
|
|
26
|
+
# @return [Symbol, :event]
|
|
27
|
+
required :object, const: :event
|
|
28
|
+
|
|
29
|
+
# @!attribute type
|
|
30
|
+
#
|
|
31
|
+
# @return [Symbol, :"live.transport.connected"]
|
|
32
|
+
required :type, const: :"live.transport.connected"
|
|
33
|
+
|
|
34
|
+
# @!method initialize(id:, created_at:, data:, object: :event, type: :"live.transport.connected")
|
|
35
|
+
# Sent when a direct Live WebRTC session is created or an Instant Connect session
|
|
36
|
+
# activates. Use its session ID to attach a sideband observer.
|
|
37
|
+
#
|
|
38
|
+
# @param id [String]
|
|
39
|
+
# The webhook event ID.
|
|
40
|
+
#
|
|
41
|
+
# @param created_at [Integer]
|
|
42
|
+
# Unix time in seconds when the event was created.
|
|
43
|
+
#
|
|
44
|
+
# @param data [OpenAI::Models::Webhooks::LiveTransportConnectedWebhookEvent::Data]
|
|
45
|
+
#
|
|
46
|
+
# @param object [Symbol, :event]
|
|
47
|
+
#
|
|
48
|
+
# @param type [Symbol, :"live.transport.connected"]
|
|
49
|
+
|
|
50
|
+
# @see OpenAI::Models::Webhooks::LiveTransportConnectedWebhookEvent#data
|
|
51
|
+
class Data < OpenAI::Internal::Type::BaseModel
|
|
52
|
+
# @!attribute session_id
|
|
53
|
+
# The Live session ID to use with the sideband attach endpoint.
|
|
54
|
+
#
|
|
55
|
+
# @return [String]
|
|
56
|
+
required :session_id, String
|
|
57
|
+
|
|
58
|
+
# @!attribute type
|
|
59
|
+
# The session transport.
|
|
60
|
+
#
|
|
61
|
+
# @return [Symbol, :webrtc]
|
|
62
|
+
required :type, const: :webrtc
|
|
63
|
+
|
|
64
|
+
# @!method initialize(session_id:, type: :webrtc)
|
|
65
|
+
# @param session_id [String]
|
|
66
|
+
# The Live session ID to use with the sideband attach endpoint.
|
|
67
|
+
#
|
|
68
|
+
# @param type [Symbol, :webrtc]
|
|
69
|
+
# The session transport.
|
|
70
|
+
end
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
end
|
|
@@ -73,6 +73,9 @@ module OpenAI
|
|
|
73
73
|
# successful Realtime or Live accept endpoint selects the runtime surface.
|
|
74
74
|
variant :"live.call.incoming", -> { OpenAI::Webhooks::LiveCallIncomingWebhookEvent }
|
|
75
75
|
|
|
76
|
+
# Sent when a direct Live WebRTC session is created or an Instant Connect session activates. Use its session ID to attach a sideband observer.
|
|
77
|
+
variant :"live.transport.connected", -> { OpenAI::Webhooks::LiveTransportConnectedWebhookEvent }
|
|
78
|
+
|
|
76
79
|
# Sent when an incoming API SIP session is available for Live acceptance. The
|
|
77
80
|
# same pending session can also emit `realtime.call.incoming`; the first
|
|
78
81
|
# successful Realtime or Live accept endpoint selects the runtime surface.
|
|
@@ -108,7 +111,7 @@ module OpenAI
|
|
|
108
111
|
variant :"safety.warning_issued", -> { OpenAI::Webhooks::SafetyWarningIssuedWebhookEvent }
|
|
109
112
|
|
|
110
113
|
# @!method self.variants
|
|
111
|
-
# @return [Array(OpenAI::Models::Webhooks::AgentEnvironmentExpiredWebhookEvent, OpenAI::Models::Webhooks::AgentEnvironmentFailedWebhookEvent, OpenAI::Models::Webhooks::AgentEnvironmentReadyWebhookEvent, OpenAI::Models::Webhooks::AgentEnvironmentSuspendedWebhookEvent, OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent, OpenAI::Models::Webhooks::AgentSessionCreatedWebhookEvent, OpenAI::Models::Webhooks::AgentSessionFailedWebhookEvent, OpenAI::Models::Webhooks::AgentSessionIdleWebhookEvent, OpenAI::Models::Webhooks::AgentSessionInProgressWebhookEvent, OpenAI::Models::Webhooks::BatchCancelledWebhookEvent, OpenAI::Models::Webhooks::BatchCompletedWebhookEvent, OpenAI::Models::Webhooks::BatchExpiredWebhookEvent, OpenAI::Models::Webhooks::BatchFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent, OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobFailedWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobSucceededWebhookEvent, OpenAI::Models::Webhooks::LiveCallIncomingWebhookEvent, OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent, OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent, OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent, OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent, OpenAI::Models::Webhooks::ResponseFailedWebhookEvent, OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent, OpenAI::Models::Webhooks::SafetyAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyDeactivationIssuedWebhookEvent, OpenAI::Models::Webhooks::SafetyOrgAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyWarningIssuedWebhookEvent)]
|
|
114
|
+
# @return [Array(OpenAI::Models::Webhooks::AgentEnvironmentExpiredWebhookEvent, OpenAI::Models::Webhooks::AgentEnvironmentFailedWebhookEvent, OpenAI::Models::Webhooks::AgentEnvironmentReadyWebhookEvent, OpenAI::Models::Webhooks::AgentEnvironmentSuspendedWebhookEvent, OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent, OpenAI::Models::Webhooks::AgentSessionCreatedWebhookEvent, OpenAI::Models::Webhooks::AgentSessionFailedWebhookEvent, OpenAI::Models::Webhooks::AgentSessionIdleWebhookEvent, OpenAI::Models::Webhooks::AgentSessionInProgressWebhookEvent, OpenAI::Models::Webhooks::BatchCancelledWebhookEvent, OpenAI::Models::Webhooks::BatchCompletedWebhookEvent, OpenAI::Models::Webhooks::BatchExpiredWebhookEvent, OpenAI::Models::Webhooks::BatchFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent, OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobFailedWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobSucceededWebhookEvent, OpenAI::Models::Webhooks::LiveCallIncomingWebhookEvent, OpenAI::Models::Webhooks::LiveTransportConnectedWebhookEvent, OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent, OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent, OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent, OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent, OpenAI::Models::Webhooks::ResponseFailedWebhookEvent, OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent, OpenAI::Models::Webhooks::SafetyAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyDeactivationIssuedWebhookEvent, OpenAI::Models::Webhooks::SafetyOrgAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyWarningIssuedWebhookEvent)]
|
|
112
115
|
end
|
|
113
116
|
end
|
|
114
117
|
end
|
|
@@ -9,7 +9,7 @@ module OpenAI
|
|
|
9
9
|
#
|
|
10
10
|
# @overload create(body:, request_options: {})
|
|
11
11
|
#
|
|
12
|
-
# @param body [OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Aws, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Gcp, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Azure]
|
|
12
|
+
# @param body [OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Aws, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Gcp, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Azure, OpenAI::Models::Admin::Organization::ExternalKeyCreateParams::Body::Oci]
|
|
13
13
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
14
14
|
#
|
|
15
15
|
# @return [OpenAI::Models::Admin::Organization::ExternalKey]
|