Module: OpenAI::Models::Responses

Defined in:

lib/openai/models/responses/tool.rb,
lib/openai/models/responses/response.rb,
lib/openai/models/responses/custom_tool.rb,
lib/openai/models/responses/computer_tool.rb,
lib/openai/models/responses/function_tool.rb,
lib/openai/models/responses/response_item.rb,
lib/openai/models/responses/response_error.rb,
lib/openai/models/responses/response_input.rb,
lib/openai/models/responses/response_usage.rb,
lib/openai/models/responses/response_prompt.rb,
lib/openai/models/responses/response_status.rb,
lib/openai/models/responses/tool_choice_mcp.rb,
lib/openai/models/responses/web_search_tool.rb,
lib/openai/models/responses/apply_patch_tool.rb,
lib/openai/models/responses/file_search_tool.rb,
lib/openai/models/responses/response_content.rb,
lib/openai/models/responses/tool_choice_shell.rb,
lib/openai/models/responses/tool_choice_types.rb,
lib/openai/models/responses/easy_input_message.rb,
lib/openai/models/responses/response_item_list.rb,
lib/openai/models/responses/tool_choice_custom.rb,
lib/openai/models/responses/function_shell_tool.rb,
lib/openai/models/responses/response_includable.rb,
lib/openai/models/responses/response_input_file.rb,
lib/openai/models/responses/response_input_item.rb,
lib/openai/models/responses/response_input_text.rb,
lib/openai/models/responses/tool_choice_allowed.rb,
lib/openai/models/responses/tool_choice_options.rb,
lib/openai/models/responses/response_error_event.rb,
lib/openai/models/responses/response_input_audio.rb,
lib/openai/models/responses/response_input_image.rb,
lib/openai/models/responses/response_output_item.rb,
lib/openai/models/responses/response_output_text.rb,
lib/openai/models/responses/response_text_config.rb,
lib/openai/models/responses/tool_choice_function.rb,
lib/openai/models/responses/response_failed_event.rb,
lib/openai/models/responses/response_output_audio.rb,
lib/openai/models/responses/response_queued_event.rb,
lib/openai/models/responses/response_stream_event.rb,
lib/openai/models/responses/input_item_list_params.rb,
lib/openai/models/responses/response_cancel_params.rb,
lib/openai/models/responses/response_create_params.rb,
lib/openai/models/responses/response_created_event.rb,
lib/openai/models/responses/response_delete_params.rb,
lib/openai/models/responses/response_input_content.rb,
lib/openai/models/responses/response_output_message.rb,
lib/openai/models/responses/response_output_refusal.rb,
lib/openai/models/responses/response_reasoning_item.rb,
lib/openai/models/responses/tool_choice_apply_patch.rb,
lib/openai/models/responses/web_search_preview_tool.rb,
lib/openai/models/responses/input_token_count_params.rb,
lib/openai/models/responses/response_completed_event.rb,
lib/openai/models/responses/response_retrieve_params.rb,
lib/openai/models/responses/response_text_done_event.rb,
lib/openai/models/responses/response_audio_done_event.rb,
lib/openai/models/responses/response_custom_tool_call.rb,
lib/openai/models/responses/response_incomplete_event.rb,
lib/openai/models/responses/response_text_delta_event.rb,
lib/openai/models/responses/input_token_count_response.rb,
lib/openai/models/responses/response_audio_delta_event.rb,
lib/openai/models/responses/response_in_progress_event.rb,
lib/openai/models/responses/response_computer_tool_call.rb,
lib/openai/models/responses/response_conversation_param.rb,
lib/openai/models/responses/response_format_text_config.rb,
lib/openai/models/responses/response_function_tool_call.rb,
lib/openai/models/responses/response_input_file_content.rb,
lib/openai/models/responses/response_input_message_item.rb,
lib/openai/models/responses/response_input_text_content.rb,
lib/openai/models/responses/response_refusal_done_event.rb,
lib/openai/models/responses/response_function_web_search.rb,
lib/openai/models/responses/response_input_image_content.rb,
lib/openai/models/responses/response_refusal_delta_event.rb,
lib/openai/models/responses/response_apply_patch_tool_call.rb,
lib/openai/models/responses/response_file_search_tool_call.rb,
lib/openai/models/responses/response_mcp_call_failed_event.rb,
lib/openai/models/responses/response_output_item_done_event.rb,
lib/openai/models/responses/response_content_part_done_event.rb,
lib/openai/models/responses/response_custom_tool_call_output.rb,
lib/openai/models/responses/response_function_tool_call_item.rb,
lib/openai/models/responses/response_output_item_added_event.rb,
lib/openai/models/responses/response_content_part_added_event.rb,
lib/openai/models/responses/response_function_shell_tool_call.rb,
lib/openai/models/responses/response_mcp_call_completed_event.rb,
lib/openai/models/responses/response_function_call_output_item.rb,
lib/openai/models/responses/response_reasoning_text_done_event.rb,
lib/openai/models/responses/response_code_interpreter_tool_call.rb,
lib/openai/models/responses/response_input_message_content_list.rb,
lib/openai/models/responses/response_mcp_call_in_progress_event.rb,
lib/openai/models/responses/response_reasoning_text_delta_event.rb,
lib/openai/models/responses/response_audio_transcript_done_event.rb,
lib/openai/models/responses/response_mcp_list_tools_failed_event.rb,
lib/openai/models/responses/response_apply_patch_tool_call_output.rb,
lib/openai/models/responses/response_audio_transcript_delta_event.rb,
lib/openai/models/responses/response_mcp_call_arguments_done_event.rb,
lib/openai/models/responses/response_computer_tool_call_output_item.rb,
lib/openai/models/responses/response_format_text_json_schema_config.rb,
lib/openai/models/responses/response_function_call_output_item_list.rb,
lib/openai/models/responses/response_function_tool_call_output_item.rb,
lib/openai/models/responses/response_image_gen_call_completed_event.rb,
lib/openai/models/responses/response_mcp_call_arguments_delta_event.rb,
lib/openai/models/responses/response_mcp_list_tools_completed_event.rb,
lib/openai/models/responses/response_function_shell_tool_call_output.rb,
lib/openai/models/responses/response_image_gen_call_generating_event.rb,
lib/openai/models/responses/response_web_search_call_completed_event.rb,
lib/openai/models/responses/response_web_search_call_searching_event.rb,
lib/openai/models/responses/response_file_search_call_completed_event.rb,
lib/openai/models/responses/response_file_search_call_searching_event.rb,
lib/openai/models/responses/response_image_gen_call_in_progress_event.rb,
lib/openai/models/responses/response_mcp_list_tools_in_progress_event.rb,
lib/openai/models/responses/response_custom_tool_call_input_done_event.rb,
lib/openai/models/responses/response_reasoning_summary_part_done_event.rb,
lib/openai/models/responses/response_reasoning_summary_text_done_event.rb,
lib/openai/models/responses/response_web_search_call_in_progress_event.rb,
lib/openai/models/responses/response_custom_tool_call_input_delta_event.rb,
lib/openai/models/responses/response_file_search_call_in_progress_event.rb,
lib/openai/models/responses/response_function_call_arguments_done_event.rb,
lib/openai/models/responses/response_function_shell_call_output_content.rb,
lib/openai/models/responses/response_image_gen_call_partial_image_event.rb,
lib/openai/models/responses/response_output_text_annotation_added_event.rb,
lib/openai/models/responses/response_reasoning_summary_part_added_event.rb,
lib/openai/models/responses/response_reasoning_summary_text_delta_event.rb,
lib/openai/models/responses/response_function_call_arguments_delta_event.rb,
lib/openai/models/responses/response_computer_tool_call_output_screenshot.rb,
lib/openai/models/responses/response_code_interpreter_call_code_done_event.rb,
lib/openai/models/responses/response_code_interpreter_call_completed_event.rb,
lib/openai/models/responses/response_code_interpreter_call_code_delta_event.rb,
lib/openai/models/responses/response_code_interpreter_call_in_progress_event.rb,
lib/openai/models/responses/response_code_interpreter_call_interpreting_event.rb

Defined Under Namespace

Modules: ResponseContent, ResponseFormatTextConfig, ResponseFunctionCallOutputItem, ResponseIncludable, ResponseInputContent, ResponseInputItem, ResponseItem, ResponseOutputItem, ResponseStatus, ResponseStreamEvent, Tool, ToolChoiceOptions Classes: ApplyPatchTool, ComputerTool, CustomTool, EasyInputMessage, FileSearchTool, FunctionShellTool, FunctionTool, InputItemListParams, InputTokenCountParams, InputTokenCountResponse, Response, ResponseApplyPatchToolCall, ResponseApplyPatchToolCallOutput, ResponseAudioDeltaEvent, ResponseAudioDoneEvent, ResponseAudioTranscriptDeltaEvent, ResponseAudioTranscriptDoneEvent, ResponseCancelParams, ResponseCodeInterpreterCallCodeDeltaEvent, ResponseCodeInterpreterCallCodeDoneEvent, ResponseCodeInterpreterCallCompletedEvent, ResponseCodeInterpreterCallInProgressEvent, ResponseCodeInterpreterCallInterpretingEvent, ResponseCodeInterpreterToolCall, ResponseCompletedEvent, ResponseComputerToolCall, ResponseComputerToolCallOutputItem, ResponseComputerToolCallOutputScreenshot, ResponseContentPartAddedEvent, ResponseContentPartDoneEvent, ResponseConversationParam, ResponseCreateParams, ResponseCreatedEvent, ResponseCustomToolCall, ResponseCustomToolCallInputDeltaEvent, ResponseCustomToolCallInputDoneEvent, ResponseCustomToolCallOutput, ResponseDeleteParams, ResponseError, ResponseErrorEvent, ResponseFailedEvent, ResponseFileSearchCallCompletedEvent, ResponseFileSearchCallInProgressEvent, ResponseFileSearchCallSearchingEvent, ResponseFileSearchToolCall, ResponseFormatTextJSONSchemaConfig, ResponseFunctionCallArgumentsDeltaEvent, ResponseFunctionCallArgumentsDoneEvent, ResponseFunctionShellCallOutputContent, ResponseFunctionShellToolCall, ResponseFunctionShellToolCallOutput, ResponseFunctionToolCall, ResponseFunctionToolCallItem, ResponseFunctionToolCallOutputItem, ResponseFunctionWebSearch, ResponseImageGenCallCompletedEvent, ResponseImageGenCallGeneratingEvent, ResponseImageGenCallInProgressEvent, ResponseImageGenCallPartialImageEvent, ResponseInProgressEvent, ResponseIncompleteEvent, ResponseInputAudio, ResponseInputFile, ResponseInputFileContent, ResponseInputImage, ResponseInputImageContent, ResponseInputMessageItem, ResponseInputText, ResponseInputTextContent, ResponseItemList, ResponseMcpCallArgumentsDeltaEvent, ResponseMcpCallArgumentsDoneEvent, ResponseMcpCallCompletedEvent, ResponseMcpCallFailedEvent, ResponseMcpCallInProgressEvent, ResponseMcpListToolsCompletedEvent, ResponseMcpListToolsFailedEvent, ResponseMcpListToolsInProgressEvent, ResponseOutputAudio, ResponseOutputItemAddedEvent, ResponseOutputItemDoneEvent, ResponseOutputMessage, ResponseOutputRefusal, ResponseOutputText, ResponseOutputTextAnnotationAddedEvent, ResponsePrompt, ResponseQueuedEvent, ResponseReasoningItem, ResponseReasoningSummaryPartAddedEvent, ResponseReasoningSummaryPartDoneEvent, ResponseReasoningSummaryTextDeltaEvent, ResponseReasoningSummaryTextDoneEvent, ResponseReasoningTextDeltaEvent, ResponseReasoningTextDoneEvent, ResponseRefusalDeltaEvent, ResponseRefusalDoneEvent, ResponseRetrieveParams, ResponseTextConfig, ResponseTextDeltaEvent, ResponseTextDoneEvent, ResponseUsage, ResponseWebSearchCallCompletedEvent, ResponseWebSearchCallInProgressEvent, ResponseWebSearchCallSearchingEvent, ToolChoiceAllowed, ToolChoiceApplyPatch, ToolChoiceCustom, ToolChoiceFunction, ToolChoiceMcp, ToolChoiceShell, ToolChoiceTypes, WebSearchPreviewTool, WebSearchTool

Constant Summary

ResponseInput =

OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::Responses::ResponseInputItem }]

ResponseInputMessageContentList =

OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::Responses::ResponseInputContent }]

ResponseFunctionCallOutputItemList =

OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::Responses::ResponseFunctionCallOutputItem }]