openai 0.63.0 → 0.65.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 +28 -0
- data/README.md +1 -1
- data/lib/openai/internal/transport/base_client.rb +2 -0
- data/lib/openai/models/admin/organization/audit_log_list_params.rb +6 -0
- data/lib/openai/models/admin/organization/audit_log_list_response.rb +231 -1
- data/lib/openai/models/admin/organization/data_retention_retrieve_params.rb +18 -0
- data/lib/openai/models/admin/organization/data_retention_update_params.rb +40 -0
- data/lib/openai/models/admin/organization/group.rb +16 -3
- data/lib/openai/models/admin/organization/group_retrieve_params.rb +24 -0
- data/lib/openai/models/admin/organization/groups/role_list_response.rb +27 -1
- data/lib/openai/models/admin/organization/groups/role_retrieve_params.rb +32 -0
- data/lib/openai/models/admin/organization/groups/role_retrieve_response.rb +134 -0
- data/lib/openai/models/admin/organization/groups/user_retrieve_params.rb +32 -0
- data/lib/openai/models/admin/organization/groups/user_retrieve_response.rb +79 -0
- data/lib/openai/models/admin/organization/invite_create_params.rb +2 -1
- data/lib/openai/models/admin/organization/organization_data_retention.rb +48 -0
- data/lib/openai/models/admin/organization/organization_spend_alert.rb +120 -0
- data/lib/openai/models/admin/organization/organization_spend_alert_deleted.rb +41 -0
- data/lib/openai/models/admin/organization/projects/data_retention_retrieve_params.rb +26 -0
- data/lib/openai/models/admin/organization/projects/data_retention_update_params.rb +51 -0
- data/lib/openai/models/admin/organization/projects/group_retrieve_params.rb +53 -0
- data/lib/openai/models/admin/organization/projects/groups/role_list_response.rb +27 -1
- data/lib/openai/models/admin/organization/projects/groups/role_retrieve_params.rb +40 -0
- data/lib/openai/models/admin/organization/projects/groups/role_retrieve_response.rb +136 -0
- data/lib/openai/models/admin/organization/projects/hosted_tool_permission_retrieve_params.rb +26 -0
- data/lib/openai/models/admin/organization/projects/hosted_tool_permission_update_params.rb +150 -0
- data/lib/openai/models/admin/organization/projects/model_permission_delete_params.rb +26 -0
- data/lib/openai/models/admin/organization/projects/model_permission_retrieve_params.rb +26 -0
- data/lib/openai/models/admin/organization/projects/model_permission_update_params.rb +54 -0
- data/lib/openai/models/admin/organization/projects/project_data_retention.rb +52 -0
- data/lib/openai/models/admin/organization/projects/project_group.rb +16 -3
- data/lib/openai/models/admin/organization/projects/project_hosted_tool_permissions.rb +133 -0
- data/lib/openai/models/admin/organization/projects/project_model_permissions.rb +56 -0
- data/lib/openai/models/admin/organization/projects/project_model_permissions_deleted.rb +35 -0
- data/lib/openai/models/admin/organization/projects/project_spend_alert.rb +122 -0
- data/lib/openai/models/admin/organization/projects/project_spend_alert_deleted.rb +43 -0
- data/lib/openai/models/admin/organization/projects/role_retrieve_params.rb +32 -0
- data/lib/openai/models/admin/organization/projects/service_account_update_params.rb +61 -0
- data/lib/openai/models/admin/organization/projects/spend_alert_create_params.rb +109 -0
- data/lib/openai/models/admin/organization/projects/spend_alert_delete_params.rb +32 -0
- data/lib/openai/models/admin/organization/projects/spend_alert_list_params.rb +76 -0
- data/lib/openai/models/admin/organization/projects/spend_alert_update_params.rb +116 -0
- data/lib/openai/models/admin/organization/projects/users/role_list_response.rb +27 -1
- data/lib/openai/models/admin/organization/projects/users/role_retrieve_params.rb +40 -0
- data/lib/openai/models/admin/organization/projects/users/role_retrieve_response.rb +136 -0
- data/lib/openai/models/admin/organization/role_retrieve_params.rb +24 -0
- data/lib/openai/models/admin/organization/spend_alert_create_params.rb +100 -0
- data/lib/openai/models/admin/organization/spend_alert_delete_params.rb +24 -0
- data/lib/openai/models/admin/organization/spend_alert_list_params.rb +66 -0
- data/lib/openai/models/admin/organization/spend_alert_update_params.rb +107 -0
- data/lib/openai/models/admin/organization/usage_audio_speeches_response.rb +148 -3
- data/lib/openai/models/admin/organization/usage_audio_transcriptions_response.rb +148 -3
- data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_response.rb +148 -3
- data/lib/openai/models/admin/organization/usage_completions_response.rb +148 -3
- data/lib/openai/models/admin/organization/usage_costs_response.rb +148 -3
- data/lib/openai/models/admin/organization/usage_embeddings_response.rb +148 -3
- data/lib/openai/models/admin/organization/usage_file_search_calls_params.rb +136 -0
- data/lib/openai/models/admin/organization/usage_file_search_calls_response.rb +889 -0
- data/lib/openai/models/admin/organization/usage_images_response.rb +148 -3
- data/lib/openai/models/admin/organization/usage_moderations_response.rb +148 -3
- data/lib/openai/models/admin/organization/usage_vector_stores_response.rb +148 -3
- data/lib/openai/models/admin/organization/usage_web_search_calls_params.rb +157 -0
- data/lib/openai/models/admin/organization/usage_web_search_calls_response.rb +889 -0
- data/lib/openai/models/admin/organization/users/role_list_response.rb +27 -1
- data/lib/openai/models/admin/organization/users/role_retrieve_params.rb +32 -0
- data/lib/openai/models/admin/organization/users/role_retrieve_response.rb +134 -0
- data/lib/openai/models/chat/completion_create_params.rb +16 -0
- data/lib/openai/models/conversations/conversation_create_params.rb +2 -2
- data/lib/openai/models/conversations/conversation_item.rb +57 -1
- data/lib/openai/models/conversations/conversation_item_list.rb +2 -2
- data/lib/openai/models/conversations/item_create_params.rb +2 -2
- data/lib/openai/models/responses/compacted_response.rb +2 -2
- data/lib/openai/models/responses/input_token_count_params.rb +41 -4
- data/lib/openai/models/responses/response.rb +21 -5
- data/lib/openai/models/responses/response_compact_params.rb +3 -3
- data/lib/openai/models/responses/response_create_params.rb +19 -3
- data/lib/openai/models/responses/response_function_web_search.rb +11 -9
- data/lib/openai/models/responses/response_input_item.rb +54 -1
- data/lib/openai/models/responses/response_item.rb +57 -1
- data/lib/openai/models/responses/response_item_list.rb +2 -2
- data/lib/openai/models/responses/response_output_item.rb +57 -1
- data/lib/openai/models/responses/response_output_item_added_event.rb +2 -2
- data/lib/openai/models/responses/response_output_item_done_event.rb +2 -2
- data/lib/openai/models/responses/responses_client_event.rb +19 -3
- data/lib/openai/resources/admin/organization/data_retention.rb +60 -0
- data/lib/openai/resources/admin/organization/groups/roles.rb +28 -0
- data/lib/openai/resources/admin/organization/groups/users.rb +28 -0
- data/lib/openai/resources/admin/organization/groups.rb +21 -0
- data/lib/openai/resources/admin/organization/projects/data_retention.rb +66 -0
- data/lib/openai/resources/admin/organization/projects/groups/roles.rb +34 -0
- data/lib/openai/resources/admin/organization/projects/groups.rb +32 -0
- data/lib/openai/resources/admin/organization/projects/hosted_tool_permissions.rb +75 -0
- data/lib/openai/resources/admin/organization/projects/model_permissions.rb +89 -0
- data/lib/openai/resources/admin/organization/projects/roles.rb +28 -0
- data/lib/openai/resources/admin/organization/projects/service_accounts.rb +33 -0
- data/lib/openai/resources/admin/organization/projects/spend_alerts.rb +153 -0
- data/lib/openai/resources/admin/organization/projects/users/roles.rb +34 -0
- data/lib/openai/resources/admin/organization/projects.rb +18 -0
- data/lib/openai/resources/admin/organization/roles.rb +21 -0
- data/lib/openai/resources/admin/organization/spend_alerts.rb +133 -0
- data/lib/openai/resources/admin/organization/usage.rb +94 -0
- data/lib/openai/resources/admin/organization/users/roles.rb +28 -0
- data/lib/openai/resources/admin/organization.rb +8 -0
- data/lib/openai/resources/conversations/items.rb +3 -3
- data/lib/openai/resources/conversations.rb +1 -1
- data/lib/openai/resources/responses/input_items.rb +1 -1
- data/lib/openai/resources/responses/input_tokens.rb +4 -2
- data/lib/openai/resources/responses.rb +3 -3
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +51 -0
- data/rbi/openai/models/admin/organization/audit_log_list_params.rbi +30 -0
- data/rbi/openai/models/admin/organization/audit_log_list_response.rbi +489 -3
- data/rbi/openai/models/admin/organization/data_retention_retrieve_params.rbi +34 -0
- data/rbi/openai/models/admin/organization/data_retention_update_params.rbi +101 -0
- data/rbi/openai/models/admin/organization/group.rbi +39 -3
- data/rbi/openai/models/admin/organization/group_retrieve_params.rbi +42 -0
- data/rbi/openai/models/admin/organization/groups/role_list_response.rbi +58 -0
- data/rbi/openai/models/admin/organization/groups/role_retrieve_params.rbi +52 -0
- data/rbi/openai/models/admin/organization/groups/role_retrieve_response.rbi +186 -0
- data/rbi/openai/models/admin/organization/groups/user_retrieve_params.rbi +52 -0
- data/rbi/openai/models/admin/organization/groups/user_retrieve_response.rbi +128 -0
- data/rbi/openai/models/admin/organization/invite_create_params.rbi +4 -2
- data/rbi/openai/models/admin/organization/organization_data_retention.rbi +106 -0
- data/rbi/openai/models/admin/organization/organization_spend_alert.rbi +225 -0
- data/rbi/openai/models/admin/organization/organization_spend_alert_deleted.rbi +58 -0
- data/rbi/openai/models/admin/organization/projects/data_retention_retrieve_params.rbi +44 -0
- data/rbi/openai/models/admin/organization/projects/data_retention_update_params.rbi +119 -0
- data/rbi/openai/models/admin/organization/projects/group_retrieve_params.rbi +115 -0
- data/rbi/openai/models/admin/organization/projects/groups/role_list_response.rbi +58 -0
- data/rbi/openai/models/admin/organization/projects/groups/role_retrieve_params.rbi +64 -0
- data/rbi/openai/models/admin/organization/projects/groups/role_retrieve_response.rbi +188 -0
- data/rbi/openai/models/admin/organization/projects/hosted_tool_permission_retrieve_params.rbi +44 -0
- data/rbi/openai/models/admin/organization/projects/hosted_tool_permission_update_params.rbi +330 -0
- data/rbi/openai/models/admin/organization/projects/model_permission_delete_params.rbi +44 -0
- data/rbi/openai/models/admin/organization/projects/model_permission_retrieve_params.rbi +44 -0
- data/rbi/openai/models/admin/organization/projects/model_permission_update_params.rbi +107 -0
- data/rbi/openai/models/admin/organization/projects/project_data_retention.rbi +118 -0
- data/rbi/openai/models/admin/organization/projects/project_group.rbi +44 -3
- data/rbi/openai/models/admin/organization/projects/project_hosted_tool_permissions.rbi +281 -0
- data/rbi/openai/models/admin/organization/projects/project_model_permissions.rbi +106 -0
- data/rbi/openai/models/admin/organization/projects/project_model_permissions_deleted.rbi +50 -0
- data/rbi/openai/models/admin/organization/projects/project_spend_alert.rbi +227 -0
- data/rbi/openai/models/admin/organization/projects/project_spend_alert_deleted.rbi +59 -0
- data/rbi/openai/models/admin/organization/projects/role_retrieve_params.rbi +52 -0
- data/rbi/openai/models/admin/organization/projects/service_account_update_params.rbi +126 -0
- data/rbi/openai/models/admin/organization/projects/spend_alert_create_params.rbi +220 -0
- data/rbi/openai/models/admin/organization/projects/spend_alert_delete_params.rbi +52 -0
- data/rbi/openai/models/admin/organization/projects/spend_alert_list_params.rbi +146 -0
- data/rbi/openai/models/admin/organization/projects/spend_alert_update_params.rbi +226 -0
- data/rbi/openai/models/admin/organization/projects/users/role_list_response.rbi +58 -0
- data/rbi/openai/models/admin/organization/projects/users/role_retrieve_params.rbi +59 -0
- data/rbi/openai/models/admin/organization/projects/users/role_retrieve_response.rbi +188 -0
- data/rbi/openai/models/admin/organization/role_retrieve_params.rbi +42 -0
- data/rbi/openai/models/admin/organization/spend_alert_create_params.rbi +212 -0
- data/rbi/openai/models/admin/organization/spend_alert_delete_params.rbi +42 -0
- data/rbi/openai/models/admin/organization/spend_alert_list_params.rbi +138 -0
- data/rbi/openai/models/admin/organization/spend_alert_update_params.rbi +218 -0
- data/rbi/openai/models/admin/organization/usage_audio_speeches_response.rbi +186 -0
- data/rbi/openai/models/admin/organization/usage_audio_transcriptions_response.rbi +186 -0
- data/rbi/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbi +186 -0
- data/rbi/openai/models/admin/organization/usage_completions_response.rbi +186 -0
- data/rbi/openai/models/admin/organization/usage_costs_response.rbi +186 -0
- data/rbi/openai/models/admin/organization/usage_embeddings_response.rbi +186 -0
- data/rbi/openai/models/admin/organization/usage_file_search_calls_params.rbi +284 -0
- data/rbi/openai/models/admin/organization/usage_file_search_calls_response.rbi +1225 -0
- data/rbi/openai/models/admin/organization/usage_images_response.rbi +186 -0
- data/rbi/openai/models/admin/organization/usage_moderations_response.rbi +186 -0
- data/rbi/openai/models/admin/organization/usage_vector_stores_response.rbi +186 -0
- data/rbi/openai/models/admin/organization/usage_web_search_calls_params.rbi +360 -0
- data/rbi/openai/models/admin/organization/usage_web_search_calls_response.rbi +1225 -0
- data/rbi/openai/models/admin/organization/users/role_list_response.rbi +58 -0
- data/rbi/openai/models/admin/organization/users/role_retrieve_params.rbi +52 -0
- data/rbi/openai/models/admin/organization/users/role_retrieve_response.rbi +186 -0
- data/rbi/openai/models/chat/completion_create_params.rbi +24 -0
- data/rbi/openai/models/conversations/conversation_create_params.rbi +6 -0
- data/rbi/openai/models/conversations/conversation_item.rbi +150 -0
- data/rbi/openai/models/conversations/conversation_item_list.rbi +1 -0
- data/rbi/openai/models/conversations/item_create_params.rbi +6 -0
- data/rbi/openai/models/responses/compacted_response.rbi +1 -0
- data/rbi/openai/models/responses/input_token_count_params.rbi +85 -0
- data/rbi/openai/models/responses/response.rbi +25 -0
- data/rbi/openai/models/responses/response_create_params.rbi +24 -0
- data/rbi/openai/models/responses/response_function_web_search.rbi +11 -8
- data/rbi/openai/models/responses/response_input_item.rbi +147 -0
- data/rbi/openai/models/responses/response_item.rbi +150 -0
- data/rbi/openai/models/responses/response_item_list.rbi +1 -0
- data/rbi/openai/models/responses/response_output_item.rbi +150 -0
- data/rbi/openai/models/responses/response_output_item_added_event.rbi +1 -0
- data/rbi/openai/models/responses/response_output_item_done_event.rbi +1 -0
- data/rbi/openai/models/responses/responses_client_event.rbi +24 -0
- data/rbi/openai/resources/admin/organization/data_retention.rbi +40 -0
- data/rbi/openai/resources/admin/organization/groups/roles.rbi +19 -0
- data/rbi/openai/resources/admin/organization/groups/users.rbi +19 -0
- data/rbi/openai/resources/admin/organization/groups.rbi +14 -0
- data/rbi/openai/resources/admin/organization/invites.rbi +2 -1
- data/rbi/openai/resources/admin/organization/projects/data_retention.rbi +54 -0
- data/rbi/openai/resources/admin/organization/projects/groups/roles.rbi +22 -0
- data/rbi/openai/resources/admin/organization/projects/groups.rbi +21 -0
- data/rbi/openai/resources/admin/organization/projects/hosted_tool_permissions.rbi +80 -0
- data/rbi/openai/resources/admin/organization/projects/model_permissions.rbi +73 -0
- data/rbi/openai/resources/admin/organization/projects/roles.rbi +17 -0
- data/rbi/openai/resources/admin/organization/projects/service_accounts.rbi +26 -0
- data/rbi/openai/resources/admin/organization/projects/spend_alerts.rbi +135 -0
- data/rbi/openai/resources/admin/organization/projects/users/roles.rbi +22 -0
- data/rbi/openai/resources/admin/organization/projects.rbi +28 -0
- data/rbi/openai/resources/admin/organization/roles.rbi +14 -0
- data/rbi/openai/resources/admin/organization/spend_alerts.rbi +117 -0
- data/rbi/openai/resources/admin/organization/usage.rbi +116 -0
- data/rbi/openai/resources/admin/organization/users/roles.rbi +19 -0
- data/rbi/openai/resources/admin/organization.rbi +6 -0
- data/rbi/openai/resources/chat/completions.rbi +16 -0
- data/rbi/openai/resources/conversations/items.rbi +2 -0
- data/rbi/openai/resources/conversations.rbi +2 -0
- data/rbi/openai/resources/responses/input_tokens.rbi +9 -0
- data/rbi/openai/resources/responses.rbi +16 -0
- data/sig/openai/models/admin/organization/audit_log_list_params.rbs +12 -0
- data/sig/openai/models/admin/organization/audit_log_list_response.rbs +216 -3
- data/sig/openai/models/admin/organization/data_retention_retrieve_params.rbs +19 -0
- data/sig/openai/models/admin/organization/data_retention_update_params.rbs +47 -0
- data/sig/openai/models/admin/organization/group.rbs +15 -4
- data/sig/openai/models/admin/organization/group_retrieve_params.rbs +27 -0
- data/sig/openai/models/admin/organization/groups/role_list_response.rbs +21 -0
- data/sig/openai/models/admin/organization/groups/role_retrieve_params.rbs +34 -0
- data/sig/openai/models/admin/organization/groups/role_retrieve_response.rbs +97 -0
- data/sig/openai/models/admin/organization/groups/user_retrieve_params.rbs +34 -0
- data/sig/openai/models/admin/organization/groups/user_retrieve_response.rbs +62 -0
- data/sig/openai/models/admin/organization/organization_data_retention.rbs +48 -0
- data/sig/openai/models/admin/organization/organization_spend_alert.rbs +98 -0
- data/sig/openai/models/admin/organization/organization_spend_alert_deleted.rbs +36 -0
- data/sig/openai/models/admin/organization/projects/data_retention_retrieve_params.rbs +29 -0
- data/sig/openai/models/admin/organization/projects/data_retention_update_params.rbs +58 -0
- data/sig/openai/models/admin/organization/projects/group_retrieve_params.rbs +57 -0
- data/sig/openai/models/admin/organization/projects/groups/role_list_response.rbs +21 -0
- data/sig/openai/models/admin/organization/projects/groups/role_retrieve_params.rbs +40 -0
- data/sig/openai/models/admin/organization/projects/groups/role_retrieve_response.rbs +99 -0
- data/sig/openai/models/admin/organization/projects/hosted_tool_permission_retrieve_params.rbs +29 -0
- data/sig/openai/models/admin/organization/projects/hosted_tool_permission_update_params.rbs +107 -0
- data/sig/openai/models/admin/organization/projects/model_permission_delete_params.rbs +29 -0
- data/sig/openai/models/admin/organization/projects/model_permission_retrieve_params.rbs +29 -0
- data/sig/openai/models/admin/organization/projects/model_permission_update_params.rbs +53 -0
- data/sig/openai/models/admin/organization/projects/project_data_retention.rbs +54 -0
- data/sig/openai/models/admin/organization/projects/project_group.rbs +15 -4
- data/sig/openai/models/admin/organization/projects/project_hosted_tool_permissions.rbs +98 -0
- data/sig/openai/models/admin/organization/projects/project_model_permissions.rbs +49 -0
- data/sig/openai/models/admin/organization/projects/project_model_permissions_deleted.rbs +30 -0
- data/sig/openai/models/admin/organization/projects/project_spend_alert.rbs +100 -0
- data/sig/openai/models/admin/organization/projects/project_spend_alert_deleted.rbs +38 -0
- data/sig/openai/models/admin/organization/projects/role_retrieve_params.rbs +34 -0
- data/sig/openai/models/admin/organization/projects/service_account_update_params.rbs +64 -0
- data/sig/openai/models/admin/organization/projects/spend_alert_create_params.rbs +99 -0
- data/sig/openai/models/admin/organization/projects/spend_alert_delete_params.rbs +34 -0
- data/sig/openai/models/admin/organization/projects/spend_alert_list_params.rbs +73 -0
- data/sig/openai/models/admin/organization/projects/spend_alert_update_params.rbs +104 -0
- data/sig/openai/models/admin/organization/projects/users/role_list_response.rbs +21 -0
- data/sig/openai/models/admin/organization/projects/users/role_retrieve_params.rbs +40 -0
- data/sig/openai/models/admin/organization/projects/users/role_retrieve_response.rbs +99 -0
- data/sig/openai/models/admin/organization/role_retrieve_params.rbs +27 -0
- data/sig/openai/models/admin/organization/spend_alert_create_params.rbs +92 -0
- data/sig/openai/models/admin/organization/spend_alert_delete_params.rbs +27 -0
- data/sig/openai/models/admin/organization/spend_alert_list_params.rbs +66 -0
- data/sig/openai/models/admin/organization/spend_alert_update_params.rbs +97 -0
- data/sig/openai/models/admin/organization/usage_audio_speeches_response.rbs +96 -0
- data/sig/openai/models/admin/organization/usage_audio_transcriptions_response.rbs +96 -0
- data/sig/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbs +96 -0
- data/sig/openai/models/admin/organization/usage_completions_response.rbs +96 -0
- data/sig/openai/models/admin/organization/usage_costs_response.rbs +96 -0
- data/sig/openai/models/admin/organization/usage_embeddings_response.rbs +96 -0
- data/sig/openai/models/admin/organization/usage_file_search_calls_params.rbs +123 -0
- data/sig/openai/models/admin/organization/usage_file_search_calls_response.rbs +628 -0
- data/sig/openai/models/admin/organization/usage_images_response.rbs +96 -0
- data/sig/openai/models/admin/organization/usage_moderations_response.rbs +96 -0
- data/sig/openai/models/admin/organization/usage_vector_stores_response.rbs +96 -0
- data/sig/openai/models/admin/organization/usage_web_search_calls_params.rbs +145 -0
- data/sig/openai/models/admin/organization/usage_web_search_calls_response.rbs +628 -0
- data/sig/openai/models/admin/organization/users/role_list_response.rbs +21 -0
- data/sig/openai/models/admin/organization/users/role_retrieve_params.rbs +34 -0
- data/sig/openai/models/admin/organization/users/role_retrieve_response.rbs +97 -0
- data/sig/openai/models/conversations/conversation_item.rbs +58 -0
- data/sig/openai/models/responses/input_token_count_params.rbs +20 -0
- data/sig/openai/models/responses/response_function_web_search.rbs +7 -5
- data/sig/openai/models/responses/response_input_item.rbs +44 -0
- data/sig/openai/models/responses/response_item.rbs +58 -0
- data/sig/openai/models/responses/response_output_item.rbs +58 -0
- data/sig/openai/resources/admin/organization/data_retention.rbs +20 -0
- data/sig/openai/resources/admin/organization/groups/roles.rbs +6 -0
- data/sig/openai/resources/admin/organization/groups/users.rbs +6 -0
- data/sig/openai/resources/admin/organization/groups.rbs +5 -0
- data/sig/openai/resources/admin/organization/projects/data_retention.rbs +24 -0
- data/sig/openai/resources/admin/organization/projects/groups/roles.rbs +7 -0
- data/sig/openai/resources/admin/organization/projects/groups.rbs +7 -0
- data/sig/openai/resources/admin/organization/projects/hosted_tool_permissions.rbs +28 -0
- data/sig/openai/resources/admin/organization/projects/model_permissions.rbs +30 -0
- data/sig/openai/resources/admin/organization/projects/roles.rbs +6 -0
- data/sig/openai/resources/admin/organization/projects/service_accounts.rbs +8 -0
- data/sig/openai/resources/admin/organization/projects/spend_alerts.rbs +47 -0
- data/sig/openai/resources/admin/organization/projects/users/roles.rbs +7 -0
- data/sig/openai/resources/admin/organization/projects.rbs +8 -0
- data/sig/openai/resources/admin/organization/roles.rbs +5 -0
- data/sig/openai/resources/admin/organization/spend_alerts.rbs +41 -0
- data/sig/openai/resources/admin/organization/usage.rbs +29 -0
- data/sig/openai/resources/admin/organization/users/roles.rbs +6 -0
- data/sig/openai/resources/admin/organization.rbs +4 -0
- data/sig/openai/resources/responses/input_tokens.rbs +1 -0
- metadata +155 -2
|
@@ -38,7 +38,7 @@ module OpenAI
|
|
|
38
38
|
# response will not be carried over to the next response. This makes it simple to
|
|
39
39
|
# swap out system (or developer) messages in new responses.
|
|
40
40
|
#
|
|
41
|
-
# @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
|
|
41
|
+
# @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
|
|
42
42
|
required :instructions, union: -> { OpenAI::Responses::Response::Instructions }, nil?: true
|
|
43
43
|
|
|
44
44
|
# @!attribute metadata
|
|
@@ -77,7 +77,7 @@ module OpenAI
|
|
|
77
77
|
# an `assistant` message with the content generated by the model, you might
|
|
78
78
|
# consider using the `output_text` property where supported in SDKs.
|
|
79
79
|
#
|
|
80
|
-
# @return [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>]
|
|
80
|
+
# @return [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>]
|
|
81
81
|
required :output, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseOutputItem] }
|
|
82
82
|
|
|
83
83
|
# @!attribute parallel_tool_calls
|
|
@@ -204,6 +204,14 @@ module OpenAI
|
|
|
204
204
|
# prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
205
205
|
# of 24 hours.
|
|
206
206
|
# [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
|
|
207
|
+
# For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
|
|
208
|
+
#
|
|
209
|
+
# For older models that support both `in_memory` and `24h`, the default depends on
|
|
210
|
+
# your organization's data retention policy:
|
|
211
|
+
#
|
|
212
|
+
# - Organizations without ZDR enabled default to `24h`.
|
|
213
|
+
# - Organizations with ZDR enabled default to `in_memory` when
|
|
214
|
+
# `prompt_cache_retention` is not specified.
|
|
207
215
|
#
|
|
208
216
|
# @return [Symbol, OpenAI::Models::Responses::Response::PromptCacheRetention, nil]
|
|
209
217
|
optional :prompt_cache_retention,
|
|
@@ -339,13 +347,13 @@ module OpenAI
|
|
|
339
347
|
#
|
|
340
348
|
# @param incomplete_details [OpenAI::Models::Responses::Response::IncompleteDetails, nil] Details about why the response is incomplete.
|
|
341
349
|
#
|
|
342
|
-
# @param instructions [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] A system (or developer) message inserted into the model's context.
|
|
350
|
+
# @param instructions [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] A system (or developer) message inserted into the model's context.
|
|
343
351
|
#
|
|
344
352
|
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
|
|
345
353
|
#
|
|
346
354
|
# @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI
|
|
347
355
|
#
|
|
348
|
-
# @param output [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>] An array of content items generated by the model.
|
|
356
|
+
# @param output [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>] An array of content items generated by the model.
|
|
349
357
|
#
|
|
350
358
|
# @param parallel_tool_calls [Boolean] Whether to allow the model to run tool calls in parallel.
|
|
351
359
|
#
|
|
@@ -441,7 +449,7 @@ module OpenAI
|
|
|
441
449
|
variant -> { OpenAI::Models::Responses::Response::Instructions::ResponseInputItemArray }
|
|
442
450
|
|
|
443
451
|
# @!method self.variants
|
|
444
|
-
# @return [Array(String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>)]
|
|
452
|
+
# @return [Array(String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>)]
|
|
445
453
|
|
|
446
454
|
# @type [OpenAI::Internal::Type::Converter]
|
|
447
455
|
ResponseInputItemArray =
|
|
@@ -511,6 +519,14 @@ module OpenAI
|
|
|
511
519
|
# prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
512
520
|
# of 24 hours.
|
|
513
521
|
# [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
|
|
522
|
+
# For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
|
|
523
|
+
#
|
|
524
|
+
# For older models that support both `in_memory` and `24h`, the default depends on
|
|
525
|
+
# your organization's data retention policy:
|
|
526
|
+
#
|
|
527
|
+
# - Organizations without ZDR enabled default to `24h`.
|
|
528
|
+
# - Organizations with ZDR enabled default to `in_memory` when
|
|
529
|
+
# `prompt_cache_retention` is not specified.
|
|
514
530
|
#
|
|
515
531
|
# @see OpenAI::Models::Responses::Response#prompt_cache_retention
|
|
516
532
|
module PromptCacheRetention
|
|
@@ -21,7 +21,7 @@ module OpenAI
|
|
|
21
21
|
# @!attribute input
|
|
22
22
|
# Text, image, or file inputs to the model, used to generate a response
|
|
23
23
|
#
|
|
24
|
-
# @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
|
|
24
|
+
# @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
|
|
25
25
|
optional :input, union: -> { OpenAI::Responses::ResponseCompactParams::Input }, nil?: true
|
|
26
26
|
|
|
27
27
|
# @!attribute instructions
|
|
@@ -68,7 +68,7 @@ module OpenAI
|
|
|
68
68
|
#
|
|
69
69
|
# @param model [Symbol, String, OpenAI::Models::Responses::ResponseCompactParams::Model, nil] Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wi
|
|
70
70
|
#
|
|
71
|
-
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Text, image, or file inputs to the model, used to generate a response
|
|
71
|
+
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Text, image, or file inputs to the model, used to generate a response
|
|
72
72
|
#
|
|
73
73
|
# @param instructions [String, nil] A system (or developer) message inserted into the model's context.
|
|
74
74
|
#
|
|
@@ -392,7 +392,7 @@ module OpenAI
|
|
|
392
392
|
variant -> { OpenAI::Models::Responses::ResponseCompactParams::Input::ResponseInputItemArray }
|
|
393
393
|
|
|
394
394
|
# @!method self.variants
|
|
395
|
-
# @return [Array(String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>)]
|
|
395
|
+
# @return [Array(String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>)]
|
|
396
396
|
|
|
397
397
|
# @type [OpenAI::Internal::Type::Converter]
|
|
398
398
|
ResponseInputItemArray =
|
|
@@ -76,7 +76,7 @@ module OpenAI
|
|
|
76
76
|
# - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
|
|
77
77
|
# - [Function calling](https://platform.openai.com/docs/guides/function-calling)
|
|
78
78
|
#
|
|
79
|
-
# @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
|
|
79
|
+
# @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
|
|
80
80
|
optional :input, union: -> { OpenAI::Responses::ResponseCreateParams::Input }
|
|
81
81
|
|
|
82
82
|
# @!attribute instructions
|
|
@@ -162,6 +162,14 @@ module OpenAI
|
|
|
162
162
|
# prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
163
163
|
# of 24 hours.
|
|
164
164
|
# [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
|
|
165
|
+
# For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
|
|
166
|
+
#
|
|
167
|
+
# For older models that support both `in_memory` and `24h`, the default depends on
|
|
168
|
+
# your organization's data retention policy:
|
|
169
|
+
#
|
|
170
|
+
# - Organizations without ZDR enabled default to `24h`.
|
|
171
|
+
# - Organizations with ZDR enabled default to `in_memory` when
|
|
172
|
+
# `prompt_cache_retention` is not specified.
|
|
165
173
|
#
|
|
166
174
|
# @return [Symbol, OpenAI::Models::Responses::ResponseCreateParams::PromptCacheRetention, nil]
|
|
167
175
|
optional :prompt_cache_retention,
|
|
@@ -332,7 +340,7 @@ module OpenAI
|
|
|
332
340
|
#
|
|
333
341
|
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently suppo
|
|
334
342
|
#
|
|
335
|
-
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Text, image, or file inputs to the model, used to generate a response.
|
|
343
|
+
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Text, image, or file inputs to the model, used to generate a response.
|
|
336
344
|
#
|
|
337
345
|
# @param instructions [String, nil] A system (or developer) message inserted into the model's context.
|
|
338
346
|
#
|
|
@@ -439,13 +447,21 @@ module OpenAI
|
|
|
439
447
|
variant -> { OpenAI::Responses::ResponseInput }
|
|
440
448
|
|
|
441
449
|
# @!method self.variants
|
|
442
|
-
# @return [Array(String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>)]
|
|
450
|
+
# @return [Array(String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference>)]
|
|
443
451
|
end
|
|
444
452
|
|
|
445
453
|
# The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
446
454
|
# prompt caching, which keeps cached prefixes active for longer, up to a maximum
|
|
447
455
|
# of 24 hours.
|
|
448
456
|
# [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
|
|
457
|
+
# For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
|
|
458
|
+
#
|
|
459
|
+
# For older models that support both `in_memory` and `24h`, the default depends on
|
|
460
|
+
# your organization's data retention policy:
|
|
461
|
+
#
|
|
462
|
+
# - Organizations without ZDR enabled default to `24h`.
|
|
463
|
+
# - Organizations with ZDR enabled default to `in_memory` when
|
|
464
|
+
# `prompt_cache_retention` is not specified.
|
|
449
465
|
module PromptCacheRetention
|
|
450
466
|
extend OpenAI::Internal::Type::Enum
|
|
451
467
|
|
|
@@ -64,12 +64,6 @@ module OpenAI
|
|
|
64
64
|
variant :find_in_page, -> { OpenAI::Responses::ResponseFunctionWebSearch::Action::Find }
|
|
65
65
|
|
|
66
66
|
class Search < OpenAI::Internal::Type::BaseModel
|
|
67
|
-
# @!attribute query
|
|
68
|
-
# [DEPRECATED] The search query.
|
|
69
|
-
#
|
|
70
|
-
# @return [String]
|
|
71
|
-
required :query, String
|
|
72
|
-
|
|
73
67
|
# @!attribute type
|
|
74
68
|
# The action type.
|
|
75
69
|
#
|
|
@@ -82,6 +76,14 @@ module OpenAI
|
|
|
82
76
|
# @return [Array<String>, nil]
|
|
83
77
|
optional :queries, OpenAI::Internal::Type::ArrayOf[String]
|
|
84
78
|
|
|
79
|
+
# @!attribute query
|
|
80
|
+
# @deprecated
|
|
81
|
+
#
|
|
82
|
+
# The search query.
|
|
83
|
+
#
|
|
84
|
+
# @return [String, nil]
|
|
85
|
+
optional :query, String
|
|
86
|
+
|
|
85
87
|
# @!attribute sources
|
|
86
88
|
# The sources used in the search.
|
|
87
89
|
#
|
|
@@ -89,17 +91,17 @@ module OpenAI
|
|
|
89
91
|
optional :sources,
|
|
90
92
|
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source] }
|
|
91
93
|
|
|
92
|
-
# @!method initialize(
|
|
94
|
+
# @!method initialize(queries: nil, query: nil, sources: nil, type: :search)
|
|
93
95
|
# Some parameter documentations has been truncated, see
|
|
94
96
|
# {OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Search} for more
|
|
95
97
|
# details.
|
|
96
98
|
#
|
|
97
99
|
# Action type "search" - Performs a web search query.
|
|
98
100
|
#
|
|
99
|
-
# @param query [String] [DEPRECATED] The search query.
|
|
100
|
-
#
|
|
101
101
|
# @param queries [Array<String>] The search queries.
|
|
102
102
|
#
|
|
103
|
+
# @param query [String] The search query.
|
|
104
|
+
#
|
|
103
105
|
# @param sources [Array<OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Search::Source>] The sources used in the search.
|
|
104
106
|
#
|
|
105
107
|
# @param type [Symbol, :search] The action type.
|
|
@@ -54,6 +54,8 @@ module OpenAI
|
|
|
54
54
|
|
|
55
55
|
variant :tool_search_output, -> { OpenAI::Responses::ResponseToolSearchOutputItemParam }
|
|
56
56
|
|
|
57
|
+
variant :additional_tools, -> { OpenAI::Responses::ResponseInputItem::AdditionalTools }
|
|
58
|
+
|
|
57
59
|
# A description of the chain of thought used by a reasoning model while generating
|
|
58
60
|
# a response. Be sure to include these items in your `input` to the Responses API
|
|
59
61
|
# for subsequent turns of a conversation if you are manually
|
|
@@ -105,6 +107,9 @@ module OpenAI
|
|
|
105
107
|
# A call to a custom tool created by the model.
|
|
106
108
|
variant :custom_tool_call, -> { OpenAI::Responses::ResponseCustomToolCall }
|
|
107
109
|
|
|
110
|
+
# Compacts the current context. Must be the final input item.
|
|
111
|
+
variant :compaction_trigger, -> { OpenAI::Responses::ResponseInputItem::CompactionTrigger }
|
|
112
|
+
|
|
108
113
|
# An internal identifier for an item to reference.
|
|
109
114
|
variant :item_reference, -> { OpenAI::Responses::ResponseInputItem::ItemReference }
|
|
110
115
|
|
|
@@ -468,6 +473,41 @@ module OpenAI
|
|
|
468
473
|
end
|
|
469
474
|
end
|
|
470
475
|
|
|
476
|
+
class AdditionalTools < OpenAI::Internal::Type::BaseModel
|
|
477
|
+
# @!attribute role
|
|
478
|
+
# The role that provided the additional tools. Only `developer` is supported.
|
|
479
|
+
#
|
|
480
|
+
# @return [Symbol, :developer]
|
|
481
|
+
required :role, const: :developer
|
|
482
|
+
|
|
483
|
+
# @!attribute tools
|
|
484
|
+
# A list of additional tools made available at this item.
|
|
485
|
+
#
|
|
486
|
+
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>]
|
|
487
|
+
required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
|
|
488
|
+
|
|
489
|
+
# @!attribute type
|
|
490
|
+
# The item type. Always `additional_tools`.
|
|
491
|
+
#
|
|
492
|
+
# @return [Symbol, :additional_tools]
|
|
493
|
+
required :type, const: :additional_tools
|
|
494
|
+
|
|
495
|
+
# @!attribute id
|
|
496
|
+
# The unique ID of this additional tools item.
|
|
497
|
+
#
|
|
498
|
+
# @return [String, nil]
|
|
499
|
+
optional :id, String, nil?: true
|
|
500
|
+
|
|
501
|
+
# @!method initialize(tools:, id: nil, role: :developer, type: :additional_tools)
|
|
502
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] A list of additional tools made available at this item.
|
|
503
|
+
#
|
|
504
|
+
# @param id [String, nil] The unique ID of this additional tools item.
|
|
505
|
+
#
|
|
506
|
+
# @param role [Symbol, :developer] The role that provided the additional tools. Only `developer` is supported.
|
|
507
|
+
#
|
|
508
|
+
# @param type [Symbol, :additional_tools] The item type. Always `additional_tools`.
|
|
509
|
+
end
|
|
510
|
+
|
|
471
511
|
class ImageGenerationCall < OpenAI::Internal::Type::BaseModel
|
|
472
512
|
# @!attribute id
|
|
473
513
|
# The unique ID of the image generation call.
|
|
@@ -1419,6 +1459,19 @@ module OpenAI
|
|
|
1419
1459
|
end
|
|
1420
1460
|
end
|
|
1421
1461
|
|
|
1462
|
+
class CompactionTrigger < OpenAI::Internal::Type::BaseModel
|
|
1463
|
+
# @!attribute type
|
|
1464
|
+
# The type of the item. Always `compaction_trigger`.
|
|
1465
|
+
#
|
|
1466
|
+
# @return [Symbol, :compaction_trigger]
|
|
1467
|
+
required :type, const: :compaction_trigger
|
|
1468
|
+
|
|
1469
|
+
# @!method initialize(type: :compaction_trigger)
|
|
1470
|
+
# Compacts the current context. Must be the final input item.
|
|
1471
|
+
#
|
|
1472
|
+
# @param type [Symbol, :compaction_trigger] The type of the item. Always `compaction_trigger`.
|
|
1473
|
+
end
|
|
1474
|
+
|
|
1422
1475
|
class ItemReference < OpenAI::Internal::Type::BaseModel
|
|
1423
1476
|
# @!attribute id
|
|
1424
1477
|
# The ID of the item to reference.
|
|
@@ -1453,7 +1506,7 @@ module OpenAI
|
|
|
1453
1506
|
end
|
|
1454
1507
|
|
|
1455
1508
|
# @!method self.variants
|
|
1456
|
-
# @return [Array(OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference)]
|
|
1509
|
+
# @return [Array(OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference)]
|
|
1457
1510
|
end
|
|
1458
1511
|
end
|
|
1459
1512
|
end
|
|
@@ -38,6 +38,8 @@ module OpenAI
|
|
|
38
38
|
|
|
39
39
|
variant :tool_search_output, -> { OpenAI::Responses::ResponseToolSearchOutputItem }
|
|
40
40
|
|
|
41
|
+
variant :additional_tools, -> { OpenAI::Responses::ResponseItem::AdditionalTools }
|
|
42
|
+
|
|
41
43
|
# A description of the chain of thought used by a reasoning model while generating
|
|
42
44
|
# a response. Be sure to include these items in your `input` to the Responses API
|
|
43
45
|
# for subsequent turns of a conversation if you are manually
|
|
@@ -89,6 +91,60 @@ module OpenAI
|
|
|
89
91
|
# The output of a custom tool call from your code, being sent back to the model.
|
|
90
92
|
variant :custom_tool_call_output, -> { OpenAI::Responses::ResponseCustomToolCallOutputItem }
|
|
91
93
|
|
|
94
|
+
class AdditionalTools < OpenAI::Internal::Type::BaseModel
|
|
95
|
+
# @!attribute id
|
|
96
|
+
# The unique ID of the additional tools item.
|
|
97
|
+
#
|
|
98
|
+
# @return [String]
|
|
99
|
+
required :id, String
|
|
100
|
+
|
|
101
|
+
# @!attribute role
|
|
102
|
+
# The role that provided the additional tools.
|
|
103
|
+
#
|
|
104
|
+
# @return [Symbol, OpenAI::Models::Responses::ResponseItem::AdditionalTools::Role]
|
|
105
|
+
required :role, enum: -> { OpenAI::Responses::ResponseItem::AdditionalTools::Role }
|
|
106
|
+
|
|
107
|
+
# @!attribute tools
|
|
108
|
+
# The additional tool definitions made available at this item.
|
|
109
|
+
#
|
|
110
|
+
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>]
|
|
111
|
+
required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
|
|
112
|
+
|
|
113
|
+
# @!attribute type
|
|
114
|
+
# The type of the item. Always `additional_tools`.
|
|
115
|
+
#
|
|
116
|
+
# @return [Symbol, :additional_tools]
|
|
117
|
+
required :type, const: :additional_tools
|
|
118
|
+
|
|
119
|
+
# @!method initialize(id:, role:, tools:, type: :additional_tools)
|
|
120
|
+
# @param id [String] The unique ID of the additional tools item.
|
|
121
|
+
#
|
|
122
|
+
# @param role [Symbol, OpenAI::Models::Responses::ResponseItem::AdditionalTools::Role] The role that provided the additional tools.
|
|
123
|
+
#
|
|
124
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] The additional tool definitions made available at this item.
|
|
125
|
+
#
|
|
126
|
+
# @param type [Symbol, :additional_tools] The type of the item. Always `additional_tools`.
|
|
127
|
+
|
|
128
|
+
# The role that provided the additional tools.
|
|
129
|
+
#
|
|
130
|
+
# @see OpenAI::Models::Responses::ResponseItem::AdditionalTools#role
|
|
131
|
+
module Role
|
|
132
|
+
extend OpenAI::Internal::Type::Enum
|
|
133
|
+
|
|
134
|
+
UNKNOWN = :unknown
|
|
135
|
+
USER = :user
|
|
136
|
+
ASSISTANT = :assistant
|
|
137
|
+
SYSTEM = :system
|
|
138
|
+
CRITIC = :critic
|
|
139
|
+
DISCRIMINATOR = :discriminator
|
|
140
|
+
DEVELOPER = :developer
|
|
141
|
+
TOOL = :tool
|
|
142
|
+
|
|
143
|
+
# @!method self.values
|
|
144
|
+
# @return [Array<Symbol>]
|
|
145
|
+
end
|
|
146
|
+
end
|
|
147
|
+
|
|
92
148
|
class ImageGenerationCall < OpenAI::Internal::Type::BaseModel
|
|
93
149
|
# @!attribute id
|
|
94
150
|
# The unique ID of the image generation call.
|
|
@@ -605,7 +661,7 @@ module OpenAI
|
|
|
605
661
|
end
|
|
606
662
|
|
|
607
663
|
# @!method self.variants
|
|
608
|
-
# @return [Array(OpenAI::Models::Responses::ResponseInputMessageItem, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseItem::LocalShellCall, OpenAI::Models::Responses::ResponseItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseItem::McpListTools, OpenAI::Models::Responses::ResponseItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallItem, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem)]
|
|
664
|
+
# @return [Array(OpenAI::Models::Responses::ResponseInputMessageItem, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseItem::LocalShellCall, OpenAI::Models::Responses::ResponseItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseItem::McpListTools, OpenAI::Models::Responses::ResponseItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallItem, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem)]
|
|
609
665
|
end
|
|
610
666
|
end
|
|
611
667
|
end
|
|
@@ -7,7 +7,7 @@ module OpenAI
|
|
|
7
7
|
# @!attribute data
|
|
8
8
|
# A list of items used to generate this response.
|
|
9
9
|
#
|
|
10
|
-
# @return [Array<OpenAI::Models::Responses::ResponseInputMessageItem, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseItem::LocalShellCall, OpenAI::Models::Responses::ResponseItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseItem::McpListTools, OpenAI::Models::Responses::ResponseItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallItem, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>]
|
|
10
|
+
# @return [Array<OpenAI::Models::Responses::ResponseInputMessageItem, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseItem::LocalShellCall, OpenAI::Models::Responses::ResponseItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseItem::McpListTools, OpenAI::Models::Responses::ResponseItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallItem, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>]
|
|
11
11
|
required :data, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseItem] }
|
|
12
12
|
|
|
13
13
|
# @!attribute first_id
|
|
@@ -37,7 +37,7 @@ module OpenAI
|
|
|
37
37
|
# @!method initialize(data:, first_id:, has_more:, last_id:, object: :list)
|
|
38
38
|
# A list of Response items.
|
|
39
39
|
#
|
|
40
|
-
# @param data [Array<OpenAI::Models::Responses::ResponseInputMessageItem, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseItem::LocalShellCall, OpenAI::Models::Responses::ResponseItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseItem::McpListTools, OpenAI::Models::Responses::ResponseItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallItem, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>] A list of items used to generate this response.
|
|
40
|
+
# @param data [Array<OpenAI::Models::Responses::ResponseInputMessageItem, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseItem::AdditionalTools, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseItem::LocalShellCall, OpenAI::Models::Responses::ResponseItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseItem::McpListTools, OpenAI::Models::Responses::ResponseItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallItem, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>] A list of items used to generate this response.
|
|
41
41
|
#
|
|
42
42
|
# @param first_id [String] The ID of the first item in the list.
|
|
43
43
|
#
|
|
@@ -42,6 +42,8 @@ module OpenAI
|
|
|
42
42
|
|
|
43
43
|
variant :tool_search_output, -> { OpenAI::Responses::ResponseToolSearchOutputItem }
|
|
44
44
|
|
|
45
|
+
variant :additional_tools, -> { OpenAI::Responses::ResponseOutputItem::AdditionalTools }
|
|
46
|
+
|
|
45
47
|
# A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact).
|
|
46
48
|
variant :compaction, -> { OpenAI::Responses::ResponseCompactionItem }
|
|
47
49
|
|
|
@@ -87,6 +89,60 @@ module OpenAI
|
|
|
87
89
|
# The output of a custom tool call from your code, being sent back to the model.
|
|
88
90
|
variant :custom_tool_call_output, -> { OpenAI::Responses::ResponseCustomToolCallOutputItem }
|
|
89
91
|
|
|
92
|
+
class AdditionalTools < OpenAI::Internal::Type::BaseModel
|
|
93
|
+
# @!attribute id
|
|
94
|
+
# The unique ID of the additional tools item.
|
|
95
|
+
#
|
|
96
|
+
# @return [String]
|
|
97
|
+
required :id, String
|
|
98
|
+
|
|
99
|
+
# @!attribute role
|
|
100
|
+
# The role that provided the additional tools.
|
|
101
|
+
#
|
|
102
|
+
# @return [Symbol, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools::Role]
|
|
103
|
+
required :role, enum: -> { OpenAI::Responses::ResponseOutputItem::AdditionalTools::Role }
|
|
104
|
+
|
|
105
|
+
# @!attribute tools
|
|
106
|
+
# The additional tool definitions made available at this item.
|
|
107
|
+
#
|
|
108
|
+
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>]
|
|
109
|
+
required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
|
|
110
|
+
|
|
111
|
+
# @!attribute type
|
|
112
|
+
# The type of the item. Always `additional_tools`.
|
|
113
|
+
#
|
|
114
|
+
# @return [Symbol, :additional_tools]
|
|
115
|
+
required :type, const: :additional_tools
|
|
116
|
+
|
|
117
|
+
# @!method initialize(id:, role:, tools:, type: :additional_tools)
|
|
118
|
+
# @param id [String] The unique ID of the additional tools item.
|
|
119
|
+
#
|
|
120
|
+
# @param role [Symbol, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools::Role] The role that provided the additional tools.
|
|
121
|
+
#
|
|
122
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] The additional tool definitions made available at this item.
|
|
123
|
+
#
|
|
124
|
+
# @param type [Symbol, :additional_tools] The type of the item. Always `additional_tools`.
|
|
125
|
+
|
|
126
|
+
# The role that provided the additional tools.
|
|
127
|
+
#
|
|
128
|
+
# @see OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools#role
|
|
129
|
+
module Role
|
|
130
|
+
extend OpenAI::Internal::Type::Enum
|
|
131
|
+
|
|
132
|
+
UNKNOWN = :unknown
|
|
133
|
+
USER = :user
|
|
134
|
+
ASSISTANT = :assistant
|
|
135
|
+
SYSTEM = :system
|
|
136
|
+
CRITIC = :critic
|
|
137
|
+
DISCRIMINATOR = :discriminator
|
|
138
|
+
DEVELOPER = :developer
|
|
139
|
+
TOOL = :tool
|
|
140
|
+
|
|
141
|
+
# @!method self.values
|
|
142
|
+
# @return [Array<Symbol>]
|
|
143
|
+
end
|
|
144
|
+
end
|
|
145
|
+
|
|
90
146
|
class ImageGenerationCall < OpenAI::Internal::Type::BaseModel
|
|
91
147
|
# @!attribute id
|
|
92
148
|
# The unique ID of the image generation call.
|
|
@@ -606,7 +662,7 @@ module OpenAI
|
|
|
606
662
|
end
|
|
607
663
|
|
|
608
664
|
# @!method self.variants
|
|
609
|
-
# @return [Array(OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem)]
|
|
665
|
+
# @return [Array(OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem)]
|
|
610
666
|
end
|
|
611
667
|
end
|
|
612
668
|
end
|
|
@@ -7,7 +7,7 @@ module OpenAI
|
|
|
7
7
|
# @!attribute item
|
|
8
8
|
# The output item that was added.
|
|
9
9
|
#
|
|
10
|
-
# @return [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem]
|
|
10
|
+
# @return [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem]
|
|
11
11
|
required :item, union: -> { OpenAI::Responses::ResponseOutputItem }
|
|
12
12
|
|
|
13
13
|
# @!attribute output_index
|
|
@@ -34,7 +34,7 @@ module OpenAI
|
|
|
34
34
|
#
|
|
35
35
|
# Emitted when a new output item is added.
|
|
36
36
|
#
|
|
37
|
-
# @param item [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem] The output item that was added.
|
|
37
|
+
# @param item [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem] The output item that was added.
|
|
38
38
|
#
|
|
39
39
|
# @param output_index [Integer] The index of the output item that was added.
|
|
40
40
|
#
|