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,11 +24,21 @@ module OpenAI
|
|
|
24
24
|
sig { returns(String) }
|
|
25
25
|
attr_accessor :session_id
|
|
26
26
|
|
|
27
|
+
# Whether to include obfuscation padding in events on this connection. Defaults to
|
|
28
|
+
# `true`.
|
|
29
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
30
|
+
attr_reader :include_obfuscation
|
|
31
|
+
|
|
32
|
+
sig { params(include_obfuscation: T::Boolean).void }
|
|
33
|
+
attr_writer :include_obfuscation
|
|
34
|
+
|
|
27
35
|
sig do
|
|
28
36
|
params(
|
|
29
37
|
|
|
30
38
|
session_id: String,
|
|
31
39
|
|
|
40
|
+
include_obfuscation: T::Boolean,
|
|
41
|
+
|
|
32
42
|
request_options: OpenAI::RequestOptions::OrHash
|
|
33
43
|
)
|
|
34
44
|
.returns(T.attached_class)
|
|
@@ -37,13 +47,17 @@ module OpenAI
|
|
|
37
47
|
|
|
38
48
|
session_id:,
|
|
39
49
|
|
|
50
|
+
# Whether to include obfuscation padding in events on this connection. Defaults to
|
|
51
|
+
# `true`.
|
|
52
|
+
include_obfuscation: nil,
|
|
53
|
+
|
|
40
54
|
request_options: {}
|
|
41
55
|
)
|
|
42
56
|
end
|
|
43
57
|
|
|
44
58
|
sig do
|
|
45
59
|
override.returns(
|
|
46
|
-
{session_id: String, request_options: OpenAI::RequestOptions}
|
|
60
|
+
{session_id: String, include_obfuscation: T::Boolean, request_options: OpenAI::RequestOptions}
|
|
47
61
|
)
|
|
48
62
|
end
|
|
49
63
|
def to_hash
|
|
@@ -71,6 +71,17 @@ module OpenAI
|
|
|
71
71
|
sig { params(usage: T.nilable(OpenAI::Beta::TokenUsage::OrHash)).void }
|
|
72
72
|
attr_writer :usage
|
|
73
73
|
|
|
74
|
+
# Prompt cache lifetime selected when this turn started, including an inherited
|
|
75
|
+
# session TTL. Null when the turn used the model default or no TTL was recorded.
|
|
76
|
+
sig { returns(T.nilable(OpenAI::Beta::Agents::Sessions::Turn::PromptCacheOptions)) }
|
|
77
|
+
attr_reader :prompt_cache_options
|
|
78
|
+
|
|
79
|
+
sig {
|
|
80
|
+
params(prompt_cache_options: T.nilable(OpenAI::Beta::Agents::Sessions::Turn::PromptCacheOptions::OrHash))
|
|
81
|
+
.void
|
|
82
|
+
}
|
|
83
|
+
attr_writer :prompt_cache_options
|
|
84
|
+
|
|
74
85
|
# The canonical public representation of a session turn.
|
|
75
86
|
sig do
|
|
76
87
|
params(
|
|
@@ -95,6 +106,8 @@ module OpenAI
|
|
|
95
106
|
|
|
96
107
|
usage: T.nilable(OpenAI::Beta::TokenUsage::OrHash),
|
|
97
108
|
|
|
109
|
+
prompt_cache_options: T.nilable(OpenAI::Beta::Agents::Sessions::Turn::PromptCacheOptions::OrHash),
|
|
110
|
+
|
|
98
111
|
object: Symbol
|
|
99
112
|
)
|
|
100
113
|
.returns(T.attached_class)
|
|
@@ -134,6 +147,10 @@ module OpenAI
|
|
|
134
147
|
# change.
|
|
135
148
|
usage:,
|
|
136
149
|
|
|
150
|
+
# Prompt cache lifetime selected when this turn started, including an inherited
|
|
151
|
+
# session TTL. Null when the turn used the model default or no TTL was recorded.
|
|
152
|
+
prompt_cache_options: nil,
|
|
153
|
+
|
|
137
154
|
# The object type. Always `agent.session.turn`.
|
|
138
155
|
|
|
139
156
|
object: :"agent.session.turn"
|
|
@@ -153,7 +170,8 @@ module OpenAI
|
|
|
153
170
|
started_at: T.nilable(Integer),
|
|
154
171
|
status: OpenAI::Beta::Agents::Sessions::Turn::Status::TaggedSymbol,
|
|
155
172
|
subagent_id: T.nilable(String),
|
|
156
|
-
usage: T.nilable(OpenAI::Beta::TokenUsage)
|
|
173
|
+
usage: T.nilable(OpenAI::Beta::TokenUsage),
|
|
174
|
+
prompt_cache_options: T.nilable(OpenAI::Beta::Agents::Sessions::Turn::PromptCacheOptions)
|
|
157
175
|
}
|
|
158
176
|
)
|
|
159
177
|
end
|
|
@@ -190,6 +208,61 @@ module OpenAI
|
|
|
190
208
|
end
|
|
191
209
|
end
|
|
192
210
|
|
|
211
|
+
class PromptCacheOptions < OpenAI::Internal::Type::BaseModel
|
|
212
|
+
OrHash = T.type_alias do
|
|
213
|
+
T.any(
|
|
214
|
+
OpenAI::Beta::Agents::Sessions::Turn::PromptCacheOptions,
|
|
215
|
+
OpenAI::Internal::AnyHash
|
|
216
|
+
)
|
|
217
|
+
end
|
|
218
|
+
|
|
219
|
+
sig { returns(OpenAI::Beta::Agents::Sessions::Turn::PromptCacheOptions::Ttl::TaggedSymbol) }
|
|
220
|
+
attr_accessor :ttl
|
|
221
|
+
|
|
222
|
+
# Prompt cache lifetime selected when this turn started, including an inherited
|
|
223
|
+
# session TTL. Null when the turn used the model default or no TTL was recorded.
|
|
224
|
+
sig do
|
|
225
|
+
params(
|
|
226
|
+
|
|
227
|
+
ttl: OpenAI::Beta::Agents::Sessions::Turn::PromptCacheOptions::Ttl::OrSymbol
|
|
228
|
+
)
|
|
229
|
+
.returns(T.attached_class)
|
|
230
|
+
end
|
|
231
|
+
def self.new(
|
|
232
|
+
|
|
233
|
+
ttl:
|
|
234
|
+
)
|
|
235
|
+
end
|
|
236
|
+
|
|
237
|
+
sig do
|
|
238
|
+
override.returns(
|
|
239
|
+
{ttl: OpenAI::Beta::Agents::Sessions::Turn::PromptCacheOptions::Ttl::TaggedSymbol}
|
|
240
|
+
)
|
|
241
|
+
end
|
|
242
|
+
def to_hash
|
|
243
|
+
end
|
|
244
|
+
|
|
245
|
+
module Ttl
|
|
246
|
+
extend OpenAI::Internal::Type::Enum
|
|
247
|
+
|
|
248
|
+
TaggedSymbol = T.type_alias {
|
|
249
|
+
T.all(Symbol, OpenAI::Beta::Agents::Sessions::Turn::PromptCacheOptions::Ttl)
|
|
250
|
+
}
|
|
251
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
252
|
+
|
|
253
|
+
TTL_30M = T.let(:"30m", OpenAI::Beta::Agents::Sessions::Turn::PromptCacheOptions::Ttl::TaggedSymbol)
|
|
254
|
+
TTL_12H = T.let(:"12h", OpenAI::Beta::Agents::Sessions::Turn::PromptCacheOptions::Ttl::TaggedSymbol)
|
|
255
|
+
|
|
256
|
+
sig {
|
|
257
|
+
override.returns(
|
|
258
|
+
T::Array[OpenAI::Beta::Agents::Sessions::Turn::PromptCacheOptions::Ttl::TaggedSymbol]
|
|
259
|
+
)
|
|
260
|
+
}
|
|
261
|
+
def self.values
|
|
262
|
+
end
|
|
263
|
+
end
|
|
264
|
+
end
|
|
265
|
+
|
|
193
266
|
end
|
|
194
267
|
|
|
195
268
|
end
|
|
@@ -342,7 +342,9 @@ module OpenAI
|
|
|
342
342
|
#
|
|
343
343
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
344
344
|
# the model will truncate the response to fit the context window by dropping
|
|
345
|
-
# items from the beginning of the conversation.
|
|
345
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
346
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
347
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
346
348
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
347
349
|
# for a model, the request will fail with a 400 error.
|
|
348
350
|
sig { returns(T.nilable(OpenAI::Beta::BetaResponse::Truncation::TaggedSymbol)) }
|
|
@@ -755,7 +757,9 @@ module OpenAI
|
|
|
755
757
|
#
|
|
756
758
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
757
759
|
# the model will truncate the response to fit the context window by dropping
|
|
758
|
-
# items from the beginning of the conversation.
|
|
760
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
761
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
762
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
759
763
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
760
764
|
# for a model, the request will fail with a 400 error.
|
|
761
765
|
truncation: nil,
|
|
@@ -2875,7 +2879,9 @@ module OpenAI
|
|
|
2875
2879
|
#
|
|
2876
2880
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
2877
2881
|
# the model will truncate the response to fit the context window by dropping
|
|
2878
|
-
# items from the beginning of the conversation.
|
|
2882
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
2883
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
2884
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
2879
2885
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
2880
2886
|
# for a model, the request will fail with a 400 error.
|
|
2881
2887
|
module Truncation
|
|
@@ -1377,7 +1377,8 @@ module OpenAI
|
|
|
1377
1377
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
1378
1378
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
1379
1379
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
1380
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1380
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1381
|
+
# `gpt-image-2.6-sunburst`.
|
|
1381
1382
|
#
|
|
1382
1383
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
1383
1384
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -1614,7 +1615,8 @@ module OpenAI
|
|
|
1614
1615
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
1615
1616
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
1616
1617
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
1617
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1618
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1619
|
+
# `gpt-image-2.6-sunburst`.
|
|
1618
1620
|
#
|
|
1619
1621
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
1620
1622
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -1902,7 +1904,8 @@ module OpenAI
|
|
|
1902
1904
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
1903
1905
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
1904
1906
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
1905
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1907
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1908
|
+
# `gpt-image-2.6-sunburst`.
|
|
1906
1909
|
#
|
|
1907
1910
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
1908
1911
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -480,7 +480,9 @@ module OpenAI
|
|
|
480
480
|
#
|
|
481
481
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
482
482
|
# the model will truncate the response to fit the context window by dropping
|
|
483
|
-
# items from the beginning of the conversation.
|
|
483
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
484
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
485
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
484
486
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
485
487
|
# for a model, the request will fail with a 400 error.
|
|
486
488
|
sig { returns(T.nilable(OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::Truncation::OrSymbol)) }
|
|
@@ -882,7 +884,9 @@ module OpenAI
|
|
|
882
884
|
#
|
|
883
885
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
884
886
|
# the model will truncate the response to fit the context window by dropping
|
|
885
|
-
# items from the beginning of the conversation.
|
|
887
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
888
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
889
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
886
890
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
887
891
|
# for a model, the request will fail with a 400 error.
|
|
888
892
|
truncation: nil,
|
|
@@ -2778,7 +2782,9 @@ module OpenAI
|
|
|
2778
2782
|
#
|
|
2779
2783
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
2780
2784
|
# the model will truncate the response to fit the context window by dropping
|
|
2781
|
-
# items from the beginning of the conversation.
|
|
2785
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
2786
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
2787
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
2782
2788
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
2783
2789
|
# for a model, the request will fail with a 400 error.
|
|
2784
2790
|
module Truncation
|
|
@@ -1021,7 +1021,8 @@ module OpenAI
|
|
|
1021
1021
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
1022
1022
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
1023
1023
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
1024
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1024
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1025
|
+
# `gpt-image-2.6-sunburst`.
|
|
1025
1026
|
#
|
|
1026
1027
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
1027
1028
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -1183,7 +1184,8 @@ module OpenAI
|
|
|
1183
1184
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
1184
1185
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
1185
1186
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
1186
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1187
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1188
|
+
# `gpt-image-2.6-sunburst`.
|
|
1187
1189
|
#
|
|
1188
1190
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
1189
1191
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -1398,7 +1400,8 @@ module OpenAI
|
|
|
1398
1400
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
1399
1401
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
1400
1402
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
1401
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1403
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
1404
|
+
# `gpt-image-2.6-sunburst`.
|
|
1402
1405
|
#
|
|
1403
1406
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
1404
1407
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -409,7 +409,9 @@ module OpenAI
|
|
|
409
409
|
#
|
|
410
410
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
411
411
|
# the model will truncate the response to fit the context window by dropping
|
|
412
|
-
# items from the beginning of the conversation.
|
|
412
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
413
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
414
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
413
415
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
414
416
|
# for a model, the request will fail with a 400 error.
|
|
415
417
|
sig { returns(T.nilable(OpenAI::Beta::ResponseCreateParams::Truncation::OrSymbol)) }
|
|
@@ -780,7 +782,9 @@ module OpenAI
|
|
|
780
782
|
#
|
|
781
783
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
782
784
|
# the model will truncate the response to fit the context window by dropping
|
|
783
|
-
# items from the beginning of the conversation.
|
|
785
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
786
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
787
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
784
788
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
785
789
|
# for a model, the request will fail with a 400 error.
|
|
786
790
|
truncation: nil,
|
|
@@ -2195,7 +2199,9 @@ module OpenAI
|
|
|
2195
2199
|
#
|
|
2196
2200
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
2197
2201
|
# the model will truncate the response to fit the context window by dropping
|
|
2198
|
-
# items from the beginning of the conversation.
|
|
2202
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
2203
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
2204
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
2199
2205
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
2200
2206
|
# for a model, the request will fail with a 400 error.
|
|
2201
2207
|
module Truncation
|
|
@@ -139,11 +139,15 @@ module OpenAI
|
|
|
139
139
|
}
|
|
140
140
|
attr_accessor :tools
|
|
141
141
|
|
|
142
|
-
# The truncation strategy to use for the model response.
|
|
143
|
-
#
|
|
144
|
-
#
|
|
145
|
-
#
|
|
146
|
-
#
|
|
142
|
+
# The truncation strategy to use for the model response.
|
|
143
|
+
#
|
|
144
|
+
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
145
|
+
# the model will truncate the response to fit the context window by dropping
|
|
146
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
147
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
148
|
+
# from its input limit before counting tokens.
|
|
149
|
+
# - `disabled` (default): If the input size will exceed the context window size
|
|
150
|
+
# for a model, the request will fail with a 400 error.
|
|
147
151
|
sig { returns(T.nilable(OpenAI::Beta::Responses::InputTokenCountParams::Truncation::OrSymbol)) }
|
|
148
152
|
attr_reader :truncation
|
|
149
153
|
|
|
@@ -278,11 +282,15 @@ module OpenAI
|
|
|
278
282
|
# specify which tool to use by setting the `tool_choice` parameter.
|
|
279
283
|
tools: nil,
|
|
280
284
|
|
|
281
|
-
# The truncation strategy to use for the model response.
|
|
282
|
-
#
|
|
283
|
-
#
|
|
284
|
-
#
|
|
285
|
-
#
|
|
285
|
+
# The truncation strategy to use for the model response.
|
|
286
|
+
#
|
|
287
|
+
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
288
|
+
# the model will truncate the response to fit the context window by dropping
|
|
289
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
290
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
291
|
+
# from its input limit before counting tokens.
|
|
292
|
+
# - `disabled` (default): If the input size will exceed the context window size
|
|
293
|
+
# for a model, the request will fail with a 400 error.
|
|
286
294
|
truncation: nil,
|
|
287
295
|
|
|
288
296
|
betas: nil,
|
|
@@ -900,11 +908,15 @@ module OpenAI
|
|
|
900
908
|
|
|
901
909
|
end
|
|
902
910
|
|
|
903
|
-
# The truncation strategy to use for the model response.
|
|
904
|
-
#
|
|
905
|
-
#
|
|
906
|
-
#
|
|
907
|
-
#
|
|
911
|
+
# The truncation strategy to use for the model response.
|
|
912
|
+
#
|
|
913
|
+
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
914
|
+
# the model will truncate the response to fit the context window by dropping
|
|
915
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
916
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
917
|
+
# from its input limit before counting tokens.
|
|
918
|
+
# - `disabled` (default): If the input size will exceed the context window size
|
|
919
|
+
# for a model, the request will fail with a 400 error.
|
|
908
920
|
module Truncation
|
|
909
921
|
extend OpenAI::Internal::Type::Enum
|
|
910
922
|
|
|
@@ -16,6 +16,7 @@ module OpenAI
|
|
|
16
16
|
end
|
|
17
17
|
|
|
18
18
|
# The image or audio file to check for supported OpenAI provenance signals.
|
|
19
|
+
# Supported image formats are PNG, JPEG, WebP, and GIF (including animated GIFs).
|
|
19
20
|
#
|
|
20
21
|
# `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
|
|
21
22
|
# metadata. Use `OpenAI::FilePart` when you need to override the filename or
|
|
@@ -35,6 +36,7 @@ module OpenAI
|
|
|
35
36
|
def self.new(
|
|
36
37
|
|
|
37
38
|
# The image or audio file to check for supported OpenAI provenance signals.
|
|
39
|
+
# Supported image formats are PNG, JPEG, WebP, and GIF (including animated GIFs).
|
|
38
40
|
#
|
|
39
41
|
# `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
|
|
40
42
|
# metadata. Use `OpenAI::FilePart` when you need to override the filename or
|
|
@@ -123,7 +123,8 @@ module OpenAI
|
|
|
123
123
|
attr_accessor :output_compression
|
|
124
124
|
|
|
125
125
|
# The format in which the generated images are returned. This parameter is only
|
|
126
|
-
# supported for the GPT image models. The default value is `png`.
|
|
126
|
+
# supported for the GPT image models. The default value is `png`. SVG output
|
|
127
|
+
# requires a supported image model and project access.
|
|
127
128
|
sig { returns(T.nilable(OpenAI::ImageEditParams::OutputFormat::OrSymbol)) }
|
|
128
129
|
attr_accessor :output_format
|
|
129
130
|
|
|
@@ -171,6 +172,16 @@ module OpenAI
|
|
|
171
172
|
sig { returns(T.nilable(T.any(String, OpenAI::ImageEditParams::Size::OrSymbol))) }
|
|
172
173
|
attr_accessor :size
|
|
173
174
|
|
|
175
|
+
# Selects the author model and reasoning effort for `output_format=svg`. Supply
|
|
176
|
+
# `svg.model` when SVG model selection is enabled. Otherwise, omit this object.
|
|
177
|
+
# SVG output requires `n=1` and cannot use streaming, partial images, or output
|
|
178
|
+
# compression. Use multipart fields such as `svg[model]`.
|
|
179
|
+
sig { returns(T.nilable(OpenAI::ImageEditParams::Svg)) }
|
|
180
|
+
attr_reader :svg
|
|
181
|
+
|
|
182
|
+
sig { params(svg: T.nilable(OpenAI::ImageEditParams::Svg::OrHash)).void }
|
|
183
|
+
attr_writer :svg
|
|
184
|
+
|
|
174
185
|
# Deprecated: use `safety_identifier` instead. This parameter remains accepted for
|
|
175
186
|
# backward compatibility and is used when `safety_identifier` is omitted, null, or
|
|
176
187
|
# empty.
|
|
@@ -220,6 +231,8 @@ module OpenAI
|
|
|
220
231
|
|
|
221
232
|
size: T.nilable(T.any(String, OpenAI::ImageEditParams::Size::OrSymbol)),
|
|
222
233
|
|
|
234
|
+
svg: T.nilable(OpenAI::ImageEditParams::Svg::OrHash),
|
|
235
|
+
|
|
223
236
|
user: String,
|
|
224
237
|
|
|
225
238
|
request_options: OpenAI::RequestOptions::OrHash
|
|
@@ -318,7 +331,8 @@ module OpenAI
|
|
|
318
331
|
output_compression: nil,
|
|
319
332
|
|
|
320
333
|
# The format in which the generated images are returned. This parameter is only
|
|
321
|
-
# supported for the GPT image models. The default value is `png`.
|
|
334
|
+
# supported for the GPT image models. The default value is `png`. SVG output
|
|
335
|
+
# requires a supported image model and project access.
|
|
322
336
|
output_format: nil,
|
|
323
337
|
|
|
324
338
|
# The number of partial images to generate. This parameter is used for streaming
|
|
@@ -360,6 +374,12 @@ module OpenAI
|
|
|
360
374
|
# models that allow automatic sizing.
|
|
361
375
|
size: nil,
|
|
362
376
|
|
|
377
|
+
# Selects the author model and reasoning effort for `output_format=svg`. Supply
|
|
378
|
+
# `svg.model` when SVG model selection is enabled. Otherwise, omit this object.
|
|
379
|
+
# SVG output requires `n=1` and cannot use streaming, partial images, or output
|
|
380
|
+
# compression. Use multipart fields such as `svg[model]`.
|
|
381
|
+
svg: nil,
|
|
382
|
+
|
|
363
383
|
# Deprecated: use `safety_identifier` instead. This parameter remains accepted for
|
|
364
384
|
# backward compatibility and is used when `safety_identifier` is omitted, null, or
|
|
365
385
|
# empty.
|
|
@@ -391,6 +411,7 @@ module OpenAI
|
|
|
391
411
|
response_format: T.nilable(OpenAI::ImageEditParams::ResponseFormat::OrSymbol),
|
|
392
412
|
safety_identifier: T.nilable(String),
|
|
393
413
|
size: T.nilable(T.any(String, OpenAI::ImageEditParams::Size::OrSymbol)),
|
|
414
|
+
svg: T.nilable(OpenAI::ImageEditParams::Svg),
|
|
394
415
|
user: String,
|
|
395
416
|
request_options: OpenAI::RequestOptions
|
|
396
417
|
}
|
|
@@ -503,7 +524,8 @@ module OpenAI
|
|
|
503
524
|
end
|
|
504
525
|
|
|
505
526
|
# The format in which the generated images are returned. This parameter is only
|
|
506
|
-
# supported for the GPT image models. The default value is `png`.
|
|
527
|
+
# supported for the GPT image models. The default value is `png`. SVG output
|
|
528
|
+
# requires a supported image model and project access.
|
|
507
529
|
module OutputFormat
|
|
508
530
|
extend OpenAI::Internal::Type::Enum
|
|
509
531
|
|
|
@@ -511,9 +533,10 @@ module OpenAI
|
|
|
511
533
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
512
534
|
|
|
513
535
|
PNG = T.let(:png, OpenAI::ImageEditParams::OutputFormat::TaggedSymbol)
|
|
514
|
-
JPEG = T.let(:jpeg, OpenAI::ImageEditParams::OutputFormat::TaggedSymbol)
|
|
515
536
|
WEBP = T.let(:webp, OpenAI::ImageEditParams::OutputFormat::TaggedSymbol)
|
|
537
|
+
JPEG = T.let(:jpeg, OpenAI::ImageEditParams::OutputFormat::TaggedSymbol)
|
|
516
538
|
GIF = T.let(:gif, OpenAI::ImageEditParams::OutputFormat::TaggedSymbol)
|
|
539
|
+
SVG = T.let(:svg, OpenAI::ImageEditParams::OutputFormat::TaggedSymbol)
|
|
517
540
|
|
|
518
541
|
sig { override.returns(T::Array[OpenAI::ImageEditParams::OutputFormat::TaggedSymbol]) }
|
|
519
542
|
def self.values
|
|
@@ -594,6 +617,122 @@ module OpenAI
|
|
|
594
617
|
|
|
595
618
|
end
|
|
596
619
|
|
|
620
|
+
class Svg < OpenAI::Internal::Type::BaseModel
|
|
621
|
+
OrHash = T.type_alias do
|
|
622
|
+
T.any(
|
|
623
|
+
OpenAI::ImageEditParams::Svg,
|
|
624
|
+
OpenAI::Internal::AnyHash
|
|
625
|
+
)
|
|
626
|
+
end
|
|
627
|
+
|
|
628
|
+
sig { returns(T.nilable(String)) }
|
|
629
|
+
attr_reader :model
|
|
630
|
+
|
|
631
|
+
sig { params(model: String).void }
|
|
632
|
+
attr_writer :model
|
|
633
|
+
|
|
634
|
+
# Reasoning effort for SVG authoring. When omitted, uses the author model's
|
|
635
|
+
# default in both Images and Responses.
|
|
636
|
+
sig { returns(T.nilable(OpenAI::ImageEditParams::Svg::Reasoning)) }
|
|
637
|
+
attr_reader :reasoning
|
|
638
|
+
|
|
639
|
+
sig { params(reasoning: T.nilable(OpenAI::ImageEditParams::Svg::Reasoning::OrHash)).void }
|
|
640
|
+
attr_writer :reasoning
|
|
641
|
+
|
|
642
|
+
# Selects the author model and reasoning effort for `output_format=svg`. Supply
|
|
643
|
+
# `svg.model` when SVG model selection is enabled. Otherwise, omit this object.
|
|
644
|
+
# SVG output requires `n=1` and cannot use streaming, partial images, or output
|
|
645
|
+
# compression. Use multipart fields such as `svg[model]`.
|
|
646
|
+
sig do
|
|
647
|
+
params(
|
|
648
|
+
|
|
649
|
+
model: String,
|
|
650
|
+
|
|
651
|
+
reasoning: T.nilable(OpenAI::ImageEditParams::Svg::Reasoning::OrHash)
|
|
652
|
+
)
|
|
653
|
+
.returns(T.attached_class)
|
|
654
|
+
end
|
|
655
|
+
def self.new(
|
|
656
|
+
|
|
657
|
+
model: nil,
|
|
658
|
+
|
|
659
|
+
# Reasoning effort for SVG authoring. When omitted, uses the author model's
|
|
660
|
+
# default in both Images and Responses.
|
|
661
|
+
|
|
662
|
+
reasoning: nil
|
|
663
|
+
)
|
|
664
|
+
end
|
|
665
|
+
|
|
666
|
+
sig do
|
|
667
|
+
override.returns(
|
|
668
|
+
{model: String, reasoning: T.nilable(OpenAI::ImageEditParams::Svg::Reasoning)}
|
|
669
|
+
)
|
|
670
|
+
end
|
|
671
|
+
def to_hash
|
|
672
|
+
end
|
|
673
|
+
|
|
674
|
+
class Reasoning < OpenAI::Internal::Type::BaseModel
|
|
675
|
+
OrHash = T.type_alias do
|
|
676
|
+
T.any(
|
|
677
|
+
OpenAI::ImageEditParams::Svg::Reasoning,
|
|
678
|
+
OpenAI::Internal::AnyHash
|
|
679
|
+
)
|
|
680
|
+
end
|
|
681
|
+
|
|
682
|
+
# Controls how much effort the model should spend on reasoning for this request.
|
|
683
|
+
sig { returns(T.nilable(OpenAI::ImageEditParams::Svg::Reasoning::Effort::OrSymbol)) }
|
|
684
|
+
attr_reader :effort
|
|
685
|
+
|
|
686
|
+
sig { params(effort: OpenAI::ImageEditParams::Svg::Reasoning::Effort::OrSymbol).void }
|
|
687
|
+
attr_writer :effort
|
|
688
|
+
|
|
689
|
+
# Reasoning effort for SVG authoring. When omitted, uses the author model's
|
|
690
|
+
# default in both Images and Responses.
|
|
691
|
+
sig do
|
|
692
|
+
params(
|
|
693
|
+
|
|
694
|
+
effort: OpenAI::ImageEditParams::Svg::Reasoning::Effort::OrSymbol
|
|
695
|
+
)
|
|
696
|
+
.returns(T.attached_class)
|
|
697
|
+
end
|
|
698
|
+
def self.new(
|
|
699
|
+
|
|
700
|
+
# Controls how much effort the model should spend on reasoning for this request.
|
|
701
|
+
|
|
702
|
+
effort: nil
|
|
703
|
+
)
|
|
704
|
+
end
|
|
705
|
+
|
|
706
|
+
sig do
|
|
707
|
+
override.returns(
|
|
708
|
+
{effort: OpenAI::ImageEditParams::Svg::Reasoning::Effort::OrSymbol}
|
|
709
|
+
)
|
|
710
|
+
end
|
|
711
|
+
def to_hash
|
|
712
|
+
end
|
|
713
|
+
|
|
714
|
+
# Controls how much effort the model should spend on reasoning for this request.
|
|
715
|
+
module Effort
|
|
716
|
+
extend OpenAI::Internal::Type::Enum
|
|
717
|
+
|
|
718
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::ImageEditParams::Svg::Reasoning::Effort) }
|
|
719
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
720
|
+
|
|
721
|
+
NONE = T.let(:none, OpenAI::ImageEditParams::Svg::Reasoning::Effort::TaggedSymbol)
|
|
722
|
+
MINIMAL = T.let(:minimal, OpenAI::ImageEditParams::Svg::Reasoning::Effort::TaggedSymbol)
|
|
723
|
+
LOW = T.let(:low, OpenAI::ImageEditParams::Svg::Reasoning::Effort::TaggedSymbol)
|
|
724
|
+
MEDIUM = T.let(:medium, OpenAI::ImageEditParams::Svg::Reasoning::Effort::TaggedSymbol)
|
|
725
|
+
HIGH = T.let(:high, OpenAI::ImageEditParams::Svg::Reasoning::Effort::TaggedSymbol)
|
|
726
|
+
XHIGH = T.let(:xhigh, OpenAI::ImageEditParams::Svg::Reasoning::Effort::TaggedSymbol)
|
|
727
|
+
MAX = T.let(:max, OpenAI::ImageEditParams::Svg::Reasoning::Effort::TaggedSymbol)
|
|
728
|
+
|
|
729
|
+
sig { override.returns(T::Array[OpenAI::ImageEditParams::Svg::Reasoning::Effort::TaggedSymbol]) }
|
|
730
|
+
def self.values
|
|
731
|
+
end
|
|
732
|
+
end
|
|
733
|
+
end
|
|
734
|
+
end
|
|
735
|
+
|
|
597
736
|
end
|
|
598
737
|
|
|
599
738
|
end
|
|
@@ -141,7 +141,7 @@ module OpenAI
|
|
|
141
141
|
# enabled, supply svg.model. When model selection is disabled, omit this object.
|
|
142
142
|
# The top-level model selects the image model that creates the reference image.
|
|
143
143
|
# SVG generation requires n=1 and does not support streaming, partial images,
|
|
144
|
-
# prompt_rewriter, or output_compression.
|
|
144
|
+
# prompt_rewriter, or output_compression.
|
|
145
145
|
sig { returns(T.nilable(OpenAI::ImageGenerateParams::Svg)) }
|
|
146
146
|
attr_reader :svg
|
|
147
147
|
|
|
@@ -313,7 +313,7 @@ module OpenAI
|
|
|
313
313
|
# enabled, supply svg.model. When model selection is disabled, omit this object.
|
|
314
314
|
# The top-level model selects the image model that creates the reference image.
|
|
315
315
|
# SVG generation requires n=1 and does not support streaming, partial images,
|
|
316
|
-
# prompt_rewriter, or output_compression.
|
|
316
|
+
# prompt_rewriter, or output_compression.
|
|
317
317
|
svg: nil,
|
|
318
318
|
|
|
319
319
|
# Deprecated: use `safety_identifier` instead. This parameter remains accepted for
|
|
@@ -442,8 +442,8 @@ module OpenAI
|
|
|
442
442
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
443
443
|
|
|
444
444
|
PNG = T.let(:png, OpenAI::ImageGenerateParams::OutputFormat::TaggedSymbol)
|
|
445
|
-
JPEG = T.let(:jpeg, OpenAI::ImageGenerateParams::OutputFormat::TaggedSymbol)
|
|
446
445
|
WEBP = T.let(:webp, OpenAI::ImageGenerateParams::OutputFormat::TaggedSymbol)
|
|
446
|
+
JPEG = T.let(:jpeg, OpenAI::ImageGenerateParams::OutputFormat::TaggedSymbol)
|
|
447
447
|
GIF = T.let(:gif, OpenAI::ImageGenerateParams::OutputFormat::TaggedSymbol)
|
|
448
448
|
SVG = T.let(:svg, OpenAI::ImageGenerateParams::OutputFormat::TaggedSymbol)
|
|
449
449
|
|
|
@@ -573,7 +573,7 @@ module OpenAI
|
|
|
573
573
|
# enabled, supply svg.model. When model selection is disabled, omit this object.
|
|
574
574
|
# The top-level model selects the image model that creates the reference image.
|
|
575
575
|
# SVG generation requires n=1 and does not support streaming, partial images,
|
|
576
|
-
# prompt_rewriter, or output_compression.
|
|
576
|
+
# prompt_rewriter, or output_compression.
|
|
577
577
|
sig do
|
|
578
578
|
params(
|
|
579
579
|
|