openai 0.51.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 +24 -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 +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 +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 +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_use_tool.rbi +31 -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_use_tool.rbs +15 -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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c21fe8d5023582f2aa3ee07216c1eacfc3a1f2123abbeb4b10505695a5db3fd3
|
|
4
|
+
data.tar.gz: 5c2ed66344801a2fded78a3065cbd7b225d42dc82c5984a717cc13462b86286f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b2e7315d276787ecec496163984da7916ac83dad16c6f83ce625261f812c9609306b9f1d4fb3494c030bb08db70bb4d4a844fab65e25126a7a3d9d3f9f27a438
|
|
7
|
+
data.tar.gz: 512dfaa1743141ac8c80d484f0dd298dc02f18150975a06b9e3b6bad1ce7d212902e62b267d0dc783995d761d03ddea455d5df39d4a438a92175997d3b9261ff
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,29 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.52.0 (2026-03-05)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.51.0...v0.52.0](https://github.com/openai/openai-ruby/compare/v0.51.0...v0.52.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** gpt-5.4, tool search tool, and new computer tool ([8cdcde5](https://github.com/openai/openai-ruby/commit/8cdcde5c4641eca5aaaf096588be4fe9e617a929))
|
|
10
|
+
* **api:** remove phase from EasyInputMessage/ResponseOutputMessage, prompt_cache_key from compact ([f603ff1](https://github.com/openai/openai-ruby/commit/f603ff148798d0d47ee2caa7281dce30547cdbd6))
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Bug Fixes
|
|
14
|
+
|
|
15
|
+
* **api:** internal schema fixes ([261ed6a](https://github.com/openai/openai-ruby/commit/261ed6ab5feb33996169e812e419e0cd4c8d7174))
|
|
16
|
+
* **api:** manual updates ([4f10197](https://github.com/openai/openai-ruby/commit/4f10197e93eccd7e49537716879419db09a6c477))
|
|
17
|
+
* **api:** readd phase ([a78d02b](https://github.com/openai/openai-ruby/commit/a78d02b807f9282b7ba6b311c9205b9998735814))
|
|
18
|
+
* properly mock time in ruby ci tests ([b554a8b](https://github.com/openai/openai-ruby/commit/b554a8bec4642f7cd9a0f9f2837e43f665ed5415))
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
### Chores
|
|
22
|
+
|
|
23
|
+
* **internal:** codegen related update ([3f6d5be](https://github.com/openai/openai-ruby/commit/3f6d5be78f67be5680eb711f0f044cf6fc2d2c5e))
|
|
24
|
+
* **internal:** codegen related update ([356b20b](https://github.com/openai/openai-ruby/commit/356b20ba42eea108ed7f46ff867ef894745e9ee2))
|
|
25
|
+
* **internal:** reduce warnings ([c13a8a3](https://github.com/openai/openai-ruby/commit/c13a8a31ecda80a45880432915855a3be9f55f70))
|
|
26
|
+
|
|
3
27
|
## 0.51.0 (2026-02-24)
|
|
4
28
|
|
|
5
29
|
Full Changelog: [v0.50.0...v0.51.0](https://github.com/openai/openai-ruby/compare/v0.50.0...v0.51.0)
|
data/README.md
CHANGED
data/lib/openai/client.rb
CHANGED
|
@@ -27,27 +27,37 @@ module OpenAI
|
|
|
27
27
|
# @return [String, nil]
|
|
28
28
|
attr_reader :webhook_secret
|
|
29
29
|
|
|
30
|
+
# Given a prompt, the model will return one or more predicted completions, and can
|
|
31
|
+
# also return the probabilities of alternative tokens at each position.
|
|
30
32
|
# @return [OpenAI::Resources::Completions]
|
|
31
33
|
attr_reader :completions
|
|
32
34
|
|
|
33
35
|
# @return [OpenAI::Resources::Chat]
|
|
34
36
|
attr_reader :chat
|
|
35
37
|
|
|
38
|
+
# Get a vector representation of a given input that can be easily consumed by
|
|
39
|
+
# machine learning models and algorithms.
|
|
36
40
|
# @return [OpenAI::Resources::Embeddings]
|
|
37
41
|
attr_reader :embeddings
|
|
38
42
|
|
|
43
|
+
# Files are used to upload documents that can be used with features like
|
|
44
|
+
# Assistants and Fine-tuning.
|
|
39
45
|
# @return [OpenAI::Resources::Files]
|
|
40
46
|
attr_reader :files
|
|
41
47
|
|
|
48
|
+
# Given a prompt and/or an input image, the model will generate a new image.
|
|
42
49
|
# @return [OpenAI::Resources::Images]
|
|
43
50
|
attr_reader :images
|
|
44
51
|
|
|
45
52
|
# @return [OpenAI::Resources::Audio]
|
|
46
53
|
attr_reader :audio
|
|
47
54
|
|
|
55
|
+
# Given text and/or image inputs, classifies if those inputs are potentially
|
|
56
|
+
# harmful.
|
|
48
57
|
# @return [OpenAI::Resources::Moderations]
|
|
49
58
|
attr_reader :moderations
|
|
50
59
|
|
|
60
|
+
# List and describe the various models available in the API.
|
|
51
61
|
# @return [OpenAI::Resources::Models]
|
|
52
62
|
attr_reader :models
|
|
53
63
|
|
|
@@ -66,9 +76,11 @@ module OpenAI
|
|
|
66
76
|
# @return [OpenAI::Resources::Beta]
|
|
67
77
|
attr_reader :beta
|
|
68
78
|
|
|
79
|
+
# Create large batches of API requests to run asynchronously.
|
|
69
80
|
# @return [OpenAI::Resources::Batches]
|
|
70
81
|
attr_reader :batches
|
|
71
82
|
|
|
83
|
+
# Use Uploads to upload large files in multiple parts.
|
|
72
84
|
# @return [OpenAI::Resources::Uploads]
|
|
73
85
|
attr_reader :uploads
|
|
74
86
|
|
|
@@ -78,9 +90,11 @@ module OpenAI
|
|
|
78
90
|
# @return [OpenAI::Resources::Realtime]
|
|
79
91
|
attr_reader :realtime
|
|
80
92
|
|
|
93
|
+
# Manage conversations and conversation items.
|
|
81
94
|
# @return [OpenAI::Resources::Conversations]
|
|
82
95
|
attr_reader :conversations
|
|
83
96
|
|
|
97
|
+
# Manage and run evals in the OpenAI platform.
|
|
84
98
|
# @return [OpenAI::Resources::Evals]
|
|
85
99
|
attr_reader :evals
|
|
86
100
|
|
|
@@ -10,8 +10,8 @@ module OpenAI
|
|
|
10
10
|
# end
|
|
11
11
|
#
|
|
12
12
|
# @example
|
|
13
|
-
# conversation_cursor_page.auto_paging_each do |
|
|
14
|
-
# puts(
|
|
13
|
+
# conversation_cursor_page.auto_paging_each do |permission|
|
|
14
|
+
# puts(permission)
|
|
15
15
|
# end
|
|
16
16
|
class ConversationCursorPage
|
|
17
17
|
include OpenAI::Internal::Type::BasePage
|
|
@@ -19,11 +19,11 @@ module OpenAI
|
|
|
19
19
|
# @example
|
|
20
20
|
# # `chat_model` is a `OpenAI::ChatModel`
|
|
21
21
|
# case chat_model
|
|
22
|
-
# when OpenAI::ChatModel::
|
|
22
|
+
# when OpenAI::ChatModel::GPT_5_4
|
|
23
23
|
# # ...
|
|
24
|
-
# when OpenAI::ChatModel::
|
|
24
|
+
# when OpenAI::ChatModel::GPT_5_3_CHAT_LATEST
|
|
25
25
|
# # ...
|
|
26
|
-
# when OpenAI::ChatModel::
|
|
26
|
+
# when OpenAI::ChatModel::GPT_5_2
|
|
27
27
|
# # ...
|
|
28
28
|
# else
|
|
29
29
|
# puts(chat_model)
|
|
@@ -31,11 +31,11 @@ module OpenAI
|
|
|
31
31
|
#
|
|
32
32
|
# @example
|
|
33
33
|
# case chat_model
|
|
34
|
-
# in :"gpt-5.
|
|
34
|
+
# in :"gpt-5.4"
|
|
35
35
|
# # ...
|
|
36
|
-
# in :"gpt-5.
|
|
36
|
+
# in :"gpt-5.3-chat-latest"
|
|
37
37
|
# # ...
|
|
38
|
-
# in :"gpt-5.2
|
|
38
|
+
# in :"gpt-5.2"
|
|
39
39
|
# # ...
|
|
40
40
|
# else
|
|
41
41
|
# puts(chat_model)
|
data/lib/openai/internal/util.rb
CHANGED
|
@@ -490,6 +490,37 @@ module OpenAI
|
|
|
490
490
|
JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
|
|
491
491
|
|
|
492
492
|
class << self
|
|
493
|
+
# @api private
|
|
494
|
+
#
|
|
495
|
+
# @param query [Hash{Symbol=>Object}]
|
|
496
|
+
#
|
|
497
|
+
# @return [Hash{Symbol=>Object}]
|
|
498
|
+
def encode_query_params(query)
|
|
499
|
+
out = {}
|
|
500
|
+
query.each { write_query_param_element!(out, _1, _2) }
|
|
501
|
+
out
|
|
502
|
+
end
|
|
503
|
+
|
|
504
|
+
# @api private
|
|
505
|
+
#
|
|
506
|
+
# @param collection [Hash{Symbol=>Object}]
|
|
507
|
+
# @param key [String]
|
|
508
|
+
# @param element [Object]
|
|
509
|
+
#
|
|
510
|
+
# @return [nil]
|
|
511
|
+
private def write_query_param_element!(collection, key, element)
|
|
512
|
+
case element
|
|
513
|
+
in Hash
|
|
514
|
+
element.each do |name, value|
|
|
515
|
+
write_query_param_element!(collection, "#{key}[#{name}]", value)
|
|
516
|
+
end
|
|
517
|
+
in Array
|
|
518
|
+
collection["#{key}[]"] = element.map(&:to_s)
|
|
519
|
+
else
|
|
520
|
+
collection[key] = element.to_s
|
|
521
|
+
end
|
|
522
|
+
end
|
|
523
|
+
|
|
493
524
|
# @api private
|
|
494
525
|
#
|
|
495
526
|
# @param y [Enumerator::Yielder]
|
|
@@ -7,7 +7,13 @@ module OpenAI
|
|
|
7
7
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include OpenAI::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute batch_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :batch_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(batch_id:, request_options: {})
|
|
16
|
+
# @param batch_id [String]
|
|
11
17
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -7,7 +7,13 @@ module OpenAI
|
|
|
7
7
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include OpenAI::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute batch_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :batch_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(batch_id:, request_options: {})
|
|
16
|
+
# @param batch_id [String]
|
|
11
17
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -250,8 +250,9 @@ module OpenAI
|
|
|
250
250
|
|
|
251
251
|
# @!attribute file_ids
|
|
252
252
|
# A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to
|
|
253
|
-
# add to the vector store.
|
|
254
|
-
# store.
|
|
253
|
+
# add to the vector store. For vector stores created before Nov 2025, there can be
|
|
254
|
+
# a maximum of 10,000 files in a vector store. For vector stores created starting
|
|
255
|
+
# in Nov 2025, the limit is 100,000,000 files.
|
|
255
256
|
#
|
|
256
257
|
# @return [Array<String>, nil]
|
|
257
258
|
optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]
|
|
@@ -8,7 +8,13 @@ module OpenAI
|
|
|
8
8
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include OpenAI::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
-
# @!
|
|
11
|
+
# @!attribute assistant_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :assistant_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(assistant_id:, request_options: {})
|
|
17
|
+
# @param assistant_id [String]
|
|
12
18
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
13
19
|
end
|
|
14
20
|
end
|
|
@@ -8,7 +8,13 @@ module OpenAI
|
|
|
8
8
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include OpenAI::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
-
# @!
|
|
11
|
+
# @!attribute assistant_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :assistant_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(assistant_id:, request_options: {})
|
|
17
|
+
# @param assistant_id [String]
|
|
12
18
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
13
19
|
end
|
|
14
20
|
end
|
|
@@ -8,6 +8,11 @@ module OpenAI
|
|
|
8
8
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include OpenAI::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
# @!attribute assistant_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :assistant_id, String
|
|
15
|
+
|
|
11
16
|
# @!attribute description
|
|
12
17
|
# The description of the assistant. The maximum length is 512 characters.
|
|
13
18
|
#
|
|
@@ -126,10 +131,12 @@ module OpenAI
|
|
|
126
131
|
# @return [Float, nil]
|
|
127
132
|
optional :top_p, Float, nil?: true
|
|
128
133
|
|
|
129
|
-
# @!method initialize(description: nil, instructions: nil, metadata: nil, model: nil, name: nil, reasoning_effort: nil, response_format: nil, temperature: nil, tool_resources: nil, tools: nil, top_p: nil, request_options: {})
|
|
134
|
+
# @!method initialize(assistant_id:, description: nil, instructions: nil, metadata: nil, model: nil, name: nil, reasoning_effort: nil, response_format: nil, temperature: nil, tool_resources: nil, tools: nil, top_p: nil, request_options: {})
|
|
130
135
|
# Some parameter documentations has been truncated, see
|
|
131
136
|
# {OpenAI::Models::Beta::AssistantUpdateParams} for more details.
|
|
132
137
|
#
|
|
138
|
+
# @param assistant_id [String]
|
|
139
|
+
#
|
|
133
140
|
# @param description [String, nil] The description of the assistant. The maximum length is 512 characters.
|
|
134
141
|
#
|
|
135
142
|
# @param instructions [String, nil] The system instructions that the assistant uses. The maximum length is 256,000 c
|
|
@@ -9,7 +9,13 @@ module OpenAI
|
|
|
9
9
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
10
10
|
include OpenAI::Internal::Type::RequestParameters
|
|
11
11
|
|
|
12
|
-
# @!
|
|
12
|
+
# @!attribute session_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :session_id, String
|
|
16
|
+
|
|
17
|
+
# @!method initialize(session_id:, request_options: {})
|
|
18
|
+
# @param session_id [String]
|
|
13
19
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
14
20
|
end
|
|
15
21
|
end
|
|
@@ -9,7 +9,13 @@ module OpenAI
|
|
|
9
9
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
10
10
|
include OpenAI::Internal::Type::RequestParameters
|
|
11
11
|
|
|
12
|
-
# @!
|
|
12
|
+
# @!attribute thread_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :thread_id, String
|
|
16
|
+
|
|
17
|
+
# @!method initialize(thread_id:, request_options: {})
|
|
18
|
+
# @param thread_id [String]
|
|
13
19
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
14
20
|
end
|
|
15
21
|
end
|
|
@@ -9,6 +9,11 @@ module OpenAI
|
|
|
9
9
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
10
10
|
include OpenAI::Internal::Type::RequestParameters
|
|
11
11
|
|
|
12
|
+
# @!attribute thread_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :thread_id, String
|
|
16
|
+
|
|
12
17
|
# @!attribute after
|
|
13
18
|
# List items created after this thread item ID. Defaults to null for the first
|
|
14
19
|
# page.
|
|
@@ -35,10 +40,12 @@ module OpenAI
|
|
|
35
40
|
# @return [Symbol, OpenAI::Models::Beta::ChatKit::ThreadListItemsParams::Order, nil]
|
|
36
41
|
optional :order, enum: -> { OpenAI::Beta::ChatKit::ThreadListItemsParams::Order }
|
|
37
42
|
|
|
38
|
-
# @!method initialize(after: nil, before: nil, limit: nil, order: nil, request_options: {})
|
|
43
|
+
# @!method initialize(thread_id:, after: nil, before: nil, limit: nil, order: nil, request_options: {})
|
|
39
44
|
# Some parameter documentations has been truncated, see
|
|
40
45
|
# {OpenAI::Models::Beta::ChatKit::ThreadListItemsParams} for more details.
|
|
41
46
|
#
|
|
47
|
+
# @param thread_id [String]
|
|
48
|
+
#
|
|
42
49
|
# @param after [String] List items created after this thread item ID. Defaults to null for the first pag
|
|
43
50
|
#
|
|
44
51
|
# @param before [String] List items created before this thread item ID. Defaults to null for the newest r
|
|
@@ -9,7 +9,13 @@ module OpenAI
|
|
|
9
9
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
10
10
|
include OpenAI::Internal::Type::RequestParameters
|
|
11
11
|
|
|
12
|
-
# @!
|
|
12
|
+
# @!attribute thread_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :thread_id, String
|
|
16
|
+
|
|
17
|
+
# @!method initialize(thread_id:, request_options: {})
|
|
18
|
+
# @param thread_id [String]
|
|
13
19
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
14
20
|
end
|
|
15
21
|
end
|
|
@@ -479,8 +479,9 @@ module OpenAI
|
|
|
479
479
|
|
|
480
480
|
# @!attribute file_ids
|
|
481
481
|
# A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to
|
|
482
|
-
# add to the vector store.
|
|
483
|
-
# store.
|
|
482
|
+
# add to the vector store. For vector stores created before Nov 2025, there can be
|
|
483
|
+
# a maximum of 10,000 files in a vector store. For vector stores created starting
|
|
484
|
+
# in Nov 2025, the limit is 100,000,000 files.
|
|
484
485
|
#
|
|
485
486
|
# @return [Array<String>, nil]
|
|
486
487
|
optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]
|
|
@@ -260,8 +260,9 @@ module OpenAI
|
|
|
260
260
|
|
|
261
261
|
# @!attribute file_ids
|
|
262
262
|
# A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to
|
|
263
|
-
# add to the vector store.
|
|
264
|
-
# store.
|
|
263
|
+
# add to the vector store. For vector stores created before Nov 2025, there can be
|
|
264
|
+
# a maximum of 10,000 files in a vector store. For vector stores created starting
|
|
265
|
+
# in Nov 2025, the limit is 100,000,000 files.
|
|
265
266
|
#
|
|
266
267
|
# @return [Array<String>, nil]
|
|
267
268
|
optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]
|
|
@@ -8,7 +8,13 @@ module OpenAI
|
|
|
8
8
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include OpenAI::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
-
# @!
|
|
11
|
+
# @!attribute thread_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :thread_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(thread_id:, request_options: {})
|
|
17
|
+
# @param thread_id [String]
|
|
12
18
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
13
19
|
end
|
|
14
20
|
end
|
|
@@ -8,7 +8,13 @@ module OpenAI
|
|
|
8
8
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include OpenAI::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
-
# @!
|
|
11
|
+
# @!attribute thread_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :thread_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(thread_id:, request_options: {})
|
|
17
|
+
# @param thread_id [String]
|
|
12
18
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
13
19
|
end
|
|
14
20
|
end
|
|
@@ -8,6 +8,11 @@ module OpenAI
|
|
|
8
8
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include OpenAI::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
# @!attribute thread_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :thread_id, String
|
|
15
|
+
|
|
11
16
|
# @!attribute metadata
|
|
12
17
|
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
13
18
|
# for storing additional information about the object in a structured format, and
|
|
@@ -28,10 +33,12 @@ module OpenAI
|
|
|
28
33
|
# @return [OpenAI::Models::Beta::ThreadUpdateParams::ToolResources, nil]
|
|
29
34
|
optional :tool_resources, -> { OpenAI::Beta::ThreadUpdateParams::ToolResources }, nil?: true
|
|
30
35
|
|
|
31
|
-
# @!method initialize(metadata: nil, tool_resources: nil, request_options: {})
|
|
36
|
+
# @!method initialize(thread_id:, metadata: nil, tool_resources: nil, request_options: {})
|
|
32
37
|
# Some parameter documentations has been truncated, see
|
|
33
38
|
# {OpenAI::Models::Beta::ThreadUpdateParams} for more details.
|
|
34
39
|
#
|
|
40
|
+
# @param thread_id [String]
|
|
41
|
+
#
|
|
35
42
|
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
|
|
36
43
|
#
|
|
37
44
|
# @param tool_resources [OpenAI::Models::Beta::ThreadUpdateParams::ToolResources, nil] A set of resources that are made available to the assistant's tools in this thre
|
|
@@ -9,6 +9,11 @@ module OpenAI
|
|
|
9
9
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
10
10
|
include OpenAI::Internal::Type::RequestParameters
|
|
11
11
|
|
|
12
|
+
# @!attribute thread_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :thread_id, String
|
|
16
|
+
|
|
12
17
|
# @!attribute content
|
|
13
18
|
# The text contents of the message.
|
|
14
19
|
#
|
|
@@ -47,10 +52,12 @@ module OpenAI
|
|
|
47
52
|
# @return [Hash{Symbol=>String}, nil]
|
|
48
53
|
optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
|
|
49
54
|
|
|
50
|
-
# @!method initialize(content:, role:, attachments: nil, metadata: nil, request_options: {})
|
|
55
|
+
# @!method initialize(thread_id:, content:, role:, attachments: nil, metadata: nil, request_options: {})
|
|
51
56
|
# Some parameter documentations has been truncated, see
|
|
52
57
|
# {OpenAI::Models::Beta::Threads::MessageCreateParams} for more details.
|
|
53
58
|
#
|
|
59
|
+
# @param thread_id [String]
|
|
60
|
+
#
|
|
54
61
|
# @param content [String, Array<OpenAI::Models::Beta::Threads::ImageFileContentBlock, OpenAI::Models::Beta::Threads::ImageURLContentBlock, OpenAI::Models::Beta::Threads::TextContentBlockParam>] The text contents of the message.
|
|
55
62
|
#
|
|
56
63
|
# @param role [Symbol, OpenAI::Models::Beta::Threads::MessageCreateParams::Role] The role of the entity that is creating the message. Allowed values include:
|
|
@@ -14,8 +14,14 @@ module OpenAI
|
|
|
14
14
|
# @return [String]
|
|
15
15
|
required :thread_id, String
|
|
16
16
|
|
|
17
|
-
# @!
|
|
17
|
+
# @!attribute message_id
|
|
18
|
+
#
|
|
19
|
+
# @return [String]
|
|
20
|
+
required :message_id, String
|
|
21
|
+
|
|
22
|
+
# @!method initialize(thread_id:, message_id:, request_options: {})
|
|
18
23
|
# @param thread_id [String]
|
|
24
|
+
# @param message_id [String]
|
|
19
25
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
20
26
|
end
|
|
21
27
|
end
|
|
@@ -9,6 +9,11 @@ module OpenAI
|
|
|
9
9
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
10
10
|
include OpenAI::Internal::Type::RequestParameters
|
|
11
11
|
|
|
12
|
+
# @!attribute thread_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :thread_id, String
|
|
16
|
+
|
|
12
17
|
# @!attribute after
|
|
13
18
|
# A cursor for use in pagination. `after` is an object ID that defines your place
|
|
14
19
|
# in the list. For instance, if you make a list request and receive 100 objects,
|
|
@@ -47,10 +52,12 @@ module OpenAI
|
|
|
47
52
|
# @return [String, nil]
|
|
48
53
|
optional :run_id, String
|
|
49
54
|
|
|
50
|
-
# @!method initialize(after: nil, before: nil, limit: nil, order: nil, run_id: nil, request_options: {})
|
|
55
|
+
# @!method initialize(thread_id:, after: nil, before: nil, limit: nil, order: nil, run_id: nil, request_options: {})
|
|
51
56
|
# Some parameter documentations has been truncated, see
|
|
52
57
|
# {OpenAI::Models::Beta::Threads::MessageListParams} for more details.
|
|
53
58
|
#
|
|
59
|
+
# @param thread_id [String]
|
|
60
|
+
#
|
|
54
61
|
# @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
|
|
55
62
|
#
|
|
56
63
|
# @param before [String] A cursor for use in pagination. `before` is an object ID that defines your place
|
|
@@ -14,8 +14,14 @@ module OpenAI
|
|
|
14
14
|
# @return [String]
|
|
15
15
|
required :thread_id, String
|
|
16
16
|
|
|
17
|
-
# @!
|
|
17
|
+
# @!attribute message_id
|
|
18
|
+
#
|
|
19
|
+
# @return [String]
|
|
20
|
+
required :message_id, String
|
|
21
|
+
|
|
22
|
+
# @!method initialize(thread_id:, message_id:, request_options: {})
|
|
18
23
|
# @param thread_id [String]
|
|
24
|
+
# @param message_id [String]
|
|
19
25
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
20
26
|
end
|
|
21
27
|
end
|
|
@@ -14,6 +14,11 @@ module OpenAI
|
|
|
14
14
|
# @return [String]
|
|
15
15
|
required :thread_id, String
|
|
16
16
|
|
|
17
|
+
# @!attribute message_id
|
|
18
|
+
#
|
|
19
|
+
# @return [String]
|
|
20
|
+
required :message_id, String
|
|
21
|
+
|
|
17
22
|
# @!attribute metadata
|
|
18
23
|
# Set of 16 key-value pairs that can be attached to an object. This can be useful
|
|
19
24
|
# for storing additional information about the object in a structured format, and
|
|
@@ -25,12 +30,14 @@ module OpenAI
|
|
|
25
30
|
# @return [Hash{Symbol=>String}, nil]
|
|
26
31
|
optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
|
|
27
32
|
|
|
28
|
-
# @!method initialize(thread_id:, metadata: nil, request_options: {})
|
|
33
|
+
# @!method initialize(thread_id:, message_id:, metadata: nil, request_options: {})
|
|
29
34
|
# Some parameter documentations has been truncated, see
|
|
30
35
|
# {OpenAI::Models::Beta::Threads::MessageUpdateParams} for more details.
|
|
31
36
|
#
|
|
32
37
|
# @param thread_id [String]
|
|
33
38
|
#
|
|
39
|
+
# @param message_id [String]
|
|
40
|
+
#
|
|
34
41
|
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
|
|
35
42
|
#
|
|
36
43
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -14,8 +14,14 @@ module OpenAI
|
|
|
14
14
|
# @return [String]
|
|
15
15
|
required :thread_id, String
|
|
16
16
|
|
|
17
|
-
# @!
|
|
17
|
+
# @!attribute run_id
|
|
18
|
+
#
|
|
19
|
+
# @return [String]
|
|
20
|
+
required :run_id, String
|
|
21
|
+
|
|
22
|
+
# @!method initialize(thread_id:, run_id:, request_options: {})
|
|
18
23
|
# @param thread_id [String]
|
|
24
|
+
# @param run_id [String]
|
|
19
25
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
20
26
|
end
|
|
21
27
|
end
|
|
@@ -11,6 +11,11 @@ module OpenAI
|
|
|
11
11
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
12
12
|
include OpenAI::Internal::Type::RequestParameters
|
|
13
13
|
|
|
14
|
+
# @!attribute thread_id
|
|
15
|
+
#
|
|
16
|
+
# @return [String]
|
|
17
|
+
required :thread_id, String
|
|
18
|
+
|
|
14
19
|
# @!attribute assistant_id
|
|
15
20
|
# The ID of the
|
|
16
21
|
# [assistant](https://platform.openai.com/docs/api-reference/assistants) to use to
|
|
@@ -199,10 +204,12 @@ module OpenAI
|
|
|
199
204
|
-> { OpenAI::Beta::Threads::RunCreateParams::TruncationStrategy },
|
|
200
205
|
nil?: true
|
|
201
206
|
|
|
202
|
-
# @!method initialize(assistant_id:, include: nil, additional_instructions: nil, additional_messages: nil, instructions: nil, max_completion_tokens: nil, max_prompt_tokens: nil, metadata: nil, model: nil, parallel_tool_calls: nil, reasoning_effort: nil, response_format: nil, temperature: nil, tool_choice: nil, tools: nil, top_p: nil, truncation_strategy: nil, request_options: {})
|
|
207
|
+
# @!method initialize(thread_id:, assistant_id:, include: nil, additional_instructions: nil, additional_messages: nil, instructions: nil, max_completion_tokens: nil, max_prompt_tokens: nil, metadata: nil, model: nil, parallel_tool_calls: nil, reasoning_effort: nil, response_format: nil, temperature: nil, tool_choice: nil, tools: nil, top_p: nil, truncation_strategy: nil, request_options: {})
|
|
203
208
|
# Some parameter documentations has been truncated, see
|
|
204
209
|
# {OpenAI::Models::Beta::Threads::RunCreateParams} for more details.
|
|
205
210
|
#
|
|
211
|
+
# @param thread_id [String]
|
|
212
|
+
#
|
|
206
213
|
# @param assistant_id [String] The ID of the [assistant](https://platform.openai.com/docs/api-reference/assista
|
|
207
214
|
#
|
|
208
215
|
# @param include [Array<Symbol, OpenAI::Models::Beta::Threads::Runs::RunStepInclude>] A list of additional fields to include in the response. Currently the only suppo
|
|
@@ -9,6 +9,11 @@ module OpenAI
|
|
|
9
9
|
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
10
10
|
include OpenAI::Internal::Type::RequestParameters
|
|
11
11
|
|
|
12
|
+
# @!attribute thread_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :thread_id, String
|
|
16
|
+
|
|
12
17
|
# @!attribute after
|
|
13
18
|
# A cursor for use in pagination. `after` is an object ID that defines your place
|
|
14
19
|
# in the list. For instance, if you make a list request and receive 100 objects,
|
|
@@ -41,10 +46,12 @@ module OpenAI
|
|
|
41
46
|
# @return [Symbol, OpenAI::Models::Beta::Threads::RunListParams::Order, nil]
|
|
42
47
|
optional :order, enum: -> { OpenAI::Beta::Threads::RunListParams::Order }
|
|
43
48
|
|
|
44
|
-
# @!method initialize(after: nil, before: nil, limit: nil, order: nil, request_options: {})
|
|
49
|
+
# @!method initialize(thread_id:, after: nil, before: nil, limit: nil, order: nil, request_options: {})
|
|
45
50
|
# Some parameter documentations has been truncated, see
|
|
46
51
|
# {OpenAI::Models::Beta::Threads::RunListParams} for more details.
|
|
47
52
|
#
|
|
53
|
+
# @param thread_id [String]
|
|
54
|
+
#
|
|
48
55
|
# @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
|
|
49
56
|
#
|
|
50
57
|
# @param before [String] A cursor for use in pagination. `before` is an object ID that defines your place
|