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
|
@@ -99,8 +99,7 @@ module OpenAI
|
|
|
99
99
|
|
|
100
100
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
101
101
|
# Context compaction settings. Omit to keep the current settings. A supplied
|
|
102
|
-
# object replaces the settings; null or an empty object
|
|
103
|
-
# compaction.
|
|
102
|
+
# object replaces the settings; null or an empty object uses blocking compaction.
|
|
104
103
|
attr_accessor compaction: OpenAI::Beta::Agents::AutomationTargetParam::NewSession::Agent::Compaction?
|
|
105
104
|
|
|
106
105
|
# Experimental settings to merge by key. Omitted settings keep their current
|
|
@@ -143,8 +142,7 @@ module OpenAI
|
|
|
143
142
|
|
|
144
143
|
# @param compaction
|
|
145
144
|
# Context compaction settings. Omit to keep the current settings. A supplied
|
|
146
|
-
# object replaces the settings; null or an empty object
|
|
147
|
-
# compaction.
|
|
145
|
+
# object replaces the settings; null or an empty object uses blocking compaction.
|
|
148
146
|
# @param experimental
|
|
149
147
|
# Experimental settings to merge by key. Omitted settings keep their current
|
|
150
148
|
# values.
|
|
@@ -193,15 +191,15 @@ module OpenAI
|
|
|
193
191
|
type compaction = { ?async: bool? }
|
|
194
192
|
|
|
195
193
|
class Compaction < OpenAI::Internal::Type::BaseModel
|
|
196
|
-
# Whether to compact context in the background. Omission or null defaults to
|
|
197
|
-
# Set to
|
|
198
|
-
# token usage.
|
|
194
|
+
# Whether to compact context in the background. Omission or null defaults to
|
|
195
|
+
# false. Set to true to enable background compaction. Background compaction may
|
|
196
|
+
# increase token usage.
|
|
199
197
|
attr_accessor async: bool?
|
|
200
198
|
|
|
201
199
|
# @param async
|
|
202
|
-
# Whether to compact context in the background. Omission or null defaults to
|
|
203
|
-
# Set to
|
|
204
|
-
# token usage.
|
|
200
|
+
# Whether to compact context in the background. Omission or null defaults to
|
|
201
|
+
# false. Set to true to enable background compaction. Background compaction may
|
|
202
|
+
# increase token usage.
|
|
205
203
|
def initialize: (?async: bool?) -> void
|
|
206
204
|
|
|
207
205
|
def to_hash: -> { ?async: bool? }
|
|
@@ -13,7 +13,8 @@ module OpenAI
|
|
|
13
13
|
run_at: Integer,
|
|
14
14
|
status: OpenAI::Models::Beta::Agents::OneTimeAutomation::status,
|
|
15
15
|
target: OpenAI::Models::Beta::Agents::automation_target,
|
|
16
|
-
?type: :once
|
|
16
|
+
?type: :once,
|
|
17
|
+
?pause_reason: OpenAI::Models::Beta::Agents::OneTimeAutomation::pause_reason?
|
|
17
18
|
}
|
|
18
19
|
|
|
19
20
|
class OneTimeAutomation < OpenAI::Internal::Type::BaseModel
|
|
@@ -47,6 +48,9 @@ module OpenAI
|
|
|
47
48
|
# The type of the object. Always `once`.
|
|
48
49
|
attr_accessor type: :once
|
|
49
50
|
|
|
51
|
+
# Why the service paused this schedule, or null for other schedules.
|
|
52
|
+
attr_accessor pause_reason: OpenAI::Models::Beta::Agents::OneTimeAutomation::pause_reason?
|
|
53
|
+
|
|
50
54
|
# @param id
|
|
51
55
|
# The automation ID.
|
|
52
56
|
# @param created_at
|
|
@@ -63,6 +67,8 @@ module OpenAI
|
|
|
63
67
|
# Completion means the schedule has finished, not the agent's work.
|
|
64
68
|
# @param target
|
|
65
69
|
# The session configuration or existing session receiving invocations.
|
|
70
|
+
# @param pause_reason
|
|
71
|
+
# Why the service paused this schedule, or null for other schedules.
|
|
66
72
|
# @param object
|
|
67
73
|
# Always `agent.automation`.
|
|
68
74
|
# @param type
|
|
@@ -76,6 +82,7 @@ module OpenAI
|
|
|
76
82
|
run_at: Integer,
|
|
77
83
|
status: OpenAI::Models::Beta::Agents::OneTimeAutomation::status,
|
|
78
84
|
target: OpenAI::Models::Beta::Agents::automation_target,
|
|
85
|
+
?pause_reason: OpenAI::Models::Beta::Agents::OneTimeAutomation::pause_reason?,
|
|
79
86
|
?object: :"agent.automation",
|
|
80
87
|
?type: :once
|
|
81
88
|
) -> void
|
|
@@ -90,7 +97,8 @@ module OpenAI
|
|
|
90
97
|
run_at: Integer,
|
|
91
98
|
status: OpenAI::Models::Beta::Agents::OneTimeAutomation::status,
|
|
92
99
|
target: OpenAI::Models::Beta::Agents::automation_target,
|
|
93
|
-
?type: :once
|
|
100
|
+
?type: :once,
|
|
101
|
+
?pause_reason: OpenAI::Models::Beta::Agents::OneTimeAutomation::pause_reason?
|
|
94
102
|
}
|
|
95
103
|
|
|
96
104
|
type status = :active | :paused | :completed
|
|
@@ -104,6 +112,16 @@ module OpenAI
|
|
|
104
112
|
|
|
105
113
|
def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::OneTimeAutomation::status]
|
|
106
114
|
end
|
|
115
|
+
|
|
116
|
+
type pause_reason = :target_session_failed
|
|
117
|
+
|
|
118
|
+
module PauseReason
|
|
119
|
+
extend OpenAI::Internal::Type::Enum
|
|
120
|
+
|
|
121
|
+
TARGET_SESSION_FAILED: :target_session_failed
|
|
122
|
+
|
|
123
|
+
def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::OneTimeAutomation::pause_reason]
|
|
124
|
+
end
|
|
107
125
|
end
|
|
108
126
|
end
|
|
109
127
|
end
|
|
@@ -14,7 +14,8 @@ module OpenAI
|
|
|
14
14
|
status: OpenAI::Models::Beta::Agents::PeriodicAutomation::status,
|
|
15
15
|
target: OpenAI::Models::Beta::Agents::automation_target,
|
|
16
16
|
timezone: String,
|
|
17
|
-
?type: :periodic
|
|
17
|
+
?type: :periodic,
|
|
18
|
+
?pause_reason: OpenAI::Models::Beta::Agents::PeriodicAutomation::pause_reason?
|
|
18
19
|
}
|
|
19
20
|
|
|
20
21
|
class PeriodicAutomation < OpenAI::Internal::Type::BaseModel
|
|
@@ -51,6 +52,9 @@ module OpenAI
|
|
|
51
52
|
# The type of the object. Always `periodic`.
|
|
52
53
|
attr_accessor type: :periodic
|
|
53
54
|
|
|
55
|
+
# Why the service paused this schedule, or null for other schedules.
|
|
56
|
+
attr_accessor pause_reason: OpenAI::Models::Beta::Agents::PeriodicAutomation::pause_reason?
|
|
57
|
+
|
|
54
58
|
# @param id
|
|
55
59
|
# The automation ID.
|
|
56
60
|
# @param created_at
|
|
@@ -69,6 +73,8 @@ module OpenAI
|
|
|
69
73
|
# The session configuration or existing session receiving invocations.
|
|
70
74
|
# @param timezone
|
|
71
75
|
# The timezone used to interpret the expression.
|
|
76
|
+
# @param pause_reason
|
|
77
|
+
# Why the service paused this schedule, or null for other schedules.
|
|
72
78
|
# @param object
|
|
73
79
|
# Always `agent.automation`.
|
|
74
80
|
# @param type
|
|
@@ -83,6 +89,7 @@ module OpenAI
|
|
|
83
89
|
status: OpenAI::Models::Beta::Agents::PeriodicAutomation::status,
|
|
84
90
|
target: OpenAI::Models::Beta::Agents::automation_target,
|
|
85
91
|
timezone: String,
|
|
92
|
+
?pause_reason: OpenAI::Models::Beta::Agents::PeriodicAutomation::pause_reason?,
|
|
86
93
|
?object: :"agent.automation",
|
|
87
94
|
?type: :periodic
|
|
88
95
|
) -> void
|
|
@@ -98,7 +105,8 @@ module OpenAI
|
|
|
98
105
|
status: OpenAI::Models::Beta::Agents::PeriodicAutomation::status,
|
|
99
106
|
target: OpenAI::Models::Beta::Agents::automation_target,
|
|
100
107
|
timezone: String,
|
|
101
|
-
?type: :periodic
|
|
108
|
+
?type: :periodic,
|
|
109
|
+
?pause_reason: OpenAI::Models::Beta::Agents::PeriodicAutomation::pause_reason?
|
|
102
110
|
}
|
|
103
111
|
|
|
104
112
|
type status = :active | :paused
|
|
@@ -111,6 +119,16 @@ module OpenAI
|
|
|
111
119
|
|
|
112
120
|
def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::PeriodicAutomation::status]
|
|
113
121
|
end
|
|
122
|
+
|
|
123
|
+
type pause_reason = :target_session_failed
|
|
124
|
+
|
|
125
|
+
module PauseReason
|
|
126
|
+
extend OpenAI::Internal::Type::Enum
|
|
127
|
+
|
|
128
|
+
TARGET_SESSION_FAILED: :target_session_failed
|
|
129
|
+
|
|
130
|
+
def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::PeriodicAutomation::pause_reason]
|
|
131
|
+
end
|
|
114
132
|
end
|
|
115
133
|
end
|
|
116
134
|
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
|
}
|
|
@@ -127,8 +150,7 @@ module OpenAI
|
|
|
127
150
|
|
|
128
151
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
129
152
|
# Context compaction settings. Omit to keep the current settings. A supplied
|
|
130
|
-
# object replaces the settings; null or an empty object
|
|
131
|
-
# compaction.
|
|
153
|
+
# object replaces the settings; null or an empty object uses blocking compaction.
|
|
132
154
|
attr_accessor compaction: OpenAI::Beta::Agents::SessionCreateParams::Agent::Compaction?
|
|
133
155
|
|
|
134
156
|
# Experimental settings to merge by key. Omitted settings keep their current
|
|
@@ -171,8 +193,7 @@ module OpenAI
|
|
|
171
193
|
|
|
172
194
|
# @param compaction
|
|
173
195
|
# Context compaction settings. Omit to keep the current settings. A supplied
|
|
174
|
-
# object replaces the settings; null or an empty object
|
|
175
|
-
# compaction.
|
|
196
|
+
# object replaces the settings; null or an empty object uses blocking compaction.
|
|
176
197
|
# @param experimental
|
|
177
198
|
# Experimental settings to merge by key. Omitted settings keep their current
|
|
178
199
|
# values.
|
|
@@ -221,15 +242,15 @@ module OpenAI
|
|
|
221
242
|
type compaction = { ?async: bool? }
|
|
222
243
|
|
|
223
244
|
class Compaction < OpenAI::Internal::Type::BaseModel
|
|
224
|
-
# Whether to compact context in the background. Omission or null defaults to
|
|
225
|
-
# Set to
|
|
226
|
-
# token usage.
|
|
245
|
+
# Whether to compact context in the background. Omission or null defaults to
|
|
246
|
+
# false. Set to true to enable background compaction. Background compaction may
|
|
247
|
+
# increase token usage.
|
|
227
248
|
attr_accessor async: bool?
|
|
228
249
|
|
|
229
250
|
# @param async
|
|
230
|
-
# Whether to compact context in the background. Omission or null defaults to
|
|
231
|
-
# Set to
|
|
232
|
-
# token usage.
|
|
251
|
+
# Whether to compact context in the background. Omission or null defaults to
|
|
252
|
+
# false. Set to true to enable background compaction. Background compaction may
|
|
253
|
+
# increase token usage.
|
|
233
254
|
def initialize: (?async: bool?) -> void
|
|
234
255
|
|
|
235
256
|
def to_hash: -> { ?async: bool? }
|
|
@@ -293,6 +314,42 @@ module OpenAI
|
|
|
293
314
|
AgentSessionInputMessageParamArray: OpenAI::Internal::Type::Converter
|
|
294
315
|
end
|
|
295
316
|
|
|
317
|
+
type prompt_cache_options =
|
|
318
|
+
{
|
|
319
|
+
?ttl: OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions::ttl
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
class PromptCacheOptions < OpenAI::Internal::Type::BaseModel
|
|
323
|
+
# Minimum lifetime for new prompt cache entries. Defaults to 30 minutes.
|
|
324
|
+
attr_reader ttl: OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions::ttl?
|
|
325
|
+
|
|
326
|
+
# Minimum lifetime for new prompt cache entries. Defaults to 30 minutes.
|
|
327
|
+
def ttl=: (
|
|
328
|
+
OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions::ttl
|
|
329
|
+
) -> OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions::ttl
|
|
330
|
+
|
|
331
|
+
# @param ttl
|
|
332
|
+
# Minimum lifetime for new prompt cache entries. Defaults to 30 minutes.
|
|
333
|
+
def initialize: (
|
|
334
|
+
?ttl: OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions::ttl
|
|
335
|
+
) -> void
|
|
336
|
+
|
|
337
|
+
def to_hash: -> {
|
|
338
|
+
?ttl: OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions::ttl
|
|
339
|
+
}
|
|
340
|
+
|
|
341
|
+
type ttl = :"30m" | :"12h"
|
|
342
|
+
|
|
343
|
+
module Ttl
|
|
344
|
+
extend OpenAI::Internal::Type::Enum
|
|
345
|
+
|
|
346
|
+
TTL_30M: :"30m"
|
|
347
|
+
TTL_12H: :"12h"
|
|
348
|
+
|
|
349
|
+
def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions::ttl]
|
|
350
|
+
end
|
|
351
|
+
end
|
|
352
|
+
|
|
296
353
|
type review = :none | :auto_review
|
|
297
354
|
|
|
298
355
|
module Review
|
|
@@ -319,6 +376,25 @@ module OpenAI
|
|
|
319
376
|
|
|
320
377
|
def to_hash: -> { limit: Integer? }
|
|
321
378
|
end
|
|
379
|
+
|
|
380
|
+
type stream_options = { ?include_obfuscation: bool }
|
|
381
|
+
|
|
382
|
+
class StreamOptions < OpenAI::Internal::Type::BaseModel
|
|
383
|
+
# Whether to include obfuscation padding in events on this connection. Defaults to
|
|
384
|
+
# `true`.
|
|
385
|
+
attr_reader include_obfuscation: bool?
|
|
386
|
+
|
|
387
|
+
# Whether to include obfuscation padding in events on this connection. Defaults to
|
|
388
|
+
# `true`.
|
|
389
|
+
def include_obfuscation=: (bool) -> bool
|
|
390
|
+
|
|
391
|
+
# @param include_obfuscation
|
|
392
|
+
# Whether to include obfuscation padding in events on this connection. Defaults to
|
|
393
|
+
# `true`.
|
|
394
|
+
def initialize: (?include_obfuscation: bool) -> void
|
|
395
|
+
|
|
396
|
+
def to_hash: -> { ?include_obfuscation: bool }
|
|
397
|
+
end
|
|
322
398
|
end
|
|
323
399
|
end
|
|
324
400
|
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
|
|
@@ -336,7 +336,9 @@ module OpenAI
|
|
|
336
336
|
#
|
|
337
337
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
338
338
|
# the model will truncate the response to fit the context window by dropping
|
|
339
|
-
# 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`.
|
|
340
342
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
341
343
|
# for a model, the request will fail with a 400 error.
|
|
342
344
|
attr_accessor truncation: OpenAI::Models::Beta::BetaResponse::truncation?
|
|
@@ -564,7 +566,9 @@ module OpenAI
|
|
|
564
566
|
#
|
|
565
567
|
# - `auto`: If the input to this Response exceeds the model's context window size,
|
|
566
568
|
# the model will truncate the response to fit the context window by dropping
|
|
567
|
-
# 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`.
|
|
568
572
|
# - `disabled` (default): If the input size will exceed the context window size
|
|
569
573
|
# for a model, the request will fail with a 400 error.
|
|
570
574
|
# @param usage
|
|
@@ -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.
|