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
|
@@ -40,7 +40,13 @@ module OpenAI
|
|
|
40
40
|
# @return [OpenAI::Models::Beta::TokenUsage, nil]
|
|
41
41
|
required :usage, -> { OpenAI::Beta::TokenUsage }, nil?: true
|
|
42
42
|
|
|
43
|
-
# @!
|
|
43
|
+
# @!attribute obfuscation
|
|
44
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
45
|
+
#
|
|
46
|
+
# @return [String, nil]
|
|
47
|
+
optional :obfuscation, String
|
|
48
|
+
|
|
49
|
+
# @!method initialize(event_id:, session_id:, turn:, turn_id:, usage:, obfuscation: nil, type: :"agent.session.turn.failed")
|
|
44
50
|
# Emitted when a turn fails.
|
|
45
51
|
#
|
|
46
52
|
# @param event_id [String]
|
|
@@ -58,6 +64,9 @@ module OpenAI
|
|
|
58
64
|
# @param usage [OpenAI::Models::Beta::TokenUsage, nil]
|
|
59
65
|
# Token usage by the root agent during the turn, when available.
|
|
60
66
|
#
|
|
67
|
+
# @param obfuscation [String]
|
|
68
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
69
|
+
#
|
|
61
70
|
# @param type [Symbol, :"agent.session.turn.failed"]
|
|
62
71
|
# The type of the object. Always `agent.session.turn.failed`.
|
|
63
72
|
end
|
|
@@ -34,7 +34,13 @@ module OpenAI
|
|
|
34
34
|
# @return [Symbol, :"agent.session.turn.in_progress"]
|
|
35
35
|
required :type, const: :"agent.session.turn.in_progress"
|
|
36
36
|
|
|
37
|
-
# @!
|
|
37
|
+
# @!attribute obfuscation
|
|
38
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
39
|
+
#
|
|
40
|
+
# @return [String, nil]
|
|
41
|
+
optional :obfuscation, String
|
|
42
|
+
|
|
43
|
+
# @!method initialize(event_id:, session_id:, turn:, turn_id:, obfuscation: nil, type: :"agent.session.turn.in_progress")
|
|
38
44
|
# Emitted when a turn starts running.
|
|
39
45
|
#
|
|
40
46
|
# @param event_id [String]
|
|
@@ -49,6 +55,9 @@ module OpenAI
|
|
|
49
55
|
# @param turn_id [String]
|
|
50
56
|
# The ID of the turn associated with the event.
|
|
51
57
|
#
|
|
58
|
+
# @param obfuscation [String]
|
|
59
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
60
|
+
#
|
|
52
61
|
# @param type [Symbol, :"agent.session.turn.in_progress"]
|
|
53
62
|
# The type of the object. Always `agent.session.turn.in_progress`.
|
|
54
63
|
end
|
|
@@ -40,7 +40,13 @@ module OpenAI
|
|
|
40
40
|
# @return [Symbol, :"agent.session.turn.item.added"]
|
|
41
41
|
required :type, const: :"agent.session.turn.item.added"
|
|
42
42
|
|
|
43
|
-
# @!
|
|
43
|
+
# @!attribute obfuscation
|
|
44
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
45
|
+
#
|
|
46
|
+
# @return [String, nil]
|
|
47
|
+
optional :obfuscation, String
|
|
48
|
+
|
|
49
|
+
# @!method initialize(event_id:, item:, output_index:, session_id:, turn_id:, obfuscation: nil, type: :"agent.session.turn.item.added")
|
|
44
50
|
# Emitted when an item is added to a turn.
|
|
45
51
|
#
|
|
46
52
|
# @param event_id [String]
|
|
@@ -58,6 +64,9 @@ module OpenAI
|
|
|
58
64
|
# @param turn_id [String, nil]
|
|
59
65
|
# The ID of the turn associated with the event, when applicable.
|
|
60
66
|
#
|
|
67
|
+
# @param obfuscation [String]
|
|
68
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
69
|
+
#
|
|
61
70
|
# @param type [Symbol, :"agent.session.turn.item.added"]
|
|
62
71
|
# The type of the object. Always `agent.session.turn.item.added`.
|
|
63
72
|
end
|
|
@@ -40,7 +40,13 @@ module OpenAI
|
|
|
40
40
|
# @return [Symbol, :"agent.session.turn.item.done"]
|
|
41
41
|
required :type, const: :"agent.session.turn.item.done"
|
|
42
42
|
|
|
43
|
-
# @!
|
|
43
|
+
# @!attribute obfuscation
|
|
44
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
45
|
+
#
|
|
46
|
+
# @return [String, nil]
|
|
47
|
+
optional :obfuscation, String
|
|
48
|
+
|
|
49
|
+
# @!method initialize(event_id:, item:, output_index:, session_id:, turn_id:, obfuscation: nil, type: :"agent.session.turn.item.done")
|
|
44
50
|
# Emitted when an output item is complete.
|
|
45
51
|
#
|
|
46
52
|
# @param event_id [String]
|
|
@@ -58,6 +64,9 @@ module OpenAI
|
|
|
58
64
|
# @param turn_id [String, nil]
|
|
59
65
|
# The ID of the turn associated with the event, when applicable.
|
|
60
66
|
#
|
|
67
|
+
# @param obfuscation [String]
|
|
68
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
69
|
+
#
|
|
61
70
|
# @param type [Symbol, :"agent.session.turn.item.done"]
|
|
62
71
|
# The type of the object. Always `agent.session.turn.item.done`.
|
|
63
72
|
end
|
|
@@ -52,7 +52,13 @@ module OpenAI
|
|
|
52
52
|
# @return [Symbol, :"agent.session.turn.output_text.delta"]
|
|
53
53
|
required :type, const: :"agent.session.turn.output_text.delta"
|
|
54
54
|
|
|
55
|
-
# @!
|
|
55
|
+
# @!attribute obfuscation
|
|
56
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
57
|
+
#
|
|
58
|
+
# @return [String, nil]
|
|
59
|
+
optional :obfuscation, String
|
|
60
|
+
|
|
61
|
+
# @!method initialize(content_index:, delta:, event_id:, item_id:, output_index:, session_id:, turn_id:, obfuscation: nil, type: :"agent.session.turn.output_text.delta")
|
|
56
62
|
# Emitted when text is appended to an output text content part.
|
|
57
63
|
#
|
|
58
64
|
# @param content_index [Integer]
|
|
@@ -76,6 +82,9 @@ module OpenAI
|
|
|
76
82
|
# @param turn_id [String, nil]
|
|
77
83
|
# The ID of the turn associated with the event, when applicable.
|
|
78
84
|
#
|
|
85
|
+
# @param obfuscation [String]
|
|
86
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
87
|
+
#
|
|
79
88
|
# @param type [Symbol, :"agent.session.turn.output_text.delta"]
|
|
80
89
|
# The type of the object. Always `agent.session.turn.output_text.delta`.
|
|
81
90
|
end
|
|
@@ -52,7 +52,13 @@ module OpenAI
|
|
|
52
52
|
# @return [Symbol, :"agent.session.turn.output_text.done"]
|
|
53
53
|
required :type, const: :"agent.session.turn.output_text.done"
|
|
54
54
|
|
|
55
|
-
# @!
|
|
55
|
+
# @!attribute obfuscation
|
|
56
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
57
|
+
#
|
|
58
|
+
# @return [String, nil]
|
|
59
|
+
optional :obfuscation, String
|
|
60
|
+
|
|
61
|
+
# @!method initialize(content_index:, event_id:, item_id:, output_index:, session_id:, text:, turn_id:, obfuscation: nil, type: :"agent.session.turn.output_text.done")
|
|
56
62
|
# Emitted when an output text content part is complete.
|
|
57
63
|
#
|
|
58
64
|
# @param content_index [Integer]
|
|
@@ -76,6 +82,9 @@ module OpenAI
|
|
|
76
82
|
# @param turn_id [String, nil]
|
|
77
83
|
# The ID of the turn associated with the event, when applicable.
|
|
78
84
|
#
|
|
85
|
+
# @param obfuscation [String]
|
|
86
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
87
|
+
#
|
|
79
88
|
# @param type [Symbol, :"agent.session.turn.output_text.done"]
|
|
80
89
|
# The type of the object. Always `agent.session.turn.output_text.done`.
|
|
81
90
|
end
|
|
@@ -53,7 +53,13 @@ module OpenAI
|
|
|
53
53
|
# @return [Symbol, :"agent.session.turn.reasoning_summary_part.added"]
|
|
54
54
|
required :type, const: :"agent.session.turn.reasoning_summary_part.added"
|
|
55
55
|
|
|
56
|
-
# @!
|
|
56
|
+
# @!attribute obfuscation
|
|
57
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
58
|
+
#
|
|
59
|
+
# @return [String, nil]
|
|
60
|
+
optional :obfuscation, String
|
|
61
|
+
|
|
62
|
+
# @!method initialize(event_id:, item_id:, output_index:, part:, session_id:, summary_index:, turn_id:, obfuscation: nil, type: :"agent.session.turn.reasoning_summary_part.added")
|
|
57
63
|
# Emitted when a reasoning summary content part is added.
|
|
58
64
|
#
|
|
59
65
|
# @param event_id [String]
|
|
@@ -77,6 +83,9 @@ module OpenAI
|
|
|
77
83
|
# @param turn_id [String, nil]
|
|
78
84
|
# The ID of the turn associated with the event, when applicable.
|
|
79
85
|
#
|
|
86
|
+
# @param obfuscation [String]
|
|
87
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
88
|
+
#
|
|
80
89
|
# @param type [Symbol, :"agent.session.turn.reasoning_summary_part.added"]
|
|
81
90
|
# The type of the object. Always
|
|
82
91
|
# `agent.session.turn.reasoning_summary_part.added`.
|
|
@@ -58,7 +58,13 @@ module OpenAI
|
|
|
58
58
|
# @return [Symbol, :"agent.session.turn.reasoning_summary_part.done"]
|
|
59
59
|
required :type, const: :"agent.session.turn.reasoning_summary_part.done"
|
|
60
60
|
|
|
61
|
-
# @!
|
|
61
|
+
# @!attribute obfuscation
|
|
62
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
63
|
+
#
|
|
64
|
+
# @return [String, nil]
|
|
65
|
+
optional :obfuscation, String
|
|
66
|
+
|
|
67
|
+
# @!method initialize(event_id:, item_id:, output_index:, part:, session_id:, summary_index:, turn_id:, obfuscation: nil, status: :incomplete, type: :"agent.session.turn.reasoning_summary_part.done")
|
|
62
68
|
# Emitted when a reasoning summary part is complete.
|
|
63
69
|
#
|
|
64
70
|
# @param event_id [String]
|
|
@@ -82,6 +88,9 @@ module OpenAI
|
|
|
82
88
|
# @param turn_id [String, nil]
|
|
83
89
|
# The ID of the turn associated with the event, when applicable.
|
|
84
90
|
#
|
|
91
|
+
# @param obfuscation [String]
|
|
92
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
93
|
+
#
|
|
85
94
|
# @param status [Symbol, :incomplete, nil]
|
|
86
95
|
# Present as `incomplete` when summary generation was interrupted.
|
|
87
96
|
#
|
|
@@ -53,7 +53,13 @@ module OpenAI
|
|
|
53
53
|
# @return [Symbol, :"agent.session.turn.reasoning_summary_text.delta"]
|
|
54
54
|
required :type, const: :"agent.session.turn.reasoning_summary_text.delta"
|
|
55
55
|
|
|
56
|
-
# @!
|
|
56
|
+
# @!attribute obfuscation
|
|
57
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
58
|
+
#
|
|
59
|
+
# @return [String, nil]
|
|
60
|
+
optional :obfuscation, String
|
|
61
|
+
|
|
62
|
+
# @!method initialize(delta:, event_id:, item_id:, output_index:, session_id:, summary_index:, turn_id:, obfuscation: nil, type: :"agent.session.turn.reasoning_summary_text.delta")
|
|
57
63
|
# Emitted when text is appended to a reasoning summary.
|
|
58
64
|
#
|
|
59
65
|
# @param delta [String]
|
|
@@ -77,6 +83,9 @@ module OpenAI
|
|
|
77
83
|
# @param turn_id [String, nil]
|
|
78
84
|
# The ID of the turn associated with the event, when applicable.
|
|
79
85
|
#
|
|
86
|
+
# @param obfuscation [String]
|
|
87
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
88
|
+
#
|
|
80
89
|
# @param type [Symbol, :"agent.session.turn.reasoning_summary_text.delta"]
|
|
81
90
|
# The type of the object. Always
|
|
82
91
|
# `agent.session.turn.reasoning_summary_text.delta`.
|
|
@@ -52,7 +52,13 @@ module OpenAI
|
|
|
52
52
|
# @return [Symbol, :"agent.session.turn.reasoning_summary_text.done"]
|
|
53
53
|
required :type, const: :"agent.session.turn.reasoning_summary_text.done"
|
|
54
54
|
|
|
55
|
-
# @!
|
|
55
|
+
# @!attribute obfuscation
|
|
56
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
57
|
+
#
|
|
58
|
+
# @return [String, nil]
|
|
59
|
+
optional :obfuscation, String
|
|
60
|
+
|
|
61
|
+
# @!method initialize(event_id:, item_id:, output_index:, session_id:, summary_index:, text:, turn_id:, obfuscation: nil, type: :"agent.session.turn.reasoning_summary_text.done")
|
|
56
62
|
# Emitted when a reasoning summary content part is complete.
|
|
57
63
|
#
|
|
58
64
|
# @param event_id [String]
|
|
@@ -76,6 +82,9 @@ module OpenAI
|
|
|
76
82
|
# @param turn_id [String, nil]
|
|
77
83
|
# The ID of the turn associated with the event, when applicable.
|
|
78
84
|
#
|
|
85
|
+
# @param obfuscation [String]
|
|
86
|
+
# Random alphanumeric padding. Present when stream obfuscation is enabled.
|
|
87
|
+
#
|
|
79
88
|
# @param type [Symbol, :"agent.session.turn.reasoning_summary_text.done"]
|
|
80
89
|
# The type of the object. Always `agent.session.turn.reasoning_summary_text.done`.
|
|
81
90
|
end
|
|
@@ -15,8 +15,7 @@ module OpenAI
|
|
|
15
15
|
|
|
16
16
|
# @!attribute compaction
|
|
17
17
|
# Context compaction settings. Omit to keep the current settings. A supplied
|
|
18
|
-
# object replaces the settings; null or an empty object
|
|
19
|
-
# compaction.
|
|
18
|
+
# object replaces the settings; null or an empty object uses blocking compaction.
|
|
20
19
|
#
|
|
21
20
|
# @return [OpenAI::Models::Beta::AgentUpdateParams::Compaction, nil]
|
|
22
21
|
optional :compaction, -> { OpenAI::Beta::AgentUpdateParams::Compaction }, nil?: true
|
|
@@ -96,8 +95,7 @@ module OpenAI
|
|
|
96
95
|
#
|
|
97
96
|
# @param compaction [OpenAI::Models::Beta::AgentUpdateParams::Compaction, nil]
|
|
98
97
|
# Context compaction settings. Omit to keep the current settings. A supplied
|
|
99
|
-
# object replaces the settings; null or an empty object
|
|
100
|
-
# compaction.
|
|
98
|
+
# object replaces the settings; null or an empty object uses blocking compaction.
|
|
101
99
|
#
|
|
102
100
|
# @param experimental [OpenAI::Models::Beta::AgentUpdateParams::Experimental]
|
|
103
101
|
# Experimental settings to merge by key. Omitted settings keep their current
|
|
@@ -139,22 +137,21 @@ module OpenAI
|
|
|
139
137
|
|
|
140
138
|
class Compaction < OpenAI::Internal::Type::BaseModel
|
|
141
139
|
# @!attribute async
|
|
142
|
-
# Whether to compact context in the background. Omission or null defaults to
|
|
143
|
-
# Set to
|
|
144
|
-
# token usage.
|
|
140
|
+
# Whether to compact context in the background. Omission or null defaults to
|
|
141
|
+
# false. Set to true to enable background compaction. Background compaction may
|
|
142
|
+
# increase token usage.
|
|
145
143
|
#
|
|
146
144
|
# @return [Boolean, nil]
|
|
147
145
|
optional :async, OpenAI::Internal::Type::Boolean, nil?: true
|
|
148
146
|
|
|
149
147
|
# @!method initialize(async: nil)
|
|
150
148
|
# Context compaction settings. Omit to keep the current settings. A supplied
|
|
151
|
-
# object replaces the settings; null or an empty object
|
|
152
|
-
# compaction.
|
|
149
|
+
# object replaces the settings; null or an empty object uses blocking compaction.
|
|
153
150
|
#
|
|
154
151
|
# @param async [Boolean, nil]
|
|
155
|
-
# Whether to compact context in the background. Omission or null defaults to
|
|
156
|
-
# Set to
|
|
157
|
-
# token usage.
|
|
152
|
+
# Whether to compact context in the background. Omission or null defaults to
|
|
153
|
+
# false. Set to true to enable background compaction. Background compaction may
|
|
154
|
+
# increase token usage.
|
|
158
155
|
end
|
|
159
156
|
|
|
160
157
|
class Experimental < OpenAI::Internal::Type::BaseModel
|
|
@@ -109,7 +109,7 @@ module OpenAI
|
|
|
109
109
|
# @see OpenAI::Models::Beta::Agents::AutomationAgentConfig#compaction
|
|
110
110
|
class Compaction < OpenAI::Internal::Type::BaseModel
|
|
111
111
|
# @!attribute async
|
|
112
|
-
# Whether context is compacted in the background. Defaults to
|
|
112
|
+
# Whether context is compacted in the background. Defaults to false.
|
|
113
113
|
#
|
|
114
114
|
# @return [Boolean]
|
|
115
115
|
required :async, OpenAI::Internal::Type::Boolean
|
|
@@ -118,7 +118,7 @@ module OpenAI
|
|
|
118
118
|
# The effective context compaction settings.
|
|
119
119
|
#
|
|
120
120
|
# @param async [Boolean]
|
|
121
|
-
# Whether context is compacted in the background. Defaults to
|
|
121
|
+
# Whether context is compacted in the background. Defaults to false.
|
|
122
122
|
end
|
|
123
123
|
|
|
124
124
|
# @see OpenAI::Models::Beta::Agents::AutomationAgentConfig#experimental
|
|
@@ -87,8 +87,7 @@ module OpenAI
|
|
|
87
87
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
88
88
|
# @!attribute compaction
|
|
89
89
|
# Context compaction settings. Omit to keep the current settings. A supplied
|
|
90
|
-
# object replaces the settings; null or an empty object
|
|
91
|
-
# compaction.
|
|
90
|
+
# object replaces the settings; null or an empty object uses blocking compaction.
|
|
92
91
|
#
|
|
93
92
|
# @return [OpenAI::Models::Beta::Agents::AutomationTargetParam::NewSession::Agent::Compaction, nil]
|
|
94
93
|
optional(
|
|
@@ -170,8 +169,7 @@ module OpenAI
|
|
|
170
169
|
#
|
|
171
170
|
# @param compaction [OpenAI::Models::Beta::Agents::AutomationTargetParam::NewSession::Agent::Compaction, nil]
|
|
172
171
|
# Context compaction settings. Omit to keep the current settings. A supplied
|
|
173
|
-
# object replaces the settings; null or an empty object
|
|
174
|
-
# compaction.
|
|
172
|
+
# object replaces the settings; null or an empty object uses blocking compaction.
|
|
175
173
|
#
|
|
176
174
|
# @param experimental [OpenAI::Models::Beta::Agents::AutomationTargetParam::NewSession::Agent::Experimental]
|
|
177
175
|
# Experimental settings to merge by key. Omitted settings keep their current
|
|
@@ -205,22 +203,21 @@ module OpenAI
|
|
|
205
203
|
# @see OpenAI::Models::Beta::Agents::AutomationTargetParam::NewSession::Agent#compaction
|
|
206
204
|
class Compaction < OpenAI::Internal::Type::BaseModel
|
|
207
205
|
# @!attribute async
|
|
208
|
-
# Whether to compact context in the background. Omission or null defaults to
|
|
209
|
-
# Set to
|
|
210
|
-
# token usage.
|
|
206
|
+
# Whether to compact context in the background. Omission or null defaults to
|
|
207
|
+
# false. Set to true to enable background compaction. Background compaction may
|
|
208
|
+
# increase token usage.
|
|
211
209
|
#
|
|
212
210
|
# @return [Boolean, nil]
|
|
213
211
|
optional :async, OpenAI::Internal::Type::Boolean, nil?: true
|
|
214
212
|
|
|
215
213
|
# @!method initialize(async: nil)
|
|
216
214
|
# Context compaction settings. Omit to keep the current settings. A supplied
|
|
217
|
-
# object replaces the settings; null or an empty object
|
|
218
|
-
# compaction.
|
|
215
|
+
# object replaces the settings; null or an empty object uses blocking compaction.
|
|
219
216
|
#
|
|
220
217
|
# @param async [Boolean, nil]
|
|
221
|
-
# Whether to compact context in the background. Omission or null defaults to
|
|
222
|
-
# Set to
|
|
223
|
-
# token usage.
|
|
218
|
+
# Whether to compact context in the background. Omission or null defaults to
|
|
219
|
+
# false. Set to true to enable background compaction. Background compaction may
|
|
220
|
+
# increase token usage.
|
|
224
221
|
end
|
|
225
222
|
|
|
226
223
|
# @see OpenAI::Models::Beta::Agents::AutomationTargetParam::NewSession::Agent#experimental
|
|
@@ -65,7 +65,19 @@ module OpenAI
|
|
|
65
65
|
# @return [Symbol, :once]
|
|
66
66
|
required :type, const: :once
|
|
67
67
|
|
|
68
|
-
# @!
|
|
68
|
+
# @!attribute pause_reason
|
|
69
|
+
# Why the service paused this schedule, or null for other schedules.
|
|
70
|
+
#
|
|
71
|
+
# @return [Symbol, OpenAI::Models::Beta::Agents::OneTimeAutomation::PauseReason, nil]
|
|
72
|
+
optional(
|
|
73
|
+
:pause_reason,
|
|
74
|
+
enum: -> {
|
|
75
|
+
OpenAI::Beta::Agents::OneTimeAutomation::PauseReason
|
|
76
|
+
},
|
|
77
|
+
nil?: true
|
|
78
|
+
)
|
|
79
|
+
|
|
80
|
+
# @!method initialize(id:, created_at:, created_by:, metadata:, name:, run_at:, status:, target:, pause_reason: nil, object: :"agent.automation", type: :once)
|
|
69
81
|
# Fields shared by periodic and one-time automations.
|
|
70
82
|
#
|
|
71
83
|
# @param id [String]
|
|
@@ -92,6 +104,9 @@ module OpenAI
|
|
|
92
104
|
# @param target [OpenAI::Models::Beta::Agents::AutomationTarget::NewSession, OpenAI::Models::Beta::Agents::AutomationTarget::ExistingSession]
|
|
93
105
|
# The session configuration or existing session receiving invocations.
|
|
94
106
|
#
|
|
107
|
+
# @param pause_reason [Symbol, OpenAI::Models::Beta::Agents::OneTimeAutomation::PauseReason, nil]
|
|
108
|
+
# Why the service paused this schedule, or null for other schedules.
|
|
109
|
+
#
|
|
95
110
|
# @param object [Symbol, :"agent.automation"]
|
|
96
111
|
# Always `agent.automation`.
|
|
97
112
|
#
|
|
@@ -111,6 +126,18 @@ module OpenAI
|
|
|
111
126
|
# @!method self.values
|
|
112
127
|
# @return [Array<Symbol>]
|
|
113
128
|
end
|
|
129
|
+
|
|
130
|
+
# Why the service paused this schedule, or null for other schedules.
|
|
131
|
+
#
|
|
132
|
+
# @see OpenAI::Models::Beta::Agents::OneTimeAutomation#pause_reason
|
|
133
|
+
module PauseReason
|
|
134
|
+
extend OpenAI::Internal::Type::Enum
|
|
135
|
+
|
|
136
|
+
TARGET_SESSION_FAILED = :target_session_failed
|
|
137
|
+
|
|
138
|
+
# @!method self.values
|
|
139
|
+
# @return [Array<Symbol>]
|
|
140
|
+
end
|
|
114
141
|
end
|
|
115
142
|
end
|
|
116
143
|
end
|
|
@@ -71,7 +71,19 @@ module OpenAI
|
|
|
71
71
|
# @return [Symbol, :periodic]
|
|
72
72
|
required :type, const: :periodic
|
|
73
73
|
|
|
74
|
-
# @!
|
|
74
|
+
# @!attribute pause_reason
|
|
75
|
+
# Why the service paused this schedule, or null for other schedules.
|
|
76
|
+
#
|
|
77
|
+
# @return [Symbol, OpenAI::Models::Beta::Agents::PeriodicAutomation::PauseReason, nil]
|
|
78
|
+
optional(
|
|
79
|
+
:pause_reason,
|
|
80
|
+
enum: -> {
|
|
81
|
+
OpenAI::Beta::Agents::PeriodicAutomation::PauseReason
|
|
82
|
+
},
|
|
83
|
+
nil?: true
|
|
84
|
+
)
|
|
85
|
+
|
|
86
|
+
# @!method initialize(id:, created_at:, created_by:, expression:, metadata:, name:, status:, target:, timezone:, pause_reason: nil, object: :"agent.automation", type: :periodic)
|
|
75
87
|
# Fields shared by periodic and one-time automations.
|
|
76
88
|
#
|
|
77
89
|
# @param id [String]
|
|
@@ -101,6 +113,9 @@ module OpenAI
|
|
|
101
113
|
# @param timezone [String]
|
|
102
114
|
# The timezone used to interpret the expression.
|
|
103
115
|
#
|
|
116
|
+
# @param pause_reason [Symbol, OpenAI::Models::Beta::Agents::PeriodicAutomation::PauseReason, nil]
|
|
117
|
+
# Why the service paused this schedule, or null for other schedules.
|
|
118
|
+
#
|
|
104
119
|
# @param object [Symbol, :"agent.automation"]
|
|
105
120
|
# Always `agent.automation`.
|
|
106
121
|
#
|
|
@@ -119,6 +134,18 @@ module OpenAI
|
|
|
119
134
|
# @!method self.values
|
|
120
135
|
# @return [Array<Symbol>]
|
|
121
136
|
end
|
|
137
|
+
|
|
138
|
+
# Why the service paused this schedule, or null for other schedules.
|
|
139
|
+
#
|
|
140
|
+
# @see OpenAI::Models::Beta::Agents::PeriodicAutomation#pause_reason
|
|
141
|
+
module PauseReason
|
|
142
|
+
extend OpenAI::Internal::Type::Enum
|
|
143
|
+
|
|
144
|
+
TARGET_SESSION_FAILED = :target_session_failed
|
|
145
|
+
|
|
146
|
+
# @!method self.values
|
|
147
|
+
# @return [Array<Symbol>]
|
|
148
|
+
end
|
|
122
149
|
end
|
|
123
150
|
end
|
|
124
151
|
end
|
|
@@ -47,6 +47,17 @@ module OpenAI
|
|
|
47
47
|
# @return [Hash{Symbol=>String}, nil]
|
|
48
48
|
optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
|
|
49
49
|
|
|
50
|
+
# @!attribute prompt_cache_options
|
|
51
|
+
# Default prompt cache lifetime for turns in this session. Omit to use the model
|
|
52
|
+
# default.
|
|
53
|
+
#
|
|
54
|
+
# @return [OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions, nil]
|
|
55
|
+
optional(
|
|
56
|
+
:prompt_cache_options,
|
|
57
|
+
-> { OpenAI::Beta::Agents::SessionCreateParams::PromptCacheOptions },
|
|
58
|
+
nil?: true
|
|
59
|
+
)
|
|
60
|
+
|
|
50
61
|
# @!attribute review
|
|
51
62
|
# Action review mode. Omit to use none.
|
|
52
63
|
#
|
|
@@ -66,13 +77,19 @@ module OpenAI
|
|
|
66
77
|
nil?: true
|
|
67
78
|
)
|
|
68
79
|
|
|
80
|
+
# @!attribute stream_options
|
|
81
|
+
# Options for the event stream. Only allowed when `stream` is `true`.
|
|
82
|
+
#
|
|
83
|
+
# @return [OpenAI::Models::Beta::Agents::SessionCreateParams::StreamOptions, nil]
|
|
84
|
+
optional :stream_options, -> { OpenAI::Beta::Agents::SessionCreateParams::StreamOptions }
|
|
85
|
+
|
|
69
86
|
# @!attribute vault_ids
|
|
70
87
|
# The IDs of vaults made available to the session.
|
|
71
88
|
#
|
|
72
89
|
# @return [Array<String>, nil]
|
|
73
90
|
optional :vault_ids, OpenAI::Internal::Type::ArrayOf[String], nil?: true
|
|
74
91
|
|
|
75
|
-
# @!method initialize(environment:, agent: nil, agent_id: nil, input: nil, metadata: nil, review: nil, spend_control: nil, vault_ids: nil, request_options: {})
|
|
92
|
+
# @!method initialize(environment:, agent: nil, agent_id: nil, input: nil, metadata: nil, prompt_cache_options: nil, review: nil, spend_control: nil, stream_options: nil, vault_ids: nil, request_options: {})
|
|
76
93
|
# @param environment [OpenAI::Models::Beta::EnvironmentParam::None, OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted, OpenAI::Models::Beta::EnvironmentParam::SelfHosted]
|
|
77
94
|
# An inline execution environment or a reference to an environment template.
|
|
78
95
|
#
|
|
@@ -94,6 +111,10 @@ module OpenAI
|
|
|
94
111
|
# Up to 16 string key-value pairs, with keys up to 64 and values up to 512
|
|
95
112
|
# characters. Omission or null defaults to an empty map.
|
|
96
113
|
#
|
|
114
|
+
# @param prompt_cache_options [OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions, nil]
|
|
115
|
+
# Default prompt cache lifetime for turns in this session. Omit to use the model
|
|
116
|
+
# default.
|
|
117
|
+
#
|
|
97
118
|
# @param review [Symbol, OpenAI::Models::Beta::Agents::SessionCreateParams::Review]
|
|
98
119
|
# Action review mode. Omit to use none.
|
|
99
120
|
#
|
|
@@ -101,6 +122,9 @@ module OpenAI
|
|
|
101
122
|
# Optional spending limit in USD cents. Omission or null creates an unlimited
|
|
102
123
|
# session.
|
|
103
124
|
#
|
|
125
|
+
# @param stream_options [OpenAI::Models::Beta::Agents::SessionCreateParams::StreamOptions]
|
|
126
|
+
# Options for the event stream. Only allowed when `stream` is `true`.
|
|
127
|
+
#
|
|
104
128
|
# @param vault_ids [Array<String>, nil]
|
|
105
129
|
# The IDs of vaults made available to the session.
|
|
106
130
|
#
|
|
@@ -109,8 +133,7 @@ module OpenAI
|
|
|
109
133
|
class Agent < OpenAI::Internal::Type::BaseModel
|
|
110
134
|
# @!attribute compaction
|
|
111
135
|
# Context compaction settings. Omit to keep the current settings. A supplied
|
|
112
|
-
# object replaces the settings; null or an empty object
|
|
113
|
-
# compaction.
|
|
136
|
+
# object replaces the settings; null or an empty object uses blocking compaction.
|
|
114
137
|
#
|
|
115
138
|
# @return [OpenAI::Models::Beta::Agents::SessionCreateParams::Agent::Compaction, nil]
|
|
116
139
|
optional(
|
|
@@ -190,8 +213,7 @@ module OpenAI
|
|
|
190
213
|
#
|
|
191
214
|
# @param compaction [OpenAI::Models::Beta::Agents::SessionCreateParams::Agent::Compaction, nil]
|
|
192
215
|
# Context compaction settings. Omit to keep the current settings. A supplied
|
|
193
|
-
# object replaces the settings; null or an empty object
|
|
194
|
-
# compaction.
|
|
216
|
+
# object replaces the settings; null or an empty object uses blocking compaction.
|
|
195
217
|
#
|
|
196
218
|
# @param experimental [OpenAI::Models::Beta::Agents::SessionCreateParams::Agent::Experimental]
|
|
197
219
|
# Experimental settings to merge by key. Omitted settings keep their current
|
|
@@ -225,22 +247,21 @@ module OpenAI
|
|
|
225
247
|
# @see OpenAI::Models::Beta::Agents::SessionCreateParams::Agent#compaction
|
|
226
248
|
class Compaction < OpenAI::Internal::Type::BaseModel
|
|
227
249
|
# @!attribute async
|
|
228
|
-
# Whether to compact context in the background. Omission or null defaults to
|
|
229
|
-
# Set to
|
|
230
|
-
# token usage.
|
|
250
|
+
# Whether to compact context in the background. Omission or null defaults to
|
|
251
|
+
# false. Set to true to enable background compaction. Background compaction may
|
|
252
|
+
# increase token usage.
|
|
231
253
|
#
|
|
232
254
|
# @return [Boolean, nil]
|
|
233
255
|
optional :async, OpenAI::Internal::Type::Boolean, nil?: true
|
|
234
256
|
|
|
235
257
|
# @!method initialize(async: nil)
|
|
236
258
|
# Context compaction settings. Omit to keep the current settings. A supplied
|
|
237
|
-
# object replaces the settings; null or an empty object
|
|
238
|
-
# compaction.
|
|
259
|
+
# object replaces the settings; null or an empty object uses blocking compaction.
|
|
239
260
|
#
|
|
240
261
|
# @param async [Boolean, nil]
|
|
241
|
-
# Whether to compact context in the background. Omission or null defaults to
|
|
242
|
-
# Set to
|
|
243
|
-
# token usage.
|
|
262
|
+
# Whether to compact context in the background. Omission or null defaults to
|
|
263
|
+
# false. Set to true to enable background compaction. Background compaction may
|
|
264
|
+
# increase token usage.
|
|
244
265
|
end
|
|
245
266
|
|
|
246
267
|
# @see OpenAI::Models::Beta::Agents::SessionCreateParams::Agent#experimental
|
|
@@ -310,6 +331,34 @@ module OpenAI
|
|
|
310
331
|
]
|
|
311
332
|
end
|
|
312
333
|
|
|
334
|
+
class PromptCacheOptions < OpenAI::Internal::Type::BaseModel
|
|
335
|
+
# @!attribute ttl
|
|
336
|
+
# Minimum lifetime for new prompt cache entries. Defaults to 30 minutes.
|
|
337
|
+
#
|
|
338
|
+
# @return [Symbol, OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions::Ttl, nil]
|
|
339
|
+
optional :ttl, enum: -> { OpenAI::Beta::Agents::SessionCreateParams::PromptCacheOptions::Ttl }
|
|
340
|
+
|
|
341
|
+
# @!method initialize(ttl: nil)
|
|
342
|
+
# Default prompt cache lifetime for turns in this session. Omit to use the model
|
|
343
|
+
# default.
|
|
344
|
+
#
|
|
345
|
+
# @param ttl [Symbol, OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions::Ttl]
|
|
346
|
+
# Minimum lifetime for new prompt cache entries. Defaults to 30 minutes.
|
|
347
|
+
|
|
348
|
+
# Minimum lifetime for new prompt cache entries. Defaults to 30 minutes.
|
|
349
|
+
#
|
|
350
|
+
# @see OpenAI::Models::Beta::Agents::SessionCreateParams::PromptCacheOptions#ttl
|
|
351
|
+
module Ttl
|
|
352
|
+
extend OpenAI::Internal::Type::Enum
|
|
353
|
+
|
|
354
|
+
TTL_30M = :"30m"
|
|
355
|
+
TTL_12H = :"12h"
|
|
356
|
+
|
|
357
|
+
# @!method self.values
|
|
358
|
+
# @return [Array<Symbol>]
|
|
359
|
+
end
|
|
360
|
+
end
|
|
361
|
+
|
|
313
362
|
# Action review mode. Omit to use none.
|
|
314
363
|
module Review
|
|
315
364
|
extend OpenAI::Internal::Type::Enum
|
|
@@ -338,6 +387,22 @@ module OpenAI
|
|
|
338
387
|
# @param limit [Integer, nil]
|
|
339
388
|
# Positive USD cents, or null to remove the limit.
|
|
340
389
|
end
|
|
390
|
+
|
|
391
|
+
class StreamOptions < OpenAI::Internal::Type::BaseModel
|
|
392
|
+
# @!attribute include_obfuscation
|
|
393
|
+
# Whether to include obfuscation padding in events on this connection. Defaults to
|
|
394
|
+
# `true`.
|
|
395
|
+
#
|
|
396
|
+
# @return [Boolean, nil]
|
|
397
|
+
optional :include_obfuscation, OpenAI::Internal::Type::Boolean
|
|
398
|
+
|
|
399
|
+
# @!method initialize(include_obfuscation: nil)
|
|
400
|
+
# Options for the event stream. Only allowed when `stream` is `true`.
|
|
401
|
+
#
|
|
402
|
+
# @param include_obfuscation [Boolean]
|
|
403
|
+
# Whether to include obfuscation padding in events on this connection. Defaults to
|
|
404
|
+
# `true`.
|
|
405
|
+
end
|
|
341
406
|
end
|
|
342
407
|
end
|
|
343
408
|
end
|