openai 0.89.0 → 0.90.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 +7 -0
- data/README.md +1 -1
- data/lib/openai/helpers/agents/message.rb +20 -0
- data/lib/openai/helpers/agents/session_stream.rb +168 -0
- data/lib/openai/helpers/agents/tools.rb +65 -0
- data/lib/openai/internal/token_page.rb +91 -0
- data/lib/openai/models/beta/agent.rb +148 -0
- data/lib/openai/models/beta/agent_close_subagent_call_item.rb +66 -0
- data/lib/openai/models/beta/agent_command_execution_item.rb +93 -0
- data/lib/openai/models/beta/agent_content.rb +46 -0
- data/lib/openai/models/beta/agent_create_params.rb +128 -0
- data/lib/openai/models/beta/agent_create_subagent_call_item.rb +84 -0
- data/lib/openai/models/beta/agent_delete_params.rb +22 -0
- data/lib/openai/models/beta/agent_deleted.rb +40 -0
- data/lib/openai/models/beta/agent_function_call_item.rb +75 -0
- data/lib/openai/models/beta/agent_function_call_output.rb +22 -0
- data/lib/openai/models/beta/agent_function_call_output_param.rb +22 -0
- data/lib/openai/models/beta/agent_function_call_status.rb +27 -0
- data/lib/openai/models/beta/agent_interrupt_subagent_call_item.rb +67 -0
- data/lib/openai/models/beta/agent_list_params.rb +57 -0
- data/lib/openai/models/beta/agent_mcp_call_item.rb +93 -0
- data/lib/openai/models/beta/agent_output_command_execution_output_delta_event.rb +75 -0
- data/lib/openai/models/beta/agent_output_item.rb +53 -0
- data/lib/openai/models/beta/agent_output_item_status.rb +24 -0
- data/lib/openai/models/beta/agent_reasoning.rb +67 -0
- data/lib/openai/models/beta/agent_reasoning_item.rb +57 -0
- data/lib/openai/models/beta/agent_reasoning_param.rb +67 -0
- data/lib/openai/models/beta/agent_resume_subagent_call_item.rb +66 -0
- data/lib/openai/models/beta/agent_retrieve_params.rb +22 -0
- data/lib/openai/models/beta/agent_send_subagent_input_call_item.rb +75 -0
- data/lib/openai/models/beta/agent_session.rb +339 -0
- data/lib/openai/models/beta/agent_session_assistant_message.rb +91 -0
- data/lib/openai/models/beta/agent_session_created_event.rb +39 -0
- data/lib/openai/models/beta/agent_session_deleted.rb +42 -0
- data/lib/openai/models/beta/agent_session_environment_connected_event.rb +57 -0
- data/lib/openai/models/beta/agent_session_environment_disconnected_event.rb +57 -0
- data/lib/openai/models/beta/agent_session_environment_failed_event.rb +57 -0
- data/lib/openai/models/beta/agent_session_environment_pending_event.rb +57 -0
- data/lib/openai/models/beta/agent_session_environment_ready_event.rb +57 -0
- data/lib/openai/models/beta/agent_session_environment_state.rb +106 -0
- data/lib/openai/models/beta/agent_session_error_event.rb +48 -0
- data/lib/openai/models/beta/agent_session_event.rb +128 -0
- data/lib/openai/models/beta/agent_session_failed_event.rb +39 -0
- data/lib/openai/models/beta/agent_session_idle_event.rb +39 -0
- data/lib/openai/models/beta/agent_session_in_progress_event.rb +39 -0
- data/lib/openai/models/beta/agent_session_input_message_param.rb +51 -0
- data/lib/openai/models/beta/agent_session_input_param.rb +131 -0
- data/lib/openai/models/beta/agent_session_item.rb +186 -0
- data/lib/openai/models/beta/agent_session_message.rb +106 -0
- data/lib/openai/models/beta/agent_session_message_content.rb +97 -0
- data/lib/openai/models/beta/agent_session_requires_action_event.rb +39 -0
- data/lib/openai/models/beta/agent_session_subagent_active_event.rb +39 -0
- data/lib/openai/models/beta/agent_session_subagent_closed_event.rb +39 -0
- data/lib/openai/models/beta/agent_session_subagent_created_event.rb +39 -0
- data/lib/openai/models/beta/agent_session_turn_cancelled_event.rb +66 -0
- data/lib/openai/models/beta/agent_session_turn_completed_event.rb +66 -0
- data/lib/openai/models/beta/agent_session_turn_content_part_added_event.rb +84 -0
- data/lib/openai/models/beta/agent_session_turn_content_part_done_event.rb +84 -0
- data/lib/openai/models/beta/agent_session_turn_created_event.rb +57 -0
- data/lib/openai/models/beta/agent_session_turn_failed_event.rb +66 -0
- data/lib/openai/models/beta/agent_session_turn_in_progress_event.rb +57 -0
- data/lib/openai/models/beta/agent_session_turn_item_added_event.rb +66 -0
- data/lib/openai/models/beta/agent_session_turn_item_done_event.rb +66 -0
- data/lib/openai/models/beta/agent_session_turn_output_text_delta_event.rb +84 -0
- data/lib/openai/models/beta/agent_session_turn_output_text_done_event.rb +84 -0
- data/lib/openai/models/beta/agent_session_turn_reasoning_summary_part_added_event.rb +86 -0
- data/lib/openai/models/beta/agent_session_turn_reasoning_summary_part_done_event.rb +93 -0
- data/lib/openai/models/beta/agent_session_turn_reasoning_summary_text_delta_event.rb +86 -0
- data/lib/openai/models/beta/agent_session_turn_reasoning_summary_text_done_event.rb +84 -0
- data/lib/openai/models/beta/agent_text.rb +44 -0
- data/lib/openai/models/beta/agent_text_param.rb +49 -0
- data/lib/openai/models/beta/agent_tool.rb +314 -0
- data/lib/openai/models/beta/agent_tool_param.rb +359 -0
- data/lib/openai/models/beta/agent_update_params.rb +137 -0
- data/lib/openai/models/beta/agent_wait_for_subagents_call_item.rb +66 -0
- data/lib/openai/models/beta/agent_web_search_call_item.rb +57 -0
- data/lib/openai/models/beta/agents/environment_info.rb +107 -0
- data/lib/openai/models/beta/agents/environment_retrieve_params.rb +24 -0
- data/lib/openai/models/beta/agents/environments/environment_file.rb +55 -0
- data/lib/openai/models/beta/agents/environments/environment_template.rb +368 -0
- data/lib/openai/models/beta/agents/environments/environment_template_deleted.rb +46 -0
- data/lib/openai/models/beta/agents/environments/file_create_params.rb +26 -0
- data/lib/openai/models/beta/agents/environments/file_list_params.rb +77 -0
- data/lib/openai/models/beta/agents/environments/template_create_params.rb +209 -0
- data/lib/openai/models/beta/agents/environments/template_delete_params.rb +26 -0
- data/lib/openai/models/beta/agents/environments/template_list_params.rb +61 -0
- data/lib/openai/models/beta/agents/environments/template_retrieve_params.rb +26 -0
- data/lib/openai/models/beta/agents/environments/template_update_params.rb +212 -0
- data/lib/openai/models/beta/agents/session_create_params.rb +203 -0
- data/lib/openai/models/beta/agents/session_delete_params.rb +24 -0
- data/lib/openai/models/beta/agents/session_list_params.rb +73 -0
- data/lib/openai/models/beta/agents/session_retrieve_params.rb +24 -0
- data/lib/openai/models/beta/agents/session_update_params.rb +38 -0
- data/lib/openai/models/beta/agents/sessions/artifact_content_params.rb +32 -0
- data/lib/openai/models/beta/agents/sessions/artifact_delete_params.rb +32 -0
- data/lib/openai/models/beta/agents/sessions/artifact_list_params.rb +77 -0
- data/lib/openai/models/beta/agents/sessions/artifact_retrieve_params.rb +32 -0
- data/lib/openai/models/beta/agents/sessions/event_create_params.rb +43 -0
- data/lib/openai/models/beta/agents/sessions/event_stream_params.rb +26 -0
- data/lib/openai/models/beta/agents/sessions/item_list_params.rb +68 -0
- data/lib/openai/models/beta/agents/sessions/session_artifact.rb +91 -0
- data/lib/openai/models/beta/agents/sessions/session_artifact_deleted.rb +46 -0
- data/lib/openai/models/beta/agents/sessions/subagent_list_params.rb +68 -0
- data/lib/openai/models/beta/agents/sessions/subagent_retrieve_params.rb +32 -0
- data/lib/openai/models/beta/agents/sessions/subagents/item_list_params.rb +77 -0
- data/lib/openai/models/beta/agents/sessions/subagents/turn_list_params.rb +77 -0
- data/lib/openai/models/beta/agents/sessions/subagents/turn_retrieve_params.rb +40 -0
- data/lib/openai/models/beta/agents/sessions/subagents/turns/item_list_params.rb +86 -0
- data/lib/openai/models/beta/agents/sessions/turn.rb +148 -0
- data/lib/openai/models/beta/agents/sessions/turn_list_params.rb +68 -0
- data/lib/openai/models/beta/agents/sessions/turn_retrieve_params.rb +32 -0
- data/lib/openai/models/beta/agents/vault.rb +63 -0
- data/lib/openai/models/beta/agents/vault_create_params.rb +40 -0
- data/lib/openai/models/beta/agents/vault_delete_params.rb +24 -0
- data/lib/openai/models/beta/agents/vault_deleted.rb +42 -0
- data/lib/openai/models/beta/agents/vault_list_params.rb +75 -0
- data/lib/openai/models/beta/agents/vault_retrieve_params.rb +24 -0
- data/lib/openai/models/beta/agents/vault_status.rb +20 -0
- data/lib/openai/models/beta/agents/vault_status_filter.rb +27 -0
- data/lib/openai/models/beta/agents/vaults/credential.rb +80 -0
- data/lib/openai/models/beta/agents/vaults/credential_auth.rb +155 -0
- data/lib/openai/models/beta/agents/vaults/credential_auth_create_param.rb +184 -0
- data/lib/openai/models/beta/agents/vaults/credential_auth_rotate_param.rb +147 -0
- data/lib/openai/models/beta/agents/vaults/credential_create_params.rb +47 -0
- data/lib/openai/models/beta/agents/vaults/credential_delete_params.rb +32 -0
- data/lib/openai/models/beta/agents/vaults/credential_deleted.rb +44 -0
- data/lib/openai/models/beta/agents/vaults/credential_list_params.rb +84 -0
- data/lib/openai/models/beta/agents/vaults/credential_retrieve_params.rb +32 -0
- data/lib/openai/models/beta/agents/vaults/credential_update_params.rb +43 -0
- data/lib/openai/models/beta/agents/vaults/mcp_oauth_token_endpoint_auth.rb +78 -0
- data/lib/openai/models/beta/agents/vaults/mcp_oauth_token_endpoint_auth_create_param.rb +96 -0
- data/lib/openai/models/beta/agents/vaults/mcp_oauth_token_endpoint_auth_rotate_param.rb +84 -0
- data/lib/openai/models/beta/environment.rb +246 -0
- data/lib/openai/models/beta/environment_param.rb +269 -0
- data/lib/openai/models/beta/hosted_environment_file.rb +64 -0
- data/lib/openai/models/beta/hosted_environment_file_id.rb +57 -0
- data/lib/openai/models/beta/hosted_environment_file_param.rb +87 -0
- data/lib/openai/models/beta/hosted_plugin.rb +39 -0
- data/lib/openai/models/beta/hosted_plugin_param.rb +48 -0
- data/lib/openai/models/beta/hosted_skill.rb +55 -0
- data/lib/openai/models/beta/hosted_skill_param.rb +96 -0
- data/lib/openai/models/beta/hosted_skill_reference.rb +57 -0
- data/lib/openai/models/beta/inline_capability_source_param.rb +39 -0
- data/lib/openai/models/beta/input_content.rb +71 -0
- data/lib/openai/models/beta/input_content_param.rb +69 -0
- data/lib/openai/models/beta/mcp_transport.rb +96 -0
- data/lib/openai/models/beta/mcp_transport_param.rb +123 -0
- data/lib/openai/models/beta/multi_agent_config.rb +32 -0
- data/lib/openai/models/beta/multi_agent_config_param.rb +30 -0
- data/lib/openai/models/beta/output_text.rb +30 -0
- data/lib/openai/models/beta/persisted_agent_tool.rb +329 -0
- data/lib/openai/models/beta/persisted_agent_tool_param.rb +355 -0
- data/lib/openai/models/beta/persisted_mcp_transport.rb +105 -0
- data/lib/openai/models/beta/persisted_mcp_transport_param.rb +105 -0
- data/lib/openai/models/beta/session_error.rb +48 -0
- data/lib/openai/models/beta/session_turn_error.rb +88 -0
- data/lib/openai/models/beta/setup_command_param.rb +30 -0
- data/lib/openai/models/beta/subagent.rb +121 -0
- data/lib/openai/models/beta/summary_text.rb +30 -0
- data/lib/openai/models/beta/text_format.rb +60 -0
- data/lib/openai/models/beta/text_format_param.rb +60 -0
- data/lib/openai/models/beta/token_usage.rb +87 -0
- data/lib/openai/models/beta/web_search_action.rb +130 -0
- data/lib/openai/models/chat/completion_create_params.rb +1 -1
- data/lib/openai/resources/beta/agents/environments/files.rb +89 -0
- data/lib/openai/resources/beta/agents/environments/templates.rb +206 -0
- data/lib/openai/resources/beta/agents/environments.rb +50 -0
- data/lib/openai/resources/beta/agents/sessions/artifacts.rb +155 -0
- data/lib/openai/resources/beta/agents/sessions/events.rb +80 -0
- data/lib/openai/resources/beta/agents/sessions/items.rb +57 -0
- data/lib/openai/resources/beta/agents/sessions/subagents/items.rb +66 -0
- data/lib/openai/resources/beta/agents/sessions/subagents/turns/items.rb +82 -0
- data/lib/openai/resources/beta/agents/sessions/subagents/turns.rb +108 -0
- data/lib/openai/resources/beta/agents/sessions/subagents.rb +95 -0
- data/lib/openai/resources/beta/agents/sessions/turns.rb +89 -0
- data/lib/openai/resources/beta/agents/sessions.rb +294 -0
- data/lib/openai/resources/beta/agents/vaults/credentials.rb +195 -0
- data/lib/openai/resources/beta/agents/vaults.rb +137 -0
- data/lib/openai/resources/beta/agents.rb +213 -0
- data/lib/openai/resources/beta.rb +4 -0
- data/lib/openai/resources/live/sessions.rb +10 -4
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +176 -0
- data/rbi/openai/helpers/agents.rbi +71 -0
- data/rbi/openai/internal/token_page.rbi +25 -0
- data/rbi/openai/models/beta/agent.rbi +209 -0
- data/rbi/openai/models/beta/agent_close_subagent_call_item.rbi +102 -0
- data/rbi/openai/models/beta/agent_command_execution_item.rbi +132 -0
- data/rbi/openai/models/beta/agent_content.rbi +75 -0
- data/rbi/openai/models/beta/agent_create_params.rbi +212 -0
- data/rbi/openai/models/beta/agent_create_subagent_call_item.rbi +124 -0
- data/rbi/openai/models/beta/agent_delete_params.rbi +53 -0
- data/rbi/openai/models/beta/agent_deleted.rbi +68 -0
- data/rbi/openai/models/beta/agent_function_call_item.rbi +112 -0
- data/rbi/openai/models/beta/agent_function_call_output.rbi +33 -0
- data/rbi/openai/models/beta/agent_function_call_output_param.rbi +33 -0
- data/rbi/openai/models/beta/agent_function_call_status.rbi +35 -0
- data/rbi/openai/models/beta/agent_interrupt_subagent_call_item.rbi +103 -0
- data/rbi/openai/models/beta/agent_list_params.rbi +102 -0
- data/rbi/openai/models/beta/agent_mcp_call_item.rbi +132 -0
- data/rbi/openai/models/beta/agent_output_command_execution_output_delta_event.rbi +112 -0
- data/rbi/openai/models/beta/agent_output_item.rbi +38 -0
- data/rbi/openai/models/beta/agent_output_item_status.rbi +32 -0
- data/rbi/openai/models/beta/agent_reasoning.rbi +103 -0
- data/rbi/openai/models/beta/agent_reasoning_item.rbi +92 -0
- data/rbi/openai/models/beta/agent_reasoning_param.rbi +103 -0
- data/rbi/openai/models/beta/agent_resume_subagent_call_item.rbi +102 -0
- data/rbi/openai/models/beta/agent_retrieve_params.rbi +53 -0
- data/rbi/openai/models/beta/agent_send_subagent_input_call_item.rbi +114 -0
- data/rbi/openai/models/beta/agent_session.rbi +494 -0
- data/rbi/openai/models/beta/agent_session_assistant_message.rbi +130 -0
- data/rbi/openai/models/beta/agent_session_created_event.rbi +71 -0
- data/rbi/openai/models/beta/agent_session_deleted.rbi +71 -0
- data/rbi/openai/models/beta/agent_session_environment_connected_event.rbi +95 -0
- data/rbi/openai/models/beta/agent_session_environment_disconnected_event.rbi +95 -0
- data/rbi/openai/models/beta/agent_session_environment_failed_event.rbi +95 -0
- data/rbi/openai/models/beta/agent_session_environment_pending_event.rbi +95 -0
- data/rbi/openai/models/beta/agent_session_environment_ready_event.rbi +95 -0
- data/rbi/openai/models/beta/agent_session_environment_state.rbi +168 -0
- data/rbi/openai/models/beta/agent_session_error_event.rbi +80 -0
- data/rbi/openai/models/beta/agent_session_event.rbi +56 -0
- data/rbi/openai/models/beta/agent_session_failed_event.rbi +71 -0
- data/rbi/openai/models/beta/agent_session_idle_event.rbi +71 -0
- data/rbi/openai/models/beta/agent_session_in_progress_event.rbi +71 -0
- data/rbi/openai/models/beta/agent_session_input_message_param.rbi +100 -0
- data/rbi/openai/models/beta/agent_session_input_param.rbi +232 -0
- data/rbi/openai/models/beta/agent_session_item.rbi +239 -0
- data/rbi/openai/models/beta/agent_session_message.rbi +153 -0
- data/rbi/openai/models/beta/agent_session_message_content.rbi +172 -0
- data/rbi/openai/models/beta/agent_session_requires_action_event.rbi +71 -0
- data/rbi/openai/models/beta/agent_session_subagent_active_event.rbi +71 -0
- data/rbi/openai/models/beta/agent_session_subagent_closed_event.rbi +71 -0
- data/rbi/openai/models/beta/agent_session_subagent_created_event.rbi +71 -0
- data/rbi/openai/models/beta/agent_session_turn_cancelled_event.rbi +108 -0
- data/rbi/openai/models/beta/agent_session_turn_completed_event.rbi +108 -0
- data/rbi/openai/models/beta/agent_session_turn_content_part_added_event.rbi +125 -0
- data/rbi/openai/models/beta/agent_session_turn_content_part_done_event.rbi +125 -0
- data/rbi/openai/models/beta/agent_session_turn_created_event.rbi +95 -0
- data/rbi/openai/models/beta/agent_session_turn_failed_event.rbi +108 -0
- data/rbi/openai/models/beta/agent_session_turn_in_progress_event.rbi +95 -0
- data/rbi/openai/models/beta/agent_session_turn_item_added_event.rbi +117 -0
- data/rbi/openai/models/beta/agent_session_turn_item_done_event.rbi +115 -0
- data/rbi/openai/models/beta/agent_session_turn_output_text_delta_event.rbi +122 -0
- data/rbi/openai/models/beta/agent_session_turn_output_text_done_event.rbi +122 -0
- data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_part_added_event.rbi +127 -0
- data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_part_done_event.rbi +135 -0
- data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_text_delta_event.rbi +124 -0
- data/rbi/openai/models/beta/agent_session_turn_reasoning_summary_text_done_event.rbi +122 -0
- data/rbi/openai/models/beta/agent_text.rbi +75 -0
- data/rbi/openai/models/beta/agent_text_param.rbi +87 -0
- data/rbi/openai/models/beta/agent_tool.rbi +467 -0
- data/rbi/openai/models/beta/agent_tool_param.rbi +530 -0
- data/rbi/openai/models/beta/agent_update_params.rbi +225 -0
- data/rbi/openai/models/beta/agent_wait_for_subagents_call_item.rbi +102 -0
- data/rbi/openai/models/beta/agent_web_search_call_item.rbi +99 -0
- data/rbi/openai/models/beta/agents/environment_info.rbi +156 -0
- data/rbi/openai/models/beta/agents/environment_retrieve_params.rbi +57 -0
- data/rbi/openai/models/beta/agents/environments/environment_file.rbi +87 -0
- data/rbi/openai/models/beta/agents/environments/environment_template.rbi +582 -0
- data/rbi/openai/models/beta/agents/environments/environment_template_deleted.rbi +78 -0
- data/rbi/openai/models/beta/agents/environments/file_create_params.rbi +61 -0
- data/rbi/openai/models/beta/agents/environments/file_list_params.rbi +130 -0
- data/rbi/openai/models/beta/agents/environments/template_create_params.rbi +350 -0
- data/rbi/openai/models/beta/agents/environments/template_delete_params.rbi +61 -0
- data/rbi/openai/models/beta/agents/environments/template_list_params.rbi +117 -0
- data/rbi/openai/models/beta/agents/environments/template_retrieve_params.rbi +61 -0
- data/rbi/openai/models/beta/agents/environments/template_update_params.rbi +354 -0
- data/rbi/openai/models/beta/agents/session_create_params.rbi +336 -0
- data/rbi/openai/models/beta/agents/session_delete_params.rbi +57 -0
- data/rbi/openai/models/beta/agents/session_list_params.rbi +124 -0
- data/rbi/openai/models/beta/agents/session_retrieve_params.rbi +57 -0
- data/rbi/openai/models/beta/agents/session_update_params.rbi +74 -0
- data/rbi/openai/models/beta/agents/sessions/artifact_content_params.rbi +68 -0
- data/rbi/openai/models/beta/agents/sessions/artifact_delete_params.rbi +68 -0
- data/rbi/openai/models/beta/agents/sessions/artifact_list_params.rbi +127 -0
- data/rbi/openai/models/beta/agents/sessions/artifact_retrieve_params.rbi +68 -0
- data/rbi/openai/models/beta/agents/sessions/event_create_params.rbi +107 -0
- data/rbi/openai/models/beta/agents/sessions/event_stream_params.rbi +61 -0
- data/rbi/openai/models/beta/agents/sessions/item_list_params.rbi +121 -0
- data/rbi/openai/models/beta/agents/sessions/session_artifact.rbi +132 -0
- data/rbi/openai/models/beta/agents/sessions/session_artifact_deleted.rbi +78 -0
- data/rbi/openai/models/beta/agents/sessions/subagent_list_params.rbi +123 -0
- data/rbi/openai/models/beta/agents/sessions/subagent_retrieve_params.rbi +68 -0
- data/rbi/openai/models/beta/agents/sessions/subagents/item_list_params.rbi +139 -0
- data/rbi/openai/models/beta/agents/sessions/subagents/turn_list_params.rbi +139 -0
- data/rbi/openai/models/beta/agents/sessions/subagents/turn_retrieve_params.rbi +79 -0
- data/rbi/openai/models/beta/agents/sessions/subagents/turns/item_list_params.rbi +161 -0
- data/rbi/openai/models/beta/agents/sessions/turn.rbi +200 -0
- data/rbi/openai/models/beta/agents/sessions/turn_list_params.rbi +121 -0
- data/rbi/openai/models/beta/agents/sessions/turn_retrieve_params.rbi +68 -0
- data/rbi/openai/models/beta/agents/vault.rbi +99 -0
- data/rbi/openai/models/beta/agents/vault_create_params.rbi +75 -0
- data/rbi/openai/models/beta/agents/vault_delete_params.rbi +57 -0
- data/rbi/openai/models/beta/agents/vault_deleted.rbi +72 -0
- data/rbi/openai/models/beta/agents/vault_list_params.rbi +149 -0
- data/rbi/openai/models/beta/agents/vault_retrieve_params.rbi +57 -0
- data/rbi/openai/models/beta/agents/vault_status.rbi +30 -0
- data/rbi/openai/models/beta/agents/vault_status_filter.rbi +39 -0
- data/rbi/openai/models/beta/agents/vaults/credential.rbi +123 -0
- data/rbi/openai/models/beta/agents/vaults/credential_auth.rbi +248 -0
- data/rbi/openai/models/beta/agents/vaults/credential_auth_create_param.rbi +293 -0
- data/rbi/openai/models/beta/agents/vaults/credential_auth_rotate_param.rbi +252 -0
- data/rbi/openai/models/beta/agents/vaults/credential_create_params.rbi +99 -0
- data/rbi/openai/models/beta/agents/vaults/credential_delete_params.rbi +68 -0
- data/rbi/openai/models/beta/agents/vaults/credential_deleted.rbi +76 -0
- data/rbi/openai/models/beta/agents/vaults/credential_list_params.rbi +163 -0
- data/rbi/openai/models/beta/agents/vaults/credential_retrieve_params.rbi +68 -0
- data/rbi/openai/models/beta/agents/vaults/credential_update_params.rbi +95 -0
- data/rbi/openai/models/beta/agents/vaults/mcp_oauth_token_endpoint_auth.rbi +151 -0
- data/rbi/openai/models/beta/agents/vaults/mcp_oauth_token_endpoint_auth_create_param.rbi +171 -0
- data/rbi/openai/models/beta/agents/vaults/mcp_oauth_token_endpoint_auth_rotate_param.rbi +137 -0
- data/rbi/openai/models/beta/environment.rbi +400 -0
- data/rbi/openai/models/beta/environment_param.rbi +448 -0
- data/rbi/openai/models/beta/hosted_environment_file.rbi +93 -0
- data/rbi/openai/models/beta/hosted_environment_file_id.rbi +86 -0
- data/rbi/openai/models/beta/hosted_environment_file_param.rbi +140 -0
- data/rbi/openai/models/beta/hosted_plugin.rbi +68 -0
- data/rbi/openai/models/beta/hosted_plugin_param.rbi +80 -0
- data/rbi/openai/models/beta/hosted_skill.rbi +84 -0
- data/rbi/openai/models/beta/hosted_skill_param.rbi +152 -0
- data/rbi/openai/models/beta/hosted_skill_reference.rbi +86 -0
- data/rbi/openai/models/beta/inline_capability_source_param.rbi +68 -0
- data/rbi/openai/models/beta/input_content.rbi +124 -0
- data/rbi/openai/models/beta/input_content_param.rbi +122 -0
- data/rbi/openai/models/beta/mcp_transport.rbi +149 -0
- data/rbi/openai/models/beta/mcp_transport_param.rbi +188 -0
- data/rbi/openai/models/beta/multi_agent_config.rbi +61 -0
- data/rbi/openai/models/beta/multi_agent_config_param.rbi +62 -0
- data/rbi/openai/models/beta/output_text.rbi +59 -0
- data/rbi/openai/models/beta/persisted_agent_tool.rbi +507 -0
- data/rbi/openai/models/beta/persisted_agent_tool_param.rbi +546 -0
- data/rbi/openai/models/beta/persisted_mcp_transport.rbi +158 -0
- data/rbi/openai/models/beta/persisted_mcp_transport_param.rbi +164 -0
- data/rbi/openai/models/beta/session_error.rbi +77 -0
- data/rbi/openai/models/beta/session_turn_error.rbi +125 -0
- data/rbi/openai/models/beta/setup_command_param.rbi +59 -0
- data/rbi/openai/models/beta/subagent.rbi +158 -0
- data/rbi/openai/models/beta/summary_text.rbi +59 -0
- data/rbi/openai/models/beta/text_format.rbi +113 -0
- data/rbi/openai/models/beta/text_format_param.rbi +113 -0
- data/rbi/openai/models/beta/token_usage.rbi +174 -0
- data/rbi/openai/models/beta/web_search_action.rbi +227 -0
- data/rbi/openai/resources/beta/agents/environments/files.rbi +79 -0
- data/rbi/openai/resources/beta/agents/environments/templates.rbi +194 -0
- data/rbi/openai/resources/beta/agents/environments.rbi +44 -0
- data/rbi/openai/resources/beta/agents/sessions/artifacts.rbi +105 -0
- data/rbi/openai/resources/beta/agents/sessions/events.rbi +71 -0
- data/rbi/openai/resources/beta/agents/sessions/items.rbi +53 -0
- data/rbi/openai/resources/beta/agents/sessions/subagents/items.rbi +60 -0
- data/rbi/openai/resources/beta/agents/sessions/subagents/turns/items.rbi +67 -0
- data/rbi/openai/resources/beta/agents/sessions/subagents/turns.rbi +85 -0
- data/rbi/openai/resources/beta/agents/sessions/subagents.rbi +74 -0
- data/rbi/openai/resources/beta/agents/sessions/turns.rbi +70 -0
- data/rbi/openai/resources/beta/agents/sessions.rbi +208 -0
- data/rbi/openai/resources/beta/agents/vaults/credentials.rbi +148 -0
- data/rbi/openai/resources/beta/agents/vaults.rbi +106 -0
- data/rbi/openai/resources/beta/agents.rbi +180 -0
- data/rbi/openai/resources/beta.rbi +3 -0
- data/rbi/openai/resources/live/sessions.rbi +10 -4
- data/rbi/openai/resources/responses.rbi +8 -8
- data/sig/openai/helpers/agents.rbs +50 -0
- data/sig/openai/internal/token_page.rbs +15 -0
- data/sig/openai/models/beta/agent.rbs +96 -0
- data/sig/openai/models/beta/agent_close_subagent_call_item.rbs +47 -0
- data/sig/openai/models/beta/agent_command_execution_item.rbs +62 -0
- data/sig/openai/models/beta/agent_content.rbs +33 -0
- data/sig/openai/models/beta/agent_create_params.rbs +91 -0
- data/sig/openai/models/beta/agent_create_subagent_call_item.rbs +57 -0
- data/sig/openai/models/beta/agent_delete_params.rbs +25 -0
- data/sig/openai/models/beta/agent_deleted.rbs +24 -0
- data/sig/openai/models/beta/agent_function_call_item.rbs +52 -0
- data/sig/openai/models/beta/agent_function_call_output.rbs +16 -0
- data/sig/openai/models/beta/agent_function_call_output_param.rbs +16 -0
- data/sig/openai/models/beta/agent_function_call_status.rbs +26 -0
- data/sig/openai/models/beta/agent_interrupt_subagent_call_item.rbs +47 -0
- data/sig/openai/models/beta/agent_list_params.rbs +58 -0
- data/sig/openai/models/beta/agent_mcp_call_item.rbs +62 -0
- data/sig/openai/models/beta/agent_output_command_execution_output_delta_event.rbs +52 -0
- data/sig/openai/models/beta/agent_output_item.rbs +25 -0
- data/sig/openai/models/beta/agent_output_item_status.rbs +22 -0
- data/sig/openai/models/beta/agent_reasoning.rbs +60 -0
- data/sig/openai/models/beta/agent_reasoning_item.rbs +42 -0
- data/sig/openai/models/beta/agent_reasoning_param.rbs +60 -0
- data/sig/openai/models/beta/agent_resume_subagent_call_item.rbs +47 -0
- data/sig/openai/models/beta/agent_retrieve_params.rbs +25 -0
- data/sig/openai/models/beta/agent_send_subagent_input_call_item.rbs +52 -0
- data/sig/openai/models/beta/agent_session.rbs +234 -0
- data/sig/openai/models/beta/agent_session_assistant_message.rbs +66 -0
- data/sig/openai/models/beta/agent_session_created_event.rbs +32 -0
- data/sig/openai/models/beta/agent_session_deleted.rbs +28 -0
- data/sig/openai/models/beta/agent_session_environment_connected_event.rbs +42 -0
- data/sig/openai/models/beta/agent_session_environment_disconnected_event.rbs +42 -0
- data/sig/openai/models/beta/agent_session_environment_failed_event.rbs +42 -0
- data/sig/openai/models/beta/agent_session_environment_pending_event.rbs +42 -0
- data/sig/openai/models/beta/agent_session_environment_ready_event.rbs +42 -0
- data/sig/openai/models/beta/agent_session_environment_state.rbs +74 -0
- data/sig/openai/models/beta/agent_session_error_event.rbs +37 -0
- data/sig/openai/models/beta/agent_session_event.rbs +43 -0
- data/sig/openai/models/beta/agent_session_failed_event.rbs +32 -0
- data/sig/openai/models/beta/agent_session_idle_event.rbs +32 -0
- data/sig/openai/models/beta/agent_session_in_progress_event.rbs +32 -0
- data/sig/openai/models/beta/agent_session_input_message_param.rbs +46 -0
- data/sig/openai/models/beta/agent_session_input_param.rbs +91 -0
- data/sig/openai/models/beta/agent_session_item.rbs +116 -0
- data/sig/openai/models/beta/agent_session_message.rbs +77 -0
- data/sig/openai/models/beta/agent_session_message_content.rbs +52 -0
- data/sig/openai/models/beta/agent_session_requires_action_event.rbs +32 -0
- data/sig/openai/models/beta/agent_session_subagent_active_event.rbs +32 -0
- data/sig/openai/models/beta/agent_session_subagent_closed_event.rbs +32 -0
- data/sig/openai/models/beta/agent_session_subagent_created_event.rbs +32 -0
- data/sig/openai/models/beta/agent_session_turn_cancelled_event.rbs +47 -0
- data/sig/openai/models/beta/agent_session_turn_completed_event.rbs +47 -0
- data/sig/openai/models/beta/agent_session_turn_content_part_added_event.rbs +57 -0
- data/sig/openai/models/beta/agent_session_turn_content_part_done_event.rbs +57 -0
- data/sig/openai/models/beta/agent_session_turn_created_event.rbs +42 -0
- data/sig/openai/models/beta/agent_session_turn_failed_event.rbs +47 -0
- data/sig/openai/models/beta/agent_session_turn_in_progress_event.rbs +42 -0
- data/sig/openai/models/beta/agent_session_turn_item_added_event.rbs +47 -0
- data/sig/openai/models/beta/agent_session_turn_item_done_event.rbs +47 -0
- data/sig/openai/models/beta/agent_session_turn_output_text_delta_event.rbs +57 -0
- data/sig/openai/models/beta/agent_session_turn_output_text_done_event.rbs +57 -0
- data/sig/openai/models/beta/agent_session_turn_reasoning_summary_part_added_event.rbs +57 -0
- data/sig/openai/models/beta/agent_session_turn_reasoning_summary_part_done_event.rbs +64 -0
- data/sig/openai/models/beta/agent_session_turn_reasoning_summary_text_delta_event.rbs +57 -0
- data/sig/openai/models/beta/agent_session_turn_reasoning_summary_text_done_event.rbs +57 -0
- data/sig/openai/models/beta/agent_text.rbs +39 -0
- data/sig/openai/models/beta/agent_text_param.rbs +44 -0
- data/sig/openai/models/beta/agent_tool.rbs +226 -0
- data/sig/openai/models/beta/agent_tool_param.rbs +251 -0
- data/sig/openai/models/beta/agent_update_params.rbs +98 -0
- data/sig/openai/models/beta/agent_wait_for_subagents_call_item.rbs +47 -0
- data/sig/openai/models/beta/agent_web_search_call_item.rbs +42 -0
- data/sig/openai/models/beta/agents/environment_info.rbs +80 -0
- data/sig/openai/models/beta/agents/environment_retrieve_params.rbs +27 -0
- data/sig/openai/models/beta/agents/environments/environment_file.rbs +43 -0
- data/sig/openai/models/beta/agents/environments/environment_template.rbs +255 -0
- data/sig/openai/models/beta/agents/environments/environment_template_deleted.rbs +38 -0
- data/sig/openai/models/beta/agents/environments/file_create_params.rbs +29 -0
- data/sig/openai/models/beta/agents/environments/file_list_params.rbs +72 -0
- data/sig/openai/models/beta/agents/environments/template_create_params.rbs +138 -0
- data/sig/openai/models/beta/agents/environments/template_delete_params.rbs +32 -0
- data/sig/openai/models/beta/agents/environments/template_list_params.rbs +64 -0
- data/sig/openai/models/beta/agents/environments/template_retrieve_params.rbs +32 -0
- data/sig/openai/models/beta/agents/environments/template_update_params.rbs +143 -0
- data/sig/openai/models/beta/agents/session_create_params.rbs +144 -0
- data/sig/openai/models/beta/agents/session_delete_params.rbs +27 -0
- data/sig/openai/models/beta/agents/session_list_params.rbs +67 -0
- data/sig/openai/models/beta/agents/session_retrieve_params.rbs +27 -0
- data/sig/openai/models/beta/agents/session_update_params.rbs +35 -0
- data/sig/openai/models/beta/agents/sessions/artifact_content_params.rbs +37 -0
- data/sig/openai/models/beta/agents/sessions/artifact_delete_params.rbs +37 -0
- data/sig/openai/models/beta/agents/sessions/artifact_list_params.rbs +70 -0
- data/sig/openai/models/beta/agents/sessions/artifact_retrieve_params.rbs +37 -0
- data/sig/openai/models/beta/agents/sessions/event_create_params.rbs +44 -0
- data/sig/openai/models/beta/agents/sessions/event_stream_params.rbs +29 -0
- data/sig/openai/models/beta/agents/sessions/item_list_params.rbs +69 -0
- data/sig/openai/models/beta/agents/sessions/session_artifact.rbs +63 -0
- data/sig/openai/models/beta/agents/sessions/session_artifact_deleted.rbs +38 -0
- data/sig/openai/models/beta/agents/sessions/subagent_list_params.rbs +69 -0
- data/sig/openai/models/beta/agents/sessions/subagent_retrieve_params.rbs +37 -0
- data/sig/openai/models/beta/agents/sessions/subagents/item_list_params.rbs +76 -0
- data/sig/openai/models/beta/agents/sessions/subagents/turn_list_params.rbs +76 -0
- data/sig/openai/models/beta/agents/sessions/subagents/turn_retrieve_params.rbs +44 -0
- data/sig/openai/models/beta/agents/sessions/subagents/turns/item_list_params.rbs +83 -0
- data/sig/openai/models/beta/agents/sessions/turn.rbs +108 -0
- data/sig/openai/models/beta/agents/sessions/turn_list_params.rbs +69 -0
- data/sig/openai/models/beta/agents/sessions/turn_retrieve_params.rbs +37 -0
- data/sig/openai/models/beta/agents/vault.rbs +44 -0
- data/sig/openai/models/beta/agents/vault_create_params.rbs +37 -0
- data/sig/openai/models/beta/agents/vault_delete_params.rbs +27 -0
- data/sig/openai/models/beta/agents/vault_deleted.rbs +30 -0
- data/sig/openai/models/beta/agents/vault_list_params.rbs +69 -0
- data/sig/openai/models/beta/agents/vault_retrieve_params.rbs +27 -0
- data/sig/openai/models/beta/agents/vault_status.rbs +18 -0
- data/sig/openai/models/beta/agents/vault_status_filter.rbs +19 -0
- data/sig/openai/models/beta/agents/vaults/credential.rbs +56 -0
- data/sig/openai/models/beta/agents/vaults/credential_auth.rbs +104 -0
- data/sig/openai/models/beta/agents/vaults/credential_auth_create_param.rbs +121 -0
- data/sig/openai/models/beta/agents/vaults/credential_auth_rotate_param.rbs +90 -0
- data/sig/openai/models/beta/agents/vaults/credential_create_params.rbs +42 -0
- data/sig/openai/models/beta/agents/vaults/credential_delete_params.rbs +37 -0
- data/sig/openai/models/beta/agents/vaults/credential_deleted.rbs +32 -0
- data/sig/openai/models/beta/agents/vaults/credential_list_params.rbs +76 -0
- data/sig/openai/models/beta/agents/vaults/credential_retrieve_params.rbs +37 -0
- data/sig/openai/models/beta/agents/vaults/credential_update_params.rbs +42 -0
- data/sig/openai/models/beta/agents/vaults/mcp_oauth_token_endpoint_auth.rbs +50 -0
- data/sig/openai/models/beta/agents/vaults/mcp_oauth_token_endpoint_auth_create_param.rbs +68 -0
- data/sig/openai/models/beta/agents/vaults/mcp_oauth_token_endpoint_auth_rotate_param.rbs +57 -0
- data/sig/openai/models/beta/environment.rbs +181 -0
- data/sig/openai/models/beta/environment_param.rbs +183 -0
- data/sig/openai/models/beta/hosted_environment_file.rbs +42 -0
- data/sig/openai/models/beta/hosted_environment_file_id.rbs +42 -0
- data/sig/openai/models/beta/hosted_environment_file_param.rbs +47 -0
- data/sig/openai/models/beta/hosted_plugin.rbs +23 -0
- data/sig/openai/models/beta/hosted_plugin_param.rbs +37 -0
- data/sig/openai/models/beta/hosted_skill.rbs +32 -0
- data/sig/openai/models/beta/hosted_skill_param.rbs +70 -0
- data/sig/openai/models/beta/hosted_skill_reference.rbs +42 -0
- data/sig/openai/models/beta/inline_capability_source_param.rbs +28 -0
- data/sig/openai/models/beta/input_content.rbs +39 -0
- data/sig/openai/models/beta/input_content_param.rbs +39 -0
- data/sig/openai/models/beta/mcp_transport.rbs +63 -0
- data/sig/openai/models/beta/mcp_transport_param.rbs +89 -0
- data/sig/openai/models/beta/multi_agent_config.rbs +21 -0
- data/sig/openai/models/beta/multi_agent_config_param.rbs +23 -0
- data/sig/openai/models/beta/output_text.rbs +17 -0
- data/sig/openai/models/beta/persisted_agent_tool.rbs +237 -0
- data/sig/openai/models/beta/persisted_agent_tool_param.rbs +251 -0
- data/sig/openai/models/beta/persisted_mcp_transport.rbs +75 -0
- data/sig/openai/models/beta/persisted_mcp_transport_param.rbs +79 -0
- data/sig/openai/models/beta/session_error.rbs +32 -0
- data/sig/openai/models/beta/session_turn_error.rbs +96 -0
- data/sig/openai/models/beta/setup_command_param.rbs +17 -0
- data/sig/openai/models/beta/subagent.rbs +76 -0
- data/sig/openai/models/beta/summary_text.rbs +17 -0
- data/sig/openai/models/beta/text_format.rbs +39 -0
- data/sig/openai/models/beta/text_format_param.rbs +40 -0
- data/sig/openai/models/beta/token_usage.rbs +62 -0
- data/sig/openai/models/beta/web_search_action.rbs +85 -0
- data/sig/openai/resources/beta/agents/environments/files.rbs +28 -0
- data/sig/openai/resources/beta/agents/environments/templates.rbs +57 -0
- data/sig/openai/resources/beta/agents/environments.rbs +20 -0
- data/sig/openai/resources/beta/agents/sessions/artifacts.rbs +40 -0
- data/sig/openai/resources/beta/agents/sessions/events.rbs +25 -0
- data/sig/openai/resources/beta/agents/sessions/items.rbs +21 -0
- data/sig/openai/resources/beta/agents/sessions/subagents/items.rbs +24 -0
- data/sig/openai/resources/beta/agents/sessions/subagents/turns/items.rbs +27 -0
- data/sig/openai/resources/beta/agents/sessions/subagents/turns.rbs +33 -0
- data/sig/openai/resources/beta/agents/sessions/subagents.rbs +31 -0
- data/sig/openai/resources/beta/agents/sessions/turns.rbs +27 -0
- data/sig/openai/resources/beta/agents/sessions.rbs +65 -0
- data/sig/openai/resources/beta/agents/vaults/credentials.rbs +48 -0
- data/sig/openai/resources/beta/agents/vaults.rbs +37 -0
- data/sig/openai/resources/beta/agents.rbs +59 -0
- data/sig/openai/resources/beta.rbs +2 -0
- metadata +525 -1
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Resources
|
|
5
|
+
class Beta
|
|
6
|
+
class Agents
|
|
7
|
+
class Sessions
|
|
8
|
+
class Artifacts
|
|
9
|
+
# Retrieves immutable metadata for one durable session artifact. See
|
|
10
|
+
# [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).
|
|
11
|
+
#
|
|
12
|
+
# @overload retrieve(artifact_id, session_id:, request_options: {})
|
|
13
|
+
#
|
|
14
|
+
# @param artifact_id [String]
|
|
15
|
+
# The immutable session artifact ID.
|
|
16
|
+
#
|
|
17
|
+
# @param session_id [String]
|
|
18
|
+
# The ID of the session that owns the artifact.
|
|
19
|
+
#
|
|
20
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
21
|
+
#
|
|
22
|
+
# @return [OpenAI::Models::Beta::Agents::Sessions::SessionArtifact]
|
|
23
|
+
#
|
|
24
|
+
# @see OpenAI::Models::Beta::Agents::Sessions::ArtifactRetrieveParams
|
|
25
|
+
def retrieve(artifact_id, params)
|
|
26
|
+
parsed, options = OpenAI::Beta::Agents::Sessions::ArtifactRetrieveParams.dump_request(params)
|
|
27
|
+
session_id = parsed.delete(:session_id) do
|
|
28
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
@client.request(
|
|
32
|
+
method: :get,
|
|
33
|
+
path: ["agents/sessions/%1$s/artifacts/%2$s", session_id, artifact_id],
|
|
34
|
+
model: OpenAI::Beta::Agents::Sessions::SessionArtifact,
|
|
35
|
+
security: {bearer_auth: true},
|
|
36
|
+
options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
|
|
37
|
+
)
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
# Lists immutable artifacts published by completed hosted session turns. See
|
|
41
|
+
# [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).
|
|
42
|
+
#
|
|
43
|
+
# @overload list(session_id, after: nil, environment_id: nil, limit: nil, order: nil, request_options: {})
|
|
44
|
+
#
|
|
45
|
+
# @param session_id [String]
|
|
46
|
+
# The ID of the session.
|
|
47
|
+
#
|
|
48
|
+
# @param after [String, nil]
|
|
49
|
+
# Return artifacts after this immutable artifact ID.
|
|
50
|
+
#
|
|
51
|
+
# @param environment_id [String, nil]
|
|
52
|
+
# Restrict the listing to artifacts produced by this environment.
|
|
53
|
+
#
|
|
54
|
+
# @param limit [Integer, nil]
|
|
55
|
+
# The maximum number of artifacts to return, between 1 and 100.
|
|
56
|
+
#
|
|
57
|
+
# @param order [Symbol, OpenAI::Models::Beta::Agents::Sessions::ArtifactListParams::Order]
|
|
58
|
+
# Sort by creation time and ID. Defaults to descending.
|
|
59
|
+
#
|
|
60
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
61
|
+
#
|
|
62
|
+
# @return [OpenAI::Internal::CursorPage<OpenAI::Models::Beta::Agents::Sessions::SessionArtifact>]
|
|
63
|
+
#
|
|
64
|
+
# @see OpenAI::Models::Beta::Agents::Sessions::ArtifactListParams
|
|
65
|
+
def list(session_id, params = {})
|
|
66
|
+
parsed, options = OpenAI::Beta::Agents::Sessions::ArtifactListParams.dump_request(params)
|
|
67
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
68
|
+
@client.request(
|
|
69
|
+
method: :get,
|
|
70
|
+
path: ["agents/sessions/%1$s/artifacts", session_id],
|
|
71
|
+
query: query,
|
|
72
|
+
page: OpenAI::Internal::CursorPage,
|
|
73
|
+
model: OpenAI::Beta::Agents::Sessions::SessionArtifact,
|
|
74
|
+
security: {bearer_auth: true},
|
|
75
|
+
options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
|
|
76
|
+
)
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
# Deletes an immutable session artifact without deleting its live environment file
|
|
80
|
+
# or original Files API object. See
|
|
81
|
+
# [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).
|
|
82
|
+
#
|
|
83
|
+
# @overload delete(artifact_id, session_id:, request_options: {})
|
|
84
|
+
#
|
|
85
|
+
# @param artifact_id [String]
|
|
86
|
+
# The immutable session artifact ID.
|
|
87
|
+
#
|
|
88
|
+
# @param session_id [String]
|
|
89
|
+
# The ID of the session that owns the artifact.
|
|
90
|
+
#
|
|
91
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
92
|
+
#
|
|
93
|
+
# @return [OpenAI::Models::Beta::Agents::Sessions::SessionArtifactDeleted]
|
|
94
|
+
#
|
|
95
|
+
# @see OpenAI::Models::Beta::Agents::Sessions::ArtifactDeleteParams
|
|
96
|
+
def delete(artifact_id, params)
|
|
97
|
+
parsed, options = OpenAI::Beta::Agents::Sessions::ArtifactDeleteParams.dump_request(params)
|
|
98
|
+
session_id = parsed.delete(:session_id) do
|
|
99
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
@client.request(
|
|
103
|
+
method: :delete,
|
|
104
|
+
path: ["agents/sessions/%1$s/artifacts/%2$s", session_id, artifact_id],
|
|
105
|
+
model: OpenAI::Beta::Agents::Sessions::SessionArtifactDeleted,
|
|
106
|
+
security: {bearer_auth: true},
|
|
107
|
+
options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
|
|
108
|
+
)
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
# Downloads immutable session artifact bytes after the execution environment
|
|
112
|
+
# expires. See
|
|
113
|
+
# [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).
|
|
114
|
+
#
|
|
115
|
+
# @overload content(artifact_id, session_id:, request_options: {})
|
|
116
|
+
#
|
|
117
|
+
# @param artifact_id [String]
|
|
118
|
+
# The immutable session artifact ID.
|
|
119
|
+
#
|
|
120
|
+
# @param session_id [String]
|
|
121
|
+
# The ID of the session that owns the artifact.
|
|
122
|
+
#
|
|
123
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
124
|
+
#
|
|
125
|
+
# @return [StringIO]
|
|
126
|
+
#
|
|
127
|
+
# @see OpenAI::Models::Beta::Agents::Sessions::ArtifactContentParams
|
|
128
|
+
def content(artifact_id, params)
|
|
129
|
+
parsed, options = OpenAI::Beta::Agents::Sessions::ArtifactContentParams.dump_request(params)
|
|
130
|
+
session_id = parsed.delete(:session_id) do
|
|
131
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
@client.request(
|
|
135
|
+
method: :get,
|
|
136
|
+
path: ["agents/sessions/%1$s/artifacts/%2$s/content", session_id, artifact_id],
|
|
137
|
+
headers: {"accept" => "application/octet-stream"},
|
|
138
|
+
model: StringIO,
|
|
139
|
+
security: {bearer_auth: true},
|
|
140
|
+
options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
|
|
141
|
+
)
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
# @api private
|
|
145
|
+
#
|
|
146
|
+
# @param client [OpenAI::Client]
|
|
147
|
+
def initialize(client:)
|
|
148
|
+
@client = client
|
|
149
|
+
end
|
|
150
|
+
end
|
|
151
|
+
end
|
|
152
|
+
end
|
|
153
|
+
end
|
|
154
|
+
end
|
|
155
|
+
end
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Resources
|
|
5
|
+
class Beta
|
|
6
|
+
class Agents
|
|
7
|
+
class Sessions
|
|
8
|
+
class Events
|
|
9
|
+
# Submits message, cancellation, or tool-result events to a managed agent session.
|
|
10
|
+
# See
|
|
11
|
+
# [session events](https://developers.openai.com/api/docs/guides/agents-api/sessions/events).
|
|
12
|
+
#
|
|
13
|
+
# @overload create(session_id, events:, idempotency_key: nil, request_options: {})
|
|
14
|
+
#
|
|
15
|
+
# @param session_id [String]
|
|
16
|
+
# Path param: The ID of the session.
|
|
17
|
+
#
|
|
18
|
+
# @param events [Array<OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputMessage, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputCancel, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputToolResult>]
|
|
19
|
+
# Body param: The input events to submit to the session.
|
|
20
|
+
#
|
|
21
|
+
# @param idempotency_key [String]
|
|
22
|
+
# Header param: An optional client-generated key that makes retries of submitted
|
|
23
|
+
# messages idempotent.
|
|
24
|
+
#
|
|
25
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
26
|
+
#
|
|
27
|
+
# @return [nil]
|
|
28
|
+
#
|
|
29
|
+
# @see OpenAI::Models::Beta::Agents::Sessions::EventCreateParams
|
|
30
|
+
def create(session_id, params)
|
|
31
|
+
parsed, options = OpenAI::Beta::Agents::Sessions::EventCreateParams.dump_request(params)
|
|
32
|
+
header_params = {idempotency_key: "idempotency-key"}
|
|
33
|
+
@client.request(
|
|
34
|
+
method: :post,
|
|
35
|
+
path: ["agents/sessions/%1$s/events", session_id],
|
|
36
|
+
headers: parsed.slice(*header_params.keys).transform_keys(header_params),
|
|
37
|
+
body: parsed.except(*header_params.keys),
|
|
38
|
+
model: NilClass,
|
|
39
|
+
security: {bearer_auth: true},
|
|
40
|
+
options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
|
|
41
|
+
)
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
# Streams live events for an agent session. See
|
|
45
|
+
# [session events](https://developers.openai.com/api/docs/guides/agents-api/sessions/events).
|
|
46
|
+
#
|
|
47
|
+
# @overload stream_streaming(session_id, request_options: {})
|
|
48
|
+
#
|
|
49
|
+
# @param session_id [String]
|
|
50
|
+
# The ID of the session.
|
|
51
|
+
#
|
|
52
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
53
|
+
#
|
|
54
|
+
# @return [OpenAI::Internal::Stream<OpenAI::Models::Beta::AgentSessionErrorEvent, OpenAI::Models::Beta::AgentSessionEnvironmentReadyEvent, OpenAI::Models::Beta::AgentOutputCommandExecutionOutputDeltaEvent, OpenAI::Models::Beta::AgentSessionCreatedEvent, OpenAI::Models::Beta::AgentSessionTurnCreatedEvent, OpenAI::Models::Beta::AgentSessionTurnInProgressEvent, OpenAI::Models::Beta::AgentSessionTurnCompletedEvent, OpenAI::Models::Beta::AgentSessionTurnFailedEvent, OpenAI::Models::Beta::AgentSessionTurnCancelledEvent, OpenAI::Models::Beta::AgentSessionTurnItemAddedEvent, OpenAI::Models::Beta::AgentSessionIdleEvent, OpenAI::Models::Beta::AgentSessionInProgressEvent, OpenAI::Models::Beta::AgentSessionRequiresActionEvent, OpenAI::Models::Beta::AgentSessionFailedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentPendingEvent, OpenAI::Models::Beta::AgentSessionEnvironmentConnectedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentDisconnectedEvent, OpenAI::Models::Beta::AgentSessionEnvironmentFailedEvent, OpenAI::Models::Beta::AgentSessionSubagentCreatedEvent, OpenAI::Models::Beta::AgentSessionSubagentActiveEvent, OpenAI::Models::Beta::AgentSessionSubagentClosedEvent, OpenAI::Models::Beta::AgentSessionTurnItemDoneEvent, OpenAI::Models::Beta::AgentSessionTurnContentPartAddedEvent, OpenAI::Models::Beta::AgentSessionTurnContentPartDoneEvent, OpenAI::Models::Beta::AgentSessionTurnOutputTextDeltaEvent, OpenAI::Models::Beta::AgentSessionTurnOutputTextDoneEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryPartAddedEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryPartDoneEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryTextDeltaEvent, OpenAI::Models::Beta::AgentSessionTurnReasoningSummaryTextDoneEvent>]
|
|
55
|
+
#
|
|
56
|
+
# @see OpenAI::Models::Beta::Agents::Sessions::EventStreamParams
|
|
57
|
+
def stream_streaming(session_id, params = {})
|
|
58
|
+
@client.request(
|
|
59
|
+
method: :get,
|
|
60
|
+
path: ["agents/sessions/%1$s/events", session_id],
|
|
61
|
+
headers: {"accept" => "text/event-stream", "accept-encoding" => "identity"},
|
|
62
|
+
stream: OpenAI::Internal::Stream,
|
|
63
|
+
model: OpenAI::Beta::AgentSessionEvent,
|
|
64
|
+
security: {bearer_auth: true},
|
|
65
|
+
options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **params[:request_options].to_h}
|
|
66
|
+
)
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
# @api private
|
|
70
|
+
#
|
|
71
|
+
# @param client [OpenAI::Client]
|
|
72
|
+
def initialize(client:)
|
|
73
|
+
@client = client
|
|
74
|
+
end
|
|
75
|
+
end
|
|
76
|
+
end
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
end
|
|
80
|
+
end
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Resources
|
|
5
|
+
class Beta
|
|
6
|
+
class Agents
|
|
7
|
+
class Sessions
|
|
8
|
+
class Items
|
|
9
|
+
# Lists items produced by the session's root agent, including its interactions
|
|
10
|
+
# with subagents. Each subagent has its own item history. See
|
|
11
|
+
# [inspecting agent output](https://developers.openai.com/api/docs/guides/agents-api/observability).
|
|
12
|
+
#
|
|
13
|
+
# @overload list(session_id, after: nil, limit: nil, order: nil, request_options: {})
|
|
14
|
+
#
|
|
15
|
+
# @param session_id [String]
|
|
16
|
+
# The ID of the session.
|
|
17
|
+
#
|
|
18
|
+
# @param after [String]
|
|
19
|
+
# Return resources after this resource ID in the selected order.
|
|
20
|
+
#
|
|
21
|
+
# @param limit [Integer]
|
|
22
|
+
# The maximum number of resources to return, between 1 and 100. Defaults to 20.
|
|
23
|
+
#
|
|
24
|
+
# @param order [Symbol, OpenAI::Models::Beta::Agents::Sessions::ItemListParams::Order]
|
|
25
|
+
# The order in which resources are returned. Defaults to `desc`.
|
|
26
|
+
#
|
|
27
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
28
|
+
#
|
|
29
|
+
# @return [OpenAI::Internal::CursorPage<OpenAI::Models::Beta::AgentSessionMessage, OpenAI::Models::Beta::AgentReasoningItem, OpenAI::Models::Beta::AgentFunctionCallItem, OpenAI::Models::Beta::AgentSessionItem::FunctionCallOutput, OpenAI::Models::Beta::AgentSessionItem::AgentMessage, OpenAI::Models::Beta::AgentMcpCallItem, OpenAI::Models::Beta::AgentWebSearchCallItem, OpenAI::Models::Beta::AgentCommandExecutionItem, OpenAI::Models::Beta::AgentCreateSubagentCallItem, OpenAI::Models::Beta::AgentSendSubagentInputCallItem, OpenAI::Models::Beta::AgentResumeSubagentCallItem, OpenAI::Models::Beta::AgentWaitForSubagentsCallItem, OpenAI::Models::Beta::AgentInterruptSubagentCallItem, OpenAI::Models::Beta::AgentCloseSubagentCallItem>]
|
|
30
|
+
#
|
|
31
|
+
# @see OpenAI::Models::Beta::Agents::Sessions::ItemListParams
|
|
32
|
+
def list(session_id, params = {})
|
|
33
|
+
parsed, options = OpenAI::Beta::Agents::Sessions::ItemListParams.dump_request(params)
|
|
34
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
35
|
+
@client.request(
|
|
36
|
+
method: :get,
|
|
37
|
+
path: ["agents/sessions/%1$s/items", session_id],
|
|
38
|
+
query: query,
|
|
39
|
+
page: OpenAI::Internal::CursorPage,
|
|
40
|
+
model: OpenAI::Beta::AgentSessionItem,
|
|
41
|
+
security: {bearer_auth: true},
|
|
42
|
+
options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
|
|
43
|
+
)
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
# @api private
|
|
47
|
+
#
|
|
48
|
+
# @param client [OpenAI::Client]
|
|
49
|
+
def initialize(client:)
|
|
50
|
+
@client = client
|
|
51
|
+
end
|
|
52
|
+
end
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
end
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Resources
|
|
5
|
+
class Beta
|
|
6
|
+
class Agents
|
|
7
|
+
class Sessions
|
|
8
|
+
class Subagents
|
|
9
|
+
class Items
|
|
10
|
+
# Lists this subagent's own items across all of its turns. See
|
|
11
|
+
# [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).
|
|
12
|
+
#
|
|
13
|
+
# @overload list(subagent_id, session_id:, after: nil, limit: nil, order: nil, request_options: {})
|
|
14
|
+
#
|
|
15
|
+
# @param subagent_id [String]
|
|
16
|
+
# Path param: The ID of the subagent in this session.
|
|
17
|
+
#
|
|
18
|
+
# @param session_id [String]
|
|
19
|
+
# Path param: The ID of the session.
|
|
20
|
+
#
|
|
21
|
+
# @param after [String]
|
|
22
|
+
# Query param: Return resources after this resource ID in the selected order.
|
|
23
|
+
#
|
|
24
|
+
# @param limit [Integer]
|
|
25
|
+
# Query param: The maximum number of resources to return, between 1 and 100.
|
|
26
|
+
# Defaults to 20.
|
|
27
|
+
#
|
|
28
|
+
# @param order [Symbol, OpenAI::Models::Beta::Agents::Sessions::Subagents::ItemListParams::Order]
|
|
29
|
+
# Query param: The order in which resources are returned. Defaults to `desc`.
|
|
30
|
+
#
|
|
31
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
32
|
+
#
|
|
33
|
+
# @return [OpenAI::Internal::CursorPage<OpenAI::Models::Beta::AgentSessionMessage, OpenAI::Models::Beta::AgentReasoningItem, OpenAI::Models::Beta::AgentFunctionCallItem, OpenAI::Models::Beta::AgentSessionItem::FunctionCallOutput, OpenAI::Models::Beta::AgentSessionItem::AgentMessage, OpenAI::Models::Beta::AgentMcpCallItem, OpenAI::Models::Beta::AgentWebSearchCallItem, OpenAI::Models::Beta::AgentCommandExecutionItem, OpenAI::Models::Beta::AgentCreateSubagentCallItem, OpenAI::Models::Beta::AgentSendSubagentInputCallItem, OpenAI::Models::Beta::AgentResumeSubagentCallItem, OpenAI::Models::Beta::AgentWaitForSubagentsCallItem, OpenAI::Models::Beta::AgentInterruptSubagentCallItem, OpenAI::Models::Beta::AgentCloseSubagentCallItem>]
|
|
34
|
+
#
|
|
35
|
+
# @see OpenAI::Models::Beta::Agents::Sessions::Subagents::ItemListParams
|
|
36
|
+
def list(subagent_id, params)
|
|
37
|
+
parsed, options = OpenAI::Beta::Agents::Sessions::Subagents::ItemListParams.dump_request(params)
|
|
38
|
+
session_id = parsed.delete(:session_id) do
|
|
39
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
43
|
+
@client.request(
|
|
44
|
+
method: :get,
|
|
45
|
+
path: ["agents/sessions/%1$s/subagents/%2$s/items", session_id, subagent_id],
|
|
46
|
+
query: query,
|
|
47
|
+
page: OpenAI::Internal::CursorPage,
|
|
48
|
+
model: OpenAI::Beta::AgentSessionItem,
|
|
49
|
+
security: {bearer_auth: true},
|
|
50
|
+
options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
|
|
51
|
+
)
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
# @api private
|
|
55
|
+
#
|
|
56
|
+
# @param client [OpenAI::Client]
|
|
57
|
+
def initialize(client:)
|
|
58
|
+
@client = client
|
|
59
|
+
end
|
|
60
|
+
end
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
end
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Resources
|
|
5
|
+
class Beta
|
|
6
|
+
class Agents
|
|
7
|
+
class Sessions
|
|
8
|
+
class Subagents
|
|
9
|
+
class Turns
|
|
10
|
+
class Items
|
|
11
|
+
# Lists items belonging to one turn of this subagent. See
|
|
12
|
+
# [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).
|
|
13
|
+
#
|
|
14
|
+
# @overload list(turn_id, session_id:, subagent_id:, after: nil, limit: nil, order: nil, request_options: {})
|
|
15
|
+
#
|
|
16
|
+
# @param turn_id [String]
|
|
17
|
+
# Path param: The ID of a turn belonging to this subagent.
|
|
18
|
+
#
|
|
19
|
+
# @param session_id [String]
|
|
20
|
+
# Path param: The ID of the session.
|
|
21
|
+
#
|
|
22
|
+
# @param subagent_id [String]
|
|
23
|
+
# Path param: The ID of the subagent in this session.
|
|
24
|
+
#
|
|
25
|
+
# @param after [String]
|
|
26
|
+
# Query param: Return resources after this resource ID in the selected order.
|
|
27
|
+
#
|
|
28
|
+
# @param limit [Integer]
|
|
29
|
+
# Query param: The maximum number of resources to return, between 1 and 100.
|
|
30
|
+
# Defaults to 20.
|
|
31
|
+
#
|
|
32
|
+
# @param order [Symbol, OpenAI::Models::Beta::Agents::Sessions::Subagents::Turns::ItemListParams::Order]
|
|
33
|
+
# Query param: The order in which resources are returned. Defaults to `desc`.
|
|
34
|
+
#
|
|
35
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
36
|
+
#
|
|
37
|
+
# @return [OpenAI::Internal::CursorPage<OpenAI::Models::Beta::AgentSessionMessage, OpenAI::Models::Beta::AgentReasoningItem, OpenAI::Models::Beta::AgentFunctionCallItem, OpenAI::Models::Beta::AgentSessionItem::FunctionCallOutput, OpenAI::Models::Beta::AgentSessionItem::AgentMessage, OpenAI::Models::Beta::AgentMcpCallItem, OpenAI::Models::Beta::AgentWebSearchCallItem, OpenAI::Models::Beta::AgentCommandExecutionItem, OpenAI::Models::Beta::AgentCreateSubagentCallItem, OpenAI::Models::Beta::AgentSendSubagentInputCallItem, OpenAI::Models::Beta::AgentResumeSubagentCallItem, OpenAI::Models::Beta::AgentWaitForSubagentsCallItem, OpenAI::Models::Beta::AgentInterruptSubagentCallItem, OpenAI::Models::Beta::AgentCloseSubagentCallItem>]
|
|
38
|
+
#
|
|
39
|
+
# @see OpenAI::Models::Beta::Agents::Sessions::Subagents::Turns::ItemListParams
|
|
40
|
+
def list(turn_id, params)
|
|
41
|
+
parsed, options = OpenAI::Beta::Agents::Sessions::Subagents::Turns::ItemListParams.dump_request(
|
|
42
|
+
params
|
|
43
|
+
)
|
|
44
|
+
session_id = parsed.delete(:session_id) do
|
|
45
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
subagent_id = parsed.delete(:subagent_id) do
|
|
49
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
53
|
+
@client.request(
|
|
54
|
+
method: :get,
|
|
55
|
+
path: [
|
|
56
|
+
"agents/sessions/%1$s/subagents/%2$s/turns/%3$s/items",
|
|
57
|
+
session_id,
|
|
58
|
+
subagent_id,
|
|
59
|
+
turn_id
|
|
60
|
+
],
|
|
61
|
+
query: query,
|
|
62
|
+
page: OpenAI::Internal::CursorPage,
|
|
63
|
+
model: OpenAI::Beta::AgentSessionItem,
|
|
64
|
+
security: {bearer_auth: true},
|
|
65
|
+
options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
|
|
66
|
+
)
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
# @api private
|
|
70
|
+
#
|
|
71
|
+
# @param client [OpenAI::Client]
|
|
72
|
+
def initialize(client:)
|
|
73
|
+
@client = client
|
|
74
|
+
end
|
|
75
|
+
end
|
|
76
|
+
end
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
end
|
|
82
|
+
end
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Resources
|
|
5
|
+
class Beta
|
|
6
|
+
class Agents
|
|
7
|
+
class Sessions
|
|
8
|
+
class Subagents
|
|
9
|
+
class Turns
|
|
10
|
+
# @return [OpenAI::Resources::Beta::Agents::Sessions::Subagents::Turns::Items]
|
|
11
|
+
attr_reader :items
|
|
12
|
+
|
|
13
|
+
# Retrieves a turn belonging to this subagent. See
|
|
14
|
+
# [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).
|
|
15
|
+
#
|
|
16
|
+
# @overload retrieve(turn_id, session_id:, subagent_id:, request_options: {})
|
|
17
|
+
#
|
|
18
|
+
# @param turn_id [String]
|
|
19
|
+
# The ID of a turn belonging to this subagent.
|
|
20
|
+
#
|
|
21
|
+
# @param session_id [String]
|
|
22
|
+
# The ID of the session.
|
|
23
|
+
#
|
|
24
|
+
# @param subagent_id [String]
|
|
25
|
+
# The ID of the subagent in this session.
|
|
26
|
+
#
|
|
27
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
28
|
+
#
|
|
29
|
+
# @return [OpenAI::Models::Beta::Agents::Sessions::Turn]
|
|
30
|
+
#
|
|
31
|
+
# @see OpenAI::Models::Beta::Agents::Sessions::Subagents::TurnRetrieveParams
|
|
32
|
+
def retrieve(turn_id, params)
|
|
33
|
+
parsed, options = OpenAI::Beta::Agents::Sessions::Subagents::TurnRetrieveParams.dump_request(params)
|
|
34
|
+
session_id = parsed.delete(:session_id) do
|
|
35
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
subagent_id = parsed.delete(:subagent_id) do
|
|
39
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
@client.request(
|
|
43
|
+
method: :get,
|
|
44
|
+
path: ["agents/sessions/%1$s/subagents/%2$s/turns/%3$s", session_id, subagent_id, turn_id],
|
|
45
|
+
model: OpenAI::Beta::Agents::Sessions::Turn,
|
|
46
|
+
security: {bearer_auth: true},
|
|
47
|
+
options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
|
|
48
|
+
)
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# Lists all turns of this subagent, including turns after a resume. See
|
|
52
|
+
# [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).
|
|
53
|
+
#
|
|
54
|
+
# @overload list(subagent_id, session_id:, after: nil, limit: nil, order: nil, request_options: {})
|
|
55
|
+
#
|
|
56
|
+
# @param subagent_id [String]
|
|
57
|
+
# Path param: The ID of the subagent in this session.
|
|
58
|
+
#
|
|
59
|
+
# @param session_id [String]
|
|
60
|
+
# Path param: The ID of the session.
|
|
61
|
+
#
|
|
62
|
+
# @param after [String]
|
|
63
|
+
# Query param: Return resources after this resource ID in the selected order.
|
|
64
|
+
#
|
|
65
|
+
# @param limit [Integer]
|
|
66
|
+
# Query param: The maximum number of resources to return, between 1 and 100.
|
|
67
|
+
# Defaults to 20.
|
|
68
|
+
#
|
|
69
|
+
# @param order [Symbol, OpenAI::Models::Beta::Agents::Sessions::Subagents::TurnListParams::Order]
|
|
70
|
+
# Query param: The order in which resources are returned. Defaults to `desc`.
|
|
71
|
+
#
|
|
72
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
73
|
+
#
|
|
74
|
+
# @return [OpenAI::Internal::CursorPage<OpenAI::Models::Beta::Agents::Sessions::Turn>]
|
|
75
|
+
#
|
|
76
|
+
# @see OpenAI::Models::Beta::Agents::Sessions::Subagents::TurnListParams
|
|
77
|
+
def list(subagent_id, params)
|
|
78
|
+
parsed, options = OpenAI::Beta::Agents::Sessions::Subagents::TurnListParams.dump_request(params)
|
|
79
|
+
session_id = parsed.delete(:session_id) do
|
|
80
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
84
|
+
@client.request(
|
|
85
|
+
method: :get,
|
|
86
|
+
path: ["agents/sessions/%1$s/subagents/%2$s/turns", session_id, subagent_id],
|
|
87
|
+
query: query,
|
|
88
|
+
page: OpenAI::Internal::CursorPage,
|
|
89
|
+
model: OpenAI::Beta::Agents::Sessions::Turn,
|
|
90
|
+
security: {bearer_auth: true},
|
|
91
|
+
options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
|
|
92
|
+
)
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
# @api private
|
|
96
|
+
#
|
|
97
|
+
# @param client [OpenAI::Client]
|
|
98
|
+
def initialize(client:)
|
|
99
|
+
@client = client
|
|
100
|
+
@items = OpenAI::Resources::Beta::Agents::Sessions::Subagents::Turns::Items.new(client: client)
|
|
101
|
+
end
|
|
102
|
+
end
|
|
103
|
+
end
|
|
104
|
+
end
|
|
105
|
+
end
|
|
106
|
+
end
|
|
107
|
+
end
|
|
108
|
+
end
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Resources
|
|
5
|
+
class Beta
|
|
6
|
+
class Agents
|
|
7
|
+
class Sessions
|
|
8
|
+
class Subagents
|
|
9
|
+
# @return [OpenAI::Resources::Beta::Agents::Sessions::Subagents::Items]
|
|
10
|
+
attr_reader :items
|
|
11
|
+
|
|
12
|
+
# @return [OpenAI::Resources::Beta::Agents::Sessions::Subagents::Turns]
|
|
13
|
+
attr_reader :turns
|
|
14
|
+
|
|
15
|
+
# Retrieves a subagent belonging to this session. See
|
|
16
|
+
# [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).
|
|
17
|
+
#
|
|
18
|
+
# @overload retrieve(subagent_id, session_id:, request_options: {})
|
|
19
|
+
#
|
|
20
|
+
# @param subagent_id [String]
|
|
21
|
+
# The ID of the subagent in this session.
|
|
22
|
+
#
|
|
23
|
+
# @param session_id [String]
|
|
24
|
+
# The ID of the session.
|
|
25
|
+
#
|
|
26
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
27
|
+
#
|
|
28
|
+
# @return [OpenAI::Models::Beta::Subagent]
|
|
29
|
+
#
|
|
30
|
+
# @see OpenAI::Models::Beta::Agents::Sessions::SubagentRetrieveParams
|
|
31
|
+
def retrieve(subagent_id, params)
|
|
32
|
+
parsed, options = OpenAI::Beta::Agents::Sessions::SubagentRetrieveParams.dump_request(params)
|
|
33
|
+
session_id = parsed.delete(:session_id) do
|
|
34
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
@client.request(
|
|
38
|
+
method: :get,
|
|
39
|
+
path: ["agents/sessions/%1$s/subagents/%2$s", session_id, subagent_id],
|
|
40
|
+
model: OpenAI::Beta::Subagent,
|
|
41
|
+
security: {bearer_auth: true},
|
|
42
|
+
options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
|
|
43
|
+
)
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
# Lists subagents in a session, including nested and closed subagents. See
|
|
47
|
+
# [subagent workflows](https://developers.openai.com/api/docs/guides/agents-api/multi-agent).
|
|
48
|
+
#
|
|
49
|
+
# @overload list(session_id, after: nil, limit: nil, order: nil, request_options: {})
|
|
50
|
+
#
|
|
51
|
+
# @param session_id [String]
|
|
52
|
+
# The ID of the session.
|
|
53
|
+
#
|
|
54
|
+
# @param after [String]
|
|
55
|
+
# Return resources after this resource ID in the selected order.
|
|
56
|
+
#
|
|
57
|
+
# @param limit [Integer]
|
|
58
|
+
# The maximum number of resources to return, between 1 and 100. Defaults to 20.
|
|
59
|
+
#
|
|
60
|
+
# @param order [Symbol, OpenAI::Models::Beta::Agents::Sessions::SubagentListParams::Order]
|
|
61
|
+
# The order in which resources are returned. Defaults to `desc`.
|
|
62
|
+
#
|
|
63
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
64
|
+
#
|
|
65
|
+
# @return [OpenAI::Internal::CursorPage<OpenAI::Models::Beta::Subagent>]
|
|
66
|
+
#
|
|
67
|
+
# @see OpenAI::Models::Beta::Agents::Sessions::SubagentListParams
|
|
68
|
+
def list(session_id, params = {})
|
|
69
|
+
parsed, options = OpenAI::Beta::Agents::Sessions::SubagentListParams.dump_request(params)
|
|
70
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
71
|
+
@client.request(
|
|
72
|
+
method: :get,
|
|
73
|
+
path: ["agents/sessions/%1$s/subagents", session_id],
|
|
74
|
+
query: query,
|
|
75
|
+
page: OpenAI::Internal::CursorPage,
|
|
76
|
+
model: OpenAI::Beta::Subagent,
|
|
77
|
+
security: {bearer_auth: true},
|
|
78
|
+
options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
|
|
79
|
+
)
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
# @api private
|
|
83
|
+
#
|
|
84
|
+
# @param client [OpenAI::Client]
|
|
85
|
+
def initialize(client:)
|
|
86
|
+
@client = client
|
|
87
|
+
@items = OpenAI::Resources::Beta::Agents::Sessions::Subagents::Items.new(client: client)
|
|
88
|
+
@turns = OpenAI::Resources::Beta::Agents::Sessions::Subagents::Turns.new(client: client)
|
|
89
|
+
end
|
|
90
|
+
end
|
|
91
|
+
end
|
|
92
|
+
end
|
|
93
|
+
end
|
|
94
|
+
end
|
|
95
|
+
end
|