openai 0.50.0 → 0.52.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 +38 -0
- data/README.md +1 -1
- data/lib/openai/client.rb +14 -0
- data/lib/openai/internal/conversation_cursor_page.rb +2 -2
- data/lib/openai/internal/type/enum.rb +6 -6
- data/lib/openai/internal/util.rb +31 -0
- data/lib/openai/models/batch_cancel_params.rb +7 -1
- data/lib/openai/models/batch_retrieve_params.rb +7 -1
- data/lib/openai/models/beta/assistant_create_params.rb +3 -2
- data/lib/openai/models/beta/assistant_delete_params.rb +7 -1
- data/lib/openai/models/beta/assistant_retrieve_params.rb +7 -1
- data/lib/openai/models/beta/assistant_update_params.rb +8 -1
- data/lib/openai/models/beta/chatkit/session_cancel_params.rb +7 -1
- data/lib/openai/models/beta/chatkit/thread_delete_params.rb +7 -1
- data/lib/openai/models/beta/chatkit/thread_list_items_params.rb +8 -1
- data/lib/openai/models/beta/chatkit/thread_retrieve_params.rb +7 -1
- data/lib/openai/models/beta/thread_create_and_run_params.rb +3 -2
- data/lib/openai/models/beta/thread_create_params.rb +3 -2
- data/lib/openai/models/beta/thread_delete_params.rb +7 -1
- data/lib/openai/models/beta/thread_retrieve_params.rb +7 -1
- data/lib/openai/models/beta/thread_update_params.rb +8 -1
- data/lib/openai/models/beta/threads/message_create_params.rb +8 -1
- data/lib/openai/models/beta/threads/message_delete_params.rb +7 -1
- data/lib/openai/models/beta/threads/message_list_params.rb +8 -1
- data/lib/openai/models/beta/threads/message_retrieve_params.rb +7 -1
- data/lib/openai/models/beta/threads/message_update_params.rb +8 -1
- data/lib/openai/models/beta/threads/run_cancel_params.rb +7 -1
- data/lib/openai/models/beta/threads/run_create_params.rb +8 -1
- data/lib/openai/models/beta/threads/run_list_params.rb +8 -1
- data/lib/openai/models/beta/threads/run_retrieve_params.rb +7 -1
- data/lib/openai/models/beta/threads/run_submit_tool_outputs_params.rb +8 -1
- data/lib/openai/models/beta/threads/run_update_params.rb +8 -1
- data/lib/openai/models/beta/threads/runs/step_list_params.rb +8 -1
- data/lib/openai/models/beta/threads/runs/step_retrieve_params.rb +8 -1
- data/lib/openai/models/chat/completion_delete_params.rb +7 -1
- data/lib/openai/models/chat/completion_retrieve_params.rb +7 -1
- data/lib/openai/models/chat/completion_update_params.rb +8 -1
- data/lib/openai/models/chat/completions/message_list_params.rb +8 -1
- data/lib/openai/models/chat_model.rb +2 -0
- data/lib/openai/models/container_delete_params.rb +7 -1
- data/lib/openai/models/container_retrieve_params.rb +7 -1
- data/lib/openai/models/containers/file_create_params.rb +8 -1
- data/lib/openai/models/containers/file_delete_params.rb +7 -1
- data/lib/openai/models/containers/file_list_params.rb +8 -1
- data/lib/openai/models/containers/file_retrieve_params.rb +7 -1
- data/lib/openai/models/containers/files/content_retrieve_params.rb +7 -1
- data/lib/openai/models/conversations/computer_screenshot_content.rb +26 -1
- data/lib/openai/models/conversations/conversation_create_params.rb +2 -2
- data/lib/openai/models/conversations/conversation_delete_params.rb +7 -1
- data/lib/openai/models/conversations/conversation_item.rb +5 -1
- data/lib/openai/models/conversations/conversation_item_list.rb +2 -2
- data/lib/openai/models/conversations/conversation_retrieve_params.rb +7 -1
- data/lib/openai/models/conversations/conversation_update_params.rb +8 -1
- data/lib/openai/models/conversations/item_create_params.rb +10 -3
- data/lib/openai/models/conversations/item_delete_params.rb +7 -1
- data/lib/openai/models/conversations/item_list_params.rb +8 -1
- data/lib/openai/models/conversations/item_retrieve_params.rb +8 -1
- data/lib/openai/models/eval_delete_params.rb +7 -1
- data/lib/openai/models/eval_retrieve_params.rb +7 -1
- data/lib/openai/models/eval_update_params.rb +8 -1
- data/lib/openai/models/evals/run_cancel_params.rb +7 -1
- data/lib/openai/models/evals/run_cancel_response.rb +2 -2
- data/lib/openai/models/evals/run_create_params.rb +10 -3
- data/lib/openai/models/evals/run_create_response.rb +2 -2
- data/lib/openai/models/evals/run_delete_params.rb +7 -1
- data/lib/openai/models/evals/run_list_params.rb +8 -1
- data/lib/openai/models/evals/run_list_response.rb +2 -2
- data/lib/openai/models/evals/run_retrieve_params.rb +7 -1
- data/lib/openai/models/evals/run_retrieve_response.rb +2 -2
- data/lib/openai/models/evals/runs/output_item_list_params.rb +8 -1
- data/lib/openai/models/evals/runs/output_item_retrieve_params.rb +7 -1
- data/lib/openai/models/file_content_params.rb +7 -1
- data/lib/openai/models/file_delete_params.rb +7 -1
- data/lib/openai/models/file_retrieve_params.rb +7 -1
- data/lib/openai/models/fine_tuning/checkpoints/permission_create_params.rb +8 -1
- data/lib/openai/models/fine_tuning/checkpoints/permission_delete_params.rb +7 -1
- data/lib/openai/models/fine_tuning/checkpoints/permission_list_params.rb +68 -0
- data/lib/openai/models/fine_tuning/checkpoints/permission_list_response.rb +48 -0
- data/lib/openai/models/fine_tuning/checkpoints/permission_retrieve_params.rb +8 -1
- data/lib/openai/models/fine_tuning/job_cancel_params.rb +7 -1
- data/lib/openai/models/fine_tuning/job_list_events_params.rb +8 -1
- data/lib/openai/models/fine_tuning/job_pause_params.rb +7 -1
- data/lib/openai/models/fine_tuning/job_resume_params.rb +7 -1
- data/lib/openai/models/fine_tuning/job_retrieve_params.rb +7 -1
- data/lib/openai/models/fine_tuning/jobs/checkpoint_list_params.rb +8 -1
- data/lib/openai/models/model_delete_params.rb +7 -1
- data/lib/openai/models/model_retrieve_params.rb +7 -1
- data/lib/openai/models/realtime/call_accept_params.rb +7 -1
- data/lib/openai/models/realtime/call_hangup_params.rb +7 -1
- data/lib/openai/models/realtime/call_refer_params.rb +8 -1
- data/lib/openai/models/realtime/call_reject_params.rb +8 -1
- data/lib/openai/models/realtime/realtime_response_create_mcp_tool.rb +9 -1
- data/lib/openai/models/realtime/realtime_session_create_response.rb +9 -1
- data/lib/openai/models/realtime/realtime_tools_config_union.rb +9 -1
- data/lib/openai/models/responses/compacted_response.rb +2 -2
- data/lib/openai/models/responses/computer_action.rb +356 -0
- data/lib/openai/models/responses/computer_action_list.rb +10 -0
- data/lib/openai/models/responses/computer_use_tool.rb +21 -0
- data/lib/openai/models/responses/custom_tool.rb +9 -1
- data/lib/openai/models/responses/easy_input_message.rb +28 -1
- data/lib/openai/models/responses/function_tool.rb +9 -1
- data/lib/openai/models/responses/input_item_list_params.rb +8 -1
- data/lib/openai/models/responses/input_token_count_params.rb +5 -5
- data/lib/openai/models/responses/namespace_tool.rb +93 -0
- data/lib/openai/models/responses/response.rb +7 -7
- data/lib/openai/models/responses/response_cancel_params.rb +7 -1
- data/lib/openai/models/responses/response_compact_params.rb +18 -4
- data/lib/openai/models/responses/response_computer_tool_call.rb +74 -65
- data/lib/openai/models/responses/response_create_params.rb +5 -5
- data/lib/openai/models/responses/response_custom_tool_call.rb +9 -1
- data/lib/openai/models/responses/response_delete_params.rb +7 -1
- data/lib/openai/models/responses/response_function_tool_call.rb +9 -1
- data/lib/openai/models/responses/response_input_file.rb +24 -1
- data/lib/openai/models/responses/response_input_file_content.rb +27 -1
- data/lib/openai/models/responses/response_input_image.rb +6 -5
- data/lib/openai/models/responses/response_input_image_content.rb +6 -5
- data/lib/openai/models/responses/response_input_item.rb +87 -1
- data/lib/openai/models/responses/response_item.rb +5 -1
- data/lib/openai/models/responses/response_item_list.rb +2 -2
- data/lib/openai/models/responses/response_output_item.rb +5 -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/response_output_message.rb +28 -1
- data/lib/openai/models/responses/response_retrieve_params.rb +8 -1
- data/lib/openai/models/responses/response_tool_search_call.rb +93 -0
- data/lib/openai/models/responses/response_tool_search_output_item.rb +93 -0
- data/lib/openai/models/responses/response_tool_search_output_item_param.rb +89 -0
- data/lib/openai/models/responses/responses_client_event.rb +5 -5
- data/lib/openai/models/responses/tool.rb +19 -2
- data/lib/openai/models/responses/tool_choice_types.rb +6 -0
- data/lib/openai/models/responses/tool_search_tool.rb +57 -0
- data/lib/openai/models/responses/web_search_preview_tool.rb +19 -1
- data/lib/openai/models/skill_delete_params.rb +7 -1
- data/lib/openai/models/skill_retrieve_params.rb +7 -1
- data/lib/openai/models/skill_update_params.rb +8 -1
- data/lib/openai/models/skills/content_retrieve_params.rb +7 -1
- data/lib/openai/models/skills/version_create_params.rb +8 -1
- data/lib/openai/models/skills/version_delete_params.rb +10 -1
- data/lib/openai/models/skills/version_list_params.rb +8 -1
- data/lib/openai/models/skills/version_retrieve_params.rb +10 -1
- data/lib/openai/models/skills/versions/content_retrieve_params.rb +10 -1
- data/lib/openai/models/upload_cancel_params.rb +7 -1
- data/lib/openai/models/upload_complete_params.rb +8 -1
- data/lib/openai/models/uploads/part_create_params.rb +8 -1
- data/lib/openai/models/vector_store_delete_params.rb +7 -1
- data/lib/openai/models/vector_store_retrieve_params.rb +7 -1
- data/lib/openai/models/vector_store_search_params.rb +8 -1
- data/lib/openai/models/vector_store_update_params.rb +8 -1
- data/lib/openai/models/vector_stores/file_batch_cancel_params.rb +7 -1
- data/lib/openai/models/vector_stores/file_batch_create_params.rb +8 -1
- data/lib/openai/models/vector_stores/file_batch_list_files_params.rb +8 -1
- data/lib/openai/models/vector_stores/file_batch_retrieve_params.rb +7 -1
- data/lib/openai/models/vector_stores/file_content_params.rb +7 -1
- data/lib/openai/models/vector_stores/file_create_params.rb +8 -1
- data/lib/openai/models/vector_stores/file_delete_params.rb +7 -1
- data/lib/openai/models/vector_stores/file_list_params.rb +8 -1
- data/lib/openai/models/vector_stores/file_retrieve_params.rb +7 -1
- data/lib/openai/models/vector_stores/file_update_params.rb +8 -1
- data/lib/openai/models/video.rb +24 -4
- data/lib/openai/models/video_create_params.rb +2 -2
- data/lib/openai/models/video_delete_params.rb +7 -1
- data/lib/openai/models/video_download_content_params.rb +8 -1
- data/lib/openai/models/video_remix_params.rb +8 -1
- data/lib/openai/models/video_retrieve_params.rb +7 -1
- data/lib/openai/resources/audio/speech.rb +1 -0
- data/lib/openai/resources/audio/transcriptions.rb +1 -0
- data/lib/openai/resources/audio/translations.rb +1 -0
- data/lib/openai/resources/audio.rb +3 -0
- data/lib/openai/resources/batches.rb +3 -1
- data/lib/openai/resources/beta/assistants.rb +3 -1
- data/lib/openai/resources/beta/chatkit/threads.rb +4 -2
- data/lib/openai/resources/beta/threads/messages.rb +4 -1
- data/lib/openai/resources/beta/threads/runs/steps.rb +6 -2
- data/lib/openai/resources/beta/threads/runs.rb +11 -5
- data/lib/openai/resources/beta/threads.rb +4 -0
- data/lib/openai/resources/beta.rb +2 -0
- data/lib/openai/resources/chat/completions/messages.rb +4 -1
- data/lib/openai/resources/chat/completions.rb +6 -1
- data/lib/openai/resources/chat.rb +2 -0
- data/lib/openai/resources/completions.rb +2 -0
- data/lib/openai/resources/containers/files.rb +2 -1
- data/lib/openai/resources/containers.rb +2 -1
- data/lib/openai/resources/conversations/items.rb +11 -7
- data/lib/openai/resources/conversations.rb +3 -1
- data/lib/openai/resources/embeddings.rb +2 -0
- data/lib/openai/resources/evals/runs/output_items.rb +3 -1
- data/lib/openai/resources/evals/runs.rb +4 -1
- data/lib/openai/resources/evals.rb +4 -1
- data/lib/openai/resources/files.rb +4 -1
- data/lib/openai/resources/fine_tuning/alpha/graders.rb +1 -0
- data/lib/openai/resources/fine_tuning/alpha.rb +1 -0
- data/lib/openai/resources/fine_tuning/checkpoints/permissions.rb +44 -1
- data/lib/openai/resources/fine_tuning/checkpoints.rb +1 -0
- data/lib/openai/resources/fine_tuning/jobs/checkpoints.rb +3 -1
- data/lib/openai/resources/fine_tuning/jobs.rb +6 -2
- data/lib/openai/resources/fine_tuning.rb +1 -0
- data/lib/openai/resources/images.rb +1 -0
- data/lib/openai/resources/models.rb +1 -0
- data/lib/openai/resources/moderations.rb +2 -0
- data/lib/openai/resources/responses/input_items.rb +3 -2
- data/lib/openai/resources/responses/input_tokens.rb +2 -2
- data/lib/openai/resources/responses.rb +12 -8
- data/lib/openai/resources/skills/versions.rb +2 -1
- data/lib/openai/resources/skills.rb +2 -1
- data/lib/openai/resources/uploads/parts.rb +1 -0
- data/lib/openai/resources/uploads.rb +2 -0
- data/lib/openai/resources/vector_stores/file_batches.rb +2 -1
- data/lib/openai/resources/vector_stores/files.rb +2 -1
- data/lib/openai/resources/vector_stores.rb +2 -1
- data/lib/openai/resources/videos.rb +5 -3
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +10 -0
- data/rbi/openai/client.rbi +14 -0
- data/rbi/openai/internal/util.rbi +20 -0
- data/rbi/openai/models/batch_cancel_params.rbi +13 -5
- data/rbi/openai/models/batch_retrieve_params.rbi +13 -5
- data/rbi/openai/models/beta/assistant_create_params.rbi +6 -4
- data/rbi/openai/models/beta/assistant_delete_params.rbi +13 -5
- data/rbi/openai/models/beta/assistant_retrieve_params.rbi +13 -5
- data/rbi/openai/models/beta/assistant_update_params.rbi +6 -0
- data/rbi/openai/models/beta/chatkit/session_cancel_params.rbi +13 -5
- data/rbi/openai/models/beta/chatkit/thread_delete_params.rbi +13 -5
- data/rbi/openai/models/beta/chatkit/thread_list_items_params.rbi +6 -0
- data/rbi/openai/models/beta/chatkit/thread_retrieve_params.rbi +13 -5
- data/rbi/openai/models/beta/thread_create_and_run_params.rbi +6 -4
- data/rbi/openai/models/beta/thread_create_params.rbi +6 -4
- data/rbi/openai/models/beta/thread_delete_params.rbi +13 -5
- data/rbi/openai/models/beta/thread_retrieve_params.rbi +13 -5
- data/rbi/openai/models/beta/thread_update_params.rbi +6 -0
- data/rbi/openai/models/beta/threads/message_create_params.rbi +6 -0
- data/rbi/openai/models/beta/threads/message_delete_params.rbi +10 -2
- data/rbi/openai/models/beta/threads/message_list_params.rbi +6 -0
- data/rbi/openai/models/beta/threads/message_retrieve_params.rbi +10 -2
- data/rbi/openai/models/beta/threads/message_update_params.rbi +6 -0
- data/rbi/openai/models/beta/threads/run_cancel_params.rbi +10 -2
- data/rbi/openai/models/beta/threads/run_create_params.rbi +6 -0
- data/rbi/openai/models/beta/threads/run_list_params.rbi +6 -0
- data/rbi/openai/models/beta/threads/run_retrieve_params.rbi +10 -2
- data/rbi/openai/models/beta/threads/run_submit_tool_outputs_params.rbi +6 -0
- data/rbi/openai/models/beta/threads/run_update_params.rbi +6 -0
- data/rbi/openai/models/beta/threads/runs/step_list_params.rbi +6 -0
- data/rbi/openai/models/beta/threads/runs/step_retrieve_params.rbi +6 -0
- data/rbi/openai/models/chat/completion_delete_params.rbi +13 -5
- data/rbi/openai/models/chat/completion_retrieve_params.rbi +13 -5
- data/rbi/openai/models/chat/completion_update_params.rbi +6 -0
- data/rbi/openai/models/chat/completions/message_list_params.rbi +6 -0
- data/rbi/openai/models/chat_model.rbi +3 -0
- data/rbi/openai/models/container_delete_params.rbi +13 -5
- data/rbi/openai/models/container_retrieve_params.rbi +13 -5
- data/rbi/openai/models/containers/file_create_params.rbi +6 -0
- data/rbi/openai/models/containers/file_delete_params.rbi +10 -2
- data/rbi/openai/models/containers/file_list_params.rbi +6 -0
- data/rbi/openai/models/containers/file_retrieve_params.rbi +10 -2
- data/rbi/openai/models/containers/files/content_retrieve_params.rbi +10 -2
- data/rbi/openai/models/conversations/computer_screenshot_content.rbi +62 -0
- data/rbi/openai/models/conversations/conversation_create_params.rbi +6 -0
- data/rbi/openai/models/conversations/conversation_delete_params.rbi +13 -5
- data/rbi/openai/models/conversations/conversation_item.rbi +2 -0
- data/rbi/openai/models/conversations/conversation_item_list.rbi +2 -0
- data/rbi/openai/models/conversations/conversation_retrieve_params.rbi +13 -5
- data/rbi/openai/models/conversations/conversation_update_params.rbi +6 -0
- data/rbi/openai/models/conversations/item_create_params.rbi +12 -0
- data/rbi/openai/models/conversations/item_delete_params.rbi +10 -2
- data/rbi/openai/models/conversations/item_list_params.rbi +6 -0
- data/rbi/openai/models/conversations/item_retrieve_params.rbi +6 -0
- data/rbi/openai/models/eval_delete_params.rbi +13 -5
- data/rbi/openai/models/eval_retrieve_params.rbi +13 -5
- data/rbi/openai/models/eval_update_params.rbi +6 -0
- data/rbi/openai/models/evals/run_cancel_params.rbi +10 -2
- data/rbi/openai/models/evals/run_cancel_response.rbi +6 -0
- data/rbi/openai/models/evals/run_create_params.rbi +18 -0
- data/rbi/openai/models/evals/run_create_response.rbi +6 -0
- data/rbi/openai/models/evals/run_delete_params.rbi +10 -2
- data/rbi/openai/models/evals/run_list_params.rbi +6 -0
- data/rbi/openai/models/evals/run_list_response.rbi +6 -0
- data/rbi/openai/models/evals/run_retrieve_params.rbi +10 -2
- data/rbi/openai/models/evals/run_retrieve_response.rbi +6 -0
- data/rbi/openai/models/evals/runs/output_item_list_params.rbi +6 -0
- data/rbi/openai/models/evals/runs/output_item_retrieve_params.rbi +6 -1
- data/rbi/openai/models/file_content_params.rbi +13 -5
- data/rbi/openai/models/file_delete_params.rbi +13 -5
- data/rbi/openai/models/file_retrieve_params.rbi +13 -5
- data/rbi/openai/models/fine_tuning/checkpoints/permission_create_params.rbi +6 -0
- data/rbi/openai/models/fine_tuning/checkpoints/permission_delete_params.rbi +10 -1
- data/rbi/openai/models/fine_tuning/checkpoints/permission_list_params.rbi +140 -0
- data/rbi/openai/models/fine_tuning/checkpoints/permission_list_response.rbi +70 -0
- data/rbi/openai/models/fine_tuning/checkpoints/permission_retrieve_params.rbi +6 -0
- data/rbi/openai/models/fine_tuning/job_cancel_params.rbi +16 -5
- data/rbi/openai/models/fine_tuning/job_list_events_params.rbi +6 -0
- data/rbi/openai/models/fine_tuning/job_pause_params.rbi +16 -5
- data/rbi/openai/models/fine_tuning/job_resume_params.rbi +16 -5
- data/rbi/openai/models/fine_tuning/job_retrieve_params.rbi +16 -5
- data/rbi/openai/models/fine_tuning/jobs/checkpoint_list_params.rbi +6 -0
- data/rbi/openai/models/model_delete_params.rbi +13 -5
- data/rbi/openai/models/model_retrieve_params.rbi +13 -5
- data/rbi/openai/models/realtime/call_accept_params.rbi +13 -5
- data/rbi/openai/models/realtime/call_hangup_params.rbi +13 -5
- data/rbi/openai/models/realtime/call_refer_params.rbi +10 -1
- data/rbi/openai/models/realtime/call_reject_params.rbi +10 -1
- data/rbi/openai/models/realtime/realtime_response_create_mcp_tool.rbi +11 -0
- data/rbi/openai/models/realtime/realtime_session_create_response.rbi +11 -0
- data/rbi/openai/models/realtime/realtime_tools_config_union.rbi +11 -0
- data/rbi/openai/models/responses/compacted_response.rbi +2 -0
- data/rbi/openai/models/responses/computer_action.rbi +534 -0
- data/rbi/openai/models/responses/computer_action_list.rbi +15 -0
- data/rbi/openai/models/responses/computer_use_tool.rbi +31 -0
- data/rbi/openai/models/responses/custom_tool.rbi +11 -0
- data/rbi/openai/models/responses/easy_input_message.rbi +53 -0
- data/rbi/openai/models/responses/function_tool.rbi +11 -0
- data/rbi/openai/models/responses/input_item_list_params.rbi +6 -0
- data/rbi/openai/models/responses/input_token_count_params.rbi +9 -0
- data/rbi/openai/models/responses/namespace_tool.rbi +163 -0
- data/rbi/openai/models/responses/response.rbi +5 -0
- data/rbi/openai/models/responses/response_cancel_params.rbi +13 -5
- data/rbi/openai/models/responses/response_compact_params.rbi +18 -0
- data/rbi/openai/models/responses/response_computer_tool_call.rbi +245 -151
- data/rbi/openai/models/responses/response_create_params.rbi +12 -0
- data/rbi/openai/models/responses/response_custom_tool_call.rbi +12 -1
- data/rbi/openai/models/responses/response_delete_params.rbi +13 -5
- data/rbi/openai/models/responses/response_function_tool_call.rbi +11 -0
- data/rbi/openai/models/responses/response_input_file.rbi +54 -0
- data/rbi/openai/models/responses/response_input_file_content.rbi +59 -0
- data/rbi/openai/models/responses/response_input_image.rbi +11 -6
- data/rbi/openai/models/responses/response_input_image_content.rbi +11 -6
- data/rbi/openai/models/responses/response_input_item.rbi +180 -0
- data/rbi/openai/models/responses/response_item.rbi +2 -0
- data/rbi/openai/models/responses/response_item_list.rbi +2 -0
- data/rbi/openai/models/responses/response_output_item.rbi +2 -0
- data/rbi/openai/models/responses/response_output_item_added_event.rbi +2 -0
- data/rbi/openai/models/responses/response_output_item_done_event.rbi +2 -0
- data/rbi/openai/models/responses/response_output_message.rbi +60 -1
- data/rbi/openai/models/responses/response_retrieve_params.rbi +6 -0
- data/rbi/openai/models/responses/response_tool_search_call.rbi +176 -0
- data/rbi/openai/models/responses/response_tool_search_output_item.rbi +199 -0
- data/rbi/openai/models/responses/response_tool_search_output_item_param.rbi +245 -0
- data/rbi/openai/models/responses/responses_client_event.rbi +12 -0
- data/rbi/openai/models/responses/tool.rbi +14 -0
- data/rbi/openai/models/responses/tool_choice_types.rbi +16 -0
- data/rbi/openai/models/responses/tool_search_tool.rbi +107 -0
- data/rbi/openai/models/responses/web_search_preview_tool.rbi +64 -0
- data/rbi/openai/models/skill_delete_params.rbi +13 -5
- data/rbi/openai/models/skill_retrieve_params.rbi +13 -5
- data/rbi/openai/models/skill_update_params.rbi +10 -1
- data/rbi/openai/models/skills/content_retrieve_params.rbi +13 -5
- data/rbi/openai/models/skills/version_create_params.rbi +6 -0
- data/rbi/openai/models/skills/version_delete_params.rbi +16 -2
- data/rbi/openai/models/skills/version_list_params.rbi +6 -0
- data/rbi/openai/models/skills/version_retrieve_params.rbi +16 -2
- data/rbi/openai/models/skills/versions/content_retrieve_params.rbi +16 -2
- data/rbi/openai/models/upload_cancel_params.rbi +13 -5
- data/rbi/openai/models/upload_complete_params.rbi +6 -0
- data/rbi/openai/models/uploads/part_create_params.rbi +6 -0
- data/rbi/openai/models/vector_store_delete_params.rbi +13 -5
- data/rbi/openai/models/vector_store_retrieve_params.rbi +13 -5
- data/rbi/openai/models/vector_store_search_params.rbi +6 -0
- data/rbi/openai/models/vector_store_update_params.rbi +6 -0
- data/rbi/openai/models/vector_stores/file_batch_cancel_params.rbi +10 -2
- data/rbi/openai/models/vector_stores/file_batch_create_params.rbi +6 -0
- data/rbi/openai/models/vector_stores/file_batch_list_files_params.rbi +6 -0
- data/rbi/openai/models/vector_stores/file_batch_retrieve_params.rbi +10 -2
- data/rbi/openai/models/vector_stores/file_content_params.rbi +10 -2
- data/rbi/openai/models/vector_stores/file_create_params.rbi +6 -0
- data/rbi/openai/models/vector_stores/file_delete_params.rbi +10 -2
- data/rbi/openai/models/vector_stores/file_list_params.rbi +6 -0
- data/rbi/openai/models/vector_stores/file_retrieve_params.rbi +10 -2
- data/rbi/openai/models/vector_stores/file_update_params.rbi +6 -0
- data/rbi/openai/models/video.rbi +20 -5
- data/rbi/openai/models/video_create_params.rbi +2 -2
- data/rbi/openai/models/video_delete_params.rbi +13 -5
- data/rbi/openai/models/video_download_content_params.rbi +6 -0
- data/rbi/openai/models/video_remix_params.rbi +10 -1
- data/rbi/openai/models/video_retrieve_params.rbi +13 -5
- data/rbi/openai/resources/audio/speech.rbi +1 -0
- data/rbi/openai/resources/audio/transcriptions.rbi +1 -0
- data/rbi/openai/resources/audio/translations.rbi +1 -0
- data/rbi/openai/resources/audio.rbi +3 -0
- data/rbi/openai/resources/batches.rbi +1 -0
- data/rbi/openai/resources/beta/assistants.rbi +1 -0
- data/rbi/openai/resources/beta/threads/messages.rbi +1 -0
- data/rbi/openai/resources/beta/threads/runs/steps.rbi +1 -0
- data/rbi/openai/resources/beta/threads/runs.rbi +2 -0
- data/rbi/openai/resources/beta/threads.rbi +3 -0
- data/rbi/openai/resources/beta.rbi +2 -0
- data/rbi/openai/resources/chat/completions/messages.rbi +2 -0
- data/rbi/openai/resources/chat/completions.rbi +4 -0
- data/rbi/openai/resources/chat.rbi +2 -0
- data/rbi/openai/resources/completions.rbi +2 -0
- data/rbi/openai/resources/conversations/items.rbi +3 -0
- data/rbi/openai/resources/conversations.rbi +4 -0
- data/rbi/openai/resources/embeddings.rbi +2 -0
- data/rbi/openai/resources/evals/runs/output_items.rbi +1 -0
- data/rbi/openai/resources/evals/runs.rbi +2 -0
- data/rbi/openai/resources/evals.rbi +2 -0
- data/rbi/openai/resources/files.rbi +2 -0
- data/rbi/openai/resources/fine_tuning/alpha/graders.rbi +1 -0
- data/rbi/openai/resources/fine_tuning/alpha.rbi +1 -0
- data/rbi/openai/resources/fine_tuning/checkpoints/permissions.rbi +35 -0
- data/rbi/openai/resources/fine_tuning/checkpoints.rbi +1 -0
- data/rbi/openai/resources/fine_tuning/jobs/checkpoints.rbi +1 -0
- data/rbi/openai/resources/fine_tuning/jobs.rbi +2 -0
- data/rbi/openai/resources/fine_tuning.rbi +1 -0
- data/rbi/openai/resources/images.rbi +1 -0
- data/rbi/openai/resources/models.rbi +1 -0
- data/rbi/openai/resources/moderations.rbi +2 -0
- data/rbi/openai/resources/responses/input_tokens.rbi +3 -0
- data/rbi/openai/resources/responses.rbi +9 -0
- data/rbi/openai/resources/uploads/parts.rbi +1 -0
- data/rbi/openai/resources/uploads.rbi +2 -0
- data/rbi/openai/resources/videos.rbi +1 -1
- data/sig/openai/internal/util.rbs +10 -0
- data/sig/openai/models/batch_cancel_params.rbs +12 -3
- data/sig/openai/models/batch_retrieve_params.rbs +11 -3
- data/sig/openai/models/beta/assistant_delete_params.rbs +11 -3
- data/sig/openai/models/beta/assistant_retrieve_params.rbs +11 -3
- data/sig/openai/models/beta/assistant_update_params.rbs +5 -0
- data/sig/openai/models/beta/chatkit/session_cancel_params.rbs +11 -3
- data/sig/openai/models/beta/chatkit/thread_delete_params.rbs +11 -3
- data/sig/openai/models/beta/chatkit/thread_list_items_params.rbs +5 -0
- data/sig/openai/models/beta/chatkit/thread_retrieve_params.rbs +11 -3
- data/sig/openai/models/beta/thread_delete_params.rbs +11 -3
- data/sig/openai/models/beta/thread_retrieve_params.rbs +11 -3
- data/sig/openai/models/beta/thread_update_params.rbs +5 -0
- data/sig/openai/models/beta/threads/message_create_params.rbs +5 -0
- data/sig/openai/models/beta/threads/message_delete_params.rbs +6 -1
- data/sig/openai/models/beta/threads/message_list_params.rbs +5 -0
- data/sig/openai/models/beta/threads/message_retrieve_params.rbs +6 -1
- data/sig/openai/models/beta/threads/message_update_params.rbs +9 -1
- data/sig/openai/models/beta/threads/run_cancel_params.rbs +6 -1
- data/sig/openai/models/beta/threads/run_create_params.rbs +5 -0
- data/sig/openai/models/beta/threads/run_list_params.rbs +5 -0
- data/sig/openai/models/beta/threads/run_retrieve_params.rbs +6 -1
- data/sig/openai/models/beta/threads/run_submit_tool_outputs_params.rbs +5 -0
- data/sig/openai/models/beta/threads/run_update_params.rbs +9 -1
- data/sig/openai/models/beta/threads/runs/step_list_params.rbs +5 -0
- data/sig/openai/models/beta/threads/runs/step_retrieve_params.rbs +5 -0
- data/sig/openai/models/chat/completion_delete_params.rbs +11 -3
- data/sig/openai/models/chat/completion_retrieve_params.rbs +11 -3
- data/sig/openai/models/chat/completion_update_params.rbs +5 -1
- data/sig/openai/models/chat/completions/message_list_params.rbs +5 -0
- data/sig/openai/models/chat_model.rbs +5 -1
- data/sig/openai/models/container_delete_params.rbs +11 -3
- data/sig/openai/models/container_retrieve_params.rbs +11 -3
- data/sig/openai/models/containers/file_create_params.rbs +9 -1
- data/sig/openai/models/containers/file_delete_params.rbs +6 -1
- data/sig/openai/models/containers/file_list_params.rbs +5 -0
- data/sig/openai/models/containers/file_retrieve_params.rbs +6 -1
- data/sig/openai/models/containers/files/content_retrieve_params.rbs +6 -1
- data/sig/openai/models/conversations/computer_screenshot_content.rbs +23 -1
- data/sig/openai/models/conversations/conversation_delete_params.rbs +11 -3
- data/sig/openai/models/conversations/conversation_item.rbs +2 -0
- data/sig/openai/models/conversations/conversation_retrieve_params.rbs +11 -3
- data/sig/openai/models/conversations/conversation_update_params.rbs +5 -1
- data/sig/openai/models/conversations/item_create_params.rbs +5 -0
- data/sig/openai/models/conversations/item_delete_params.rbs +6 -1
- data/sig/openai/models/conversations/item_list_params.rbs +5 -0
- data/sig/openai/models/conversations/item_retrieve_params.rbs +5 -0
- data/sig/openai/models/eval_delete_params.rbs +12 -3
- data/sig/openai/models/eval_retrieve_params.rbs +11 -3
- data/sig/openai/models/eval_update_params.rbs +5 -1
- data/sig/openai/models/evals/run_cancel_params.rbs +6 -1
- data/sig/openai/models/evals/run_create_params.rbs +5 -0
- data/sig/openai/models/evals/run_delete_params.rbs +6 -1
- data/sig/openai/models/evals/run_list_params.rbs +5 -0
- data/sig/openai/models/evals/run_retrieve_params.rbs +6 -1
- data/sig/openai/models/evals/runs/output_item_list_params.rbs +5 -0
- data/sig/openai/models/evals/runs/output_item_retrieve_params.rbs +5 -1
- data/sig/openai/models/file_content_params.rbs +12 -3
- data/sig/openai/models/file_delete_params.rbs +12 -3
- data/sig/openai/models/file_retrieve_params.rbs +11 -3
- data/sig/openai/models/fine_tuning/checkpoints/permission_create_params.rbs +5 -1
- data/sig/openai/models/fine_tuning/checkpoints/permission_delete_params.rbs +5 -1
- data/sig/openai/models/fine_tuning/checkpoints/permission_list_params.rbs +71 -0
- data/sig/openai/models/fine_tuning/checkpoints/permission_list_response.rbs +39 -0
- data/sig/openai/models/fine_tuning/checkpoints/permission_retrieve_params.rbs +5 -0
- data/sig/openai/models/fine_tuning/job_cancel_params.rbs +13 -3
- data/sig/openai/models/fine_tuning/job_list_events_params.rbs +5 -1
- data/sig/openai/models/fine_tuning/job_pause_params.rbs +13 -3
- data/sig/openai/models/fine_tuning/job_resume_params.rbs +13 -3
- data/sig/openai/models/fine_tuning/job_retrieve_params.rbs +12 -3
- data/sig/openai/models/fine_tuning/jobs/checkpoint_list_params.rbs +5 -1
- data/sig/openai/models/model_delete_params.rbs +9 -3
- data/sig/openai/models/model_retrieve_params.rbs +8 -3
- data/sig/openai/models/realtime/call_accept_params.rbs +13 -3
- data/sig/openai/models/realtime/call_hangup_params.rbs +11 -3
- data/sig/openai/models/realtime/call_refer_params.rbs +6 -1
- data/sig/openai/models/realtime/call_reject_params.rbs +6 -1
- data/sig/openai/models/realtime/realtime_response_create_mcp_tool.rbs +7 -0
- data/sig/openai/models/realtime/realtime_session_create_response.rbs +7 -0
- data/sig/openai/models/realtime/realtime_tools_config_union.rbs +7 -0
- data/sig/openai/models/responses/computer_action.rbs +215 -0
- data/sig/openai/models/responses/computer_action_list.rbs +10 -0
- data/sig/openai/models/responses/computer_use_tool.rbs +15 -0
- data/sig/openai/models/responses/custom_tool.rbs +7 -0
- data/sig/openai/models/responses/easy_input_message.rbs +16 -0
- data/sig/openai/models/responses/function_tool.rbs +7 -0
- data/sig/openai/models/responses/input_item_list_params.rbs +5 -0
- data/sig/openai/models/responses/namespace_tool.rbs +84 -0
- data/sig/openai/models/responses/response_cancel_params.rbs +11 -3
- data/sig/openai/models/responses/response_compact_params.rbs +11 -2
- data/sig/openai/models/responses/response_computer_tool_call.rbs +62 -49
- data/sig/openai/models/responses/response_custom_tool_call.rbs +9 -2
- data/sig/openai/models/responses/response_delete_params.rbs +11 -3
- data/sig/openai/models/responses/response_function_tool_call.rbs +7 -0
- data/sig/openai/models/responses/response_input_file.rbs +20 -0
- data/sig/openai/models/responses/response_input_file_content.rbs +20 -0
- data/sig/openai/models/responses/response_input_image.rbs +2 -1
- data/sig/openai/models/responses/response_input_image_content.rbs +2 -1
- data/sig/openai/models/responses/response_input_item.rbs +71 -0
- data/sig/openai/models/responses/response_item.rbs +2 -0
- data/sig/openai/models/responses/response_output_item.rbs +2 -0
- data/sig/openai/models/responses/response_output_message.rbs +18 -2
- data/sig/openai/models/responses/response_retrieve_params.rbs +5 -0
- data/sig/openai/models/responses/response_tool_search_call.rbs +77 -0
- data/sig/openai/models/responses/response_tool_search_output_item.rbs +77 -0
- data/sig/openai/models/responses/response_tool_search_output_item_param.rbs +74 -0
- data/sig/openai/models/responses/tool.rbs +10 -0
- data/sig/openai/models/responses/tool_choice_types.rbs +4 -0
- data/sig/openai/models/responses/tool_search_tool.rbs +52 -0
- data/sig/openai/models/responses/web_search_preview_tool.rbs +20 -0
- data/sig/openai/models/skill_delete_params.rbs +12 -3
- data/sig/openai/models/skill_retrieve_params.rbs +11 -3
- data/sig/openai/models/skill_update_params.rbs +6 -1
- data/sig/openai/models/skills/content_retrieve_params.rbs +11 -3
- data/sig/openai/models/skills/version_create_params.rbs +5 -0
- data/sig/openai/models/skills/version_delete_params.rbs +6 -1
- data/sig/openai/models/skills/version_list_params.rbs +5 -0
- data/sig/openai/models/skills/version_retrieve_params.rbs +6 -1
- data/sig/openai/models/skills/versions/content_retrieve_params.rbs +6 -1
- data/sig/openai/models/upload_cancel_params.rbs +11 -3
- data/sig/openai/models/upload_complete_params.rbs +5 -1
- data/sig/openai/models/uploads/part_create_params.rbs +5 -1
- data/sig/openai/models/vector_store_delete_params.rbs +11 -3
- data/sig/openai/models/vector_store_retrieve_params.rbs +11 -3
- data/sig/openai/models/vector_store_search_params.rbs +5 -0
- data/sig/openai/models/vector_store_update_params.rbs +5 -0
- data/sig/openai/models/vector_stores/file_batch_cancel_params.rbs +6 -1
- data/sig/openai/models/vector_stores/file_batch_create_params.rbs +5 -0
- data/sig/openai/models/vector_stores/file_batch_list_files_params.rbs +5 -0
- data/sig/openai/models/vector_stores/file_batch_retrieve_params.rbs +6 -1
- data/sig/openai/models/vector_stores/file_content_params.rbs +6 -1
- data/sig/openai/models/vector_stores/file_create_params.rbs +5 -0
- data/sig/openai/models/vector_stores/file_delete_params.rbs +6 -1
- data/sig/openai/models/vector_stores/file_list_params.rbs +5 -0
- data/sig/openai/models/vector_stores/file_retrieve_params.rbs +6 -1
- data/sig/openai/models/vector_stores/file_update_params.rbs +5 -0
- data/sig/openai/models/video.rbs +12 -4
- data/sig/openai/models/video_delete_params.rbs +12 -3
- data/sig/openai/models/video_download_content_params.rbs +8 -1
- data/sig/openai/models/video_remix_params.rbs +6 -1
- data/sig/openai/models/video_retrieve_params.rbs +11 -3
- data/sig/openai/resources/fine_tuning/checkpoints/permissions.rbs +9 -0
- data/sig/openai/resources/responses.rbs +1 -0
- metadata +32 -2
|
@@ -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::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>]
|
|
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::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>]
|
|
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::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>] 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::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>] 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
|
#
|
|
@@ -34,6 +34,10 @@ module OpenAI
|
|
|
34
34
|
# [managing context](https://platform.openai.com/docs/guides/conversation-state).
|
|
35
35
|
variant :reasoning, -> { OpenAI::Responses::ResponseReasoningItem }
|
|
36
36
|
|
|
37
|
+
variant :tool_search_call, -> { OpenAI::Responses::ResponseToolSearchCall }
|
|
38
|
+
|
|
39
|
+
variant :tool_search_output, -> { OpenAI::Responses::ResponseToolSearchOutputItem }
|
|
40
|
+
|
|
37
41
|
# A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact).
|
|
38
42
|
variant :compaction, -> { OpenAI::Responses::ResponseCompactionItem }
|
|
39
43
|
|
|
@@ -483,7 +487,7 @@ module OpenAI
|
|
|
483
487
|
end
|
|
484
488
|
|
|
485
489
|
# @!method self.variants
|
|
486
|
-
# @return [Array(OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, 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::ResponseCustomToolCall)]
|
|
490
|
+
# @return [Array(OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, 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::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::ResponseCustomToolCall)]
|
|
487
491
|
end
|
|
488
492
|
end
|
|
489
493
|
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::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, 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::ResponseCustomToolCall]
|
|
10
|
+
# @return [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, 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::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::ResponseCustomToolCall]
|
|
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::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, 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::ResponseCustomToolCall] The output item that was added.
|
|
37
|
+
# @param item [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, 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::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::ResponseCustomToolCall] 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
|
#
|
|
@@ -7,7 +7,7 @@ module OpenAI
|
|
|
7
7
|
# @!attribute item
|
|
8
8
|
# The output item that was marked done.
|
|
9
9
|
#
|
|
10
|
-
# @return [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, 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::ResponseCustomToolCall]
|
|
10
|
+
# @return [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, 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::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::ResponseCustomToolCall]
|
|
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 an output item is marked done.
|
|
36
36
|
#
|
|
37
|
-
# @param item [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, 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::ResponseCustomToolCall] The output item that was marked done.
|
|
37
|
+
# @param item [OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, 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::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::ResponseCustomToolCall] The output item that was marked done.
|
|
38
38
|
#
|
|
39
39
|
# @param output_index [Integer] The index of the output item that was marked done.
|
|
40
40
|
#
|
|
@@ -36,7 +36,16 @@ module OpenAI
|
|
|
36
36
|
# @return [Symbol, :message]
|
|
37
37
|
required :type, const: :message
|
|
38
38
|
|
|
39
|
-
# @!
|
|
39
|
+
# @!attribute phase
|
|
40
|
+
# Labels an `assistant` message as intermediate commentary (`commentary`) or the
|
|
41
|
+
# final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when
|
|
42
|
+
# sending follow-up requests, preserve and resend phase on all assistant messages
|
|
43
|
+
# — dropping it can degrade performance. Not used for user messages.
|
|
44
|
+
#
|
|
45
|
+
# @return [Symbol, OpenAI::Models::Responses::ResponseOutputMessage::Phase, nil]
|
|
46
|
+
optional :phase, enum: -> { OpenAI::Responses::ResponseOutputMessage::Phase }, nil?: true
|
|
47
|
+
|
|
48
|
+
# @!method initialize(id:, content:, status:, phase: nil, role: :assistant, type: :message)
|
|
40
49
|
# Some parameter documentations has been truncated, see
|
|
41
50
|
# {OpenAI::Models::Responses::ResponseOutputMessage} for more details.
|
|
42
51
|
#
|
|
@@ -48,6 +57,8 @@ module OpenAI
|
|
|
48
57
|
#
|
|
49
58
|
# @param status [Symbol, OpenAI::Models::Responses::ResponseOutputMessage::Status] The status of the message input. One of `in_progress`, `completed`, or
|
|
50
59
|
#
|
|
60
|
+
# @param phase [Symbol, OpenAI::Models::Responses::ResponseOutputMessage::Phase, nil] Labels an `assistant` message as intermediate commentary (`commentary`) or the f
|
|
61
|
+
#
|
|
51
62
|
# @param role [Symbol, :assistant] The role of the output message. Always `assistant`.
|
|
52
63
|
#
|
|
53
64
|
# @param type [Symbol, :message] The type of the output message. Always `message`.
|
|
@@ -82,6 +93,22 @@ module OpenAI
|
|
|
82
93
|
# @!method self.values
|
|
83
94
|
# @return [Array<Symbol>]
|
|
84
95
|
end
|
|
96
|
+
|
|
97
|
+
# Labels an `assistant` message as intermediate commentary (`commentary`) or the
|
|
98
|
+
# final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when
|
|
99
|
+
# sending follow-up requests, preserve and resend phase on all assistant messages
|
|
100
|
+
# — dropping it can degrade performance. Not used for user messages.
|
|
101
|
+
#
|
|
102
|
+
# @see OpenAI::Models::Responses::ResponseOutputMessage#phase
|
|
103
|
+
module Phase
|
|
104
|
+
extend OpenAI::Internal::Type::Enum
|
|
105
|
+
|
|
106
|
+
COMMENTARY = :commentary
|
|
107
|
+
FINAL_ANSWER = :final_answer
|
|
108
|
+
|
|
109
|
+
# @!method self.values
|
|
110
|
+
# @return [Array<Symbol>]
|
|
111
|
+
end
|
|
85
112
|
end
|
|
86
113
|
end
|
|
87
114
|
end
|
|
@@ -10,6 +10,11 @@ module OpenAI
|
|
|
10
10
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
11
11
|
include OpenAI::Internal::Type::RequestParameters
|
|
12
12
|
|
|
13
|
+
# @!attribute response_id
|
|
14
|
+
#
|
|
15
|
+
# @return [String]
|
|
16
|
+
required :response_id, String
|
|
17
|
+
|
|
13
18
|
# @!attribute include
|
|
14
19
|
# Additional fields to include in the response. See the `include` parameter for
|
|
15
20
|
# Response creation above for more information.
|
|
@@ -34,10 +39,12 @@ module OpenAI
|
|
|
34
39
|
# @return [Integer, nil]
|
|
35
40
|
optional :starting_after, Integer
|
|
36
41
|
|
|
37
|
-
# @!method initialize(include: nil, include_obfuscation: nil, starting_after: nil, request_options: {})
|
|
42
|
+
# @!method initialize(response_id:, include: nil, include_obfuscation: nil, starting_after: nil, request_options: {})
|
|
38
43
|
# Some parameter documentations has been truncated, see
|
|
39
44
|
# {OpenAI::Models::Responses::ResponseRetrieveParams} for more details.
|
|
40
45
|
#
|
|
46
|
+
# @param response_id [String]
|
|
47
|
+
#
|
|
41
48
|
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Additional fields to include in the response. See the `include`
|
|
42
49
|
#
|
|
43
50
|
# @param include_obfuscation [Boolean] When true, stream obfuscation will be enabled. Stream obfuscation adds
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Responses
|
|
6
|
+
class ResponseToolSearchCall < OpenAI::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The unique ID of the tool search call item.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute arguments
|
|
14
|
+
# Arguments used for the tool search call.
|
|
15
|
+
#
|
|
16
|
+
# @return [Object]
|
|
17
|
+
required :arguments, OpenAI::Internal::Type::Unknown
|
|
18
|
+
|
|
19
|
+
# @!attribute call_id
|
|
20
|
+
# The unique ID of the tool search call generated by the model.
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
required :call_id, String, nil?: true
|
|
24
|
+
|
|
25
|
+
# @!attribute execution
|
|
26
|
+
# Whether tool search was executed by the server or by the client.
|
|
27
|
+
#
|
|
28
|
+
# @return [Symbol, OpenAI::Models::Responses::ResponseToolSearchCall::Execution]
|
|
29
|
+
required :execution, enum: -> { OpenAI::Responses::ResponseToolSearchCall::Execution }
|
|
30
|
+
|
|
31
|
+
# @!attribute status
|
|
32
|
+
# The status of the tool search call item that was recorded.
|
|
33
|
+
#
|
|
34
|
+
# @return [Symbol, OpenAI::Models::Responses::ResponseToolSearchCall::Status]
|
|
35
|
+
required :status, enum: -> { OpenAI::Responses::ResponseToolSearchCall::Status }
|
|
36
|
+
|
|
37
|
+
# @!attribute type
|
|
38
|
+
# The type of the item. Always `tool_search_call`.
|
|
39
|
+
#
|
|
40
|
+
# @return [Symbol, :tool_search_call]
|
|
41
|
+
required :type, const: :tool_search_call
|
|
42
|
+
|
|
43
|
+
# @!attribute created_by
|
|
44
|
+
# The identifier of the actor that created the item.
|
|
45
|
+
#
|
|
46
|
+
# @return [String, nil]
|
|
47
|
+
optional :created_by, String
|
|
48
|
+
|
|
49
|
+
# @!method initialize(id:, arguments:, call_id:, execution:, status:, created_by: nil, type: :tool_search_call)
|
|
50
|
+
# @param id [String] The unique ID of the tool search call item.
|
|
51
|
+
#
|
|
52
|
+
# @param arguments [Object] Arguments used for the tool search call.
|
|
53
|
+
#
|
|
54
|
+
# @param call_id [String, nil] The unique ID of the tool search call generated by the model.
|
|
55
|
+
#
|
|
56
|
+
# @param execution [Symbol, OpenAI::Models::Responses::ResponseToolSearchCall::Execution] Whether tool search was executed by the server or by the client.
|
|
57
|
+
#
|
|
58
|
+
# @param status [Symbol, OpenAI::Models::Responses::ResponseToolSearchCall::Status] The status of the tool search call item that was recorded.
|
|
59
|
+
#
|
|
60
|
+
# @param created_by [String] The identifier of the actor that created the item.
|
|
61
|
+
#
|
|
62
|
+
# @param type [Symbol, :tool_search_call] The type of the item. Always `tool_search_call`.
|
|
63
|
+
|
|
64
|
+
# Whether tool search was executed by the server or by the client.
|
|
65
|
+
#
|
|
66
|
+
# @see OpenAI::Models::Responses::ResponseToolSearchCall#execution
|
|
67
|
+
module Execution
|
|
68
|
+
extend OpenAI::Internal::Type::Enum
|
|
69
|
+
|
|
70
|
+
SERVER = :server
|
|
71
|
+
CLIENT = :client
|
|
72
|
+
|
|
73
|
+
# @!method self.values
|
|
74
|
+
# @return [Array<Symbol>]
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
# The status of the tool search call item that was recorded.
|
|
78
|
+
#
|
|
79
|
+
# @see OpenAI::Models::Responses::ResponseToolSearchCall#status
|
|
80
|
+
module Status
|
|
81
|
+
extend OpenAI::Internal::Type::Enum
|
|
82
|
+
|
|
83
|
+
IN_PROGRESS = :in_progress
|
|
84
|
+
COMPLETED = :completed
|
|
85
|
+
INCOMPLETE = :incomplete
|
|
86
|
+
|
|
87
|
+
# @!method self.values
|
|
88
|
+
# @return [Array<Symbol>]
|
|
89
|
+
end
|
|
90
|
+
end
|
|
91
|
+
end
|
|
92
|
+
end
|
|
93
|
+
end
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Responses
|
|
6
|
+
class ResponseToolSearchOutputItem < OpenAI::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The unique ID of the tool search output item.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute call_id
|
|
14
|
+
# The unique ID of the tool search call generated by the model.
|
|
15
|
+
#
|
|
16
|
+
# @return [String, nil]
|
|
17
|
+
required :call_id, String, nil?: true
|
|
18
|
+
|
|
19
|
+
# @!attribute execution
|
|
20
|
+
# Whether tool search was executed by the server or by the client.
|
|
21
|
+
#
|
|
22
|
+
# @return [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItem::Execution]
|
|
23
|
+
required :execution, enum: -> { OpenAI::Responses::ResponseToolSearchOutputItem::Execution }
|
|
24
|
+
|
|
25
|
+
# @!attribute status
|
|
26
|
+
# The status of the tool search output item that was recorded.
|
|
27
|
+
#
|
|
28
|
+
# @return [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItem::Status]
|
|
29
|
+
required :status, enum: -> { OpenAI::Responses::ResponseToolSearchOutputItem::Status }
|
|
30
|
+
|
|
31
|
+
# @!attribute tools
|
|
32
|
+
# The loaded tool definitions returned by tool search.
|
|
33
|
+
#
|
|
34
|
+
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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>]
|
|
35
|
+
required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
|
|
36
|
+
|
|
37
|
+
# @!attribute type
|
|
38
|
+
# The type of the item. Always `tool_search_output`.
|
|
39
|
+
#
|
|
40
|
+
# @return [Symbol, :tool_search_output]
|
|
41
|
+
required :type, const: :tool_search_output
|
|
42
|
+
|
|
43
|
+
# @!attribute created_by
|
|
44
|
+
# The identifier of the actor that created the item.
|
|
45
|
+
#
|
|
46
|
+
# @return [String, nil]
|
|
47
|
+
optional :created_by, String
|
|
48
|
+
|
|
49
|
+
# @!method initialize(id:, call_id:, execution:, status:, tools:, created_by: nil, type: :tool_search_output)
|
|
50
|
+
# @param id [String] The unique ID of the tool search output item.
|
|
51
|
+
#
|
|
52
|
+
# @param call_id [String, nil] The unique ID of the tool search call generated by the model.
|
|
53
|
+
#
|
|
54
|
+
# @param execution [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItem::Execution] Whether tool search was executed by the server or by the client.
|
|
55
|
+
#
|
|
56
|
+
# @param status [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItem::Status] The status of the tool search output item that was recorded.
|
|
57
|
+
#
|
|
58
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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 loaded tool definitions returned by tool search.
|
|
59
|
+
#
|
|
60
|
+
# @param created_by [String] The identifier of the actor that created the item.
|
|
61
|
+
#
|
|
62
|
+
# @param type [Symbol, :tool_search_output] The type of the item. Always `tool_search_output`.
|
|
63
|
+
|
|
64
|
+
# Whether tool search was executed by the server or by the client.
|
|
65
|
+
#
|
|
66
|
+
# @see OpenAI::Models::Responses::ResponseToolSearchOutputItem#execution
|
|
67
|
+
module Execution
|
|
68
|
+
extend OpenAI::Internal::Type::Enum
|
|
69
|
+
|
|
70
|
+
SERVER = :server
|
|
71
|
+
CLIENT = :client
|
|
72
|
+
|
|
73
|
+
# @!method self.values
|
|
74
|
+
# @return [Array<Symbol>]
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
# The status of the tool search output item that was recorded.
|
|
78
|
+
#
|
|
79
|
+
# @see OpenAI::Models::Responses::ResponseToolSearchOutputItem#status
|
|
80
|
+
module Status
|
|
81
|
+
extend OpenAI::Internal::Type::Enum
|
|
82
|
+
|
|
83
|
+
IN_PROGRESS = :in_progress
|
|
84
|
+
COMPLETED = :completed
|
|
85
|
+
INCOMPLETE = :incomplete
|
|
86
|
+
|
|
87
|
+
# @!method self.values
|
|
88
|
+
# @return [Array<Symbol>]
|
|
89
|
+
end
|
|
90
|
+
end
|
|
91
|
+
end
|
|
92
|
+
end
|
|
93
|
+
end
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Responses
|
|
6
|
+
class ResponseToolSearchOutputItemParam < OpenAI::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute tools
|
|
8
|
+
# The loaded tool definitions returned by the tool search output.
|
|
9
|
+
#
|
|
10
|
+
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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>]
|
|
11
|
+
required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
|
|
12
|
+
|
|
13
|
+
# @!attribute type
|
|
14
|
+
# The item type. Always `tool_search_output`.
|
|
15
|
+
#
|
|
16
|
+
# @return [Symbol, :tool_search_output]
|
|
17
|
+
required :type, const: :tool_search_output
|
|
18
|
+
|
|
19
|
+
# @!attribute id
|
|
20
|
+
# The unique ID of this tool search output.
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
optional :id, String, nil?: true
|
|
24
|
+
|
|
25
|
+
# @!attribute call_id
|
|
26
|
+
# The unique ID of the tool search call generated by the model.
|
|
27
|
+
#
|
|
28
|
+
# @return [String, nil]
|
|
29
|
+
optional :call_id, String, nil?: true
|
|
30
|
+
|
|
31
|
+
# @!attribute execution
|
|
32
|
+
# Whether tool search was executed by the server or by the client.
|
|
33
|
+
#
|
|
34
|
+
# @return [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Execution, nil]
|
|
35
|
+
optional :execution, enum: -> { OpenAI::Responses::ResponseToolSearchOutputItemParam::Execution }
|
|
36
|
+
|
|
37
|
+
# @!attribute status
|
|
38
|
+
# The status of the tool search output.
|
|
39
|
+
#
|
|
40
|
+
# @return [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Status, nil]
|
|
41
|
+
optional :status,
|
|
42
|
+
enum: -> {
|
|
43
|
+
OpenAI::Responses::ResponseToolSearchOutputItemParam::Status
|
|
44
|
+
},
|
|
45
|
+
nil?: true
|
|
46
|
+
|
|
47
|
+
# @!method initialize(tools:, id: nil, call_id: nil, execution: nil, status: nil, type: :tool_search_output)
|
|
48
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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 loaded tool definitions returned by the tool search output.
|
|
49
|
+
#
|
|
50
|
+
# @param id [String, nil] The unique ID of this tool search output.
|
|
51
|
+
#
|
|
52
|
+
# @param call_id [String, nil] The unique ID of the tool search call generated by the model.
|
|
53
|
+
#
|
|
54
|
+
# @param execution [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Execution] Whether tool search was executed by the server or by the client.
|
|
55
|
+
#
|
|
56
|
+
# @param status [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam::Status, nil] The status of the tool search output.
|
|
57
|
+
#
|
|
58
|
+
# @param type [Symbol, :tool_search_output] The item type. Always `tool_search_output`.
|
|
59
|
+
|
|
60
|
+
# Whether tool search was executed by the server or by the client.
|
|
61
|
+
#
|
|
62
|
+
# @see OpenAI::Models::Responses::ResponseToolSearchOutputItemParam#execution
|
|
63
|
+
module Execution
|
|
64
|
+
extend OpenAI::Internal::Type::Enum
|
|
65
|
+
|
|
66
|
+
SERVER = :server
|
|
67
|
+
CLIENT = :client
|
|
68
|
+
|
|
69
|
+
# @!method self.values
|
|
70
|
+
# @return [Array<Symbol>]
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
# The status of the tool search output.
|
|
74
|
+
#
|
|
75
|
+
# @see OpenAI::Models::Responses::ResponseToolSearchOutputItemParam#status
|
|
76
|
+
module Status
|
|
77
|
+
extend OpenAI::Internal::Type::Enum
|
|
78
|
+
|
|
79
|
+
IN_PROGRESS = :in_progress
|
|
80
|
+
COMPLETED = :completed
|
|
81
|
+
INCOMPLETE = :incomplete
|
|
82
|
+
|
|
83
|
+
# @!method self.values
|
|
84
|
+
# @return [Array<Symbol>]
|
|
85
|
+
end
|
|
86
|
+
end
|
|
87
|
+
end
|
|
88
|
+
end
|
|
89
|
+
end
|
|
@@ -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::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::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]
|
|
80
80
|
optional :input, union: -> { OpenAI::Responses::ResponsesClientEvent::Input }
|
|
81
81
|
|
|
82
82
|
# @!attribute instructions
|
|
@@ -280,7 +280,7 @@ module OpenAI
|
|
|
280
280
|
# [function calling](https://platform.openai.com/docs/guides/function-calling).
|
|
281
281
|
# You can also use custom tools to call your own code.
|
|
282
282
|
#
|
|
283
|
-
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, 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::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil]
|
|
283
|
+
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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>, nil]
|
|
284
284
|
optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
|
|
285
285
|
|
|
286
286
|
# @!attribute top_logprobs
|
|
@@ -336,7 +336,7 @@ module OpenAI
|
|
|
336
336
|
#
|
|
337
337
|
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently suppo
|
|
338
338
|
#
|
|
339
|
-
# @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::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.
|
|
339
|
+
# @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.
|
|
340
340
|
#
|
|
341
341
|
# @param instructions [String, nil] A system (or developer) message inserted into the model's context.
|
|
342
342
|
#
|
|
@@ -376,7 +376,7 @@ module OpenAI
|
|
|
376
376
|
#
|
|
377
377
|
# @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, OpenAI::Models::Responses::ToolChoiceCustom, OpenAI::Models::Responses::ToolChoiceApplyPatch, OpenAI::Models::Responses::ToolChoiceShell] How the model should select which tool (or tools) to use when generating
|
|
378
378
|
#
|
|
379
|
-
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, 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::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
|
|
379
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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>] An array of tools the model may call while generating a response. You
|
|
380
380
|
#
|
|
381
381
|
# @param top_logprobs [Integer, nil] An integer between 0 and 20 specifying the number of most likely tokens to
|
|
382
382
|
#
|
|
@@ -449,7 +449,7 @@ module OpenAI
|
|
|
449
449
|
variant -> { OpenAI::Responses::ResponseInput }
|
|
450
450
|
|
|
451
451
|
# @!method self.variants
|
|
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::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::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>)]
|
|
453
453
|
end
|
|
454
454
|
|
|
455
455
|
# The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
@@ -17,6 +17,9 @@ module OpenAI
|
|
|
17
17
|
# A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](https://platform.openai.com/docs/guides/tools-file-search).
|
|
18
18
|
variant :file_search, -> { OpenAI::Responses::FileSearchTool }
|
|
19
19
|
|
|
20
|
+
# A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
|
|
21
|
+
variant :computer, -> { OpenAI::Responses::ComputerUseTool }
|
|
22
|
+
|
|
20
23
|
# A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
|
|
21
24
|
variant :computer_use_preview, -> { OpenAI::Responses::ComputerTool }
|
|
22
25
|
|
|
@@ -39,6 +42,12 @@ module OpenAI
|
|
|
39
42
|
# A custom tool that processes input using a specified format. Learn more about [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools)
|
|
40
43
|
variant :custom, -> { OpenAI::Responses::CustomTool }
|
|
41
44
|
|
|
45
|
+
# Groups function/custom tools under a shared namespace.
|
|
46
|
+
variant :namespace, -> { OpenAI::Responses::NamespaceTool }
|
|
47
|
+
|
|
48
|
+
# Hosted or BYOT tool search configuration for deferred tools.
|
|
49
|
+
variant :tool_search, -> { OpenAI::Responses::ToolSearchTool }
|
|
50
|
+
|
|
42
51
|
# Allows the assistant to create, delete, or update files using unified diffs.
|
|
43
52
|
variant :apply_patch, -> { OpenAI::Responses::ApplyPatchTool }
|
|
44
53
|
|
|
@@ -96,6 +105,12 @@ module OpenAI
|
|
|
96
105
|
# @return [Symbol, OpenAI::Models::Responses::Tool::Mcp::ConnectorID, nil]
|
|
97
106
|
optional :connector_id, enum: -> { OpenAI::Responses::Tool::Mcp::ConnectorID }
|
|
98
107
|
|
|
108
|
+
# @!attribute defer_loading
|
|
109
|
+
# Whether this MCP tool is deferred and discovered via tool search.
|
|
110
|
+
#
|
|
111
|
+
# @return [Boolean, nil]
|
|
112
|
+
optional :defer_loading, OpenAI::Internal::Type::Boolean
|
|
113
|
+
|
|
99
114
|
# @!attribute headers
|
|
100
115
|
# Optional HTTP headers to send to the MCP server. Use for authentication or other
|
|
101
116
|
# purposes.
|
|
@@ -122,7 +137,7 @@ module OpenAI
|
|
|
122
137
|
# @return [String, nil]
|
|
123
138
|
optional :server_url, String
|
|
124
139
|
|
|
125
|
-
# @!method initialize(server_label:, allowed_tools: nil, authorization: nil, connector_id: nil, headers: nil, require_approval: nil, server_description: nil, server_url: nil, type: :mcp)
|
|
140
|
+
# @!method initialize(server_label:, allowed_tools: nil, authorization: nil, connector_id: nil, defer_loading: nil, headers: nil, require_approval: nil, server_description: nil, server_url: nil, type: :mcp)
|
|
126
141
|
# Some parameter documentations has been truncated, see
|
|
127
142
|
# {OpenAI::Models::Responses::Tool::Mcp} for more details.
|
|
128
143
|
#
|
|
@@ -138,6 +153,8 @@ module OpenAI
|
|
|
138
153
|
#
|
|
139
154
|
# @param connector_id [Symbol, OpenAI::Models::Responses::Tool::Mcp::ConnectorID] Identifier for service connectors, like those available in ChatGPT. One of
|
|
140
155
|
#
|
|
156
|
+
# @param defer_loading [Boolean] Whether this MCP tool is deferred and discovered via tool search.
|
|
157
|
+
#
|
|
141
158
|
# @param headers [Hash{Symbol=>String}, nil] Optional HTTP headers to send to the MCP server. Use for authentication
|
|
142
159
|
#
|
|
143
160
|
# @param require_approval [OpenAI::Models::Responses::Tool::Mcp::RequireApproval::McpToolApprovalFilter, Symbol, OpenAI::Models::Responses::Tool::Mcp::RequireApproval::McpToolApprovalSetting, nil] Specify which of the MCP server's tools require approval.
|
|
@@ -757,7 +774,7 @@ module OpenAI
|
|
|
757
774
|
end
|
|
758
775
|
|
|
759
776
|
# @!method self.variants
|
|
760
|
-
# @return [Array(OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, 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::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool)]
|
|
777
|
+
# @return [Array(OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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)]
|
|
761
778
|
end
|
|
762
779
|
end
|
|
763
780
|
end
|
|
@@ -12,7 +12,9 @@ module OpenAI
|
|
|
12
12
|
#
|
|
13
13
|
# - `file_search`
|
|
14
14
|
# - `web_search_preview`
|
|
15
|
+
# - `computer`
|
|
15
16
|
# - `computer_use_preview`
|
|
17
|
+
# - `computer_use`
|
|
16
18
|
# - `code_interpreter`
|
|
17
19
|
# - `image_generation`
|
|
18
20
|
#
|
|
@@ -35,7 +37,9 @@ module OpenAI
|
|
|
35
37
|
#
|
|
36
38
|
# - `file_search`
|
|
37
39
|
# - `web_search_preview`
|
|
40
|
+
# - `computer`
|
|
38
41
|
# - `computer_use_preview`
|
|
42
|
+
# - `computer_use`
|
|
39
43
|
# - `code_interpreter`
|
|
40
44
|
# - `image_generation`
|
|
41
45
|
#
|
|
@@ -45,7 +49,9 @@ module OpenAI
|
|
|
45
49
|
|
|
46
50
|
FILE_SEARCH = :file_search
|
|
47
51
|
WEB_SEARCH_PREVIEW = :web_search_preview
|
|
52
|
+
COMPUTER = :computer
|
|
48
53
|
COMPUTER_USE_PREVIEW = :computer_use_preview
|
|
54
|
+
COMPUTER_USE = :computer_use
|
|
49
55
|
WEB_SEARCH_PREVIEW_2025_03_11 = :web_search_preview_2025_03_11
|
|
50
56
|
IMAGE_GENERATION = :image_generation
|
|
51
57
|
CODE_INTERPRETER = :code_interpreter
|