openai 0.51.0 → 0.53.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 +32 -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_tool.rb +5 -45
- data/lib/openai/models/responses/computer_use_preview_tool.rb +61 -0
- data/lib/openai/models/responses/custom_tool.rb +9 -1
- data/lib/openai/models/responses/easy_input_message.rb +9 -13
- 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 +9 -3
- 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 +9 -13
- 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 +20 -3
- 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 +9 -7
- 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_tool.rbi +5 -87
- data/rbi/openai/models/responses/computer_use_preview_tool.rbi +124 -0
- data/rbi/openai/models/responses/custom_tool.rbi +11 -0
- data/rbi/openai/models/responses/easy_input_message.rbi +12 -18
- 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 +10 -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 +12 -18
- 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 +6 -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_tool.rbs +4 -40
- data/sig/openai/models/responses/computer_use_preview_tool.rbs +51 -0
- data/sig/openai/models/responses/custom_tool.rbs +7 -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 +5 -1
- 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_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
- metadata +32 -2
|
@@ -4,6 +4,7 @@ module OpenAI
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Evals
|
|
6
6
|
class Runs
|
|
7
|
+
# Manage and run evals in the OpenAI platform.
|
|
7
8
|
class OutputItems
|
|
8
9
|
# Get an evaluation run output item by ID.
|
|
9
10
|
#
|
|
@@ -64,6 +65,7 @@ module OpenAI
|
|
|
64
65
|
# @see OpenAI::Models::Evals::Runs::OutputItemListParams
|
|
65
66
|
def list(run_id, params)
|
|
66
67
|
parsed, options = OpenAI::Evals::Runs::OutputItemListParams.dump_request(params)
|
|
68
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
67
69
|
eval_id =
|
|
68
70
|
parsed.delete(:eval_id) do
|
|
69
71
|
raise ArgumentError.new("missing required path argument #{_1}")
|
|
@@ -71,7 +73,7 @@ module OpenAI
|
|
|
71
73
|
@client.request(
|
|
72
74
|
method: :get,
|
|
73
75
|
path: ["evals/%1$s/runs/%2$s/output_items", eval_id, run_id],
|
|
74
|
-
query:
|
|
76
|
+
query: query,
|
|
75
77
|
page: OpenAI::Internal::CursorPage,
|
|
76
78
|
model: OpenAI::Models::Evals::Runs::OutputItemListResponse,
|
|
77
79
|
options: options
|
|
@@ -3,7 +3,9 @@
|
|
|
3
3
|
module OpenAI
|
|
4
4
|
module Resources
|
|
5
5
|
class Evals
|
|
6
|
+
# Manage and run evals in the OpenAI platform.
|
|
6
7
|
class Runs
|
|
8
|
+
# Manage and run evals in the OpenAI platform.
|
|
7
9
|
# @return [OpenAI::Resources::Evals::Runs::OutputItems]
|
|
8
10
|
attr_reader :output_items
|
|
9
11
|
|
|
@@ -91,10 +93,11 @@ module OpenAI
|
|
|
91
93
|
# @see OpenAI::Models::Evals::RunListParams
|
|
92
94
|
def list(eval_id, params = {})
|
|
93
95
|
parsed, options = OpenAI::Evals::RunListParams.dump_request(params)
|
|
96
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
94
97
|
@client.request(
|
|
95
98
|
method: :get,
|
|
96
99
|
path: ["evals/%1$s/runs", eval_id],
|
|
97
|
-
query:
|
|
100
|
+
query: query,
|
|
98
101
|
page: OpenAI::Internal::CursorPage,
|
|
99
102
|
model: OpenAI::Models::Evals::RunListResponse,
|
|
100
103
|
options: options
|
|
@@ -2,7 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
module OpenAI
|
|
4
4
|
module Resources
|
|
5
|
+
# Manage and run evals in the OpenAI platform.
|
|
5
6
|
class Evals
|
|
7
|
+
# Manage and run evals in the OpenAI platform.
|
|
6
8
|
# @return [OpenAI::Resources::Evals::Runs]
|
|
7
9
|
attr_reader :runs
|
|
8
10
|
|
|
@@ -113,10 +115,11 @@ module OpenAI
|
|
|
113
115
|
# @see OpenAI::Models::EvalListParams
|
|
114
116
|
def list(params = {})
|
|
115
117
|
parsed, options = OpenAI::EvalListParams.dump_request(params)
|
|
118
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
116
119
|
@client.request(
|
|
117
120
|
method: :get,
|
|
118
121
|
path: "evals",
|
|
119
|
-
query:
|
|
122
|
+
query: query,
|
|
120
123
|
page: OpenAI::Internal::CursorPage,
|
|
121
124
|
model: OpenAI::Models::EvalListResponse,
|
|
122
125
|
options: options
|
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
module OpenAI
|
|
4
4
|
module Resources
|
|
5
|
+
# Files are used to upload documents that can be used with features like
|
|
6
|
+
# Assistants and Fine-tuning.
|
|
5
7
|
class Files
|
|
6
8
|
# Some parameter documentations has been truncated, see
|
|
7
9
|
# {OpenAI::Models::FileCreateParams} for more details.
|
|
@@ -94,10 +96,11 @@ module OpenAI
|
|
|
94
96
|
# @see OpenAI::Models::FileListParams
|
|
95
97
|
def list(params = {})
|
|
96
98
|
parsed, options = OpenAI::FileListParams.dump_request(params)
|
|
99
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
97
100
|
@client.request(
|
|
98
101
|
method: :get,
|
|
99
102
|
path: "files",
|
|
100
|
-
query:
|
|
103
|
+
query: query,
|
|
101
104
|
page: OpenAI::Internal::CursorPage,
|
|
102
105
|
model: OpenAI::FileObject,
|
|
103
106
|
options: options
|
|
@@ -4,6 +4,7 @@ module OpenAI
|
|
|
4
4
|
module Resources
|
|
5
5
|
class FineTuning
|
|
6
6
|
class Alpha
|
|
7
|
+
# Manage fine-tuning jobs to tailor a model to your specific training data.
|
|
7
8
|
class Graders
|
|
8
9
|
# Some parameter documentations has been truncated, see
|
|
9
10
|
# {OpenAI::Models::FineTuning::Alpha::GraderRunParams} for more details.
|
|
@@ -4,6 +4,7 @@ module OpenAI
|
|
|
4
4
|
module Resources
|
|
5
5
|
class FineTuning
|
|
6
6
|
class Checkpoints
|
|
7
|
+
# Manage fine-tuning jobs to tailor a model to your specific training data.
|
|
7
8
|
class Permissions
|
|
8
9
|
# Some parameter documentations has been truncated, see
|
|
9
10
|
# {OpenAI::Models::FineTuning::Checkpoints::PermissionCreateParams} for more
|
|
@@ -37,6 +38,8 @@ module OpenAI
|
|
|
37
38
|
)
|
|
38
39
|
end
|
|
39
40
|
|
|
41
|
+
# @deprecated Retrieve is deprecated. Please swap to the paginated list method instead.
|
|
42
|
+
#
|
|
40
43
|
# Some parameter documentations has been truncated, see
|
|
41
44
|
# {OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveParams} for more
|
|
42
45
|
# details.
|
|
@@ -65,15 +68,55 @@ module OpenAI
|
|
|
65
68
|
# @see OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveParams
|
|
66
69
|
def retrieve(fine_tuned_model_checkpoint, params = {})
|
|
67
70
|
parsed, options = OpenAI::FineTuning::Checkpoints::PermissionRetrieveParams.dump_request(params)
|
|
71
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
68
72
|
@client.request(
|
|
69
73
|
method: :get,
|
|
70
74
|
path: ["fine_tuning/checkpoints/%1$s/permissions", fine_tuned_model_checkpoint],
|
|
71
|
-
query:
|
|
75
|
+
query: query,
|
|
72
76
|
model: OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveResponse,
|
|
73
77
|
options: options
|
|
74
78
|
)
|
|
75
79
|
end
|
|
76
80
|
|
|
81
|
+
# Some parameter documentations has been truncated, see
|
|
82
|
+
# {OpenAI::Models::FineTuning::Checkpoints::PermissionListParams} for more
|
|
83
|
+
# details.
|
|
84
|
+
#
|
|
85
|
+
# **NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
|
|
86
|
+
#
|
|
87
|
+
# Organization owners can use this endpoint to view all permissions for a
|
|
88
|
+
# fine-tuned model checkpoint.
|
|
89
|
+
#
|
|
90
|
+
# @overload list(fine_tuned_model_checkpoint, after: nil, limit: nil, order: nil, project_id: nil, request_options: {})
|
|
91
|
+
#
|
|
92
|
+
# @param fine_tuned_model_checkpoint [String] The ID of the fine-tuned model checkpoint to get permissions for.
|
|
93
|
+
#
|
|
94
|
+
# @param after [String] Identifier for the last permission ID from the previous pagination request.
|
|
95
|
+
#
|
|
96
|
+
# @param limit [Integer] Number of permissions to retrieve.
|
|
97
|
+
#
|
|
98
|
+
# @param order [Symbol, OpenAI::Models::FineTuning::Checkpoints::PermissionListParams::Order] The order in which to retrieve permissions.
|
|
99
|
+
#
|
|
100
|
+
# @param project_id [String] The ID of the project to get permissions for.
|
|
101
|
+
#
|
|
102
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
103
|
+
#
|
|
104
|
+
# @return [OpenAI::Internal::ConversationCursorPage<OpenAI::Models::FineTuning::Checkpoints::PermissionListResponse>]
|
|
105
|
+
#
|
|
106
|
+
# @see OpenAI::Models::FineTuning::Checkpoints::PermissionListParams
|
|
107
|
+
def list(fine_tuned_model_checkpoint, params = {})
|
|
108
|
+
parsed, options = OpenAI::FineTuning::Checkpoints::PermissionListParams.dump_request(params)
|
|
109
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
110
|
+
@client.request(
|
|
111
|
+
method: :get,
|
|
112
|
+
path: ["fine_tuning/checkpoints/%1$s/permissions", fine_tuned_model_checkpoint],
|
|
113
|
+
query: query,
|
|
114
|
+
page: OpenAI::Internal::ConversationCursorPage,
|
|
115
|
+
model: OpenAI::Models::FineTuning::Checkpoints::PermissionListResponse,
|
|
116
|
+
options: options
|
|
117
|
+
)
|
|
118
|
+
end
|
|
119
|
+
|
|
77
120
|
# Some parameter documentations has been truncated, see
|
|
78
121
|
# {OpenAI::Models::FineTuning::Checkpoints::PermissionDeleteParams} for more
|
|
79
122
|
# details.
|
|
@@ -4,6 +4,7 @@ module OpenAI
|
|
|
4
4
|
module Resources
|
|
5
5
|
class FineTuning
|
|
6
6
|
class Jobs
|
|
7
|
+
# Manage fine-tuning jobs to tailor a model to your specific training data.
|
|
7
8
|
class Checkpoints
|
|
8
9
|
# Some parameter documentations has been truncated, see
|
|
9
10
|
# {OpenAI::Models::FineTuning::Jobs::CheckpointListParams} for more details.
|
|
@@ -25,10 +26,11 @@ module OpenAI
|
|
|
25
26
|
# @see OpenAI::Models::FineTuning::Jobs::CheckpointListParams
|
|
26
27
|
def list(fine_tuning_job_id, params = {})
|
|
27
28
|
parsed, options = OpenAI::FineTuning::Jobs::CheckpointListParams.dump_request(params)
|
|
29
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
28
30
|
@client.request(
|
|
29
31
|
method: :get,
|
|
30
32
|
path: ["fine_tuning/jobs/%1$s/checkpoints", fine_tuning_job_id],
|
|
31
|
-
query:
|
|
33
|
+
query: query,
|
|
32
34
|
page: OpenAI::Internal::CursorPage,
|
|
33
35
|
model: OpenAI::FineTuning::Jobs::FineTuningJobCheckpoint,
|
|
34
36
|
options: options
|
|
@@ -3,7 +3,9 @@
|
|
|
3
3
|
module OpenAI
|
|
4
4
|
module Resources
|
|
5
5
|
class FineTuning
|
|
6
|
+
# Manage fine-tuning jobs to tailor a model to your specific training data.
|
|
6
7
|
class Jobs
|
|
8
|
+
# Manage fine-tuning jobs to tailor a model to your specific training data.
|
|
7
9
|
# @return [OpenAI::Resources::FineTuning::Jobs::Checkpoints]
|
|
8
10
|
attr_reader :checkpoints
|
|
9
11
|
|
|
@@ -99,10 +101,11 @@ module OpenAI
|
|
|
99
101
|
# @see OpenAI::Models::FineTuning::JobListParams
|
|
100
102
|
def list(params = {})
|
|
101
103
|
parsed, options = OpenAI::FineTuning::JobListParams.dump_request(params)
|
|
104
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
102
105
|
@client.request(
|
|
103
106
|
method: :get,
|
|
104
107
|
path: "fine_tuning/jobs",
|
|
105
|
-
query:
|
|
108
|
+
query: query,
|
|
106
109
|
page: OpenAI::Internal::CursorPage,
|
|
107
110
|
model: OpenAI::FineTuning::FineTuningJob,
|
|
108
111
|
options: options
|
|
@@ -152,10 +155,11 @@ module OpenAI
|
|
|
152
155
|
# @see OpenAI::Models::FineTuning::JobListEventsParams
|
|
153
156
|
def list_events(fine_tuning_job_id, params = {})
|
|
154
157
|
parsed, options = OpenAI::FineTuning::JobListEventsParams.dump_request(params)
|
|
158
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
155
159
|
@client.request(
|
|
156
160
|
method: :get,
|
|
157
161
|
path: ["fine_tuning/jobs/%1$s/events", fine_tuning_job_id],
|
|
158
|
-
query:
|
|
162
|
+
query: query,
|
|
159
163
|
page: OpenAI::Internal::CursorPage,
|
|
160
164
|
model: OpenAI::FineTuning::FineTuningJobEvent,
|
|
161
165
|
options: options
|
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
module OpenAI
|
|
4
4
|
module Resources
|
|
5
|
+
# Given text and/or image inputs, classifies if those inputs are potentially
|
|
6
|
+
# harmful.
|
|
5
7
|
class Moderations
|
|
6
8
|
# Some parameter documentations has been truncated, see
|
|
7
9
|
# {OpenAI::Models::ModerationCreateParams} for more details.
|
|
@@ -23,15 +23,16 @@ module OpenAI
|
|
|
23
23
|
#
|
|
24
24
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
25
25
|
#
|
|
26
|
-
# @return [OpenAI::Internal::CursorPage<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>]
|
|
26
|
+
# @return [OpenAI::Internal::CursorPage<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>]
|
|
27
27
|
#
|
|
28
28
|
# @see OpenAI::Models::Responses::InputItemListParams
|
|
29
29
|
def list(response_id, params = {})
|
|
30
30
|
parsed, options = OpenAI::Responses::InputItemListParams.dump_request(params)
|
|
31
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
31
32
|
@client.request(
|
|
32
33
|
method: :get,
|
|
33
34
|
path: ["responses/%1$s/input_items", response_id],
|
|
34
|
-
query:
|
|
35
|
+
query: query,
|
|
35
36
|
page: OpenAI::Internal::CursorPage,
|
|
36
37
|
model: OpenAI::Responses::ResponseItem,
|
|
37
38
|
options: options
|
|
@@ -16,7 +16,7 @@ module OpenAI
|
|
|
16
16
|
#
|
|
17
17
|
# @param conversation [String, OpenAI::Models::Responses::ResponseConversationParam, nil] The conversation that this response belongs to. Items from this conversation are
|
|
18
18
|
#
|
|
19
|
-
# @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>, nil] Text, image, or file inputs to the model, used to generate a response
|
|
19
|
+
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Text, image, or file inputs to the model, used to generate a response
|
|
20
20
|
#
|
|
21
21
|
# @param instructions [String, nil] A system (or developer) message inserted into the model's context.
|
|
22
22
|
#
|
|
@@ -32,7 +32,7 @@ module OpenAI
|
|
|
32
32
|
#
|
|
33
33
|
# @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, nil] Controls which tool the model should use, if any.
|
|
34
34
|
#
|
|
35
|
-
# @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>, nil] An array of tools the model may call while generating a response. You can specif
|
|
35
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil] An array of tools the model may call while generating a response. You can specif
|
|
36
36
|
#
|
|
37
37
|
# @param truncation [Symbol, OpenAI::Models::Responses::InputTokenCountParams::Truncation] The truncation strategy to use for the model response. - `auto`: If the input to
|
|
38
38
|
#
|
|
@@ -36,7 +36,7 @@ module OpenAI
|
|
|
36
36
|
#
|
|
37
37
|
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently suppo
|
|
38
38
|
#
|
|
39
|
-
# @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.
|
|
39
|
+
# @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.
|
|
40
40
|
#
|
|
41
41
|
# @param instructions [String, nil] A system (or developer) message inserted into the model's context.
|
|
42
42
|
#
|
|
@@ -74,7 +74,7 @@ module OpenAI
|
|
|
74
74
|
#
|
|
75
75
|
# @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
|
|
76
76
|
#
|
|
77
|
-
# @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
|
|
77
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
|
|
78
78
|
#
|
|
79
79
|
# @param top_logprobs [Integer, nil] An integer between 0 and 20 specifying the number of most likely tokens to
|
|
80
80
|
#
|
|
@@ -139,7 +139,7 @@ module OpenAI
|
|
|
139
139
|
#
|
|
140
140
|
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently suppo
|
|
141
141
|
#
|
|
142
|
-
# @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.
|
|
142
|
+
# @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.
|
|
143
143
|
#
|
|
144
144
|
# @param instructions [String, nil] A system (or developer) message inserted into the model's context.
|
|
145
145
|
#
|
|
@@ -295,7 +295,7 @@ module OpenAI
|
|
|
295
295
|
#
|
|
296
296
|
# @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
|
|
297
297
|
#
|
|
298
|
-
# @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
|
|
298
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
|
|
299
299
|
#
|
|
300
300
|
# @param top_logprobs [Integer, nil] An integer between 0 and 20 specifying the number of most likely tokens to
|
|
301
301
|
#
|
|
@@ -353,6 +353,7 @@ module OpenAI
|
|
|
353
353
|
# @see OpenAI::Models::Responses::ResponseRetrieveParams
|
|
354
354
|
def retrieve(response_id, params = {})
|
|
355
355
|
parsed, options = OpenAI::Responses::ResponseRetrieveParams.dump_request(params)
|
|
356
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
356
357
|
if parsed[:stream]
|
|
357
358
|
message = "Please use `#retrieve_streaming` for the streaming use case."
|
|
358
359
|
raise ArgumentError.new(message)
|
|
@@ -360,7 +361,7 @@ module OpenAI
|
|
|
360
361
|
@client.request(
|
|
361
362
|
method: :get,
|
|
362
363
|
path: ["responses/%1$s", response_id],
|
|
363
|
-
query:
|
|
364
|
+
query: query,
|
|
364
365
|
model: OpenAI::Responses::Response,
|
|
365
366
|
options: options
|
|
366
367
|
)
|
|
@@ -390,6 +391,7 @@ module OpenAI
|
|
|
390
391
|
# @see OpenAI::Models::Responses::ResponseRetrieveParams
|
|
391
392
|
def retrieve_streaming(response_id, params = {})
|
|
392
393
|
parsed, options = OpenAI::Responses::ResponseRetrieveParams.dump_request(params)
|
|
394
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
393
395
|
unless parsed.fetch(:stream, true)
|
|
394
396
|
message = "Please use `#retrieve` for the non-streaming use case."
|
|
395
397
|
raise ArgumentError.new(message)
|
|
@@ -398,7 +400,7 @@ module OpenAI
|
|
|
398
400
|
@client.request(
|
|
399
401
|
method: :get,
|
|
400
402
|
path: ["responses/%1$s", response_id],
|
|
401
|
-
query:
|
|
403
|
+
query: query,
|
|
402
404
|
headers: {"accept" => "text/event-stream"},
|
|
403
405
|
stream: OpenAI::Internal::Stream,
|
|
404
406
|
model: OpenAI::Responses::ResponseStreamEvent,
|
|
@@ -477,7 +479,7 @@ module OpenAI
|
|
|
477
479
|
#
|
|
478
480
|
# @param model [Symbol, String, OpenAI::Models::Responses::ResponseCompactParams::Model, nil] Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wi
|
|
479
481
|
#
|
|
480
|
-
# @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>, nil] Text, image, or file inputs to the model, used to generate a response
|
|
482
|
+
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Text, image, or file inputs to the model, used to generate a response
|
|
481
483
|
#
|
|
482
484
|
# @param instructions [String, nil] A system (or developer) message inserted into the model's context.
|
|
483
485
|
#
|
|
@@ -80,10 +80,11 @@ module OpenAI
|
|
|
80
80
|
# @see OpenAI::Models::Skills::VersionListParams
|
|
81
81
|
def list(skill_id, params = {})
|
|
82
82
|
parsed, options = OpenAI::Skills::VersionListParams.dump_request(params)
|
|
83
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
83
84
|
@client.request(
|
|
84
85
|
method: :get,
|
|
85
86
|
path: ["skills/%1$s/versions", skill_id],
|
|
86
|
-
query:
|
|
87
|
+
query: query,
|
|
87
88
|
page: OpenAI::Internal::CursorPage,
|
|
88
89
|
model: OpenAI::Skills::SkillVersion,
|
|
89
90
|
options: options
|
|
@@ -96,10 +96,11 @@ module OpenAI
|
|
|
96
96
|
# @see OpenAI::Models::SkillListParams
|
|
97
97
|
def list(params = {})
|
|
98
98
|
parsed, options = OpenAI::SkillListParams.dump_request(params)
|
|
99
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
99
100
|
@client.request(
|
|
100
101
|
method: :get,
|
|
101
102
|
path: "skills",
|
|
102
|
-
query:
|
|
103
|
+
query: query,
|
|
103
104
|
page: OpenAI::Internal::CursorPage,
|
|
104
105
|
model: OpenAI::Skill,
|
|
105
106
|
options: options
|
|
@@ -120,6 +120,7 @@ module OpenAI
|
|
|
120
120
|
# @see OpenAI::Models::VectorStores::FileBatchListFilesParams
|
|
121
121
|
def list_files(batch_id, params)
|
|
122
122
|
parsed, options = OpenAI::VectorStores::FileBatchListFilesParams.dump_request(params)
|
|
123
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
123
124
|
vector_store_id =
|
|
124
125
|
parsed.delete(:vector_store_id) do
|
|
125
126
|
raise ArgumentError.new("missing required path argument #{_1}")
|
|
@@ -127,7 +128,7 @@ module OpenAI
|
|
|
127
128
|
@client.request(
|
|
128
129
|
method: :get,
|
|
129
130
|
path: ["vector_stores/%1$s/file_batches/%2$s/files", vector_store_id, batch_id],
|
|
130
|
-
query:
|
|
131
|
+
query: query,
|
|
131
132
|
page: OpenAI::Internal::CursorPage,
|
|
132
133
|
model: OpenAI::VectorStores::VectorStoreFile,
|
|
133
134
|
options: {extra_headers: {"OpenAI-Beta" => "assistants=v2"}, **options}
|
|
@@ -123,10 +123,11 @@ module OpenAI
|
|
|
123
123
|
# @see OpenAI::Models::VectorStores::FileListParams
|
|
124
124
|
def list(vector_store_id, params = {})
|
|
125
125
|
parsed, options = OpenAI::VectorStores::FileListParams.dump_request(params)
|
|
126
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
126
127
|
@client.request(
|
|
127
128
|
method: :get,
|
|
128
129
|
path: ["vector_stores/%1$s/files", vector_store_id],
|
|
129
|
-
query:
|
|
130
|
+
query: query,
|
|
130
131
|
page: OpenAI::Internal::CursorPage,
|
|
131
132
|
model: OpenAI::VectorStores::VectorStoreFile,
|
|
132
133
|
options: {extra_headers: {"OpenAI-Beta" => "assistants=v2"}, **options}
|
|
@@ -117,10 +117,11 @@ module OpenAI
|
|
|
117
117
|
# @see OpenAI::Models::VectorStoreListParams
|
|
118
118
|
def list(params = {})
|
|
119
119
|
parsed, options = OpenAI::VectorStoreListParams.dump_request(params)
|
|
120
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
120
121
|
@client.request(
|
|
121
122
|
method: :get,
|
|
122
123
|
path: "vector_stores",
|
|
123
|
-
query:
|
|
124
|
+
query: query,
|
|
124
125
|
page: OpenAI::Internal::CursorPage,
|
|
125
126
|
model: OpenAI::VectorStore,
|
|
126
127
|
options: {extra_headers: {"OpenAI-Beta" => "assistants=v2"}, **options}
|
|
@@ -12,7 +12,7 @@ module OpenAI
|
|
|
12
12
|
#
|
|
13
13
|
# @param prompt [String] Text prompt that describes the video to generate.
|
|
14
14
|
#
|
|
15
|
-
# @param input_reference [Pathname, StringIO, IO, String, OpenAI::FilePart] Optional
|
|
15
|
+
# @param input_reference [Pathname, StringIO, IO, String, OpenAI::FilePart] Optional multipart reference asset that guides generation.
|
|
16
16
|
#
|
|
17
17
|
# @param model [String, Symbol, OpenAI::Models::VideoModel] The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults
|
|
18
18
|
#
|
|
@@ -77,10 +77,11 @@ module OpenAI
|
|
|
77
77
|
# @see OpenAI::Models::VideoListParams
|
|
78
78
|
def list(params = {})
|
|
79
79
|
parsed, options = OpenAI::VideoListParams.dump_request(params)
|
|
80
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
80
81
|
@client.request(
|
|
81
82
|
method: :get,
|
|
82
83
|
path: "videos",
|
|
83
|
-
query:
|
|
84
|
+
query: query,
|
|
84
85
|
page: OpenAI::Internal::ConversationCursorPage,
|
|
85
86
|
model: OpenAI::Video,
|
|
86
87
|
options: options
|
|
@@ -124,10 +125,11 @@ module OpenAI
|
|
|
124
125
|
# @see OpenAI::Models::VideoDownloadContentParams
|
|
125
126
|
def download_content(video_id, params = {})
|
|
126
127
|
parsed, options = OpenAI::VideoDownloadContentParams.dump_request(params)
|
|
128
|
+
query = OpenAI::Internal::Util.encode_query_params(parsed)
|
|
127
129
|
@client.request(
|
|
128
130
|
method: :get,
|
|
129
131
|
path: ["videos/%1$s/content", video_id],
|
|
130
|
-
query:
|
|
132
|
+
query: query,
|
|
131
133
|
headers: {"accept" => "application/binary"},
|
|
132
134
|
model: StringIO,
|
|
133
135
|
options: options
|
data/lib/openai/version.rb
CHANGED
data/lib/openai.rb
CHANGED
|
@@ -363,6 +363,8 @@ require_relative "openai/models/fine_tuning/checkpoints/permission_create_params
|
|
|
363
363
|
require_relative "openai/models/fine_tuning/checkpoints/permission_create_response"
|
|
364
364
|
require_relative "openai/models/fine_tuning/checkpoints/permission_delete_params"
|
|
365
365
|
require_relative "openai/models/fine_tuning/checkpoints/permission_delete_response"
|
|
366
|
+
require_relative "openai/models/fine_tuning/checkpoints/permission_list_params"
|
|
367
|
+
require_relative "openai/models/fine_tuning/checkpoints/permission_list_response"
|
|
366
368
|
require_relative "openai/models/fine_tuning/checkpoints/permission_retrieve_params"
|
|
367
369
|
require_relative "openai/models/fine_tuning/checkpoints/permission_retrieve_response"
|
|
368
370
|
require_relative "openai/models/fine_tuning/dpo_hyperparameters"
|
|
@@ -535,7 +537,10 @@ require_relative "openai/models/response_format_text_grammar"
|
|
|
535
537
|
require_relative "openai/models/response_format_text_python"
|
|
536
538
|
require_relative "openai/models/responses/apply_patch_tool"
|
|
537
539
|
require_relative "openai/models/responses/compacted_response"
|
|
540
|
+
require_relative "openai/models/responses/computer_action"
|
|
541
|
+
require_relative "openai/models/responses/computer_action_list"
|
|
538
542
|
require_relative "openai/models/responses/computer_tool"
|
|
543
|
+
require_relative "openai/models/responses/computer_use_preview_tool"
|
|
539
544
|
require_relative "openai/models/responses/container_auto"
|
|
540
545
|
require_relative "openai/models/responses/container_network_policy_allowlist"
|
|
541
546
|
require_relative "openai/models/responses/container_network_policy_disabled"
|
|
@@ -553,6 +558,7 @@ require_relative "openai/models/responses/input_token_count_params"
|
|
|
553
558
|
require_relative "openai/models/responses/input_token_count_response"
|
|
554
559
|
require_relative "openai/models/responses/local_environment"
|
|
555
560
|
require_relative "openai/models/responses/local_skill"
|
|
561
|
+
require_relative "openai/models/responses/namespace_tool"
|
|
556
562
|
require_relative "openai/models/responses/response"
|
|
557
563
|
require_relative "openai/models/responses/response_apply_patch_tool_call"
|
|
558
564
|
require_relative "openai/models/responses/response_apply_patch_tool_call_output"
|
|
@@ -657,6 +663,9 @@ require_relative "openai/models/responses/response_stream_event"
|
|
|
657
663
|
require_relative "openai/models/responses/response_text_config"
|
|
658
664
|
require_relative "openai/models/responses/response_text_delta_event"
|
|
659
665
|
require_relative "openai/models/responses/response_text_done_event"
|
|
666
|
+
require_relative "openai/models/responses/response_tool_search_call"
|
|
667
|
+
require_relative "openai/models/responses/response_tool_search_output_item"
|
|
668
|
+
require_relative "openai/models/responses/response_tool_search_output_item_param"
|
|
660
669
|
require_relative "openai/models/responses/response_usage"
|
|
661
670
|
require_relative "openai/models/responses/response_web_search_call_completed_event"
|
|
662
671
|
require_relative "openai/models/responses/response_web_search_call_in_progress_event"
|
|
@@ -671,6 +680,7 @@ require_relative "openai/models/responses/tool_choice_mcp"
|
|
|
671
680
|
require_relative "openai/models/responses/tool_choice_options"
|
|
672
681
|
require_relative "openai/models/responses/tool_choice_shell"
|
|
673
682
|
require_relative "openai/models/responses/tool_choice_types"
|
|
683
|
+
require_relative "openai/models/responses/tool_search_tool"
|
|
674
684
|
require_relative "openai/models/responses/web_search_preview_tool"
|
|
675
685
|
require_relative "openai/models/responses/web_search_tool"
|
|
676
686
|
require_relative "openai/models/responses_model"
|