openai 0.122.0 → 0.124.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 +24 -0
- data/README.md +1 -1
- 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_output_command_execution_output_delta_event.rb +10 -1
- data/lib/openai/models/beta/agent_session.rb +128 -4
- 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/agents/session_create_params.rb +69 -1
- 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 +69 -4
- 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/responses/input_token_count_params.rb +27 -15
- data/lib/openai/models/responses/response.rb +69 -4
- 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 +10 -3
- data/lib/openai/resources/beta/agents/sessions.rb +24 -5
- 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/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_output_command_execution_output_delta_event.rbi +14 -1
- data/rbi/openai/models/beta/agent_session.rbi +207 -0
- 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/agents/session_create_params.rbi +138 -0
- 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 +112 -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/responses/input_token_count_params.rbi +27 -15
- data/rbi/openai/models/responses/response.rbi +115 -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/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/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_output_command_execution_output_delta_event.rbs +13 -2
- data/sig/openai/models/beta/agent_session.rbs +126 -1
- 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/agents/session_create_params.rbs +78 -0
- 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 +73 -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/responses/input_token_count_params.rbs +27 -15
- data/sig/openai/models/responses/response.rbs +73 -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
|
@@ -10,7 +10,8 @@ module OpenAI
|
|
|
10
10
|
summary_index: Integer,
|
|
11
11
|
text: String,
|
|
12
12
|
turn_id: String?,
|
|
13
|
-
?type: :"agent.session.turn.reasoning_summary_text.done"
|
|
13
|
+
?type: :"agent.session.turn.reasoning_summary_text.done",
|
|
14
|
+
?obfuscation: String
|
|
14
15
|
}
|
|
15
16
|
|
|
16
17
|
class AgentSessionTurnReasoningSummaryTextDoneEvent < OpenAI::Internal::Type::BaseModel
|
|
@@ -38,6 +39,12 @@ module OpenAI
|
|
|
38
39
|
# The type of the object. Always `agent.session.turn.reasoning_summary_text.done`.
|
|
39
40
|
attr_accessor type: :"agent.session.turn.reasoning_summary_text.done"
|
|
40
41
|
|
|
42
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
43
|
+
attr_reader obfuscation: String?
|
|
44
|
+
|
|
45
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
46
|
+
def obfuscation=: (String) -> String
|
|
47
|
+
|
|
41
48
|
# @param event_id
|
|
42
49
|
# The unique ID of the event.
|
|
43
50
|
# @param item_id
|
|
@@ -52,6 +59,8 @@ module OpenAI
|
|
|
52
59
|
# The complete reasoning summary text.
|
|
53
60
|
# @param turn_id
|
|
54
61
|
# The ID of the turn associated with the event, when applicable.
|
|
62
|
+
# @param obfuscation
|
|
63
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
55
64
|
# @param type
|
|
56
65
|
# The type of the object. Always `agent.session.turn.reasoning_summary_text.done`.
|
|
57
66
|
def initialize: (
|
|
@@ -62,6 +71,7 @@ module OpenAI
|
|
|
62
71
|
summary_index: Integer,
|
|
63
72
|
text: String,
|
|
64
73
|
turn_id: String?,
|
|
74
|
+
?obfuscation: String,
|
|
65
75
|
?type: :"agent.session.turn.reasoning_summary_text.done"
|
|
66
76
|
) -> void
|
|
67
77
|
|
|
@@ -73,7 +83,8 @@ module OpenAI
|
|
|
73
83
|
summary_index: Integer,
|
|
74
84
|
text: String,
|
|
75
85
|
turn_id: String?,
|
|
76
|
-
?type: :"agent.session.turn.reasoning_summary_text.done"
|
|
86
|
+
?type: :"agent.session.turn.reasoning_summary_text.done",
|
|
87
|
+
?obfuscation: String
|
|
77
88
|
}
|
|
78
89
|
end
|
|
79
90
|
end
|
|
@@ -9,8 +9,10 @@ module OpenAI
|
|
|
9
9
|
?agent_id: String,
|
|
10
10
|
?input: OpenAI::Models::Beta::Agents::SessionCreateParams::input?,
|
|
11
11
|
?metadata: ::Hash[Symbol, String]?,
|
|
12
|
+
?prompt_cache_options: OpenAI::Beta::Agents::SessionCreateParams::PromptCacheOptions?,
|
|
12
13
|
?review: OpenAI::Models::Beta::Agents::SessionCreateParams::review,
|
|
13
14
|
?spend_control: OpenAI::Beta::Agents::SessionCreateParams::SpendControl?,
|
|
15
|
+
?stream_options: OpenAI::Beta::Agents::SessionCreateParams::StreamOptions,
|
|
14
16
|
?vault_ids: ::Array[String]?,
|
|
15
17
|
?request_options: OpenAI::request_opts
|
|
16
18
|
}
|
|
@@ -50,6 +52,10 @@ module OpenAI
|
|
|
50
52
|
# characters. Omission or null defaults to an empty map.
|
|
51
53
|
attr_accessor metadata: ::Hash[Symbol, String]?
|
|
52
54
|
|
|
55
|
+
# Default prompt cache lifetime for turns in this session. Omit to use the model
|
|
56
|
+
# default.
|
|
57
|
+
attr_accessor prompt_cache_options: OpenAI::Beta::Agents::SessionCreateParams::PromptCacheOptions?
|
|
58
|
+
|
|
53
59
|
# Action review mode. Omit to use none.
|
|
54
60
|
attr_reader review: OpenAI::Models::Beta::Agents::SessionCreateParams::review?
|
|
55
61
|
|
|
@@ -62,6 +68,14 @@ module OpenAI
|
|
|
62
68
|
# session.
|
|
63
69
|
attr_accessor spend_control: OpenAI::Beta::Agents::SessionCreateParams::SpendControl?
|
|
64
70
|
|
|
71
|
+
# Options for the event stream. Only allowed when `stream` is `true`.
|
|
72
|
+
attr_reader stream_options: OpenAI::Beta::Agents::SessionCreateParams::StreamOptions?
|
|
73
|
+
|
|
74
|
+
# Options for the event stream. Only allowed when `stream` is `true`.
|
|
75
|
+
def stream_options=: (
|
|
76
|
+
OpenAI::Beta::Agents::SessionCreateParams::StreamOptions
|
|
77
|
+
) -> OpenAI::Beta::Agents::SessionCreateParams::StreamOptions
|
|
78
|
+
|
|
65
79
|
# The IDs of vaults made available to the session.
|
|
66
80
|
attr_accessor vault_ids: ::Array[String]?
|
|
67
81
|
|
|
@@ -81,11 +95,16 @@ module OpenAI
|
|
|
81
95
|
# @param metadata
|
|
82
96
|
# Up to 16 string key-value pairs, with keys up to 64 and values up to 512
|
|
83
97
|
# characters. Omission or null defaults to an empty map.
|
|
98
|
+
# @param prompt_cache_options
|
|
99
|
+
# Default prompt cache lifetime for turns in this session. Omit to use the model
|
|
100
|
+
# default.
|
|
84
101
|
# @param review
|
|
85
102
|
# Action review mode. Omit to use none.
|
|
86
103
|
# @param spend_control
|
|
87
104
|
# Optional spending limit in USD cents. Omission or null creates an unlimited
|
|
88
105
|
# session.
|
|
106
|
+
# @param stream_options
|
|
107
|
+
# Options for the event stream. Only allowed when `stream` is `true`.
|
|
89
108
|
# @param vault_ids
|
|
90
109
|
# The IDs of vaults made available to the session.
|
|
91
110
|
def initialize: (
|
|
@@ -94,8 +113,10 @@ module OpenAI
|
|
|
94
113
|
?agent_id: String,
|
|
95
114
|
?input: OpenAI::Models::Beta::Agents::SessionCreateParams::input?,
|
|
96
115
|
?metadata: ::Hash[Symbol, String]?,
|
|
116
|
+
?prompt_cache_options: OpenAI::Beta::Agents::SessionCreateParams::PromptCacheOptions?,
|
|
97
117
|
?review: OpenAI::Models::Beta::Agents::SessionCreateParams::review,
|
|
98
118
|
?spend_control: OpenAI::Beta::Agents::SessionCreateParams::SpendControl?,
|
|
119
|
+
?stream_options: OpenAI::Beta::Agents::SessionCreateParams::StreamOptions,
|
|
99
120
|
?vault_ids: ::Array[String]?,
|
|
100
121
|
?request_options: OpenAI::request_opts
|
|
101
122
|
) -> void
|
|
@@ -106,8 +127,10 @@ module OpenAI
|
|
|
106
127
|
?agent_id: String,
|
|
107
128
|
?input: OpenAI::Models::Beta::Agents::SessionCreateParams::input?,
|
|
108
129
|
?metadata: ::Hash[Symbol, String]?,
|
|
130
|
+
?prompt_cache_options: OpenAI::Beta::Agents::SessionCreateParams::PromptCacheOptions?,
|
|
109
131
|
?review: OpenAI::Models::Beta::Agents::SessionCreateParams::review,
|
|
110
132
|
?spend_control: OpenAI::Beta::Agents::SessionCreateParams::SpendControl?,
|
|
133
|
+
?stream_options: OpenAI::Beta::Agents::SessionCreateParams::StreamOptions,
|
|
111
134
|
?vault_ids: ::Array[String]?,
|
|
112
135
|
?request_options: OpenAI::RequestOptions
|
|
113
136
|
}
|
|
@@ -293,6 +316,42 @@ module OpenAI
|
|
|
293
316
|
AgentSessionInputMessageParamArray: OpenAI::Internal::Type::Converter
|
|
294
317
|
end
|
|
295
318
|
|
|
319
|
+
type prompt_cache_options =
|
|
320
|
+
{
|
|
321
|
+
?ttl: OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions::ttl
|
|
322
|
+
}
|
|
323
|
+
|
|
324
|
+
class PromptCacheOptions < OpenAI::Internal::Type::BaseModel
|
|
325
|
+
# Minimum lifetime for new prompt cache entries. Defaults to 30 minutes.
|
|
326
|
+
attr_reader ttl: OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions::ttl?
|
|
327
|
+
|
|
328
|
+
# Minimum lifetime for new prompt cache entries. Defaults to 30 minutes.
|
|
329
|
+
def ttl=: (
|
|
330
|
+
OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions::ttl
|
|
331
|
+
) -> OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions::ttl
|
|
332
|
+
|
|
333
|
+
# @param ttl
|
|
334
|
+
# Minimum lifetime for new prompt cache entries. Defaults to 30 minutes.
|
|
335
|
+
def initialize: (
|
|
336
|
+
?ttl: OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions::ttl
|
|
337
|
+
) -> void
|
|
338
|
+
|
|
339
|
+
def to_hash: -> {
|
|
340
|
+
?ttl: OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions::ttl
|
|
341
|
+
}
|
|
342
|
+
|
|
343
|
+
type ttl = :"30m" | :"12h"
|
|
344
|
+
|
|
345
|
+
module Ttl
|
|
346
|
+
extend OpenAI::Internal::Type::Enum
|
|
347
|
+
|
|
348
|
+
TTL_30M: :"30m"
|
|
349
|
+
TTL_12H: :"12h"
|
|
350
|
+
|
|
351
|
+
def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions::ttl]
|
|
352
|
+
end
|
|
353
|
+
end
|
|
354
|
+
|
|
296
355
|
type review = :none | :auto_review
|
|
297
356
|
|
|
298
357
|
module Review
|
|
@@ -319,6 +378,25 @@ module OpenAI
|
|
|
319
378
|
|
|
320
379
|
def to_hash: -> { limit: Integer? }
|
|
321
380
|
end
|
|
381
|
+
|
|
382
|
+
type stream_options = { ?include_obfuscation: bool }
|
|
383
|
+
|
|
384
|
+
class StreamOptions < OpenAI::Internal::Type::BaseModel
|
|
385
|
+
# Whether to include obfuscation padding in events on this connection. Defaults to
|
|
386
|
+
# `true`.
|
|
387
|
+
attr_reader include_obfuscation: bool?
|
|
388
|
+
|
|
389
|
+
# Whether to include obfuscation padding in events on this connection. Defaults to
|
|
390
|
+
# `true`.
|
|
391
|
+
def include_obfuscation=: (bool) -> bool
|
|
392
|
+
|
|
393
|
+
# @param include_obfuscation
|
|
394
|
+
# Whether to include obfuscation padding in events on this connection. Defaults to
|
|
395
|
+
# `true`.
|
|
396
|
+
def initialize: (?include_obfuscation: bool) -> void
|
|
397
|
+
|
|
398
|
+
def to_hash: -> { ?include_obfuscation: bool }
|
|
399
|
+
end
|
|
322
400
|
end
|
|
323
401
|
end
|
|
324
402
|
end
|
|
@@ -7,6 +7,7 @@ module OpenAI
|
|
|
7
7
|
session_id: String,
|
|
8
8
|
?agent: OpenAI::Beta::Agents::SessionUpdateParams::Agent,
|
|
9
9
|
?metadata: ::Hash[Symbol, String]?,
|
|
10
|
+
?prompt_cache_options: OpenAI::Beta::Agents::SessionUpdateParams::PromptCacheOptions?,
|
|
10
11
|
?review: OpenAI::Models::Beta::Agents::SessionUpdateParams::review,
|
|
11
12
|
?spend_control: OpenAI::Beta::Agents::SessionUpdateParams::SpendControl?,
|
|
12
13
|
?request_options: OpenAI::request_opts
|
|
@@ -31,6 +32,10 @@ module OpenAI
|
|
|
31
32
|
# characters.
|
|
32
33
|
attr_accessor metadata: ::Hash[Symbol, String]?
|
|
33
34
|
|
|
35
|
+
# Default prompt cache lifetime for future turns. Send null to clear the session
|
|
36
|
+
# default.
|
|
37
|
+
attr_accessor prompt_cache_options: OpenAI::Beta::Agents::SessionUpdateParams::PromptCacheOptions?
|
|
38
|
+
|
|
34
39
|
# Default action review for new root turns. Existing turns and their subagents
|
|
35
40
|
# keep their review mode.
|
|
36
41
|
attr_reader review: OpenAI::Models::Beta::Agents::SessionUpdateParams::review?
|
|
@@ -51,6 +56,9 @@ module OpenAI
|
|
|
51
56
|
# Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it.
|
|
52
57
|
# Up to 16 string key-value pairs, with keys up to 64 and values up to 512
|
|
53
58
|
# characters.
|
|
59
|
+
# @param prompt_cache_options
|
|
60
|
+
# Default prompt cache lifetime for future turns. Send null to clear the session
|
|
61
|
+
# default.
|
|
54
62
|
# @param review
|
|
55
63
|
# Default action review for new root turns. Existing turns and their subagents
|
|
56
64
|
# keep their review mode.
|
|
@@ -61,6 +69,7 @@ module OpenAI
|
|
|
61
69
|
session_id: String,
|
|
62
70
|
?agent: OpenAI::Beta::Agents::SessionUpdateParams::Agent,
|
|
63
71
|
?metadata: ::Hash[Symbol, String]?,
|
|
72
|
+
?prompt_cache_options: OpenAI::Beta::Agents::SessionUpdateParams::PromptCacheOptions?,
|
|
64
73
|
?review: OpenAI::Models::Beta::Agents::SessionUpdateParams::review,
|
|
65
74
|
?spend_control: OpenAI::Beta::Agents::SessionUpdateParams::SpendControl?,
|
|
66
75
|
?request_options: OpenAI::request_opts
|
|
@@ -70,6 +79,7 @@ module OpenAI
|
|
|
70
79
|
session_id: String,
|
|
71
80
|
?agent: OpenAI::Beta::Agents::SessionUpdateParams::Agent,
|
|
72
81
|
?metadata: ::Hash[Symbol, String]?,
|
|
82
|
+
?prompt_cache_options: OpenAI::Beta::Agents::SessionUpdateParams::PromptCacheOptions?,
|
|
73
83
|
?review: OpenAI::Models::Beta::Agents::SessionUpdateParams::review,
|
|
74
84
|
?spend_control: OpenAI::Beta::Agents::SessionUpdateParams::SpendControl?,
|
|
75
85
|
?request_options: OpenAI::RequestOptions
|
|
@@ -195,6 +205,42 @@ module OpenAI
|
|
|
195
205
|
end
|
|
196
206
|
end
|
|
197
207
|
|
|
208
|
+
type prompt_cache_options =
|
|
209
|
+
{
|
|
210
|
+
?ttl: OpenAI::Models::Beta::Agents::SessionUpdateParams::PromptCacheOptions::ttl
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
class PromptCacheOptions < OpenAI::Internal::Type::BaseModel
|
|
214
|
+
# Minimum lifetime for new prompt cache entries. Defaults to 30 minutes.
|
|
215
|
+
attr_reader ttl: OpenAI::Models::Beta::Agents::SessionUpdateParams::PromptCacheOptions::ttl?
|
|
216
|
+
|
|
217
|
+
# Minimum lifetime for new prompt cache entries. Defaults to 30 minutes.
|
|
218
|
+
def ttl=: (
|
|
219
|
+
OpenAI::Models::Beta::Agents::SessionUpdateParams::PromptCacheOptions::ttl
|
|
220
|
+
) -> OpenAI::Models::Beta::Agents::SessionUpdateParams::PromptCacheOptions::ttl
|
|
221
|
+
|
|
222
|
+
# @param ttl
|
|
223
|
+
# Minimum lifetime for new prompt cache entries. Defaults to 30 minutes.
|
|
224
|
+
def initialize: (
|
|
225
|
+
?ttl: OpenAI::Models::Beta::Agents::SessionUpdateParams::PromptCacheOptions::ttl
|
|
226
|
+
) -> void
|
|
227
|
+
|
|
228
|
+
def to_hash: -> {
|
|
229
|
+
?ttl: OpenAI::Models::Beta::Agents::SessionUpdateParams::PromptCacheOptions::ttl
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
type ttl = :"30m" | :"12h"
|
|
233
|
+
|
|
234
|
+
module Ttl
|
|
235
|
+
extend OpenAI::Internal::Type::Enum
|
|
236
|
+
|
|
237
|
+
TTL_30M: :"30m"
|
|
238
|
+
TTL_12H: :"12h"
|
|
239
|
+
|
|
240
|
+
def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::SessionUpdateParams::PromptCacheOptions::ttl]
|
|
241
|
+
end
|
|
242
|
+
end
|
|
243
|
+
|
|
198
244
|
type review = :none | :auto_review
|
|
199
245
|
|
|
200
246
|
module Review
|
|
@@ -4,7 +4,11 @@ module OpenAI
|
|
|
4
4
|
module Agents
|
|
5
5
|
module Sessions
|
|
6
6
|
type event_stream_params =
|
|
7
|
-
{
|
|
7
|
+
{
|
|
8
|
+
session_id: String,
|
|
9
|
+
?include_obfuscation: bool,
|
|
10
|
+
?request_options: OpenAI::request_opts
|
|
11
|
+
}
|
|
8
12
|
|
|
9
13
|
class EventStreamParams < OpenAI::Internal::Type::BaseModel
|
|
10
14
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
@@ -12,13 +16,26 @@ module OpenAI
|
|
|
12
16
|
|
|
13
17
|
attr_accessor session_id: String
|
|
14
18
|
|
|
19
|
+
# Whether to include obfuscation padding in events on this connection. Defaults to
|
|
20
|
+
# `true`.
|
|
21
|
+
attr_reader include_obfuscation: bool?
|
|
22
|
+
|
|
23
|
+
# Whether to include obfuscation padding in events on this connection. Defaults to
|
|
24
|
+
# `true`.
|
|
25
|
+
def include_obfuscation=: (bool) -> bool
|
|
26
|
+
|
|
27
|
+
# @param include_obfuscation
|
|
28
|
+
# Whether to include obfuscation padding in events on this connection. Defaults to
|
|
29
|
+
# `true`.
|
|
15
30
|
def initialize: (
|
|
16
31
|
session_id: String,
|
|
32
|
+
?include_obfuscation: bool,
|
|
17
33
|
?request_options: OpenAI::request_opts
|
|
18
34
|
) -> void
|
|
19
35
|
|
|
20
36
|
def to_hash: -> {
|
|
21
37
|
session_id: String,
|
|
38
|
+
?include_obfuscation: bool,
|
|
22
39
|
?request_options: OpenAI::RequestOptions
|
|
23
40
|
}
|
|
24
41
|
end
|
|
@@ -15,7 +15,8 @@ module OpenAI
|
|
|
15
15
|
started_at: Integer?,
|
|
16
16
|
status: OpenAI::Models::Beta::Agents::Sessions::Turn::status,
|
|
17
17
|
subagent_id: String?,
|
|
18
|
-
usage: OpenAI::Beta::TokenUsage
|
|
18
|
+
usage: OpenAI::Beta::TokenUsage?,
|
|
19
|
+
?prompt_cache_options: OpenAI::Beta::Agents::Sessions::Turn::PromptCacheOptions?
|
|
19
20
|
}
|
|
20
21
|
|
|
21
22
|
class Turn < OpenAI::Internal::Type::BaseModel
|
|
@@ -55,6 +56,10 @@ module OpenAI
|
|
|
55
56
|
# change.
|
|
56
57
|
attr_accessor usage: OpenAI::Beta::TokenUsage?
|
|
57
58
|
|
|
59
|
+
# Prompt cache lifetime selected when this turn started, including an inherited
|
|
60
|
+
# session TTL. Null when the turn used the model default or no TTL was recorded.
|
|
61
|
+
attr_accessor prompt_cache_options: OpenAI::Beta::Agents::Sessions::Turn::PromptCacheOptions?
|
|
62
|
+
|
|
58
63
|
# @param id
|
|
59
64
|
# The ID of the turn.
|
|
60
65
|
# @param agent_id
|
|
@@ -78,6 +83,9 @@ module OpenAI
|
|
|
78
83
|
# @param usage
|
|
79
84
|
# Best-effort token usage for the turn, or null if unknown. Recorded usage may
|
|
80
85
|
# change.
|
|
86
|
+
# @param prompt_cache_options
|
|
87
|
+
# Prompt cache lifetime selected when this turn started, including an inherited
|
|
88
|
+
# session TTL. Null when the turn used the model default or no TTL was recorded.
|
|
81
89
|
# @param object
|
|
82
90
|
# The object type. Always `agent.session.turn`.
|
|
83
91
|
def initialize: (
|
|
@@ -91,6 +99,7 @@ module OpenAI
|
|
|
91
99
|
status: OpenAI::Models::Beta::Agents::Sessions::Turn::status,
|
|
92
100
|
subagent_id: String?,
|
|
93
101
|
usage: OpenAI::Beta::TokenUsage?,
|
|
102
|
+
?prompt_cache_options: OpenAI::Beta::Agents::Sessions::Turn::PromptCacheOptions?,
|
|
94
103
|
?object: :"agent.session.turn"
|
|
95
104
|
) -> void
|
|
96
105
|
|
|
@@ -105,7 +114,8 @@ module OpenAI
|
|
|
105
114
|
started_at: Integer?,
|
|
106
115
|
status: OpenAI::Models::Beta::Agents::Sessions::Turn::status,
|
|
107
116
|
subagent_id: String?,
|
|
108
|
-
usage: OpenAI::Beta::TokenUsage
|
|
117
|
+
usage: OpenAI::Beta::TokenUsage?,
|
|
118
|
+
?prompt_cache_options: OpenAI::Beta::Agents::Sessions::Turn::PromptCacheOptions?
|
|
109
119
|
}
|
|
110
120
|
|
|
111
121
|
type status =
|
|
@@ -139,6 +149,34 @@ module OpenAI
|
|
|
139
149
|
|
|
140
150
|
def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::Sessions::Turn::status]
|
|
141
151
|
end
|
|
152
|
+
|
|
153
|
+
type prompt_cache_options =
|
|
154
|
+
{
|
|
155
|
+
ttl: OpenAI::Models::Beta::Agents::Sessions::Turn::PromptCacheOptions::ttl
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
class PromptCacheOptions < OpenAI::Internal::Type::BaseModel
|
|
159
|
+
attr_accessor ttl: OpenAI::Models::Beta::Agents::Sessions::Turn::PromptCacheOptions::ttl
|
|
160
|
+
|
|
161
|
+
def initialize: (
|
|
162
|
+
ttl: OpenAI::Models::Beta::Agents::Sessions::Turn::PromptCacheOptions::ttl
|
|
163
|
+
) -> void
|
|
164
|
+
|
|
165
|
+
def to_hash: -> {
|
|
166
|
+
ttl: OpenAI::Models::Beta::Agents::Sessions::Turn::PromptCacheOptions::ttl
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
type ttl = :"30m" | :"12h"
|
|
170
|
+
|
|
171
|
+
module Ttl
|
|
172
|
+
extend OpenAI::Internal::Type::Enum
|
|
173
|
+
|
|
174
|
+
TTL_30M: :"30m"
|
|
175
|
+
TTL_12H: :"12h"
|
|
176
|
+
|
|
177
|
+
def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::Sessions::Turn::PromptCacheOptions::ttl]
|
|
178
|
+
end
|
|
179
|
+
end
|
|
142
180
|
end
|
|
143
181
|
end
|
|
144
182
|
end
|
|
@@ -24,6 +24,7 @@ module OpenAI
|
|
|
24
24
|
?completed_at: Float?,
|
|
25
25
|
?conversation: OpenAI::Beta::BetaResponse::Conversation?,
|
|
26
26
|
?image: OpenAI::Beta::BetaResponse::Image,
|
|
27
|
+
?input_transformations: ::Array[OpenAI::Beta::BetaResponse::InputTransformation],
|
|
27
28
|
?max_output_tokens: Integer?,
|
|
28
29
|
?max_tool_calls: Integer?,
|
|
29
30
|
?moderation: OpenAI::Beta::BetaResponse::Moderation?,
|
|
@@ -155,6 +156,14 @@ module OpenAI
|
|
|
155
156
|
OpenAI::Beta::BetaResponse::Image
|
|
156
157
|
) -> OpenAI::Beta::BetaResponse::Image
|
|
157
158
|
|
|
159
|
+
# Reasoning inputs withheld from the model, in input order.
|
|
160
|
+
attr_reader input_transformations: ::Array[OpenAI::Beta::BetaResponse::InputTransformation]?
|
|
161
|
+
|
|
162
|
+
# Reasoning inputs withheld from the model, in input order.
|
|
163
|
+
def input_transformations=: (
|
|
164
|
+
::Array[OpenAI::Beta::BetaResponse::InputTransformation]
|
|
165
|
+
) -> ::Array[OpenAI::Beta::BetaResponse::InputTransformation]
|
|
166
|
+
|
|
158
167
|
# An upper bound for the number of tokens that can be generated for a response,
|
|
159
168
|
# including visible output tokens and
|
|
160
169
|
# [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).
|
|
@@ -327,7 +336,9 @@ module OpenAI
|
|
|
327
336
|
#
|
|
328
337
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
329
338
|
# the model will truncate the response to fit the context window by dropping
|
|
330
|
-
# items from the beginning of the conversation.
|
|
339
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
340
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
341
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
331
342
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
332
343
|
# for a model, the request will fail with a 400 error.
|
|
333
344
|
attr_accessor truncation: OpenAI::Models::Beta::BetaResponse::truncation?
|
|
@@ -438,6 +449,8 @@ module OpenAI
|
|
|
438
449
|
# @param conversation
|
|
439
450
|
# The conversation that this response belonged to. Input items and output items
|
|
440
451
|
# from this response were automatically added to this conversation.
|
|
452
|
+
# @param input_transformations
|
|
453
|
+
# Reasoning inputs withheld from the model, in input order.
|
|
441
454
|
# @param max_output_tokens
|
|
442
455
|
# An upper bound for the number of tokens that can be generated for a response,
|
|
443
456
|
# including visible output tokens and
|
|
@@ -553,7 +566,9 @@ module OpenAI
|
|
|
553
566
|
#
|
|
554
567
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
555
568
|
# the model will truncate the response to fit the context window by dropping
|
|
556
|
-
# items from the beginning of the conversation.
|
|
569
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
570
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
571
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
557
572
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
558
573
|
# for a model, the request will fail with a 400 error.
|
|
559
574
|
# @param usage
|
|
@@ -586,6 +601,7 @@ module OpenAI
|
|
|
586
601
|
?completed_at: Float?,
|
|
587
602
|
?conversation: OpenAI::Beta::BetaResponse::Conversation?,
|
|
588
603
|
?image: OpenAI::Beta::BetaResponse::Image,
|
|
604
|
+
?input_transformations: ::Array[OpenAI::Beta::BetaResponse::InputTransformation],
|
|
589
605
|
?max_output_tokens: Integer?,
|
|
590
606
|
?max_tool_calls: Integer?,
|
|
591
607
|
?moderation: OpenAI::Beta::BetaResponse::Moderation?,
|
|
@@ -628,6 +644,7 @@ module OpenAI
|
|
|
628
644
|
?completed_at: Float?,
|
|
629
645
|
?conversation: OpenAI::Beta::BetaResponse::Conversation?,
|
|
630
646
|
?image: OpenAI::Beta::BetaResponse::Image,
|
|
647
|
+
?input_transformations: ::Array[OpenAI::Beta::BetaResponse::InputTransformation],
|
|
631
648
|
?max_output_tokens: Integer?,
|
|
632
649
|
?max_tool_calls: Integer?,
|
|
633
650
|
?moderation: OpenAI::Beta::BetaResponse::Moderation?,
|
|
@@ -1042,6 +1059,60 @@ module OpenAI
|
|
|
1042
1059
|
end
|
|
1043
1060
|
end
|
|
1044
1061
|
|
|
1062
|
+
type input_transformation =
|
|
1063
|
+
{
|
|
1064
|
+
id: String,
|
|
1065
|
+
?action: :removed,
|
|
1066
|
+
reason: OpenAI::Models::Beta::BetaResponse::InputTransformation::reason,
|
|
1067
|
+
?type: :reasoning
|
|
1068
|
+
}
|
|
1069
|
+
|
|
1070
|
+
class InputTransformation < OpenAI::Internal::Type::BaseModel
|
|
1071
|
+
# The original reasoning item ID.
|
|
1072
|
+
attr_accessor id: String
|
|
1073
|
+
|
|
1074
|
+
attr_accessor action: :removed
|
|
1075
|
+
|
|
1076
|
+
attr_accessor reason: OpenAI::Models::Beta::BetaResponse::InputTransformation::reason
|
|
1077
|
+
|
|
1078
|
+
attr_accessor type: :reasoning
|
|
1079
|
+
|
|
1080
|
+
# @param id
|
|
1081
|
+
# The original reasoning item ID.
|
|
1082
|
+
def initialize: (
|
|
1083
|
+
id: String,
|
|
1084
|
+
reason: OpenAI::Models::Beta::BetaResponse::InputTransformation::reason,
|
|
1085
|
+
?action: :removed,
|
|
1086
|
+
?type: :reasoning
|
|
1087
|
+
) -> void
|
|
1088
|
+
|
|
1089
|
+
def to_hash: -> {
|
|
1090
|
+
id: String,
|
|
1091
|
+
?action: :removed,
|
|
1092
|
+
reason: OpenAI::Models::Beta::BetaResponse::InputTransformation::reason,
|
|
1093
|
+
?type: :reasoning
|
|
1094
|
+
}
|
|
1095
|
+
|
|
1096
|
+
type reason =
|
|
1097
|
+
:organization_mismatch
|
|
1098
|
+
| :end_user_mismatch
|
|
1099
|
+
| :model_mismatch
|
|
1100
|
+
| :prefix_mismatch
|
|
1101
|
+
| :turn_boundary
|
|
1102
|
+
|
|
1103
|
+
module Reason
|
|
1104
|
+
extend OpenAI::Internal::Type::Enum
|
|
1105
|
+
|
|
1106
|
+
ORGANIZATION_MISMATCH: :organization_mismatch
|
|
1107
|
+
END_USER_MISMATCH: :end_user_mismatch
|
|
1108
|
+
MODEL_MISMATCH: :model_mismatch
|
|
1109
|
+
PREFIX_MISMATCH: :prefix_mismatch
|
|
1110
|
+
TURN_BOUNDARY: :turn_boundary
|
|
1111
|
+
|
|
1112
|
+
def self?.values: -> ::Array[OpenAI::Models::Beta::BetaResponse::InputTransformation::reason]
|
|
1113
|
+
end
|
|
1114
|
+
end
|
|
1115
|
+
|
|
1045
1116
|
type moderation =
|
|
1046
1117
|
{
|
|
1047
1118
|
input: OpenAI::Models::Beta::BetaResponse::Moderation::input,
|
|
@@ -772,7 +772,8 @@ module OpenAI
|
|
|
772
772
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
773
773
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
774
774
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
775
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
775
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
776
|
+
# `gpt-image-2.6-sunburst`.
|
|
776
777
|
#
|
|
777
778
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
778
779
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -782,7 +783,8 @@ module OpenAI
|
|
|
782
783
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
783
784
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
784
785
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
785
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
786
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
787
|
+
# `gpt-image-2.6-sunburst`.
|
|
786
788
|
#
|
|
787
789
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
788
790
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -920,7 +922,8 @@ module OpenAI
|
|
|
920
922
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
921
923
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
922
924
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
923
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
925
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
926
|
+
# `gpt-image-2.6-sunburst`.
|
|
924
927
|
#
|
|
925
928
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
926
929
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -415,7 +415,9 @@ module OpenAI
|
|
|
415
415
|
#
|
|
416
416
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
417
417
|
# the model will truncate the response to fit the context window by dropping
|
|
418
|
-
# items from the beginning of the conversation.
|
|
418
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
419
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
420
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
419
421
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
420
422
|
# for a model, the request will fail with a 400 error.
|
|
421
423
|
attr_accessor truncation: OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::truncation?
|
|
@@ -663,7 +665,9 @@ module OpenAI
|
|
|
663
665
|
#
|
|
664
666
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
665
667
|
# the model will truncate the response to fit the context window by dropping
|
|
666
|
-
# items from the beginning of the conversation.
|
|
668
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
669
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
670
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
667
671
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
668
672
|
# for a model, the request will fail with a 400 error.
|
|
669
673
|
# @param user
|
|
@@ -697,7 +697,8 @@ module OpenAI
|
|
|
697
697
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
698
698
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
699
699
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
700
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
700
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
701
|
+
# `gpt-image-2.6-sunburst`.
|
|
701
702
|
#
|
|
702
703
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
703
704
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -707,7 +708,8 @@ module OpenAI
|
|
|
707
708
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
708
709
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
709
710
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
710
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
711
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
712
|
+
# `gpt-image-2.6-sunburst`.
|
|
711
713
|
#
|
|
712
714
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
713
715
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -845,7 +847,8 @@ module OpenAI
|
|
|
845
847
|
# `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
|
|
846
848
|
# `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
|
|
847
849
|
# `gpt-image-2.5-flare-2026-09-08`, `gpt-image-2.6-sunburst`,
|
|
848
|
-
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
850
|
+
# `gpt-image-2.6-flare`, or `chatgpt-image-latest`. Default:
|
|
851
|
+
# `gpt-image-2.6-sunburst`.
|
|
849
852
|
#
|
|
850
853
|
# `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
|
|
851
854
|
# `gpt-image-2.5-flare` instead.
|
|
@@ -373,7 +373,9 @@ module OpenAI
|
|
|
373
373
|
#
|
|
374
374
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
375
375
|
# the model will truncate the response to fit the context window by dropping
|
|
376
|
-
# items from the beginning of the conversation.
|
|
376
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
377
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
378
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
377
379
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
378
380
|
# for a model, the request will fail with a 400 error.
|
|
379
381
|
attr_accessor truncation: OpenAI::Models::Beta::ResponseCreateParams::truncation?
|
|
@@ -610,7 +612,9 @@ module OpenAI
|
|
|
610
612
|
#
|
|
611
613
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
612
614
|
# the model will truncate the response to fit the context window by dropping
|
|
613
|
-
# items from the beginning of the conversation.
|
|
615
|
+
# items from the beginning of the conversation. On some models, trimming can
|
|
616
|
+
# begin earlier because the API subtracts the model's maximum output allowance
|
|
617
|
+
# from its input limit, even if you set a lower `max_output_tokens`.
|
|
614
618
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
615
619
|
# for a model, the request will fail with a 400 error.
|
|
616
620
|
# @param user
|