openai 0.89.0 → 0.91.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 +26 -0
- data/README.md +1 -1
- data/examples/realtime/README.md +8 -0
- data/examples/realtime/browser/README.md +167 -0
- data/examples/realtime/browser/index.html +19 -0
- data/examples/realtime/browser/page.js +21 -0
- data/examples/realtime/browser/peer.js +180 -0
- data/examples/realtime/browser/server.rb +281 -0
- data/examples/responses/websocket_workflows.rb +66 -6
- data/lib/openai/auth/workload_identity.rb +5 -1
- data/lib/openai/auth/workload_identity_auth.rb +2 -2
- data/lib/openai/auth/x509_token_exchange.rb +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/helpers/local_audio/process.rb +1 -1
- data/lib/openai/helpers/responses_websocket/connection.rb +2 -1
- data/lib/openai/helpers/responses_websocket/session.rb +551 -0
- data/lib/openai/helpers/responses_websocket.rb +1 -0
- data/lib/openai/helpers/sorbet.rb +1 -1
- data/lib/openai/helpers/websocket/async_websocket_transport.rb +6 -1
- data/lib/openai/internal/poller.rb +2 -2
- data/lib/openai/internal/token_page.rb +91 -0
- data/lib/openai/internal/transport/base_client.rb +1 -1
- data/lib/openai/internal/util.rb +1 -1
- 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 +145 -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/beta_response.rb +9 -3
- data/lib/openai/models/beta/beta_response_compaction_compacting_event.rb +75 -0
- data/lib/openai/models/beta/beta_response_stream_event.rb +4 -1
- data/lib/openai/models/beta/beta_responses_client_event.rb +25 -4
- data/lib/openai/models/beta/beta_responses_server_event.rb +39 -1
- 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/response_compact_params.rb +9 -3
- data/lib/openai/models/beta/response_create_params.rb +21 -4
- data/lib/openai/models/beta/session_error.rb +48 -0
- data/lib/openai/models/beta/session_turn_error.rb +91 -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/models/chat_model.rb +3 -1
- data/lib/openai/models/responses/response_compact_params.rb +9 -3
- data/lib/openai/models/responses/response_compaction_compacting_event.rb +49 -0
- data/lib/openai/models/responses/response_create_params.rb +12 -1
- data/lib/openai/models/responses/response_stream_event.rb +4 -1
- data/lib/openai/models/responses/responses_client_event.rb +12 -1
- data/lib/openai/models/responses/responses_server_event.rb +36 -1
- data/lib/openai/models/webhooks/realtime_call_incoming_webhook_event.rb +6 -8
- 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 +298 -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/responses.rb +2 -2
- data/lib/openai/resources/beta.rb +4 -0
- data/lib/openai/resources/live/sessions.rb +10 -4
- data/lib/openai/resources/responses.rb +2 -2
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +178 -0
- data/rbi/openai/helpers/agents.rbi +71 -0
- data/rbi/openai/helpers/responses_websocket/connection.rbi +5 -0
- data/rbi/openai/helpers/responses_websocket/session.rbi +206 -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 +252 -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/beta_response.rbi +6 -1
- data/rbi/openai/models/beta/beta_response_compaction_compacting_event.rbi +136 -0
- data/rbi/openai/models/beta/beta_response_stream_event.rbi +1 -0
- data/rbi/openai/models/beta/beta_responses_client_event.rbi +27 -4
- data/rbi/openai/models/beta/beta_responses_server_event.rbi +77 -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/response_compact_params.rbi +6 -1
- data/rbi/openai/models/beta/response_create_params.rbi +21 -1
- data/rbi/openai/models/beta/session_error.rbi +77 -0
- data/rbi/openai/models/beta/session_turn_error.rbi +131 -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/models/chat_model.rbi +3 -1
- data/rbi/openai/models/responses/response_compact_params.rbi +6 -1
- data/rbi/openai/models/responses/response_compaction_compacting_event.rbi +78 -0
- data/rbi/openai/models/responses/response_create_params.rbi +15 -0
- data/rbi/openai/models/responses/response_stream_event.rbi +1 -0
- data/rbi/openai/models/responses/responses_client_event.rbi +15 -0
- data/rbi/openai/models/responses/responses_server_event.rbi +71 -0
- data/rbi/openai/models/webhooks/realtime_call_incoming_webhook_event.rbi +6 -8
- 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 +212 -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/responses-websocket.md +117 -10
- data/sig/openai/helpers/agents.rbs +50 -0
- data/sig/openai/helpers/responses_websocket/connection.rbs +5 -0
- data/sig/openai/helpers/responses_websocket/session.rbs +123 -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 +134 -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/beta_response.rbs +6 -2
- data/sig/openai/models/beta/beta_response_compaction_compacting_event.rbs +58 -0
- data/sig/openai/models/beta/beta_response_stream_event.rbs +1 -0
- data/sig/openai/models/beta/beta_responses_client_event.rbs +13 -2
- data/sig/openai/models/beta/beta_responses_server_event.rbs +35 -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/response_compact_params.rbs +6 -2
- data/sig/openai/models/beta/response_create_params.rbs +13 -2
- data/sig/openai/models/beta/session_error.rbs +32 -0
- data/sig/openai/models/beta/session_turn_error.rbs +100 -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/models/chat_model.rbs +6 -2
- data/sig/openai/models/responses/response_compact_params.rbs +6 -2
- data/sig/openai/models/responses/response_compaction_compacting_event.rbs +37 -0
- data/sig/openai/models/responses/response_create_params.rbs +7 -0
- data/sig/openai/models/responses/response_stream_event.rbs +1 -0
- data/sig/openai/models/responses/responses_client_event.rbs +7 -0
- data/sig/openai/models/responses/responses_server_event.rbs +32 -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 +66 -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 +540 -2
|
@@ -0,0 +1,212 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Resources
|
|
5
|
+
|
|
6
|
+
class Beta
|
|
7
|
+
|
|
8
|
+
class Agents
|
|
9
|
+
|
|
10
|
+
class Sessions
|
|
11
|
+
|
|
12
|
+
sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Subagents) }
|
|
13
|
+
attr_reader :subagents
|
|
14
|
+
|
|
15
|
+
sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Artifacts) }
|
|
16
|
+
attr_reader :artifacts
|
|
17
|
+
|
|
18
|
+
sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Items) }
|
|
19
|
+
attr_reader :items
|
|
20
|
+
|
|
21
|
+
sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Events) }
|
|
22
|
+
attr_reader :events
|
|
23
|
+
|
|
24
|
+
sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Turns) }
|
|
25
|
+
attr_reader :turns
|
|
26
|
+
|
|
27
|
+
# See {OpenAI::Resources::Beta::Agents::Sessions#create_streaming} for streaming
|
|
28
|
+
# counterpart.
|
|
29
|
+
#
|
|
30
|
+
# Creates a managed agent session, optionally submits initial input, and returns
|
|
31
|
+
# the session or streams its events when stream is true. See
|
|
32
|
+
# [running sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions).
|
|
33
|
+
sig {
|
|
34
|
+
params(
|
|
35
|
+
environment: T.any(
|
|
36
|
+
OpenAI::Beta::EnvironmentParam::None::OrHash,
|
|
37
|
+
OpenAI::Beta::EnvironmentParam::OpenAIHosted::OrHash,
|
|
38
|
+
OpenAI::Beta::EnvironmentParam::SelfHosted::OrHash
|
|
39
|
+
),
|
|
40
|
+
agent: OpenAI::Beta::Agents::SessionCreateParams::Agent::OrHash,
|
|
41
|
+
agent_id: String,
|
|
42
|
+
input: T.nilable(OpenAI::Beta::Agents::SessionCreateParams::Input::Variants),
|
|
43
|
+
metadata: T.nilable(T::Hash[Symbol, String]),
|
|
44
|
+
vault_ids: T.nilable(T::Array[String]),
|
|
45
|
+
stream: T.noreturn,
|
|
46
|
+
request_options: OpenAI::RequestOptions::OrHash
|
|
47
|
+
)
|
|
48
|
+
.returns(OpenAI::Beta::AgentSession)
|
|
49
|
+
}
|
|
50
|
+
def create(
|
|
51
|
+
# An inline execution environment or a reference to an environment template.
|
|
52
|
+
environment:,
|
|
53
|
+
# Agent configuration. With `agent_id`, supplied fields override the saved agent
|
|
54
|
+
# for this session. Without `agent_id`, `model` is required.
|
|
55
|
+
agent: nil,
|
|
56
|
+
# The ID of a saved reusable agent. Omit `agent` to use its configuration
|
|
57
|
+
# unchanged.
|
|
58
|
+
agent_id: nil,
|
|
59
|
+
# Initial input submitted when creating a session.
|
|
60
|
+
input: nil,
|
|
61
|
+
# Up to 16 string key-value pairs, with keys up to 64 and values up to 512
|
|
62
|
+
# characters. Omission or null defaults to an empty map.
|
|
63
|
+
metadata: nil,
|
|
64
|
+
# The IDs of vaults made available to the session.
|
|
65
|
+
vault_ids: nil,
|
|
66
|
+
# There is no need to provide `stream:`. Instead, use `#create_streaming` or
|
|
67
|
+
# `#create` for streaming and non-streaming use cases, respectively.
|
|
68
|
+
stream: false,
|
|
69
|
+
request_options: {}
|
|
70
|
+
)
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
# See {OpenAI::Resources::Beta::Agents::Sessions#create} for non-streaming
|
|
74
|
+
# counterpart.
|
|
75
|
+
#
|
|
76
|
+
# Creates a managed agent session, optionally submits initial input, and returns
|
|
77
|
+
# the session or streams its events when stream is true. See
|
|
78
|
+
# [running sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions).
|
|
79
|
+
sig {
|
|
80
|
+
params(
|
|
81
|
+
environment: T.any(
|
|
82
|
+
OpenAI::Beta::EnvironmentParam::None::OrHash,
|
|
83
|
+
OpenAI::Beta::EnvironmentParam::OpenAIHosted::OrHash,
|
|
84
|
+
OpenAI::Beta::EnvironmentParam::SelfHosted::OrHash
|
|
85
|
+
),
|
|
86
|
+
agent: OpenAI::Beta::Agents::SessionCreateParams::Agent::OrHash,
|
|
87
|
+
agent_id: String,
|
|
88
|
+
input: T.nilable(OpenAI::Beta::Agents::SessionCreateParams::Input::Variants),
|
|
89
|
+
metadata: T.nilable(T::Hash[Symbol, String]),
|
|
90
|
+
vault_ids: T.nilable(T::Array[String]),
|
|
91
|
+
stream: T.noreturn,
|
|
92
|
+
request_options: OpenAI::RequestOptions::OrHash
|
|
93
|
+
)
|
|
94
|
+
.returns(OpenAI::Internal::Stream[OpenAI::Beta::AgentSessionEvent::Variants])
|
|
95
|
+
}
|
|
96
|
+
def create_streaming(
|
|
97
|
+
# An inline execution environment or a reference to an environment template.
|
|
98
|
+
environment:,
|
|
99
|
+
# Agent configuration. With `agent_id`, supplied fields override the saved agent
|
|
100
|
+
# for this session. Without `agent_id`, `model` is required.
|
|
101
|
+
agent: nil,
|
|
102
|
+
# The ID of a saved reusable agent. Omit `agent` to use its configuration
|
|
103
|
+
# unchanged.
|
|
104
|
+
agent_id: nil,
|
|
105
|
+
# Initial input submitted when creating a session.
|
|
106
|
+
input: nil,
|
|
107
|
+
# Up to 16 string key-value pairs, with keys up to 64 and values up to 512
|
|
108
|
+
# characters. Omission or null defaults to an empty map.
|
|
109
|
+
metadata: nil,
|
|
110
|
+
# The IDs of vaults made available to the session.
|
|
111
|
+
vault_ids: nil,
|
|
112
|
+
# There is no need to provide `stream:`. Instead, use `#create_streaming` or
|
|
113
|
+
# `#create` for streaming and non-streaming use cases, respectively.
|
|
114
|
+
stream: true,
|
|
115
|
+
request_options: {}
|
|
116
|
+
)
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
# Retrieves the current state of a managed agent session. See
|
|
120
|
+
# [managing sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage).
|
|
121
|
+
sig {
|
|
122
|
+
params(session_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
|
|
123
|
+
OpenAI::Beta::AgentSession
|
|
124
|
+
)
|
|
125
|
+
}
|
|
126
|
+
def retrieve(
|
|
127
|
+
# The ID of the session.
|
|
128
|
+
session_id,
|
|
129
|
+
request_options: {}
|
|
130
|
+
)
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
# Updates session metadata, model, reasoning effort, or service tier. Model
|
|
134
|
+
# settings apply to subsequent turns. Omitted fields are unchanged. See
|
|
135
|
+
# [managing sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage).
|
|
136
|
+
sig {
|
|
137
|
+
params(
|
|
138
|
+
session_id: String,
|
|
139
|
+
agent: OpenAI::Beta::Agents::SessionUpdateParams::Agent::OrHash,
|
|
140
|
+
metadata: T.nilable(T::Hash[Symbol, String]),
|
|
141
|
+
request_options: OpenAI::RequestOptions::OrHash
|
|
142
|
+
)
|
|
143
|
+
.returns(OpenAI::Beta::AgentSession)
|
|
144
|
+
}
|
|
145
|
+
def update(
|
|
146
|
+
# The ID of the session.
|
|
147
|
+
session_id,
|
|
148
|
+
# Model settings for subsequent turns. Omitted fields stay unchanged.
|
|
149
|
+
agent: nil,
|
|
150
|
+
# Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it.
|
|
151
|
+
# Up to 16 string key-value pairs, with keys up to 64 and values up to 512
|
|
152
|
+
# characters.
|
|
153
|
+
metadata: nil,
|
|
154
|
+
request_options: {}
|
|
155
|
+
)
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# Lists managed agent sessions using ID-based pagination and the requested sort
|
|
159
|
+
# order. See
|
|
160
|
+
# [managing sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage).
|
|
161
|
+
sig {
|
|
162
|
+
params(
|
|
163
|
+
after: String,
|
|
164
|
+
agent_id: String,
|
|
165
|
+
limit: T.nilable(Integer),
|
|
166
|
+
order: OpenAI::Beta::Agents::SessionListParams::Order::OrSymbol,
|
|
167
|
+
request_options: OpenAI::RequestOptions::OrHash
|
|
168
|
+
)
|
|
169
|
+
.returns(OpenAI::Internal::CursorPage[OpenAI::Beta::AgentSession])
|
|
170
|
+
}
|
|
171
|
+
def list(
|
|
172
|
+
# Return resources after this resource ID in the selected order.
|
|
173
|
+
after: nil,
|
|
174
|
+
# Only return sessions whose root agent has this ID. Omit to return sessions for
|
|
175
|
+
# all agents.
|
|
176
|
+
agent_id: nil,
|
|
177
|
+
# The maximum number of resources to return.
|
|
178
|
+
limit: nil,
|
|
179
|
+
# Sort order by the `created_at` timestamp. Use `asc` for ascending order or
|
|
180
|
+
# `desc` for descending order. Defaults to `desc`.
|
|
181
|
+
order: nil,
|
|
182
|
+
request_options: {}
|
|
183
|
+
)
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
# Removes a managed agent session from the public API and returns a deletion
|
|
187
|
+
# confirmation. Physical cleanup may continue asynchronously. See
|
|
188
|
+
# [managing sessions](https://developers.openai.com/api/docs/guides/agents-api/sessions/manage).
|
|
189
|
+
sig {
|
|
190
|
+
params(session_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
|
|
191
|
+
OpenAI::Beta::AgentSessionDeleted
|
|
192
|
+
)
|
|
193
|
+
}
|
|
194
|
+
def delete(
|
|
195
|
+
# The ID of the session.
|
|
196
|
+
session_id,
|
|
197
|
+
request_options: {}
|
|
198
|
+
)
|
|
199
|
+
end
|
|
200
|
+
|
|
201
|
+
# @api private
|
|
202
|
+
sig { params(client: OpenAI::Client).returns(T.attached_class) }
|
|
203
|
+
def self.new(client:)
|
|
204
|
+
end
|
|
205
|
+
end
|
|
206
|
+
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
end
|
|
212
|
+
end
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Resources
|
|
5
|
+
|
|
6
|
+
class Beta
|
|
7
|
+
|
|
8
|
+
class Agents
|
|
9
|
+
|
|
10
|
+
class Vaults
|
|
11
|
+
|
|
12
|
+
class Credentials
|
|
13
|
+
|
|
14
|
+
# Creates a vault credential. Secret values are write-only and are never returned.
|
|
15
|
+
# See
|
|
16
|
+
# [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
|
|
17
|
+
sig {
|
|
18
|
+
params(
|
|
19
|
+
vault_id: String,
|
|
20
|
+
auth: T.any(
|
|
21
|
+
OpenAI::Beta::Agents::Vaults::CredentialAuthCreateParam::McpOauth::OrHash,
|
|
22
|
+
OpenAI::Beta::Agents::Vaults::CredentialAuthCreateParam::StaticBearer::OrHash
|
|
23
|
+
),
|
|
24
|
+
name: String,
|
|
25
|
+
request_options: OpenAI::RequestOptions::OrHash
|
|
26
|
+
)
|
|
27
|
+
.returns(OpenAI::Beta::Agents::Vaults::Credential)
|
|
28
|
+
}
|
|
29
|
+
def create(
|
|
30
|
+
# The ID of the vault.
|
|
31
|
+
vault_id,
|
|
32
|
+
# The authentication method and secret values to store for the MCP server.
|
|
33
|
+
auth:,
|
|
34
|
+
# The name is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after
|
|
35
|
+
# trimming.
|
|
36
|
+
name:,
|
|
37
|
+
request_options: {}
|
|
38
|
+
)
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
# Retrieves vault credential metadata without returning secret values. See
|
|
42
|
+
# [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
|
|
43
|
+
sig {
|
|
44
|
+
params(credential_id: String, vault_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
|
|
45
|
+
OpenAI::Beta::Agents::Vaults::Credential
|
|
46
|
+
)
|
|
47
|
+
}
|
|
48
|
+
def retrieve(
|
|
49
|
+
# The ID of the vault credential.
|
|
50
|
+
credential_id,
|
|
51
|
+
# The ID of the vault.
|
|
52
|
+
vault_id:,
|
|
53
|
+
request_options: {}
|
|
54
|
+
)
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# Rotates a vault credential's write-only secret and returns only credential
|
|
58
|
+
# metadata. See
|
|
59
|
+
# [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
|
|
60
|
+
sig {
|
|
61
|
+
params(
|
|
62
|
+
credential_id: String,
|
|
63
|
+
vault_id: String,
|
|
64
|
+
auth: T.any(
|
|
65
|
+
OpenAI::Beta::Agents::Vaults::CredentialAuthRotateParam::McpOauth::OrHash,
|
|
66
|
+
OpenAI::Beta::Agents::Vaults::CredentialAuthRotateParam::StaticBearer::OrHash
|
|
67
|
+
),
|
|
68
|
+
request_options: OpenAI::RequestOptions::OrHash
|
|
69
|
+
)
|
|
70
|
+
.returns(OpenAI::Beta::Agents::Vaults::Credential)
|
|
71
|
+
}
|
|
72
|
+
def update(
|
|
73
|
+
# Path param: The ID of the vault credential.
|
|
74
|
+
credential_id,
|
|
75
|
+
# Path param: The ID of the vault.
|
|
76
|
+
vault_id:,
|
|
77
|
+
# Body param: Replacement values for the credential's existing authentication
|
|
78
|
+
# method.
|
|
79
|
+
auth:,
|
|
80
|
+
request_options: {}
|
|
81
|
+
)
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
# Lists a vault's credentials using ID-based pagination without returning secret
|
|
85
|
+
# values. See
|
|
86
|
+
# [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
|
|
87
|
+
sig {
|
|
88
|
+
params(
|
|
89
|
+
vault_id: String,
|
|
90
|
+
after: String,
|
|
91
|
+
limit: T.nilable(Integer),
|
|
92
|
+
order: OpenAI::Beta::Agents::Vaults::CredentialListParams::Order::OrSymbol,
|
|
93
|
+
status: T.any(
|
|
94
|
+
OpenAI::Beta::Agents::VaultStatus::OrSymbol,
|
|
95
|
+
T::Array[OpenAI::Beta::Agents::VaultStatus::OrSymbol]
|
|
96
|
+
),
|
|
97
|
+
request_options: OpenAI::RequestOptions::OrHash
|
|
98
|
+
)
|
|
99
|
+
.returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Agents::Vaults::Credential])
|
|
100
|
+
}
|
|
101
|
+
def list(
|
|
102
|
+
# The ID of the vault.
|
|
103
|
+
vault_id,
|
|
104
|
+
# Return resources after this resource ID in the selected order.
|
|
105
|
+
after: nil,
|
|
106
|
+
# The maximum number of resources to return. Defaults to 20. Values are clamped
|
|
107
|
+
# between 1 and 100.
|
|
108
|
+
limit: nil,
|
|
109
|
+
# Sort order by the `created_at` timestamp. Use `asc` for ascending order or
|
|
110
|
+
# `desc` for descending order. Defaults to `desc`.
|
|
111
|
+
order: nil,
|
|
112
|
+
# Filter by one status or a list, such as `status=active` or
|
|
113
|
+
# `status[]=active&status[]=archived`. Both statuses are included by default.
|
|
114
|
+
status: nil,
|
|
115
|
+
request_options: {}
|
|
116
|
+
)
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
# Deletes a vault credential. See
|
|
120
|
+
# [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
|
|
121
|
+
sig {
|
|
122
|
+
params(credential_id: String, vault_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
|
|
123
|
+
OpenAI::Beta::Agents::Vaults::CredentialDeleted
|
|
124
|
+
)
|
|
125
|
+
}
|
|
126
|
+
def delete(
|
|
127
|
+
# The ID of the vault credential.
|
|
128
|
+
credential_id,
|
|
129
|
+
# The ID of the vault.
|
|
130
|
+
vault_id:,
|
|
131
|
+
request_options: {}
|
|
132
|
+
)
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
# @api private
|
|
136
|
+
sig { params(client: OpenAI::Client).returns(T.attached_class) }
|
|
137
|
+
def self.new(client:)
|
|
138
|
+
end
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
end
|
|
148
|
+
end
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Resources
|
|
5
|
+
|
|
6
|
+
class Beta
|
|
7
|
+
|
|
8
|
+
class Agents
|
|
9
|
+
|
|
10
|
+
class Vaults
|
|
11
|
+
|
|
12
|
+
sig { returns(OpenAI::Resources::Beta::Agents::Vaults::Credentials) }
|
|
13
|
+
attr_reader :credentials
|
|
14
|
+
|
|
15
|
+
# Creates a vault for the current project. See
|
|
16
|
+
# [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
|
|
17
|
+
sig {
|
|
18
|
+
params(
|
|
19
|
+
metadata: T.nilable(T::Hash[Symbol, String]),
|
|
20
|
+
name: String,
|
|
21
|
+
request_options: OpenAI::RequestOptions::OrHash
|
|
22
|
+
)
|
|
23
|
+
.returns(OpenAI::Beta::Agents::Vault)
|
|
24
|
+
}
|
|
25
|
+
def create(
|
|
26
|
+
# Key-value pairs to associate with the vault, such as an application or team
|
|
27
|
+
# identifier.
|
|
28
|
+
metadata: nil,
|
|
29
|
+
# The name is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after
|
|
30
|
+
# trimming.
|
|
31
|
+
name: nil,
|
|
32
|
+
request_options: {}
|
|
33
|
+
)
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# Retrieves a vault by its ID. See
|
|
37
|
+
# [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
|
|
38
|
+
sig {
|
|
39
|
+
params(vault_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
|
|
40
|
+
OpenAI::Beta::Agents::Vault
|
|
41
|
+
)
|
|
42
|
+
}
|
|
43
|
+
def retrieve(
|
|
44
|
+
# The ID of the vault.
|
|
45
|
+
vault_id,
|
|
46
|
+
request_options: {}
|
|
47
|
+
)
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# Lists vaults using ID-based pagination. See
|
|
51
|
+
# [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
|
|
52
|
+
sig {
|
|
53
|
+
params(
|
|
54
|
+
after: String,
|
|
55
|
+
limit: T.nilable(Integer),
|
|
56
|
+
order: OpenAI::Beta::Agents::VaultListParams::Order::OrSymbol,
|
|
57
|
+
status: T.any(
|
|
58
|
+
OpenAI::Beta::Agents::VaultStatus::OrSymbol,
|
|
59
|
+
T::Array[OpenAI::Beta::Agents::VaultStatus::OrSymbol]
|
|
60
|
+
),
|
|
61
|
+
request_options: OpenAI::RequestOptions::OrHash
|
|
62
|
+
)
|
|
63
|
+
.returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Agents::Vault])
|
|
64
|
+
}
|
|
65
|
+
def list(
|
|
66
|
+
# Return resources after this resource ID in the selected order.
|
|
67
|
+
after: nil,
|
|
68
|
+
# The maximum number of resources to return. Defaults to 20. Values are clamped
|
|
69
|
+
# between 1 and 100.
|
|
70
|
+
limit: nil,
|
|
71
|
+
# Sort order by the `created_at` timestamp. Use `asc` for ascending order or
|
|
72
|
+
# `desc` for descending order. Defaults to `desc`.
|
|
73
|
+
order: nil,
|
|
74
|
+
# Filter by one status or a list, such as `status=active` or
|
|
75
|
+
# `status[]=active&status[]=archived`. Both statuses are included by default.
|
|
76
|
+
status: nil,
|
|
77
|
+
request_options: {}
|
|
78
|
+
)
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
# Deletes a vault and all its credentials. See
|
|
82
|
+
# [vaults](https://developers.openai.com/api/docs/guides/agents-api/tools/vaults).
|
|
83
|
+
sig {
|
|
84
|
+
params(vault_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
|
|
85
|
+
OpenAI::Beta::Agents::VaultDeleted
|
|
86
|
+
)
|
|
87
|
+
}
|
|
88
|
+
def delete(
|
|
89
|
+
# The ID of the vault.
|
|
90
|
+
vault_id,
|
|
91
|
+
request_options: {}
|
|
92
|
+
)
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
# @api private
|
|
96
|
+
sig { params(client: OpenAI::Client).returns(T.attached_class) }
|
|
97
|
+
def self.new(client:)
|
|
98
|
+
end
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
end
|
|
106
|
+
end
|
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Resources
|
|
5
|
+
|
|
6
|
+
class Beta
|
|
7
|
+
|
|
8
|
+
class Agents
|
|
9
|
+
|
|
10
|
+
sig { returns(OpenAI::Resources::Beta::Agents::Environments) }
|
|
11
|
+
attr_reader :environments
|
|
12
|
+
|
|
13
|
+
sig { returns(OpenAI::Resources::Beta::Agents::Vaults) }
|
|
14
|
+
attr_reader :vaults
|
|
15
|
+
|
|
16
|
+
sig { returns(OpenAI::Resources::Beta::Agents::Sessions) }
|
|
17
|
+
attr_reader :sessions
|
|
18
|
+
|
|
19
|
+
# Creates a reusable agent without storing credentials. See
|
|
20
|
+
# [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).
|
|
21
|
+
sig {
|
|
22
|
+
params(
|
|
23
|
+
model: String,
|
|
24
|
+
instructions: T.nilable(String),
|
|
25
|
+
metadata: T.nilable(T::Hash[Symbol, String]),
|
|
26
|
+
multi_agent: T.nilable(OpenAI::Beta::MultiAgentConfigParam::OrHash),
|
|
27
|
+
name: T.nilable(String),
|
|
28
|
+
reasoning: T.nilable(OpenAI::Beta::AgentReasoningParam::OrHash),
|
|
29
|
+
service_tier: T.nilable(OpenAI::Beta::AgentCreateParams::ServiceTier::OrSymbol),
|
|
30
|
+
text: T.nilable(OpenAI::Beta::AgentTextParam::OrHash),
|
|
31
|
+
tools: T.nilable(
|
|
32
|
+
T::Array[
|
|
33
|
+
T.any(
|
|
34
|
+
OpenAI::Beta::PersistedAgentToolParam::Function::OrHash,
|
|
35
|
+
OpenAI::Beta::PersistedAgentToolParam::ToolSearch::OrHash,
|
|
36
|
+
OpenAI::Beta::PersistedAgentToolParam::ProgrammaticToolCalling::OrHash,
|
|
37
|
+
OpenAI::Beta::PersistedAgentToolParam::Mcp::OrHash,
|
|
38
|
+
OpenAI::Beta::PersistedAgentToolParam::WebSearch::OrHash
|
|
39
|
+
)
|
|
40
|
+
]
|
|
41
|
+
),
|
|
42
|
+
request_options: OpenAI::RequestOptions::OrHash
|
|
43
|
+
)
|
|
44
|
+
.returns(OpenAI::Beta::Agent)
|
|
45
|
+
}
|
|
46
|
+
def create(
|
|
47
|
+
# The model to use for the agent. The requested model name is preserved.
|
|
48
|
+
model:,
|
|
49
|
+
# Additional instructions appended to the agent's default base instructions. Omit
|
|
50
|
+
# or set to null to add no custom instructions.
|
|
51
|
+
instructions: nil,
|
|
52
|
+
# Up to 16 string key-value pairs, with keys up to 64 and values up to 512
|
|
53
|
+
# characters. Omission or null defaults to an empty map.
|
|
54
|
+
metadata: nil,
|
|
55
|
+
# Explicit configuration for creating and coordinating subagents.
|
|
56
|
+
multi_agent: nil,
|
|
57
|
+
# A human-readable name for the agent. Omission or null leaves the agent unnamed.
|
|
58
|
+
name: nil,
|
|
59
|
+
# Reasoning configuration for the agent.
|
|
60
|
+
reasoning: nil,
|
|
61
|
+
# The service tier used for model requests.
|
|
62
|
+
service_tier: nil,
|
|
63
|
+
# Configuration for text generated by the agent.
|
|
64
|
+
text: nil,
|
|
65
|
+
# Tools available to the agent. Defaults to an empty list.
|
|
66
|
+
tools: nil,
|
|
67
|
+
request_options: {}
|
|
68
|
+
)
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
# Retrieves a reusable agent by ID. See
|
|
72
|
+
# [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).
|
|
73
|
+
sig { params(agent_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(OpenAI::Beta::Agent) }
|
|
74
|
+
def retrieve(
|
|
75
|
+
# The ID of the reusable agent.
|
|
76
|
+
agent_id,
|
|
77
|
+
request_options: {}
|
|
78
|
+
)
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
# Updates a reusable agent. See
|
|
82
|
+
# [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).
|
|
83
|
+
sig {
|
|
84
|
+
params(
|
|
85
|
+
agent_id: String,
|
|
86
|
+
instructions: T.nilable(String),
|
|
87
|
+
metadata: T.nilable(T::Hash[Symbol, String]),
|
|
88
|
+
model: String,
|
|
89
|
+
multi_agent: T.nilable(OpenAI::Beta::MultiAgentConfigParam::OrHash),
|
|
90
|
+
name: T.nilable(String),
|
|
91
|
+
reasoning: T.nilable(OpenAI::Beta::AgentReasoningParam::OrHash),
|
|
92
|
+
service_tier: T.nilable(OpenAI::Beta::AgentUpdateParams::ServiceTier::OrSymbol),
|
|
93
|
+
text: T.nilable(OpenAI::Beta::AgentTextParam::OrHash),
|
|
94
|
+
tools: T.nilable(
|
|
95
|
+
T::Array[
|
|
96
|
+
T.any(
|
|
97
|
+
OpenAI::Beta::PersistedAgentToolParam::Function::OrHash,
|
|
98
|
+
OpenAI::Beta::PersistedAgentToolParam::ToolSearch::OrHash,
|
|
99
|
+
OpenAI::Beta::PersistedAgentToolParam::ProgrammaticToolCalling::OrHash,
|
|
100
|
+
OpenAI::Beta::PersistedAgentToolParam::Mcp::OrHash,
|
|
101
|
+
OpenAI::Beta::PersistedAgentToolParam::WebSearch::OrHash
|
|
102
|
+
)
|
|
103
|
+
]
|
|
104
|
+
),
|
|
105
|
+
request_options: OpenAI::RequestOptions::OrHash
|
|
106
|
+
)
|
|
107
|
+
.returns(OpenAI::Beta::Agent)
|
|
108
|
+
}
|
|
109
|
+
def update(
|
|
110
|
+
# The ID of the reusable agent.
|
|
111
|
+
agent_id,
|
|
112
|
+
# Additional instructions appended to the agent's default base instructions. Omit
|
|
113
|
+
# to leave unchanged.
|
|
114
|
+
instructions: nil,
|
|
115
|
+
# Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it.
|
|
116
|
+
# Up to 16 string key-value pairs, with keys up to 64 and values up to 512
|
|
117
|
+
# characters.
|
|
118
|
+
metadata: nil,
|
|
119
|
+
# The model to use for the agent. The requested model name is preserved.
|
|
120
|
+
model: nil,
|
|
121
|
+
# Explicit configuration for creating and coordinating subagents.
|
|
122
|
+
multi_agent: nil,
|
|
123
|
+
# A replacement name. Omit to leave unchanged, or pass null to clear it.
|
|
124
|
+
name: nil,
|
|
125
|
+
# Reasoning configuration for the agent.
|
|
126
|
+
reasoning: nil,
|
|
127
|
+
# The service tier used for model requests.
|
|
128
|
+
service_tier: nil,
|
|
129
|
+
# Configuration for text generated by the agent.
|
|
130
|
+
text: nil,
|
|
131
|
+
# Tools available to the agent.
|
|
132
|
+
tools: nil,
|
|
133
|
+
request_options: {}
|
|
134
|
+
)
|
|
135
|
+
end
|
|
136
|
+
|
|
137
|
+
# Lists reusable agents in the current project. See
|
|
138
|
+
# [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).
|
|
139
|
+
sig {
|
|
140
|
+
params(
|
|
141
|
+
after: String,
|
|
142
|
+
limit: T.nilable(Integer),
|
|
143
|
+
order: OpenAI::Beta::AgentListParams::Order::OrSymbol,
|
|
144
|
+
request_options: OpenAI::RequestOptions::OrHash
|
|
145
|
+
)
|
|
146
|
+
.returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Agent])
|
|
147
|
+
}
|
|
148
|
+
def list(
|
|
149
|
+
# Return resources after this resource ID in the selected order.
|
|
150
|
+
after: nil,
|
|
151
|
+
# The maximum number of resources to return.
|
|
152
|
+
limit: nil,
|
|
153
|
+
# The order in which resources are returned. Defaults to `desc`.
|
|
154
|
+
order: nil,
|
|
155
|
+
request_options: {}
|
|
156
|
+
)
|
|
157
|
+
end
|
|
158
|
+
|
|
159
|
+
# Deletes a reusable agent. See
|
|
160
|
+
# [agent configuration](https://developers.openai.com/api/docs/guides/agents-api/configuration).
|
|
161
|
+
sig {
|
|
162
|
+
params(agent_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(OpenAI::Beta::AgentDeleted)
|
|
163
|
+
}
|
|
164
|
+
def delete(
|
|
165
|
+
# The ID of the reusable agent.
|
|
166
|
+
agent_id,
|
|
167
|
+
request_options: {}
|
|
168
|
+
)
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
# @api private
|
|
172
|
+
sig { params(client: OpenAI::Client).returns(T.attached_class) }
|
|
173
|
+
def self.new(client:)
|
|
174
|
+
end
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
end
|
|
180
|
+
end
|
|
@@ -7,7 +7,11 @@ module OpenAI
|
|
|
7
7
|
|
|
8
8
|
class Sessions
|
|
9
9
|
|
|
10
|
-
# Accept an incoming SIP call with
|
|
10
|
+
# Accept an incoming SIP call. Supply session with type live, the model, and
|
|
11
|
+
# startup configuration. Before accepting calls, follow the
|
|
12
|
+
# [Live prompting guide](https://developers.openai.com/api/docs/guides/live-prompting)
|
|
13
|
+
# to write frontend conversation instructions and a separate backend prompt. SIP
|
|
14
|
+
# media format is negotiated; omit audio.format.
|
|
11
15
|
sig {
|
|
12
16
|
params(
|
|
13
17
|
session_id: String,
|
|
@@ -63,7 +67,7 @@ module OpenAI
|
|
|
63
67
|
)
|
|
64
68
|
end
|
|
65
69
|
|
|
66
|
-
#
|
|
70
|
+
# End a SIP call identified by session_id.
|
|
67
71
|
sig { params(session_id: String, request_options: OpenAI::RequestOptions::OrHash).void }
|
|
68
72
|
def hangup(
|
|
69
73
|
# Opaque Live session identifier from the creation response or incoming-call
|
|
@@ -73,7 +77,8 @@ module OpenAI
|
|
|
73
77
|
)
|
|
74
78
|
end
|
|
75
79
|
|
|
76
|
-
# Transfer a
|
|
80
|
+
# Transfer a SIP call to another destination. Supply a nonblank target_uri for the
|
|
81
|
+
# SIP Refer-To header.
|
|
77
82
|
sig { params(session_id: String, target_uri: String, request_options: OpenAI::RequestOptions::OrHash).void }
|
|
78
83
|
def refer(
|
|
79
84
|
# Opaque Live session identifier from the creation response or incoming-call
|
|
@@ -86,7 +91,8 @@ module OpenAI
|
|
|
86
91
|
)
|
|
87
92
|
end
|
|
88
93
|
|
|
89
|
-
# Reject an incoming SIP call.
|
|
94
|
+
# Reject an incoming SIP call. Send a required SIP rejection status_code between
|
|
95
|
+
# 300 and 699.
|
|
90
96
|
sig { params(session_id: String, status_code: Integer, request_options: OpenAI::RequestOptions::OrHash).void }
|
|
91
97
|
def reject(
|
|
92
98
|
# Opaque Live session identifier from the creation response or incoming-call
|