openai 0.68.0 → 0.69.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 +23 -0
- data/README.md +7 -7
- data/lib/openai/internal/type/enum.rb +6 -6
- data/lib/openai/internal/util.rb +14 -2
- data/lib/openai/models/beta/assistant_create_params.rb +7 -14
- data/lib/openai/models/beta/assistant_update_params.rb +7 -14
- data/lib/openai/models/beta/beta_apply_patch_tool.rb +44 -0
- data/lib/openai/models/beta/beta_compacted_response.rb +58 -0
- data/lib/openai/models/beta/beta_computer_action.rb +398 -0
- data/lib/openai/models/beta/beta_computer_action_list.rb +13 -0
- data/lib/openai/models/beta/beta_computer_tool.rb +23 -0
- data/lib/openai/models/beta/beta_computer_use_preview_tool.rb +63 -0
- data/lib/openai/models/beta/beta_container_auto.rb +96 -0
- data/lib/openai/models/beta/beta_container_network_policy_allowlist.rb +37 -0
- data/lib/openai/models/beta/beta_container_network_policy_disabled.rb +20 -0
- data/lib/openai/models/beta/beta_container_network_policy_domain_secret.rb +36 -0
- data/lib/openai/models/beta/beta_container_reference.rb +28 -0
- data/lib/openai/models/beta/beta_custom_tool.rb +148 -0
- data/lib/openai/models/beta/beta_easy_input_message.rb +120 -0
- data/lib/openai/models/beta/beta_file_search_tool.rb +424 -0
- data/lib/openai/models/beta/beta_function_shell_tool.rb +67 -0
- data/lib/openai/models/beta/beta_function_tool.rb +97 -0
- data/lib/openai/models/beta/beta_inline_skill.rb +44 -0
- data/lib/openai/models/beta/beta_inline_skill_source.rb +38 -0
- data/lib/openai/models/beta/beta_local_environment.rb +28 -0
- data/lib/openai/models/beta/beta_local_skill.rb +36 -0
- data/lib/openai/models/beta/beta_namespace_tool.rb +146 -0
- data/lib/openai/models/beta/beta_response.rb +1425 -0
- data/lib/openai/models/beta/beta_response_apply_patch_tool_call.rb +258 -0
- data/lib/openai/models/beta/beta_response_apply_patch_tool_call_output.rb +156 -0
- data/lib/openai/models/beta/beta_response_audio_delta_event.rb +63 -0
- data/lib/openai/models/beta/beta_response_audio_done_event.rb +55 -0
- data/lib/openai/models/beta/beta_response_audio_transcript_delta_event.rb +63 -0
- data/lib/openai/models/beta/beta_response_audio_transcript_done_event.rb +55 -0
- data/lib/openai/models/beta/beta_response_code_interpreter_call_code_delta_event.rb +81 -0
- data/lib/openai/models/beta/beta_response_code_interpreter_call_code_done_event.rb +76 -0
- data/lib/openai/models/beta/beta_response_code_interpreter_call_completed_event.rb +73 -0
- data/lib/openai/models/beta/beta_response_code_interpreter_call_in_progress_event.rb +77 -0
- data/lib/openai/models/beta/beta_response_code_interpreter_call_interpreting_event.rb +77 -0
- data/lib/openai/models/beta/beta_response_code_interpreter_tool_call.rb +168 -0
- data/lib/openai/models/beta/beta_response_compaction_item.rb +69 -0
- data/lib/openai/models/beta/beta_response_compaction_item_param.rb +61 -0
- data/lib/openai/models/beta/beta_response_completed_event.rb +63 -0
- data/lib/openai/models/beta/beta_response_computer_tool_call.rb +156 -0
- data/lib/openai/models/beta/beta_response_computer_tool_call_output_item.rb +141 -0
- data/lib/openai/models/beta/beta_response_computer_tool_call_output_screenshot.rb +43 -0
- data/lib/openai/models/beta/beta_response_container_reference.rb +29 -0
- data/lib/openai/models/beta/beta_response_content.rb +56 -0
- data/lib/openai/models/beta/beta_response_content_part_added_event.rb +129 -0
- data/lib/openai/models/beta/beta_response_content_part_done_event.rb +129 -0
- data/lib/openai/models/beta/beta_response_conversation_param.rb +22 -0
- data/lib/openai/models/beta/beta_response_created_event.rb +63 -0
- data/lib/openai/models/beta/beta_response_custom_tool_call.rb +142 -0
- data/lib/openai/models/beta/beta_response_custom_tool_call_input_delta_event.rb +76 -0
- data/lib/openai/models/beta/beta_response_custom_tool_call_input_done_event.rb +76 -0
- data/lib/openai/models/beta/beta_response_custom_tool_call_item.rb +55 -0
- data/lib/openai/models/beta/beta_response_custom_tool_call_output.rb +171 -0
- data/lib/openai/models/beta/beta_response_custom_tool_call_output_item.rb +55 -0
- data/lib/openai/models/beta/beta_response_error.rb +63 -0
- data/lib/openai/models/beta/beta_response_error_event.rb +79 -0
- data/lib/openai/models/beta/beta_response_failed_event.rb +63 -0
- data/lib/openai/models/beta/beta_response_file_search_call_completed_event.rb +72 -0
- data/lib/openai/models/beta/beta_response_file_search_call_in_progress_event.rb +72 -0
- data/lib/openai/models/beta/beta_response_file_search_call_searching_event.rb +72 -0
- data/lib/openai/models/beta/beta_response_file_search_tool_call.rb +168 -0
- data/lib/openai/models/beta/beta_response_format_text_config.rb +72 -0
- data/lib/openai/models/beta/beta_response_format_text_json_schema_config.rb +66 -0
- data/lib/openai/models/beta/beta_response_function_call_arguments_delta_event.rb +80 -0
- data/lib/openai/models/beta/beta_response_function_call_arguments_done_event.rb +83 -0
- data/lib/openai/models/beta/beta_response_function_call_output_item.rb +28 -0
- data/lib/openai/models/beta/beta_response_function_call_output_item_list.rb +14 -0
- data/lib/openai/models/beta/beta_response_function_shell_call_output_content.rb +90 -0
- data/lib/openai/models/beta/beta_response_function_shell_tool_call.rb +216 -0
- data/lib/openai/models/beta/beta_response_function_shell_tool_call_output.rb +265 -0
- data/lib/openai/models/beta/beta_response_function_tool_call.rb +168 -0
- data/lib/openai/models/beta/beta_response_function_tool_call_item.rb +57 -0
- data/lib/openai/models/beta/beta_response_function_tool_call_output_item.rb +201 -0
- data/lib/openai/models/beta/beta_response_function_web_search.rb +238 -0
- data/lib/openai/models/beta/beta_response_image_gen_call_completed_event.rb +69 -0
- data/lib/openai/models/beta/beta_response_image_gen_call_generating_event.rb +69 -0
- data/lib/openai/models/beta/beta_response_image_gen_call_in_progress_event.rb +68 -0
- data/lib/openai/models/beta/beta_response_image_gen_call_partial_image_event.rb +89 -0
- data/lib/openai/models/beta/beta_response_in_progress_event.rb +63 -0
- data/lib/openai/models/beta/beta_response_includable.rb +45 -0
- data/lib/openai/models/beta/beta_response_incomplete_event.rb +63 -0
- data/lib/openai/models/beta/beta_response_inject_created_event.rb +51 -0
- data/lib/openai/models/beta/beta_response_inject_event.rb +40 -0
- data/lib/openai/models/beta/beta_response_inject_failed_event.rb +103 -0
- data/lib/openai/models/beta/beta_response_input.rb +13 -0
- data/lib/openai/models/beta/beta_response_input_audio.rb +70 -0
- data/lib/openai/models/beta/beta_response_input_content.rb +28 -0
- data/lib/openai/models/beta/beta_response_input_file.rb +113 -0
- data/lib/openai/models/beta/beta_response_input_file_content.rb +115 -0
- data/lib/openai/models/beta/beta_response_input_image.rb +94 -0
- data/lib/openai/models/beta/beta_response_input_image_content.rb +96 -0
- data/lib/openai/models/beta/beta_response_input_item.rb +2819 -0
- data/lib/openai/models/beta/beta_response_input_message_content_list.rb +14 -0
- data/lib/openai/models/beta/beta_response_input_message_item.rb +108 -0
- data/lib/openai/models/beta/beta_response_input_text.rb +59 -0
- data/lib/openai/models/beta/beta_response_input_text_content.rb +61 -0
- data/lib/openai/models/beta/beta_response_item.rb +1438 -0
- data/lib/openai/models/beta/beta_response_local_environment.rb +22 -0
- data/lib/openai/models/beta/beta_response_mcp_call_arguments_delta_event.rb +81 -0
- data/lib/openai/models/beta/beta_response_mcp_call_arguments_done_event.rb +79 -0
- data/lib/openai/models/beta/beta_response_mcp_call_completed_event.rb +68 -0
- data/lib/openai/models/beta/beta_response_mcp_call_failed_event.rb +68 -0
- data/lib/openai/models/beta/beta_response_mcp_call_in_progress_event.rb +68 -0
- data/lib/openai/models/beta/beta_response_mcp_list_tools_completed_event.rb +68 -0
- data/lib/openai/models/beta/beta_response_mcp_list_tools_failed_event.rb +68 -0
- data/lib/openai/models/beta/beta_response_mcp_list_tools_in_progress_event.rb +69 -0
- data/lib/openai/models/beta/beta_response_output_audio.rb +41 -0
- data/lib/openai/models/beta/beta_response_output_item.rb +1444 -0
- data/lib/openai/models/beta/beta_response_output_item_added_event.rb +71 -0
- data/lib/openai/models/beta/beta_response_output_item_done_event.rb +71 -0
- data/lib/openai/models/beta/beta_response_output_message.rb +139 -0
- data/lib/openai/models/beta/beta_response_output_refusal.rb +30 -0
- data/lib/openai/models/beta/beta_response_output_text.rb +292 -0
- data/lib/openai/models/beta/beta_response_output_text_annotation_added_event.rb +92 -0
- data/lib/openai/models/beta/beta_response_prompt.rb +65 -0
- data/lib/openai/models/beta/beta_response_queued_event.rb +60 -0
- data/lib/openai/models/beta/beta_response_reasoning_item.rb +151 -0
- data/lib/openai/models/beta/beta_response_reasoning_summary_part_added_event.rb +110 -0
- data/lib/openai/models/beta/beta_response_reasoning_summary_part_done_event.rb +132 -0
- data/lib/openai/models/beta/beta_response_reasoning_summary_text_delta_event.rb +88 -0
- data/lib/openai/models/beta/beta_response_reasoning_summary_text_done_event.rb +88 -0
- data/lib/openai/models/beta/beta_response_reasoning_text_delta_event.rb +87 -0
- data/lib/openai/models/beta/beta_response_reasoning_text_done_event.rb +87 -0
- data/lib/openai/models/beta/beta_response_refusal_delta_event.rb +87 -0
- data/lib/openai/models/beta/beta_response_refusal_done_event.rb +87 -0
- data/lib/openai/models/beta/beta_response_status.rb +25 -0
- data/lib/openai/models/beta/beta_response_stream_event.rb +203 -0
- data/lib/openai/models/beta/beta_response_text_config.rb +67 -0
- data/lib/openai/models/beta/beta_response_text_delta_event.rb +150 -0
- data/lib/openai/models/beta/beta_response_text_done_event.rb +150 -0
- data/lib/openai/models/beta/beta_response_tool_search_call.rb +117 -0
- data/lib/openai/models/beta/beta_response_tool_search_output_item.rb +117 -0
- data/lib/openai/models/beta/beta_response_tool_search_output_item_param.rb +109 -0
- data/lib/openai/models/beta/beta_response_usage.rb +95 -0
- data/lib/openai/models/beta/beta_response_web_search_call_completed_event.rb +72 -0
- data/lib/openai/models/beta/beta_response_web_search_call_in_progress_event.rb +72 -0
- data/lib/openai/models/beta/beta_response_web_search_call_searching_event.rb +72 -0
- data/lib/openai/models/beta/beta_responses_client_event.rb +1432 -0
- data/lib/openai/models/beta/beta_responses_server_event.rb +212 -0
- data/lib/openai/models/beta/beta_skill_reference.rb +36 -0
- data/lib/openai/models/beta/beta_tool.rb +910 -0
- data/lib/openai/models/beta/beta_tool_choice_allowed.rb +75 -0
- data/lib/openai/models/beta/beta_tool_choice_apply_patch.rb +22 -0
- data/lib/openai/models/beta/beta_tool_choice_custom.rb +30 -0
- data/lib/openai/models/beta/beta_tool_choice_function.rb +30 -0
- data/lib/openai/models/beta/beta_tool_choice_mcp.rb +42 -0
- data/lib/openai/models/beta/beta_tool_choice_options.rb +28 -0
- data/lib/openai/models/beta/beta_tool_choice_shell.rb +22 -0
- data/lib/openai/models/beta/beta_tool_choice_types.rb +67 -0
- data/lib/openai/models/beta/beta_tool_search_tool.rb +59 -0
- data/lib/openai/models/beta/beta_web_search_preview_tool.rb +143 -0
- data/lib/openai/models/beta/beta_web_search_tool.rb +162 -0
- data/lib/openai/models/beta/response_cancel_params.rb +37 -0
- data/lib/openai/models/beta/response_compact_params.rb +549 -0
- data/lib/openai/models/beta/response_create_params.rb +1343 -0
- data/lib/openai/models/beta/response_delete_params.rb +37 -0
- data/lib/openai/models/beta/response_retrieve_params.rb +74 -0
- data/lib/openai/models/beta/responses/beta_response_item_list.rb +54 -0
- data/lib/openai/models/beta/responses/input_item_list_params.rb +96 -0
- data/lib/openai/models/beta/responses/input_token_count_params.rb +542 -0
- data/lib/openai/models/beta/responses/input_token_count_response.rb +26 -0
- data/lib/openai/models/beta/threads/run_create_params.rb +7 -14
- data/lib/openai/models/chat/chat_completion_content_part.rb +31 -1
- data/lib/openai/models/chat/chat_completion_content_part_image.rb +31 -1
- data/lib/openai/models/chat/chat_completion_content_part_input_audio.rb +31 -1
- data/lib/openai/models/chat/chat_completion_content_part_text.rb +31 -1
- data/lib/openai/models/chat/completion_create_params.rb +200 -19
- data/lib/openai/models/chat_model.rb +3 -0
- data/lib/openai/models/completion_usage.rb +9 -1
- data/lib/openai/models/conversations/computer_screenshot_content.rb +28 -1
- data/lib/openai/models/conversations/conversation_create_params.rb +2 -2
- data/lib/openai/models/conversations/conversation_item.rb +106 -3
- data/lib/openai/models/conversations/conversation_item_list.rb +2 -2
- data/lib/openai/models/conversations/item_create_params.rb +2 -2
- data/lib/openai/models/evals/create_eval_completions_run_data_source.rb +7 -14
- data/lib/openai/models/evals/run_cancel_response.rb +16 -30
- data/lib/openai/models/evals/run_create_params.rb +16 -30
- data/lib/openai/models/evals/run_create_response.rb +16 -30
- data/lib/openai/models/evals/run_list_response.rb +16 -30
- data/lib/openai/models/evals/run_retrieve_response.rb +16 -30
- data/lib/openai/models/graders/score_model_grader.rb +7 -14
- data/lib/openai/models/realtime/realtime_response_create_mcp_tool.rb +23 -1
- data/lib/openai/models/realtime/realtime_session_create_request.rb +6 -0
- data/lib/openai/models/realtime/realtime_session_create_response.rb +29 -1
- data/lib/openai/models/realtime/realtime_tools_config_union.rb +23 -1
- data/lib/openai/models/reasoning.rb +47 -15
- data/lib/openai/models/reasoning_effort.rb +7 -13
- data/lib/openai/models/responses/apply_patch_tool.rb +23 -1
- data/lib/openai/models/responses/compacted_response.rb +2 -2
- data/lib/openai/models/responses/custom_tool.rb +21 -1
- data/lib/openai/models/responses/function_shell_tool.rb +23 -1
- data/lib/openai/models/responses/function_tool.rb +32 -3
- data/lib/openai/models/responses/input_token_count_params.rb +21 -8
- data/lib/openai/models/responses/namespace_tool.rb +41 -2
- data/lib/openai/models/responses/response.rb +98 -14
- data/lib/openai/models/responses/response_apply_patch_tool_call.rb +56 -1
- data/lib/openai/models/responses/response_apply_patch_tool_call_output.rb +56 -1
- data/lib/openai/models/responses/response_compact_params.rb +107 -4
- data/lib/openai/models/responses/response_create_params.rb +214 -13
- data/lib/openai/models/responses/response_custom_tool_call.rb +56 -1
- data/lib/openai/models/responses/response_custom_tool_call_output.rb +58 -1
- data/lib/openai/models/responses/response_error.rb +1 -0
- data/lib/openai/models/responses/response_function_shell_tool_call.rb +56 -1
- data/lib/openai/models/responses/response_function_shell_tool_call_output.rb +56 -1
- data/lib/openai/models/responses/response_function_tool_call.rb +56 -1
- data/lib/openai/models/responses/response_function_tool_call_output_item.rb +58 -1
- data/lib/openai/models/responses/response_input_file.rb +39 -8
- data/lib/openai/models/responses/response_input_file_content.rb +41 -8
- data/lib/openai/models/responses/response_input_image.rb +27 -1
- data/lib/openai/models/responses/response_input_image_content.rb +29 -1
- data/lib/openai/models/responses/response_input_item.rb +396 -8
- data/lib/openai/models/responses/response_input_text.rb +30 -1
- data/lib/openai/models/responses/response_input_text_content.rb +32 -1
- data/lib/openai/models/responses/response_item.rb +106 -3
- data/lib/openai/models/responses/response_item_list.rb +2 -2
- data/lib/openai/models/responses/response_output_item.rb +106 -3
- 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_reasoning_summary_part_done_event.rb +23 -1
- data/lib/openai/models/responses/response_tool_search_output_item.rb +2 -2
- data/lib/openai/models/responses/response_tool_search_output_item_param.rb +2 -2
- data/lib/openai/models/responses/response_usage.rb +9 -1
- data/lib/openai/models/responses/responses_client_event.rb +215 -13
- data/lib/openai/models/responses/tool.rb +58 -3
- data/lib/openai/models/webhooks/safety_identifier_blocked_webhook_event.rb +118 -0
- data/lib/openai/models/webhooks/unwrap_webhook_event.rb +4 -1
- data/lib/openai/resources/beta/assistants.rb +2 -2
- data/lib/openai/resources/beta/responses/input_items.rb +58 -0
- data/lib/openai/resources/beta/responses/input_tokens.rb +73 -0
- data/lib/openai/resources/beta/responses.rb +440 -0
- data/lib/openai/resources/beta/threads/runs.rb +2 -2
- data/lib/openai/resources/beta.rb +4 -0
- data/lib/openai/resources/chat/completions.rb +10 -6
- data/lib/openai/resources/conversations/items.rb +3 -3
- data/lib/openai/resources/conversations.rb +1 -1
- data/lib/openai/resources/responses/input_items.rb +1 -1
- data/lib/openai/resources/responses/input_tokens.rb +3 -3
- data/lib/openai/resources/responses.rb +22 -12
- data/lib/openai/resources/webhooks.rb +1 -1
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +163 -0
- data/rbi/openai/models/beta/assistant_create_params.rbi +12 -26
- data/rbi/openai/models/beta/assistant_update_params.rbi +12 -26
- data/rbi/openai/models/beta/beta_apply_patch_tool.rbi +99 -0
- data/rbi/openai/models/beta/beta_compacted_response.rbi +120 -0
- data/rbi/openai/models/beta/beta_computer_action.rbi +593 -0
- data/rbi/openai/models/beta/beta_computer_action_list.rbi +18 -0
- data/rbi/openai/models/beta/beta_computer_tool.rbi +33 -0
- data/rbi/openai/models/beta/beta_computer_use_preview_tool.rbi +126 -0
- data/rbi/openai/models/beta/beta_container_auto.rbi +231 -0
- data/rbi/openai/models/beta/beta_container_network_policy_allowlist.rbi +81 -0
- data/rbi/openai/models/beta/beta_container_network_policy_disabled.rbi +35 -0
- data/rbi/openai/models/beta/beta_container_network_policy_domain_secret.rbi +53 -0
- data/rbi/openai/models/beta/beta_container_reference.rbi +42 -0
- data/rbi/openai/models/beta/beta_custom_tool.rbi +302 -0
- data/rbi/openai/models/beta/beta_easy_input_message.rbi +211 -0
- data/rbi/openai/models/beta/beta_file_search_tool.rbi +863 -0
- data/rbi/openai/models/beta/beta_function_shell_tool.rbi +155 -0
- data/rbi/openai/models/beta/beta_function_tool.rbi +154 -0
- data/rbi/openai/models/beta/beta_inline_skill.rbi +68 -0
- data/rbi/openai/models/beta/beta_inline_skill_source.rbi +53 -0
- data/rbi/openai/models/beta/beta_local_environment.rbi +51 -0
- data/rbi/openai/models/beta/beta_local_skill.rbi +49 -0
- data/rbi/openai/models/beta/beta_namespace_tool.rbi +252 -0
- data/rbi/openai/models/beta/beta_response.rbi +2495 -0
- data/rbi/openai/models/beta/beta_response_apply_patch_tool_call.rbi +431 -0
- data/rbi/openai/models/beta/beta_response_apply_patch_tool_call_output.rbi +277 -0
- data/rbi/openai/models/beta/beta_response_audio_delta_event.rbi +110 -0
- data/rbi/openai/models/beta/beta_response_audio_done_event.rbi +100 -0
- data/rbi/openai/models/beta/beta_response_audio_transcript_delta_event.rbi +118 -0
- data/rbi/openai/models/beta/beta_response_audio_transcript_done_event.rbi +108 -0
- data/rbi/openai/models/beta/beta_response_code_interpreter_call_code_delta_event.rbi +136 -0
- data/rbi/openai/models/beta/beta_response_code_interpreter_call_code_done_event.rbi +134 -0
- data/rbi/openai/models/beta/beta_response_code_interpreter_call_completed_event.rbi +128 -0
- data/rbi/openai/models/beta/beta_response_code_interpreter_call_in_progress_event.rbi +128 -0
- data/rbi/openai/models/beta/beta_response_code_interpreter_call_interpreting_event.rbi +128 -0
- data/rbi/openai/models/beta/beta_response_code_interpreter_tool_call.rbi +315 -0
- data/rbi/openai/models/beta/beta_response_compaction_item.rbi +116 -0
- data/rbi/openai/models/beta/beta_response_compaction_item_param.rbi +114 -0
- data/rbi/openai/models/beta/beta_response_completed_event.rbi +111 -0
- data/rbi/openai/models/beta/beta_response_computer_tool_call.rbi +404 -0
- data/rbi/openai/models/beta/beta_response_computer_tool_call_output_item.rbi +296 -0
- data/rbi/openai/models/beta/beta_response_computer_tool_call_output_screenshot.rbi +62 -0
- data/rbi/openai/models/beta/beta_response_container_reference.rbi +41 -0
- data/rbi/openai/models/beta/beta_response_content.rbi +66 -0
- data/rbi/openai/models/beta/beta_response_content_part_added_event.rbi +205 -0
- data/rbi/openai/models/beta/beta_response_content_part_done_event.rbi +203 -0
- data/rbi/openai/models/beta/beta_response_conversation_param.rbi +35 -0
- data/rbi/openai/models/beta/beta_response_created_event.rbi +109 -0
- data/rbi/openai/models/beta/beta_response_custom_tool_call.rbi +242 -0
- data/rbi/openai/models/beta/beta_response_custom_tool_call_input_delta_event.rbi +134 -0
- data/rbi/openai/models/beta/beta_response_custom_tool_call_input_done_event.rbi +134 -0
- data/rbi/openai/models/beta/beta_response_custom_tool_call_item.rbi +113 -0
- data/rbi/openai/models/beta/beta_response_custom_tool_call_output.rbi +303 -0
- data/rbi/openai/models/beta/beta_response_custom_tool_call_output_item.rbi +114 -0
- data/rbi/openai/models/beta/beta_response_error.rbi +165 -0
- data/rbi/openai/models/beta/beta_response_error_event.rbi +120 -0
- data/rbi/openai/models/beta/beta_response_failed_event.rbi +107 -0
- data/rbi/openai/models/beta/beta_response_file_search_call_completed_event.rbi +126 -0
- data/rbi/openai/models/beta/beta_response_file_search_call_in_progress_event.rbi +126 -0
- data/rbi/openai/models/beta/beta_response_file_search_call_searching_event.rbi +126 -0
- data/rbi/openai/models/beta/beta_response_file_search_tool_call.rbi +328 -0
- data/rbi/openai/models/beta/beta_response_format_text_config.rbi +97 -0
- data/rbi/openai/models/beta/beta_response_format_text_json_schema_config.rbi +97 -0
- data/rbi/openai/models/beta/beta_response_function_call_arguments_delta_event.rbi +134 -0
- data/rbi/openai/models/beta/beta_response_function_call_arguments_done_event.rbi +140 -0
- data/rbi/openai/models/beta/beta_response_function_call_output_item.rbi +32 -0
- data/rbi/openai/models/beta/beta_response_function_call_output_item_list.rbi +21 -0
- data/rbi/openai/models/beta/beta_response_function_shell_call_output_content.rbi +160 -0
- data/rbi/openai/models/beta/beta_response_function_shell_tool_call.rbi +389 -0
- data/rbi/openai/models/beta/beta_response_function_shell_tool_call_output.rbi +470 -0
- data/rbi/openai/models/beta/beta_response_function_tool_call.rbi +310 -0
- data/rbi/openai/models/beta/beta_response_function_tool_call_item.rbi +115 -0
- data/rbi/openai/models/beta/beta_response_function_tool_call_output_item.rbi +364 -0
- data/rbi/openai/models/beta/beta_response_function_web_search.rbi +416 -0
- data/rbi/openai/models/beta/beta_response_image_gen_call_completed_event.rbi +127 -0
- data/rbi/openai/models/beta/beta_response_image_gen_call_generating_event.rbi +127 -0
- data/rbi/openai/models/beta/beta_response_image_gen_call_in_progress_event.rbi +126 -0
- data/rbi/openai/models/beta/beta_response_image_gen_call_partial_image_event.rbi +144 -0
- data/rbi/openai/models/beta/beta_response_in_progress_event.rbi +113 -0
- data/rbi/openai/models/beta/beta_response_includable.rbi +86 -0
- data/rbi/openai/models/beta/beta_response_incomplete_event.rbi +113 -0
- data/rbi/openai/models/beta/beta_response_inject_created_event.rbi +75 -0
- data/rbi/openai/models/beta/beta_response_inject_event.rbi +183 -0
- data/rbi/openai/models/beta/beta_response_inject_failed_event.rbi +304 -0
- data/rbi/openai/models/beta/beta_response_input.rbi +18 -0
- data/rbi/openai/models/beta/beta_response_input_audio.rbi +144 -0
- data/rbi/openai/models/beta/beta_response_input_content.rbi +31 -0
- data/rbi/openai/models/beta/beta_response_input_file.rbi +210 -0
- data/rbi/openai/models/beta/beta_response_input_file_content.rbi +211 -0
- data/rbi/openai/models/beta/beta_response_input_image.rbi +173 -0
- data/rbi/openai/models/beta/beta_response_input_image_content.rbi +191 -0
- data/rbi/openai/models/beta/beta_response_input_item.rbi +5505 -0
- data/rbi/openai/models/beta/beta_response_input_message_content_list.rbi +21 -0
- data/rbi/openai/models/beta/beta_response_input_message_item.rbi +235 -0
- data/rbi/openai/models/beta/beta_response_input_text.rbi +109 -0
- data/rbi/openai/models/beta/beta_response_input_text_content.rbi +115 -0
- data/rbi/openai/models/beta/beta_response_item.rbi +2592 -0
- data/rbi/openai/models/beta/beta_response_local_environment.rbi +35 -0
- data/rbi/openai/models/beta/beta_response_mcp_call_arguments_delta_event.rbi +137 -0
- data/rbi/openai/models/beta/beta_response_mcp_call_arguments_done_event.rbi +134 -0
- data/rbi/openai/models/beta/beta_response_mcp_call_completed_event.rbi +123 -0
- data/rbi/openai/models/beta/beta_response_mcp_call_failed_event.rbi +121 -0
- data/rbi/openai/models/beta/beta_response_mcp_call_in_progress_event.rbi +124 -0
- data/rbi/openai/models/beta/beta_response_mcp_list_tools_completed_event.rbi +126 -0
- data/rbi/openai/models/beta/beta_response_mcp_list_tools_failed_event.rbi +124 -0
- data/rbi/openai/models/beta/beta_response_mcp_list_tools_in_progress_event.rbi +127 -0
- data/rbi/openai/models/beta/beta_response_output_audio.rbi +53 -0
- data/rbi/openai/models/beta/beta_response_output_item.rbi +2627 -0
- data/rbi/openai/models/beta/beta_response_output_item_added_event.rbi +154 -0
- data/rbi/openai/models/beta/beta_response_output_item_done_event.rbi +154 -0
- data/rbi/openai/models/beta/beta_response_output_message.rbi +267 -0
- data/rbi/openai/models/beta/beta_response_output_refusal.rbi +41 -0
- data/rbi/openai/models/beta/beta_response_output_text.rbi +479 -0
- data/rbi/openai/models/beta/beta_response_output_text_annotation_added_event.rbi +150 -0
- data/rbi/openai/models/beta/beta_response_prompt.rbi +122 -0
- data/rbi/openai/models/beta/beta_response_queued_event.rbi +107 -0
- data/rbi/openai/models/beta/beta_response_reasoning_item.rbi +274 -0
- data/rbi/openai/models/beta/beta_response_reasoning_summary_part_added_event.rbi +188 -0
- data/rbi/openai/models/beta/beta_response_reasoning_summary_part_done_event.rbi +243 -0
- data/rbi/openai/models/beta/beta_response_reasoning_summary_text_delta_event.rbi +142 -0
- data/rbi/openai/models/beta/beta_response_reasoning_summary_text_done_event.rbi +142 -0
- data/rbi/openai/models/beta/beta_response_reasoning_text_delta_event.rbi +140 -0
- data/rbi/openai/models/beta/beta_response_reasoning_text_done_event.rbi +140 -0
- data/rbi/openai/models/beta/beta_response_refusal_delta_event.rbi +135 -0
- data/rbi/openai/models/beta/beta_response_refusal_done_event.rbi +135 -0
- data/rbi/openai/models/beta/beta_response_status.rbi +38 -0
- data/rbi/openai/models/beta/beta_response_stream_event.rbi +81 -0
- data/rbi/openai/models/beta/beta_response_text_config.rbi +166 -0
- data/rbi/openai/models/beta/beta_response_text_delta_event.rbi +263 -0
- data/rbi/openai/models/beta/beta_response_text_done_event.rbi +261 -0
- data/rbi/openai/models/beta/beta_response_tool_search_call.rbi +218 -0
- data/rbi/openai/models/beta/beta_response_tool_search_output_item.rbi +248 -0
- data/rbi/openai/models/beta/beta_response_tool_search_output_item_param.rbi +307 -0
- data/rbi/openai/models/beta/beta_response_usage.rbi +163 -0
- data/rbi/openai/models/beta/beta_response_web_search_call_completed_event.rbi +126 -0
- data/rbi/openai/models/beta/beta_response_web_search_call_in_progress_event.rbi +126 -0
- data/rbi/openai/models/beta/beta_response_web_search_call_searching_event.rbi +126 -0
- data/rbi/openai/models/beta/beta_responses_client_event.rbi +2831 -0
- data/rbi/openai/models/beta/beta_responses_server_event.rbi +83 -0
- data/rbi/openai/models/beta/beta_skill_reference.rbi +52 -0
- data/rbi/openai/models/beta/beta_tool.rbi +1835 -0
- data/rbi/openai/models/beta/beta_tool_choice_allowed.rbi +126 -0
- data/rbi/openai/models/beta/beta_tool_choice_apply_patch.rbi +35 -0
- data/rbi/openai/models/beta/beta_tool_choice_custom.rbi +38 -0
- data/rbi/openai/models/beta/beta_tool_choice_function.rbi +41 -0
- data/rbi/openai/models/beta/beta_tool_choice_mcp.rbi +55 -0
- data/rbi/openai/models/beta/beta_tool_choice_options.rbi +38 -0
- data/rbi/openai/models/beta/beta_tool_choice_shell.rbi +32 -0
- data/rbi/openai/models/beta/beta_tool_choice_types.rbi +134 -0
- data/rbi/openai/models/beta/beta_tool_search_tool.rbi +109 -0
- data/rbi/openai/models/beta/beta_web_search_preview_tool.rbi +311 -0
- data/rbi/openai/models/beta/beta_web_search_tool.rbi +329 -0
- data/rbi/openai/models/beta/response_cancel_params.rbi +83 -0
- data/rbi/openai/models/beta/response_compact_params.rbi +1033 -0
- data/rbi/openai/models/beta/response_create_params.rbi +2739 -0
- data/rbi/openai/models/beta/response_delete_params.rbi +83 -0
- data/rbi/openai/models/beta/response_retrieve_params.rbi +145 -0
- data/rbi/openai/models/beta/responses/beta_response_item_list.rbi +113 -0
- data/rbi/openai/models/beta/responses/input_item_list_params.rbi +223 -0
- data/rbi/openai/models/beta/responses/input_token_count_params.rbi +1248 -0
- data/rbi/openai/models/beta/responses/input_token_count_response.rbi +37 -0
- data/rbi/openai/models/beta/threads/run_create_params.rbi +12 -26
- data/rbi/openai/models/chat/chat_completion_content_part.rbi +57 -1
- data/rbi/openai/models/chat/chat_completion_content_part_image.rbi +57 -1
- data/rbi/openai/models/chat/chat_completion_content_part_input_audio.rbi +57 -1
- data/rbi/openai/models/chat/chat_completion_content_part_text.rbi +70 -2
- data/rbi/openai/models/chat/completion_create_params.rbi +513 -32
- data/rbi/openai/models/chat_model.rbi +3 -0
- data/rbi/openai/models/completion_usage.rbi +21 -4
- data/rbi/openai/models/conversations/computer_screenshot_content.rbi +57 -1
- data/rbi/openai/models/conversations/conversation_create_params.rbi +9 -3
- data/rbi/openai/models/conversations/conversation_item.rbi +178 -0
- data/rbi/openai/models/conversations/conversation_item_list.rbi +2 -0
- data/rbi/openai/models/conversations/item_create_params.rbi +9 -3
- data/rbi/openai/models/evals/create_eval_completions_run_data_source.rbi +12 -26
- data/rbi/openai/models/evals/run_cancel_response.rbi +26 -52
- data/rbi/openai/models/evals/run_create_params.rbi +28 -52
- data/rbi/openai/models/evals/run_create_response.rbi +26 -52
- data/rbi/openai/models/evals/run_list_response.rbi +26 -52
- data/rbi/openai/models/evals/run_retrieve_response.rbi +26 -52
- data/rbi/openai/models/graders/score_model_grader.rbi +12 -26
- data/rbi/openai/models/realtime/realtime_response_create_mcp_tool.rbi +60 -0
- data/rbi/openai/models/realtime/realtime_session_create_request.rbi +10 -0
- data/rbi/openai/models/realtime/realtime_session_create_response.rbi +70 -0
- data/rbi/openai/models/realtime/realtime_tools_config_union.rbi +60 -0
- data/rbi/openai/models/reasoning.rbi +51 -26
- data/rbi/openai/models/reasoning_effort.rbi +7 -13
- data/rbi/openai/models/responses/apply_patch_tool.rbi +69 -2
- data/rbi/openai/models/responses/compacted_response.rbi +2 -0
- data/rbi/openai/models/responses/custom_tool.rbi +53 -0
- data/rbi/openai/models/responses/function_shell_tool.rbi +57 -0
- data/rbi/openai/models/responses/function_tool.rbi +68 -3
- data/rbi/openai/models/responses/input_token_count_params.rbi +32 -0
- data/rbi/openai/models/responses/namespace_tool.rbi +76 -0
- data/rbi/openai/models/responses/response.rbi +192 -3
- data/rbi/openai/models/responses/response_apply_patch_tool_call.rbi +98 -0
- data/rbi/openai/models/responses/response_apply_patch_tool_call_output.rbi +98 -0
- data/rbi/openai/models/responses/response_compact_params.rbi +231 -0
- data/rbi/openai/models/responses/response_create_params.rbi +537 -6
- data/rbi/openai/models/responses/response_custom_tool_call.rbi +104 -0
- data/rbi/openai/models/responses/response_custom_tool_call_output.rbi +111 -1
- data/rbi/openai/models/responses/response_error.rbi +5 -0
- data/rbi/openai/models/responses/response_function_shell_tool_call.rbi +98 -0
- data/rbi/openai/models/responses/response_function_shell_tool_call_output.rbi +98 -0
- data/rbi/openai/models/responses/response_function_tool_call.rbi +104 -0
- data/rbi/openai/models/responses/response_function_tool_call_output_item.rbi +104 -0
- data/rbi/openai/models/responses/response_input_file.rbi +77 -10
- data/rbi/openai/models/responses/response_input_file_content.rbi +83 -10
- data/rbi/openai/models/responses/response_input_image.rbi +57 -1
- data/rbi/openai/models/responses/response_input_image_content.rbi +63 -1
- data/rbi/openai/models/responses/response_input_item.rbi +748 -8
- data/rbi/openai/models/responses/response_input_text.rbi +70 -2
- data/rbi/openai/models/responses/response_input_text_content.rbi +76 -2
- data/rbi/openai/models/responses/response_item.rbi +178 -0
- data/rbi/openai/models/responses/response_item_list.rbi +2 -0
- data/rbi/openai/models/responses/response_output_item.rbi +178 -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_reasoning_summary_part_done_event.rbi +58 -1
- data/rbi/openai/models/responses/response_tool_search_output_item.rbi +1 -0
- data/rbi/openai/models/responses/response_tool_search_output_item_param.rbi +3 -0
- data/rbi/openai/models/responses/response_usage.rbi +16 -2
- data/rbi/openai/models/responses/responses_client_event.rbi +537 -6
- data/rbi/openai/models/responses/tool.rbi +142 -1
- data/rbi/openai/models/webhooks/safety_identifier_blocked_webhook_event.rbi +209 -0
- data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi +2 -1
- data/rbi/openai/resources/beta/assistants.rbi +12 -26
- data/rbi/openai/resources/beta/responses/input_items.rbi +58 -0
- data/rbi/openai/resources/beta/responses/input_tokens.rbi +154 -0
- data/rbi/openai/resources/beta/responses.rbi +903 -0
- data/rbi/openai/resources/beta/threads/runs.rbi +12 -26
- data/rbi/openai/resources/beta.rbi +3 -0
- data/rbi/openai/resources/chat/completions.rbi +48 -28
- data/rbi/openai/resources/conversations/items.rbi +3 -1
- data/rbi/openai/resources/conversations.rbi +3 -1
- data/rbi/openai/resources/responses/input_tokens.rbi +2 -0
- data/rbi/openai/resources/responses.rbi +54 -2
- data/rbi/openai/resources/webhooks.rbi +2 -1
- data/sig/openai/client.rbs +1 -1
- data/sig/openai/internal/transport/base_client.rbs +2 -2
- data/sig/openai/models/beta/beta_apply_patch_tool.rbs +40 -0
- data/sig/openai/models/beta/beta_compacted_response.rbs +44 -0
- data/sig/openai/models/beta/beta_computer_action.rbs +259 -0
- data/sig/openai/models/beta/beta_computer_action_list.rbs +12 -0
- data/sig/openai/models/beta/beta_computer_tool.rbs +17 -0
- data/sig/openai/models/beta/beta_computer_use_preview_tool.rbs +53 -0
- data/sig/openai/models/beta/beta_container_auto.rbs +86 -0
- data/sig/openai/models/beta/beta_container_network_policy_allowlist.rbs +38 -0
- data/sig/openai/models/beta/beta_container_network_policy_disabled.rbs +17 -0
- data/sig/openai/models/beta/beta_container_network_policy_domain_secret.rbs +22 -0
- data/sig/openai/models/beta/beta_container_reference.rbs +23 -0
- data/sig/openai/models/beta/beta_custom_tool.rbs +126 -0
- data/sig/openai/models/beta/beta_easy_input_message.rbs +87 -0
- data/sig/openai/models/beta/beta_file_search_tool.rbs +298 -0
- data/sig/openai/models/beta/beta_function_shell_tool.rbs +56 -0
- data/sig/openai/models/beta/beta_function_tool.rbs +72 -0
- data/sig/openai/models/beta/beta_inline_skill.rbs +39 -0
- data/sig/openai/models/beta/beta_inline_skill_source.rbs +30 -0
- data/sig/openai/models/beta/beta_local_environment.rbs +30 -0
- data/sig/openai/models/beta/beta_local_skill.rbs +26 -0
- data/sig/openai/models/beta/beta_namespace_tool.rbs +114 -0
- data/sig/openai/models/beta/beta_response.rbs +860 -0
- data/sig/openai/models/beta/beta_response_apply_patch_tool_call.rbs +177 -0
- data/sig/openai/models/beta/beta_response_apply_patch_tool_call_output.rbs +118 -0
- data/sig/openai/models/beta/beta_response_audio_delta_event.rbs +49 -0
- data/sig/openai/models/beta/beta_response_audio_done_event.rbs +44 -0
- data/sig/openai/models/beta/beta_response_audio_transcript_delta_event.rbs +49 -0
- data/sig/openai/models/beta/beta_response_audio_transcript_done_event.rbs +44 -0
- data/sig/openai/models/beta/beta_response_code_interpreter_call_code_delta_event.rbs +59 -0
- data/sig/openai/models/beta/beta_response_code_interpreter_call_code_done_event.rbs +59 -0
- data/sig/openai/models/beta/beta_response_code_interpreter_call_completed_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_code_interpreter_call_in_progress_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_code_interpreter_call_interpreting_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_code_interpreter_tool_call.rbs +113 -0
- data/sig/openai/models/beta/beta_response_compaction_item.rbs +60 -0
- data/sig/openai/models/beta/beta_response_compaction_item_param.rbs +49 -0
- data/sig/openai/models/beta/beta_response_completed_event.rbs +49 -0
- data/sig/openai/models/beta/beta_response_computer_tool_call.rbs +118 -0
- data/sig/openai/models/beta/beta_response_computer_tool_call_output_item.rbs +107 -0
- data/sig/openai/models/beta/beta_response_computer_tool_call_output_screenshot.rbs +34 -0
- data/sig/openai/models/beta/beta_response_container_reference.rbs +23 -0
- data/sig/openai/models/beta/beta_response_content.rbs +33 -0
- data/sig/openai/models/beta/beta_response_content_part_added_event.rbs +87 -0
- data/sig/openai/models/beta/beta_response_content_part_done_event.rbs +87 -0
- data/sig/openai/models/beta/beta_response_conversation_param.rbs +17 -0
- data/sig/openai/models/beta/beta_response_created_event.rbs +49 -0
- data/sig/openai/models/beta/beta_response_custom_tool_call.rbs +105 -0
- data/sig/openai/models/beta/beta_response_custom_tool_call_input_delta_event.rbs +59 -0
- data/sig/openai/models/beta/beta_response_custom_tool_call_input_done_event.rbs +59 -0
- data/sig/openai/models/beta/beta_response_custom_tool_call_item.rbs +54 -0
- data/sig/openai/models/beta/beta_response_custom_tool_call_output.rbs +116 -0
- data/sig/openai/models/beta/beta_response_custom_tool_call_output_item.rbs +54 -0
- data/sig/openai/models/beta/beta_response_error.rbs +73 -0
- data/sig/openai/models/beta/beta_response_error_event.rbs +59 -0
- data/sig/openai/models/beta/beta_response_failed_event.rbs +49 -0
- data/sig/openai/models/beta/beta_response_file_search_call_completed_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_file_search_call_in_progress_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_file_search_call_searching_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_file_search_tool_call.rbs +127 -0
- data/sig/openai/models/beta/beta_response_format_text_config.rbs +38 -0
- data/sig/openai/models/beta/beta_response_format_text_json_schema_config.rbs +46 -0
- data/sig/openai/models/beta/beta_response_function_call_arguments_delta_event.rbs +59 -0
- data/sig/openai/models/beta/beta_response_function_call_arguments_done_event.rbs +64 -0
- data/sig/openai/models/beta/beta_response_function_call_output_item.rbs +18 -0
- data/sig/openai/models/beta/beta_response_function_call_output_item_list.rbs +12 -0
- data/sig/openai/models/beta/beta_response_function_shell_call_output_content.rbs +66 -0
- data/sig/openai/models/beta/beta_response_function_shell_tool_call.rbs +161 -0
- data/sig/openai/models/beta/beta_response_function_shell_tool_call_output.rbs +190 -0
- data/sig/openai/models/beta/beta_response_function_tool_call.rbs +126 -0
- data/sig/openai/models/beta/beta_response_function_tool_call_item.rbs +54 -0
- data/sig/openai/models/beta/beta_response_function_tool_call_output_item.rbs +138 -0
- data/sig/openai/models/beta/beta_response_function_web_search.rbs +165 -0
- data/sig/openai/models/beta/beta_response_image_gen_call_completed_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_image_gen_call_generating_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_image_gen_call_in_progress_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_image_gen_call_partial_image_event.rbs +64 -0
- data/sig/openai/models/beta/beta_response_in_progress_event.rbs +49 -0
- data/sig/openai/models/beta/beta_response_includable.rbs +32 -0
- data/sig/openai/models/beta/beta_response_incomplete_event.rbs +49 -0
- data/sig/openai/models/beta/beta_response_inject_created_event.rbs +41 -0
- data/sig/openai/models/beta/beta_response_inject_event.rbs +34 -0
- data/sig/openai/models/beta/beta_response_inject_failed_event.rbs +84 -0
- data/sig/openai/models/beta/beta_response_input.rbs +12 -0
- data/sig/openai/models/beta/beta_response_input_audio.rbs +62 -0
- data/sig/openai/models/beta/beta_response_input_content.rbs +18 -0
- data/sig/openai/models/beta/beta_response_input_file.rbs +90 -0
- data/sig/openai/models/beta/beta_response_input_file_content.rbs +80 -0
- data/sig/openai/models/beta/beta_response_input_image.rbs +71 -0
- data/sig/openai/models/beta/beta_response_input_image_content.rbs +67 -0
- data/sig/openai/models/beta/beta_response_input_item.rbs +2064 -0
- data/sig/openai/models/beta/beta_response_input_message_content_list.rbs +12 -0
- data/sig/openai/models/beta/beta_response_input_message_item.rbs +87 -0
- data/sig/openai/models/beta/beta_response_input_text.rbs +48 -0
- data/sig/openai/models/beta/beta_response_input_text_content.rbs +44 -0
- data/sig/openai/models/beta/beta_response_item.rbs +1097 -0
- data/sig/openai/models/beta/beta_response_local_environment.rbs +17 -0
- data/sig/openai/models/beta/beta_response_mcp_call_arguments_delta_event.rbs +59 -0
- data/sig/openai/models/beta/beta_response_mcp_call_arguments_done_event.rbs +59 -0
- data/sig/openai/models/beta/beta_response_mcp_call_completed_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_mcp_call_failed_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_mcp_call_in_progress_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_mcp_list_tools_completed_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_mcp_list_tools_failed_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_mcp_list_tools_in_progress_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_output_audio.rbs +30 -0
- data/sig/openai/models/beta/beta_response_output_item.rbs +1096 -0
- data/sig/openai/models/beta/beta_response_output_item_added_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_output_item_done_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_output_message.rbs +97 -0
- data/sig/openai/models/beta/beta_response_output_refusal.rbs +19 -0
- data/sig/openai/models/beta/beta_response_output_text.rbs +243 -0
- data/sig/openai/models/beta/beta_response_output_text_annotation_added_event.rbs +69 -0
- data/sig/openai/models/beta/beta_response_prompt.rbs +46 -0
- data/sig/openai/models/beta/beta_response_queued_event.rbs +49 -0
- data/sig/openai/models/beta/beta_response_reasoning_item.rbs +108 -0
- data/sig/openai/models/beta/beta_response_reasoning_summary_part_added_event.rbs +76 -0
- data/sig/openai/models/beta/beta_response_reasoning_summary_part_done_event.rbs +95 -0
- data/sig/openai/models/beta/beta_response_reasoning_summary_text_delta_event.rbs +64 -0
- data/sig/openai/models/beta/beta_response_reasoning_summary_text_done_event.rbs +64 -0
- data/sig/openai/models/beta/beta_response_reasoning_text_delta_event.rbs +64 -0
- data/sig/openai/models/beta/beta_response_reasoning_text_done_event.rbs +64 -0
- data/sig/openai/models/beta/beta_response_refusal_delta_event.rbs +64 -0
- data/sig/openai/models/beta/beta_response_refusal_done_event.rbs +64 -0
- data/sig/openai/models/beta/beta_response_status.rbs +23 -0
- data/sig/openai/models/beta/beta_response_stream_event.rbs +68 -0
- data/sig/openai/models/beta/beta_response_text_config.rbs +45 -0
- data/sig/openai/models/beta/beta_response_text_delta_event.rbs +116 -0
- data/sig/openai/models/beta/beta_response_text_done_event.rbs +116 -0
- data/sig/openai/models/beta/beta_response_tool_search_call.rbs +98 -0
- data/sig/openai/models/beta/beta_response_tool_search_output_item.rbs +98 -0
- data/sig/openai/models/beta/beta_response_tool_search_output_item_param.rbs +91 -0
- data/sig/openai/models/beta/beta_response_usage.rbs +73 -0
- data/sig/openai/models/beta/beta_response_web_search_call_completed_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_web_search_call_in_progress_event.rbs +54 -0
- data/sig/openai/models/beta/beta_response_web_search_call_searching_event.rbs +54 -0
- data/sig/openai/models/beta/beta_responses_client_event.rbs +804 -0
- data/sig/openai/models/beta/beta_responses_server_event.rbs +70 -0
- data/sig/openai/models/beta/beta_skill_reference.rbs +32 -0
- data/sig/openai/models/beta/beta_tool.rbs +634 -0
- data/sig/openai/models/beta/beta_tool_choice_allowed.rbs +45 -0
- data/sig/openai/models/beta/beta_tool_choice_apply_patch.rbs +17 -0
- data/sig/openai/models/beta/beta_tool_choice_custom.rbs +19 -0
- data/sig/openai/models/beta/beta_tool_choice_function.rbs +19 -0
- data/sig/openai/models/beta/beta_tool_choice_mcp.rbs +26 -0
- data/sig/openai/models/beta/beta_tool_choice_options.rbs +19 -0
- data/sig/openai/models/beta/beta_tool_choice_shell.rbs +17 -0
- data/sig/openai/models/beta/beta_tool_choice_types.rbs +47 -0
- data/sig/openai/models/beta/beta_tool_search_tool.rbs +54 -0
- data/sig/openai/models/beta/beta_web_search_preview_tool.rbs +118 -0
- data/sig/openai/models/beta/beta_web_search_tool.rbs +127 -0
- data/sig/openai/models/beta/response_cancel_params.rbs +47 -0
- data/sig/openai/models/beta/response_compact_params.rbs +368 -0
- data/sig/openai/models/beta/response_create_params.rbs +804 -0
- data/sig/openai/models/beta/response_delete_params.rbs +47 -0
- data/sig/openai/models/beta/response_retrieve_params.rbs +70 -0
- data/sig/openai/models/beta/responses/beta_response_item_list.rbs +44 -0
- data/sig/openai/models/beta/responses/input_item_list_params.rbs +92 -0
- data/sig/openai/models/beta/responses/input_token_count_params.rbs +325 -0
- data/sig/openai/models/beta/responses/input_token_count_response.rbs +26 -0
- data/sig/openai/models/chat/chat_completion_content_part.rbs +21 -2
- data/sig/openai/models/chat/chat_completion_content_part_image.rbs +21 -2
- data/sig/openai/models/chat/chat_completion_content_part_input_audio.rbs +21 -2
- data/sig/openai/models/chat/chat_completion_content_part_text.rbs +32 -3
- data/sig/openai/models/chat/completion_create_params.rbs +153 -3
- data/sig/openai/models/chat_model.rbs +7 -1
- data/sig/openai/models/completion_usage.rbs +15 -2
- data/sig/openai/models/conversations/computer_screenshot_content.rbs +21 -2
- data/sig/openai/models/conversations/conversation_item.rbs +87 -0
- data/sig/openai/models/realtime/realtime_response_create_mcp_tool.rbs +16 -0
- data/sig/openai/models/realtime/realtime_session_create_request.rbs +4 -0
- data/sig/openai/models/realtime/realtime_session_create_response.rbs +20 -0
- data/sig/openai/models/realtime/realtime_tools_config_union.rbs +16 -0
- data/sig/openai/models/reasoning.rbs +20 -0
- data/sig/openai/models/reasoning_effort.rbs +3 -1
- data/sig/openai/models/responses/apply_patch_tool.rbs +26 -3
- data/sig/openai/models/responses/custom_tool.rbs +16 -0
- data/sig/openai/models/responses/function_shell_tool.rbs +16 -0
- data/sig/openai/models/responses/function_tool.rbs +23 -2
- data/sig/openai/models/responses/input_token_count_params.rbs +12 -0
- data/sig/openai/models/responses/namespace_tool.rbs +21 -0
- data/sig/openai/models/responses/response.rbs +64 -0
- data/sig/openai/models/responses/response_apply_patch_tool_call.rbs +37 -0
- data/sig/openai/models/responses/response_apply_patch_tool_call_output.rbs +37 -0
- data/sig/openai/models/responses/response_compact_params.rbs +63 -1
- data/sig/openai/models/responses/response_create_params.rbs +165 -3
- data/sig/openai/models/responses/response_custom_tool_call.rbs +37 -0
- data/sig/openai/models/responses/response_custom_tool_call_output.rbs +39 -2
- data/sig/openai/models/responses/response_error.rbs +2 -0
- data/sig/openai/models/responses/response_function_shell_tool_call.rbs +37 -0
- data/sig/openai/models/responses/response_function_shell_tool_call_output.rbs +37 -0
- data/sig/openai/models/responses/response_function_tool_call.rbs +37 -0
- data/sig/openai/models/responses/response_function_tool_call_output_item.rbs +37 -0
- data/sig/openai/models/responses/response_input_file.rbs +23 -3
- data/sig/openai/models/responses/response_input_file_content.rbs +19 -3
- data/sig/openai/models/responses/response_input_image.rbs +21 -2
- data/sig/openai/models/responses/response_input_image_content.rbs +17 -2
- data/sig/openai/models/responses/response_input_item.rbs +274 -2
- data/sig/openai/models/responses/response_input_text.rbs +32 -3
- data/sig/openai/models/responses/response_input_text_content.rbs +28 -3
- data/sig/openai/models/responses/response_item.rbs +87 -0
- data/sig/openai/models/responses/response_output_item.rbs +87 -0
- data/sig/openai/models/responses/response_reasoning_summary_part_done_event.rbs +21 -2
- data/sig/openai/models/responses/response_usage.rbs +12 -3
- data/sig/openai/models/responses/responses_client_event.rbs +165 -3
- data/sig/openai/models/responses/tool.rbs +45 -2
- data/sig/openai/models/webhooks/safety_identifier_blocked_webhook_event.rbs +99 -0
- data/sig/openai/models/webhooks/unwrap_webhook_event.rbs +1 -0
- data/sig/openai/resources/beta/responses/input_items.rbs +21 -0
- data/sig/openai/resources/beta/responses/input_tokens.rbs +28 -0
- data/sig/openai/resources/beta/responses.rbs +128 -0
- data/sig/openai/resources/beta.rbs +2 -0
- data/sig/openai/resources/chat/completions.rbs +2 -0
- data/sig/openai/resources/responses.rbs +3 -0
- data/sig/openai/resources/webhooks.rbs +2 -1
- metadata +491 -2
|
@@ -0,0 +1,542 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Beta
|
|
6
|
+
module Responses
|
|
7
|
+
# @see OpenAI::Resources::Beta::Responses::InputTokens#count
|
|
8
|
+
class InputTokenCountParams < OpenAI::Internal::Type::BaseModel
|
|
9
|
+
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
10
|
+
include OpenAI::Internal::Type::RequestParameters
|
|
11
|
+
|
|
12
|
+
# @!attribute conversation
|
|
13
|
+
# The conversation that this response belongs to. Items from this conversation are
|
|
14
|
+
# prepended to `input_items` for this response request. Input items and output
|
|
15
|
+
# items from this response are automatically added to this conversation after this
|
|
16
|
+
# response completes.
|
|
17
|
+
#
|
|
18
|
+
# @return [String, OpenAI::Models::Beta::BetaResponseConversationParam, nil]
|
|
19
|
+
optional :conversation,
|
|
20
|
+
union: -> { OpenAI::Beta::Responses::InputTokenCountParams::Conversation },
|
|
21
|
+
nil?: true
|
|
22
|
+
|
|
23
|
+
# @!attribute input
|
|
24
|
+
# Text, image, or file inputs to the model, used to generate a response
|
|
25
|
+
#
|
|
26
|
+
# @return [String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>, nil]
|
|
27
|
+
optional :input, union: -> { OpenAI::Beta::Responses::InputTokenCountParams::Input }, nil?: true
|
|
28
|
+
|
|
29
|
+
# @!attribute instructions
|
|
30
|
+
# A system (or developer) message inserted into the model's context. When used
|
|
31
|
+
# along with `previous_response_id`, the instructions from a previous response
|
|
32
|
+
# will not be carried over to the next response. This makes it simple to swap out
|
|
33
|
+
# system (or developer) messages in new responses.
|
|
34
|
+
#
|
|
35
|
+
# @return [String, nil]
|
|
36
|
+
optional :instructions, String, nil?: true
|
|
37
|
+
|
|
38
|
+
# @!attribute model
|
|
39
|
+
# Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
|
|
40
|
+
# wide range of models with different capabilities, performance characteristics,
|
|
41
|
+
# and price points. Refer to the
|
|
42
|
+
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
43
|
+
# available models.
|
|
44
|
+
#
|
|
45
|
+
# @return [String, nil]
|
|
46
|
+
optional :model, String, nil?: true
|
|
47
|
+
|
|
48
|
+
# @!attribute parallel_tool_calls
|
|
49
|
+
# Whether to allow the model to run tool calls in parallel.
|
|
50
|
+
#
|
|
51
|
+
# @return [Boolean, nil]
|
|
52
|
+
optional :parallel_tool_calls, OpenAI::Internal::Type::Boolean, nil?: true
|
|
53
|
+
|
|
54
|
+
# @!attribute personality
|
|
55
|
+
# A model-owned style preset to apply to this request. Omit this parameter to use
|
|
56
|
+
# the model's default style. Supported values may expand over time. Values must be
|
|
57
|
+
# at most 64 characters.
|
|
58
|
+
#
|
|
59
|
+
# @return [String, Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Personality, nil]
|
|
60
|
+
optional :personality, union: -> { OpenAI::Beta::Responses::InputTokenCountParams::Personality }
|
|
61
|
+
|
|
62
|
+
# @!attribute previous_response_id
|
|
63
|
+
# The unique ID of the previous response to the model. Use this to create
|
|
64
|
+
# multi-turn conversations. Learn more about
|
|
65
|
+
# [conversation state](https://platform.openai.com/docs/guides/conversation-state).
|
|
66
|
+
# Cannot be used in conjunction with `conversation`.
|
|
67
|
+
#
|
|
68
|
+
# @return [String, nil]
|
|
69
|
+
optional :previous_response_id, String, nil?: true
|
|
70
|
+
|
|
71
|
+
# @!attribute reasoning
|
|
72
|
+
# **gpt-5 and o-series models only** Configuration options for
|
|
73
|
+
# [reasoning models](https://platform.openai.com/docs/guides/reasoning).
|
|
74
|
+
#
|
|
75
|
+
# @return [OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning, nil]
|
|
76
|
+
optional :reasoning, -> { OpenAI::Beta::Responses::InputTokenCountParams::Reasoning }, nil?: true
|
|
77
|
+
|
|
78
|
+
# @!attribute text
|
|
79
|
+
# Configuration options for a text response from the model. Can be plain text or
|
|
80
|
+
# structured JSON data. Learn more:
|
|
81
|
+
#
|
|
82
|
+
# - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
|
|
83
|
+
# - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
|
|
84
|
+
#
|
|
85
|
+
# @return [OpenAI::Models::Beta::Responses::InputTokenCountParams::Text, nil]
|
|
86
|
+
optional :text, -> { OpenAI::Beta::Responses::InputTokenCountParams::Text }, nil?: true
|
|
87
|
+
|
|
88
|
+
# @!attribute tool_choice
|
|
89
|
+
# Controls which tool the model should use, if any.
|
|
90
|
+
#
|
|
91
|
+
# @return [Symbol, OpenAI::Models::Beta::BetaToolChoiceOptions, OpenAI::Models::Beta::BetaToolChoiceAllowed, OpenAI::Models::Beta::BetaToolChoiceTypes, OpenAI::Models::Beta::BetaToolChoiceFunction, OpenAI::Models::Beta::BetaToolChoiceMcp, OpenAI::Models::Beta::BetaToolChoiceCustom, OpenAI::Models::Beta::Responses::InputTokenCountParams::ToolChoice::BetaSpecificProgrammaticToolCallingParam, OpenAI::Models::Beta::BetaToolChoiceApplyPatch, OpenAI::Models::Beta::BetaToolChoiceShell, nil]
|
|
92
|
+
optional :tool_choice,
|
|
93
|
+
union: -> { OpenAI::Beta::Responses::InputTokenCountParams::ToolChoice },
|
|
94
|
+
nil?: true
|
|
95
|
+
|
|
96
|
+
# @!attribute tools
|
|
97
|
+
# An array of tools the model may call while generating a response. You can
|
|
98
|
+
# specify which tool to use by setting the `tool_choice` parameter.
|
|
99
|
+
#
|
|
100
|
+
# @return [Array<OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool>, nil]
|
|
101
|
+
optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaTool] }, nil?: true
|
|
102
|
+
|
|
103
|
+
# @!attribute truncation
|
|
104
|
+
# @deprecated
|
|
105
|
+
#
|
|
106
|
+
# The truncation strategy to use for the model response. - `auto`: If the input to
|
|
107
|
+
# this Response exceeds the model's context window size, the model will truncate
|
|
108
|
+
# the response to fit the context window by dropping items from the beginning of
|
|
109
|
+
# the conversation. - `disabled` (default): If the input size will exceed the
|
|
110
|
+
# context window size for a model, the request will fail with a 400 error.
|
|
111
|
+
#
|
|
112
|
+
# @return [Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Truncation, nil]
|
|
113
|
+
optional :truncation, enum: -> { OpenAI::Beta::Responses::InputTokenCountParams::Truncation }
|
|
114
|
+
|
|
115
|
+
# @!attribute betas
|
|
116
|
+
#
|
|
117
|
+
# @return [Array<Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Beta>, nil]
|
|
118
|
+
optional :betas,
|
|
119
|
+
-> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Beta::Responses::InputTokenCountParams::Beta] }
|
|
120
|
+
|
|
121
|
+
# @!method initialize(conversation: nil, input: nil, instructions: nil, model: nil, parallel_tool_calls: nil, personality: nil, previous_response_id: nil, reasoning: nil, text: nil, tool_choice: nil, tools: nil, truncation: nil, betas: nil, request_options: {})
|
|
122
|
+
# Some parameter documentations has been truncated, see
|
|
123
|
+
# {OpenAI::Models::Beta::Responses::InputTokenCountParams} for more details.
|
|
124
|
+
#
|
|
125
|
+
# @param conversation [String, OpenAI::Models::Beta::BetaResponseConversationParam, nil] The conversation that this response belongs to. Items from this conversation are
|
|
126
|
+
#
|
|
127
|
+
# @param input [String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>, nil] Text, image, or file inputs to the model, used to generate a response
|
|
128
|
+
#
|
|
129
|
+
# @param instructions [String, nil] A system (or developer) message inserted into the model's context.
|
|
130
|
+
#
|
|
131
|
+
# @param model [String, nil] Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a w
|
|
132
|
+
#
|
|
133
|
+
# @param parallel_tool_calls [Boolean, nil] Whether to allow the model to run tool calls in parallel.
|
|
134
|
+
#
|
|
135
|
+
# @param personality [String, Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Personality] A model-owned style preset to apply to this request. Omit this parameter to use
|
|
136
|
+
#
|
|
137
|
+
# @param previous_response_id [String, nil] The unique ID of the previous response to the model. Use this to create multi-tu
|
|
138
|
+
#
|
|
139
|
+
# @param reasoning [OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning, nil] **gpt-5 and o-series models only** Configuration options for [reasoning models](
|
|
140
|
+
#
|
|
141
|
+
# @param text [OpenAI::Models::Beta::Responses::InputTokenCountParams::Text, nil] Configuration options for a text response from the model. Can be plain
|
|
142
|
+
#
|
|
143
|
+
# @param tool_choice [Symbol, OpenAI::Models::Beta::BetaToolChoiceOptions, OpenAI::Models::Beta::BetaToolChoiceAllowed, OpenAI::Models::Beta::BetaToolChoiceTypes, OpenAI::Models::Beta::BetaToolChoiceFunction, OpenAI::Models::Beta::BetaToolChoiceMcp, OpenAI::Models::Beta::BetaToolChoiceCustom, OpenAI::Models::Beta::Responses::InputTokenCountParams::ToolChoice::BetaSpecificProgrammaticToolCallingParam, OpenAI::Models::Beta::BetaToolChoiceApplyPatch, OpenAI::Models::Beta::BetaToolChoiceShell, nil] Controls which tool the model should use, if any.
|
|
144
|
+
#
|
|
145
|
+
# @param tools [Array<OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool>, nil] An array of tools the model may call while generating a response. You can specif
|
|
146
|
+
#
|
|
147
|
+
# @param truncation [Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Truncation] The truncation strategy to use for the model response. - `auto`: If the input to
|
|
148
|
+
#
|
|
149
|
+
# @param betas [Array<Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Beta>]
|
|
150
|
+
#
|
|
151
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
152
|
+
|
|
153
|
+
# The conversation that this response belongs to. Items from this conversation are
|
|
154
|
+
# prepended to `input_items` for this response request. Input items and output
|
|
155
|
+
# items from this response are automatically added to this conversation after this
|
|
156
|
+
# response completes.
|
|
157
|
+
module Conversation
|
|
158
|
+
extend OpenAI::Internal::Type::Union
|
|
159
|
+
|
|
160
|
+
# The unique ID of the conversation.
|
|
161
|
+
variant String
|
|
162
|
+
|
|
163
|
+
# The conversation that this response belongs to.
|
|
164
|
+
variant -> { OpenAI::Beta::BetaResponseConversationParam }
|
|
165
|
+
|
|
166
|
+
# @!method self.variants
|
|
167
|
+
# @return [Array(String, OpenAI::Models::Beta::BetaResponseConversationParam)]
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
# Text, image, or file inputs to the model, used to generate a response
|
|
171
|
+
module Input
|
|
172
|
+
extend OpenAI::Internal::Type::Union
|
|
173
|
+
|
|
174
|
+
# A text input to the model, equivalent to a text input with the `user` role.
|
|
175
|
+
variant String
|
|
176
|
+
|
|
177
|
+
# A list of one or many input items to the model, containing different content types.
|
|
178
|
+
variant -> { OpenAI::Models::Beta::Responses::InputTokenCountParams::Input::BetaResponseInputItemArray }
|
|
179
|
+
|
|
180
|
+
# @!method self.variants
|
|
181
|
+
# @return [Array(String, Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>)]
|
|
182
|
+
|
|
183
|
+
# @type [OpenAI::Internal::Type::Converter]
|
|
184
|
+
BetaResponseInputItemArray =
|
|
185
|
+
OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::Beta::BetaResponseInputItem }]
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
# A model-owned style preset to apply to this request. Omit this parameter to use
|
|
189
|
+
# the model's default style. Supported values may expand over time. Values must be
|
|
190
|
+
# at most 64 characters.
|
|
191
|
+
module Personality
|
|
192
|
+
extend OpenAI::Internal::Type::Union
|
|
193
|
+
|
|
194
|
+
variant String
|
|
195
|
+
|
|
196
|
+
variant const: -> { OpenAI::Models::Beta::Responses::InputTokenCountParams::Personality::FRIENDLY }
|
|
197
|
+
|
|
198
|
+
variant const: -> { OpenAI::Models::Beta::Responses::InputTokenCountParams::Personality::PRAGMATIC }
|
|
199
|
+
|
|
200
|
+
# @!method self.variants
|
|
201
|
+
# @return [Array(String, Symbol)]
|
|
202
|
+
|
|
203
|
+
define_sorbet_constant!(:Variants) do
|
|
204
|
+
T.type_alias { T.any(String, OpenAI::Beta::Responses::InputTokenCountParams::Personality::TaggedSymbol) }
|
|
205
|
+
end
|
|
206
|
+
|
|
207
|
+
# @!group
|
|
208
|
+
|
|
209
|
+
FRIENDLY = :friendly
|
|
210
|
+
PRAGMATIC = :pragmatic
|
|
211
|
+
|
|
212
|
+
# @!endgroup
|
|
213
|
+
end
|
|
214
|
+
|
|
215
|
+
class Reasoning < OpenAI::Internal::Type::BaseModel
|
|
216
|
+
# @!attribute context
|
|
217
|
+
# Controls which reasoning items are rendered back to the model on later turns.
|
|
218
|
+
# When returned on a response, this is the effective reasoning context mode used
|
|
219
|
+
# for the response.
|
|
220
|
+
#
|
|
221
|
+
# @return [Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::Context, nil]
|
|
222
|
+
optional :context,
|
|
223
|
+
enum: -> { OpenAI::Beta::Responses::InputTokenCountParams::Reasoning::Context },
|
|
224
|
+
nil?: true
|
|
225
|
+
|
|
226
|
+
# @!attribute effort
|
|
227
|
+
# Constrains effort on reasoning for reasoning models. Currently supported values
|
|
228
|
+
# are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
229
|
+
# reasoning effort can result in faster responses and fewer tokens used on
|
|
230
|
+
# reasoning in a response. Not all reasoning models support every value. See the
|
|
231
|
+
# [reasoning guide](https://platform.openai.com/docs/guides/reasoning) for
|
|
232
|
+
# model-specific support.
|
|
233
|
+
#
|
|
234
|
+
# @return [Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::Effort, nil]
|
|
235
|
+
optional :effort,
|
|
236
|
+
enum: -> { OpenAI::Beta::Responses::InputTokenCountParams::Reasoning::Effort },
|
|
237
|
+
nil?: true
|
|
238
|
+
|
|
239
|
+
# @!attribute generate_summary
|
|
240
|
+
# @deprecated
|
|
241
|
+
#
|
|
242
|
+
# **Deprecated:** use `summary` instead.
|
|
243
|
+
#
|
|
244
|
+
# A summary of the reasoning performed by the model. This can be useful for
|
|
245
|
+
# debugging and understanding the model's reasoning process. One of `auto`,
|
|
246
|
+
# `concise`, or `detailed`.
|
|
247
|
+
#
|
|
248
|
+
# @return [Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::GenerateSummary, nil]
|
|
249
|
+
optional :generate_summary,
|
|
250
|
+
enum: -> { OpenAI::Beta::Responses::InputTokenCountParams::Reasoning::GenerateSummary },
|
|
251
|
+
nil?: true
|
|
252
|
+
|
|
253
|
+
# @!attribute mode
|
|
254
|
+
# Controls the reasoning execution mode for the request.
|
|
255
|
+
#
|
|
256
|
+
# When returned on a response, this is the effective execution mode.
|
|
257
|
+
#
|
|
258
|
+
# @return [String, Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::Mode, nil]
|
|
259
|
+
optional :mode, union: -> { OpenAI::Beta::Responses::InputTokenCountParams::Reasoning::Mode }
|
|
260
|
+
|
|
261
|
+
# @!attribute summary
|
|
262
|
+
# A summary of the reasoning performed by the model. This can be useful for
|
|
263
|
+
# debugging and understanding the model's reasoning process. One of `auto`,
|
|
264
|
+
# `concise`, or `detailed`.
|
|
265
|
+
#
|
|
266
|
+
# `concise` is supported for `computer-use-preview` models and all reasoning
|
|
267
|
+
# models after `gpt-5`.
|
|
268
|
+
#
|
|
269
|
+
# @return [Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::Summary, nil]
|
|
270
|
+
optional :summary,
|
|
271
|
+
enum: -> { OpenAI::Beta::Responses::InputTokenCountParams::Reasoning::Summary },
|
|
272
|
+
nil?: true
|
|
273
|
+
|
|
274
|
+
# @!method initialize(context: nil, effort: nil, generate_summary: nil, mode: nil, summary: nil)
|
|
275
|
+
# Some parameter documentations has been truncated, see
|
|
276
|
+
# {OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning} for more
|
|
277
|
+
# details.
|
|
278
|
+
#
|
|
279
|
+
# **gpt-5 and o-series models only** Configuration options for
|
|
280
|
+
# [reasoning models](https://platform.openai.com/docs/guides/reasoning).
|
|
281
|
+
#
|
|
282
|
+
# @param context [Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::Context, nil] Controls which reasoning items are rendered back to the model on later turns.
|
|
283
|
+
#
|
|
284
|
+
# @param effort [Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::Effort, nil] Constrains effort on reasoning for reasoning models. Currently supported
|
|
285
|
+
#
|
|
286
|
+
# @param generate_summary [Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::GenerateSummary, nil] **Deprecated:** use `summary` instead.
|
|
287
|
+
#
|
|
288
|
+
# @param mode [String, Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::Mode] Controls the reasoning execution mode for the request.
|
|
289
|
+
#
|
|
290
|
+
# @param summary [Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::Summary, nil] A summary of the reasoning performed by the model. This can be
|
|
291
|
+
|
|
292
|
+
# Controls which reasoning items are rendered back to the model on later turns.
|
|
293
|
+
# When returned on a response, this is the effective reasoning context mode used
|
|
294
|
+
# for the response.
|
|
295
|
+
#
|
|
296
|
+
# @see OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning#context
|
|
297
|
+
module Context
|
|
298
|
+
extend OpenAI::Internal::Type::Enum
|
|
299
|
+
|
|
300
|
+
AUTO = :auto
|
|
301
|
+
CURRENT_TURN = :current_turn
|
|
302
|
+
ALL_TURNS = :all_turns
|
|
303
|
+
|
|
304
|
+
# @!method self.values
|
|
305
|
+
# @return [Array<Symbol>]
|
|
306
|
+
end
|
|
307
|
+
|
|
308
|
+
# Constrains effort on reasoning for reasoning models. Currently supported values
|
|
309
|
+
# are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
310
|
+
# reasoning effort can result in faster responses and fewer tokens used on
|
|
311
|
+
# reasoning in a response. Not all reasoning models support every value. See the
|
|
312
|
+
# [reasoning guide](https://platform.openai.com/docs/guides/reasoning) for
|
|
313
|
+
# model-specific support.
|
|
314
|
+
#
|
|
315
|
+
# @see OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning#effort
|
|
316
|
+
module Effort
|
|
317
|
+
extend OpenAI::Internal::Type::Enum
|
|
318
|
+
|
|
319
|
+
NONE = :none
|
|
320
|
+
MINIMAL = :minimal
|
|
321
|
+
LOW = :low
|
|
322
|
+
MEDIUM = :medium
|
|
323
|
+
HIGH = :high
|
|
324
|
+
XHIGH = :xhigh
|
|
325
|
+
MAX = :max
|
|
326
|
+
|
|
327
|
+
# @!method self.values
|
|
328
|
+
# @return [Array<Symbol>]
|
|
329
|
+
end
|
|
330
|
+
|
|
331
|
+
# @deprecated
|
|
332
|
+
#
|
|
333
|
+
# **Deprecated:** use `summary` instead.
|
|
334
|
+
#
|
|
335
|
+
# A summary of the reasoning performed by the model. This can be useful for
|
|
336
|
+
# debugging and understanding the model's reasoning process. One of `auto`,
|
|
337
|
+
# `concise`, or `detailed`.
|
|
338
|
+
#
|
|
339
|
+
# @see OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning#generate_summary
|
|
340
|
+
module GenerateSummary
|
|
341
|
+
extend OpenAI::Internal::Type::Enum
|
|
342
|
+
|
|
343
|
+
AUTO = :auto
|
|
344
|
+
CONCISE = :concise
|
|
345
|
+
DETAILED = :detailed
|
|
346
|
+
|
|
347
|
+
# @!method self.values
|
|
348
|
+
# @return [Array<Symbol>]
|
|
349
|
+
end
|
|
350
|
+
|
|
351
|
+
# Controls the reasoning execution mode for the request.
|
|
352
|
+
#
|
|
353
|
+
# When returned on a response, this is the effective execution mode.
|
|
354
|
+
#
|
|
355
|
+
# @see OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning#mode
|
|
356
|
+
module Mode
|
|
357
|
+
extend OpenAI::Internal::Type::Union
|
|
358
|
+
|
|
359
|
+
variant String
|
|
360
|
+
|
|
361
|
+
variant const: -> { OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::Mode::STANDARD }
|
|
362
|
+
|
|
363
|
+
variant const: -> { OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning::Mode::PRO }
|
|
364
|
+
|
|
365
|
+
# @!method self.variants
|
|
366
|
+
# @return [Array(String, Symbol)]
|
|
367
|
+
|
|
368
|
+
define_sorbet_constant!(:Variants) do
|
|
369
|
+
T.type_alias { T.any(String, OpenAI::Beta::Responses::InputTokenCountParams::Reasoning::Mode::TaggedSymbol) }
|
|
370
|
+
end
|
|
371
|
+
|
|
372
|
+
# @!group
|
|
373
|
+
|
|
374
|
+
STANDARD = :standard
|
|
375
|
+
PRO = :pro
|
|
376
|
+
|
|
377
|
+
# @!endgroup
|
|
378
|
+
end
|
|
379
|
+
|
|
380
|
+
# A summary of the reasoning performed by the model. This can be useful for
|
|
381
|
+
# debugging and understanding the model's reasoning process. One of `auto`,
|
|
382
|
+
# `concise`, or `detailed`.
|
|
383
|
+
#
|
|
384
|
+
# `concise` is supported for `computer-use-preview` models and all reasoning
|
|
385
|
+
# models after `gpt-5`.
|
|
386
|
+
#
|
|
387
|
+
# @see OpenAI::Models::Beta::Responses::InputTokenCountParams::Reasoning#summary
|
|
388
|
+
module Summary
|
|
389
|
+
extend OpenAI::Internal::Type::Enum
|
|
390
|
+
|
|
391
|
+
AUTO = :auto
|
|
392
|
+
CONCISE = :concise
|
|
393
|
+
DETAILED = :detailed
|
|
394
|
+
|
|
395
|
+
# @!method self.values
|
|
396
|
+
# @return [Array<Symbol>]
|
|
397
|
+
end
|
|
398
|
+
end
|
|
399
|
+
|
|
400
|
+
class Text < OpenAI::Internal::Type::BaseModel
|
|
401
|
+
# @!attribute format_
|
|
402
|
+
# An object specifying the format that the model must output.
|
|
403
|
+
#
|
|
404
|
+
# Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
|
|
405
|
+
# ensures the model will match your supplied JSON schema. Learn more in the
|
|
406
|
+
# [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
|
|
407
|
+
#
|
|
408
|
+
# The default format is `{ "type": "text" }` with no additional options.
|
|
409
|
+
#
|
|
410
|
+
# **Not recommended for gpt-4o and newer models:**
|
|
411
|
+
#
|
|
412
|
+
# Setting to `{ "type": "json_object" }` enables the older JSON mode, which
|
|
413
|
+
# ensures the message the model generates is valid JSON. Using `json_schema` is
|
|
414
|
+
# preferred for models that support it.
|
|
415
|
+
#
|
|
416
|
+
# @return [OpenAI::Models::Beta::BetaResponseFormatTextConfig::Text, OpenAI::Models::Beta::BetaResponseFormatTextJSONSchemaConfig, OpenAI::Models::Beta::BetaResponseFormatTextConfig::JSONObject, nil]
|
|
417
|
+
optional :format_, union: -> { OpenAI::Beta::BetaResponseFormatTextConfig }, api_name: :format
|
|
418
|
+
|
|
419
|
+
# @!attribute verbosity
|
|
420
|
+
# Constrains the verbosity of the model's response. Lower values will result in
|
|
421
|
+
# more concise responses, while higher values will result in more verbose
|
|
422
|
+
# responses. Currently supported values are `low`, `medium`, and `high`.
|
|
423
|
+
#
|
|
424
|
+
# @return [Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Text::Verbosity, nil]
|
|
425
|
+
optional :verbosity,
|
|
426
|
+
enum: -> { OpenAI::Beta::Responses::InputTokenCountParams::Text::Verbosity },
|
|
427
|
+
nil?: true
|
|
428
|
+
|
|
429
|
+
# @!method initialize(format_: nil, verbosity: nil)
|
|
430
|
+
# Some parameter documentations has been truncated, see
|
|
431
|
+
# {OpenAI::Models::Beta::Responses::InputTokenCountParams::Text} for more details.
|
|
432
|
+
#
|
|
433
|
+
# Configuration options for a text response from the model. Can be plain text or
|
|
434
|
+
# structured JSON data. Learn more:
|
|
435
|
+
#
|
|
436
|
+
# - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
|
|
437
|
+
# - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
|
|
438
|
+
#
|
|
439
|
+
# @param format_ [OpenAI::Models::Beta::BetaResponseFormatTextConfig::Text, OpenAI::Models::Beta::BetaResponseFormatTextJSONSchemaConfig, OpenAI::Models::Beta::BetaResponseFormatTextConfig::JSONObject] An object specifying the format that the model must output.
|
|
440
|
+
#
|
|
441
|
+
# @param verbosity [Symbol, OpenAI::Models::Beta::Responses::InputTokenCountParams::Text::Verbosity, nil] Constrains the verbosity of the model's response. Lower values will result in
|
|
442
|
+
|
|
443
|
+
# Constrains the verbosity of the model's response. Lower values will result in
|
|
444
|
+
# more concise responses, while higher values will result in more verbose
|
|
445
|
+
# responses. Currently supported values are `low`, `medium`, and `high`.
|
|
446
|
+
#
|
|
447
|
+
# @see OpenAI::Models::Beta::Responses::InputTokenCountParams::Text#verbosity
|
|
448
|
+
module Verbosity
|
|
449
|
+
extend OpenAI::Internal::Type::Enum
|
|
450
|
+
|
|
451
|
+
LOW = :low
|
|
452
|
+
MEDIUM = :medium
|
|
453
|
+
HIGH = :high
|
|
454
|
+
|
|
455
|
+
# @!method self.values
|
|
456
|
+
# @return [Array<Symbol>]
|
|
457
|
+
end
|
|
458
|
+
end
|
|
459
|
+
|
|
460
|
+
# Controls which tool the model should use, if any.
|
|
461
|
+
module ToolChoice
|
|
462
|
+
extend OpenAI::Internal::Type::Union
|
|
463
|
+
|
|
464
|
+
# Controls which (if any) tool is called by the model.
|
|
465
|
+
#
|
|
466
|
+
# `none` means the model will not call any tool and instead generates a message.
|
|
467
|
+
#
|
|
468
|
+
# `auto` means the model can pick between generating a message or calling one or
|
|
469
|
+
# more tools.
|
|
470
|
+
#
|
|
471
|
+
# `required` means the model must call one or more tools.
|
|
472
|
+
variant enum: -> { OpenAI::Beta::BetaToolChoiceOptions }
|
|
473
|
+
|
|
474
|
+
# Constrains the tools available to the model to a pre-defined set.
|
|
475
|
+
variant -> { OpenAI::Beta::BetaToolChoiceAllowed }
|
|
476
|
+
|
|
477
|
+
# Indicates that the model should use a built-in tool to generate a response.
|
|
478
|
+
# [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools).
|
|
479
|
+
variant -> { OpenAI::Beta::BetaToolChoiceTypes }
|
|
480
|
+
|
|
481
|
+
# Use this option to force the model to call a specific function.
|
|
482
|
+
variant -> { OpenAI::Beta::BetaToolChoiceFunction }
|
|
483
|
+
|
|
484
|
+
# Use this option to force the model to call a specific tool on a remote MCP server.
|
|
485
|
+
variant -> { OpenAI::Beta::BetaToolChoiceMcp }
|
|
486
|
+
|
|
487
|
+
# Use this option to force the model to call a specific custom tool.
|
|
488
|
+
variant -> { OpenAI::Beta::BetaToolChoiceCustom }
|
|
489
|
+
|
|
490
|
+
variant -> { OpenAI::Beta::Responses::InputTokenCountParams::ToolChoice::BetaSpecificProgrammaticToolCallingParam }
|
|
491
|
+
|
|
492
|
+
# Forces the model to call the apply_patch tool when executing a tool call.
|
|
493
|
+
variant -> { OpenAI::Beta::BetaToolChoiceApplyPatch }
|
|
494
|
+
|
|
495
|
+
# Forces the model to call the shell tool when a tool call is required.
|
|
496
|
+
variant -> { OpenAI::Beta::BetaToolChoiceShell }
|
|
497
|
+
|
|
498
|
+
class BetaSpecificProgrammaticToolCallingParam < OpenAI::Internal::Type::BaseModel
|
|
499
|
+
# @!attribute type
|
|
500
|
+
# The tool to call. Always `programmatic_tool_calling`.
|
|
501
|
+
#
|
|
502
|
+
# @return [Symbol, :programmatic_tool_calling]
|
|
503
|
+
required :type, const: :programmatic_tool_calling
|
|
504
|
+
|
|
505
|
+
# @!method initialize(type: :programmatic_tool_calling)
|
|
506
|
+
# @param type [Symbol, :programmatic_tool_calling] The tool to call. Always `programmatic_tool_calling`.
|
|
507
|
+
end
|
|
508
|
+
|
|
509
|
+
# @!method self.variants
|
|
510
|
+
# @return [Array(Symbol, OpenAI::Models::Beta::BetaToolChoiceOptions, OpenAI::Models::Beta::BetaToolChoiceAllowed, OpenAI::Models::Beta::BetaToolChoiceTypes, OpenAI::Models::Beta::BetaToolChoiceFunction, OpenAI::Models::Beta::BetaToolChoiceMcp, OpenAI::Models::Beta::BetaToolChoiceCustom, OpenAI::Models::Beta::Responses::InputTokenCountParams::ToolChoice::BetaSpecificProgrammaticToolCallingParam, OpenAI::Models::Beta::BetaToolChoiceApplyPatch, OpenAI::Models::Beta::BetaToolChoiceShell)]
|
|
511
|
+
end
|
|
512
|
+
|
|
513
|
+
# @deprecated
|
|
514
|
+
#
|
|
515
|
+
# The truncation strategy to use for the model response. - `auto`: If the input to
|
|
516
|
+
# this Response exceeds the model's context window size, the model will truncate
|
|
517
|
+
# the response to fit the context window by dropping items from the beginning of
|
|
518
|
+
# the conversation. - `disabled` (default): If the input size will exceed the
|
|
519
|
+
# context window size for a model, the request will fail with a 400 error.
|
|
520
|
+
module Truncation
|
|
521
|
+
extend OpenAI::Internal::Type::Enum
|
|
522
|
+
|
|
523
|
+
AUTO = :auto
|
|
524
|
+
DISABLED = :disabled
|
|
525
|
+
|
|
526
|
+
# @!method self.values
|
|
527
|
+
# @return [Array<Symbol>]
|
|
528
|
+
end
|
|
529
|
+
|
|
530
|
+
module Beta
|
|
531
|
+
extend OpenAI::Internal::Type::Enum
|
|
532
|
+
|
|
533
|
+
RESPONSES_MULTI_AGENT_V1 = :"responses_multi_agent=v1"
|
|
534
|
+
|
|
535
|
+
# @!method self.values
|
|
536
|
+
# @return [Array<Symbol>]
|
|
537
|
+
end
|
|
538
|
+
end
|
|
539
|
+
end
|
|
540
|
+
end
|
|
541
|
+
end
|
|
542
|
+
end
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Beta
|
|
6
|
+
module Responses
|
|
7
|
+
# @see OpenAI::Resources::Beta::Responses::InputTokens#count
|
|
8
|
+
class InputTokenCountResponse < OpenAI::Internal::Type::BaseModel
|
|
9
|
+
# @!attribute input_tokens
|
|
10
|
+
#
|
|
11
|
+
# @return [Integer]
|
|
12
|
+
required :input_tokens, Integer
|
|
13
|
+
|
|
14
|
+
# @!attribute object
|
|
15
|
+
#
|
|
16
|
+
# @return [Symbol, :"response.input_tokens"]
|
|
17
|
+
required :object, const: :"response.input_tokens"
|
|
18
|
+
|
|
19
|
+
# @!method initialize(input_tokens:, object: :"response.input_tokens")
|
|
20
|
+
# @param input_tokens [Integer]
|
|
21
|
+
# @param object [Symbol, :"response.input_tokens"]
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
|
@@ -112,19 +112,12 @@ module OpenAI
|
|
|
112
112
|
optional :parallel_tool_calls, OpenAI::Internal::Type::Boolean
|
|
113
113
|
|
|
114
114
|
# @!attribute reasoning_effort
|
|
115
|
-
# Constrains effort on reasoning for
|
|
116
|
-
#
|
|
117
|
-
#
|
|
118
|
-
#
|
|
119
|
-
#
|
|
120
|
-
#
|
|
121
|
-
# - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported
|
|
122
|
-
# reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool
|
|
123
|
-
# calls are supported for all reasoning values in gpt-5.1.
|
|
124
|
-
# - All models before `gpt-5.1` default to `medium` reasoning effort, and do not
|
|
125
|
-
# support `none`.
|
|
126
|
-
# - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
127
|
-
# - `xhigh` is supported for all models after `gpt-5.1-codex-max`.
|
|
115
|
+
# Constrains effort on reasoning for reasoning models. Currently supported values
|
|
116
|
+
# are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
|
|
117
|
+
# reasoning effort can result in faster responses and fewer tokens used on
|
|
118
|
+
# reasoning in a response. Not all reasoning models support every value. See the
|
|
119
|
+
# [reasoning guide](https://platform.openai.com/docs/guides/reasoning) for
|
|
120
|
+
# model-specific support.
|
|
128
121
|
#
|
|
129
122
|
# @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
|
|
130
123
|
optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
|
|
@@ -230,7 +223,7 @@ module OpenAI
|
|
|
230
223
|
#
|
|
231
224
|
# @param parallel_tool_calls [Boolean] Whether to enable [parallel function calling](https://platform.openai.com/docs/g
|
|
232
225
|
#
|
|
233
|
-
# @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for
|
|
226
|
+
# @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for reasoning models. Currently supported
|
|
234
227
|
#
|
|
235
228
|
# @param response_format [Symbol, :auto, OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONObject, OpenAI::Models::ResponseFormatJSONSchema, nil] Specifies the format that the model must output. Compatible with [GPT-4o](https:
|
|
236
229
|
#
|
|
@@ -34,12 +34,26 @@ module OpenAI
|
|
|
34
34
|
# @return [Symbol, :file]
|
|
35
35
|
required :type, const: :file
|
|
36
36
|
|
|
37
|
-
# @!
|
|
37
|
+
# @!attribute prompt_cache_breakpoint
|
|
38
|
+
# Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
|
|
39
|
+
# from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
|
|
40
|
+
# token block.
|
|
41
|
+
#
|
|
42
|
+
# @return [OpenAI::Models::Chat::ChatCompletionContentPart::File::PromptCacheBreakpoint, nil]
|
|
43
|
+
optional :prompt_cache_breakpoint,
|
|
44
|
+
-> { OpenAI::Chat::ChatCompletionContentPart::File::PromptCacheBreakpoint }
|
|
45
|
+
|
|
46
|
+
# @!method initialize(file:, prompt_cache_breakpoint: nil, type: :file)
|
|
47
|
+
# Some parameter documentations has been truncated, see
|
|
48
|
+
# {OpenAI::Models::Chat::ChatCompletionContentPart::File} for more details.
|
|
49
|
+
#
|
|
38
50
|
# Learn about [file inputs](https://platform.openai.com/docs/guides/text) for text
|
|
39
51
|
# generation.
|
|
40
52
|
#
|
|
41
53
|
# @param file [OpenAI::Models::Chat::ChatCompletionContentPart::File::File]
|
|
42
54
|
#
|
|
55
|
+
# @param prompt_cache_breakpoint [OpenAI::Models::Chat::ChatCompletionContentPart::File::PromptCacheBreakpoint] Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
|
|
56
|
+
#
|
|
43
57
|
# @param type [Symbol, :file] The type of the content part. Always `file`.
|
|
44
58
|
|
|
45
59
|
# @see OpenAI::Models::Chat::ChatCompletionContentPart::File#file
|
|
@@ -73,6 +87,22 @@ module OpenAI
|
|
|
73
87
|
#
|
|
74
88
|
# @param filename [String] The name of the file, used when passing the file to the model as a
|
|
75
89
|
end
|
|
90
|
+
|
|
91
|
+
# @see OpenAI::Models::Chat::ChatCompletionContentPart::File#prompt_cache_breakpoint
|
|
92
|
+
class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
|
|
93
|
+
# @!attribute mode
|
|
94
|
+
# The breakpoint mode. Always `explicit`.
|
|
95
|
+
#
|
|
96
|
+
# @return [Symbol, :explicit]
|
|
97
|
+
required :mode, const: :explicit
|
|
98
|
+
|
|
99
|
+
# @!method initialize(mode: :explicit)
|
|
100
|
+
# Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
|
|
101
|
+
# from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
|
|
102
|
+
# token block.
|
|
103
|
+
#
|
|
104
|
+
# @param mode [Symbol, :explicit] The breakpoint mode. Always `explicit`.
|
|
105
|
+
end
|
|
76
106
|
end
|
|
77
107
|
|
|
78
108
|
# @!method self.variants
|