openai 0.36.1 → 0.37.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 +14 -0
- data/README.md +1 -1
- data/lib/openai/models/all_models.rb +1 -0
- data/lib/openai/models/beta/assistant_create_params.rb +4 -3
- data/lib/openai/models/beta/assistant_update_params.rb +4 -3
- data/lib/openai/models/beta/threads/run_create_params.rb +4 -3
- data/lib/openai/models/chat/completion_create_params.rb +4 -3
- data/lib/openai/models/container_create_params.rb +22 -1
- data/lib/openai/models/container_create_response.rb +32 -1
- data/lib/openai/models/container_list_response.rb +32 -1
- data/lib/openai/models/container_retrieve_response.rb +32 -1
- data/lib/openai/models/conversations/conversation_create_params.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 +4 -3
- data/lib/openai/models/evals/run_cancel_response.rb +8 -6
- data/lib/openai/models/evals/run_create_params.rb +8 -6
- data/lib/openai/models/evals/run_create_response.rb +8 -6
- data/lib/openai/models/evals/run_list_response.rb +8 -6
- data/lib/openai/models/evals/run_retrieve_response.rb +8 -6
- data/lib/openai/models/graders/score_model_grader.rb +4 -3
- data/lib/openai/models/realtime/input_audio_buffer_dtmf_event_received_event.rb +43 -0
- data/lib/openai/models/realtime/output_audio_buffer_clear_event.rb +4 -4
- data/lib/openai/models/realtime/realtime_audio_input_turn_detection.rb +13 -5
- data/lib/openai/models/realtime/realtime_client_event.rb +1 -1
- data/lib/openai/models/realtime/realtime_server_event.rb +16 -9
- data/lib/openai/models/realtime/realtime_session.rb +13 -5
- data/lib/openai/models/realtime/realtime_session_create_request.rb +14 -9
- data/lib/openai/models/realtime/realtime_session_create_response.rb +27 -14
- data/lib/openai/models/realtime/realtime_transcription_session_audio_input_turn_detection.rb +13 -5
- data/lib/openai/models/realtime/realtime_truncation.rb +14 -9
- data/lib/openai/models/reasoning.rb +4 -3
- data/lib/openai/models/reasoning_effort.rb +5 -3
- data/lib/openai/models/responses/compacted_response.rb +56 -0
- data/lib/openai/models/responses/input_token_count_params.rb +4 -4
- data/lib/openai/models/responses/response.rb +6 -6
- data/lib/openai/models/responses/response_compact_params.rb +344 -0
- data/lib/openai/models/responses/response_compaction_item.rb +43 -0
- data/lib/openai/models/responses/response_compaction_item_param.rb +36 -0
- data/lib/openai/models/responses/response_create_params.rb +4 -4
- data/lib/openai/models/responses/response_function_shell_call_output_content.rb +10 -10
- data/lib/openai/models/responses/response_function_shell_tool_call.rb +5 -5
- data/lib/openai/models/responses/response_function_shell_tool_call_output.rb +2 -2
- data/lib/openai/models/responses/response_input_item.rb +20 -17
- data/lib/openai/models/responses/response_output_item.rb +4 -1
- data/lib/openai/models/responses/response_output_item_added_event.rb +2 -2
- data/lib/openai/models/responses/response_output_item_done_event.rb +2 -2
- data/lib/openai/models/responses/tool.rb +4 -2
- data/lib/openai/models/responses/tool_choice_shell.rb +1 -1
- data/lib/openai/models/responses_model.rb +1 -0
- data/lib/openai/models/video_create_params.rb +11 -6
- data/lib/openai/resources/containers.rb +3 -1
- data/lib/openai/resources/conversations/items.rb +1 -1
- data/lib/openai/resources/conversations.rb +1 -1
- data/lib/openai/resources/responses/input_tokens.rb +1 -1
- data/lib/openai/resources/responses.rb +33 -2
- data/lib/openai/resources/videos.rb +6 -3
- data/lib/openai/resources/webhooks.rb +0 -3
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +6 -0
- data/manifest.yaml +1 -0
- data/rbi/openai/models/all_models.rbi +5 -0
- data/rbi/openai/models/beta/assistant_create_params.rbi +8 -6
- data/rbi/openai/models/beta/assistant_update_params.rbi +8 -6
- data/rbi/openai/models/beta/threads/run_create_params.rbi +8 -6
- data/rbi/openai/models/chat/completion_create_params.rbi +8 -6
- data/rbi/openai/models/container_create_params.rbi +51 -0
- data/rbi/openai/models/container_create_response.rbi +81 -3
- data/rbi/openai/models/container_list_response.rbi +80 -3
- data/rbi/openai/models/container_retrieve_response.rbi +83 -3
- data/rbi/openai/models/conversations/conversation_create_params.rbi +3 -0
- data/rbi/openai/models/conversations/item_create_params.rbi +3 -0
- data/rbi/openai/models/evals/create_eval_completions_run_data_source.rbi +8 -6
- data/rbi/openai/models/evals/run_cancel_response.rbi +16 -12
- data/rbi/openai/models/evals/run_create_params.rbi +16 -12
- data/rbi/openai/models/evals/run_create_response.rbi +16 -12
- data/rbi/openai/models/evals/run_list_response.rbi +16 -12
- data/rbi/openai/models/evals/run_retrieve_response.rbi +16 -12
- data/rbi/openai/models/graders/score_model_grader.rbi +8 -6
- data/rbi/openai/models/realtime/input_audio_buffer_dtmf_event_received_event.rbi +56 -0
- data/rbi/openai/models/realtime/output_audio_buffer_clear_event.rbi +4 -4
- data/rbi/openai/models/realtime/realtime_audio_input_turn_detection.rbi +24 -8
- data/rbi/openai/models/realtime/realtime_server_event.rbi +6 -5
- data/rbi/openai/models/realtime/realtime_session.rbi +24 -8
- data/rbi/openai/models/realtime/realtime_session_create_request.rbi +28 -18
- data/rbi/openai/models/realtime/realtime_session_create_response.rbi +52 -26
- data/rbi/openai/models/realtime/realtime_transcription_session_audio_input_turn_detection.rbi +24 -8
- data/rbi/openai/models/realtime/realtime_truncation.rbi +14 -9
- data/rbi/openai/models/reasoning.rbi +8 -6
- data/rbi/openai/models/reasoning_effort.rbi +5 -3
- data/rbi/openai/models/responses/compacted_response.rbi +105 -0
- data/rbi/openai/models/responses/response.rbi +1 -0
- data/rbi/openai/models/responses/response_compact_params.rbi +593 -0
- data/rbi/openai/models/responses/response_compaction_item.rbi +67 -0
- data/rbi/openai/models/responses/response_compaction_item_param.rbi +54 -0
- data/rbi/openai/models/responses/response_function_shell_call_output_content.rbi +9 -9
- data/rbi/openai/models/responses/response_function_shell_tool_call.rbi +6 -6
- data/rbi/openai/models/responses/response_function_shell_tool_call_output.rbi +1 -1
- data/rbi/openai/models/responses/response_input_item.rbi +18 -17
- data/rbi/openai/models/responses/response_output_item.rbi +1 -0
- data/rbi/openai/models/responses/response_output_item_added_event.rbi +1 -0
- data/rbi/openai/models/responses/response_output_item_done_event.rbi +1 -0
- data/rbi/openai/models/responses/tool.rbi +6 -3
- data/rbi/openai/models/responses/tool_choice_shell.rbi +1 -1
- data/rbi/openai/models/responses_model.rbi +5 -0
- data/rbi/openai/models/video_create_params.rbi +10 -6
- data/rbi/openai/resources/beta/assistants.rbi +8 -6
- data/rbi/openai/resources/beta/threads/runs.rbi +8 -6
- data/rbi/openai/resources/chat/completions.rbi +8 -6
- data/rbi/openai/resources/containers.rbi +3 -0
- data/rbi/openai/resources/conversations/items.rbi +1 -0
- data/rbi/openai/resources/conversations.rbi +1 -0
- data/rbi/openai/resources/realtime/calls.rbi +14 -9
- data/rbi/openai/resources/responses.rbi +42 -0
- data/rbi/openai/resources/videos.rbi +5 -3
- data/sig/openai/models/all_models.rbs +2 -0
- data/sig/openai/models/container_create_params.rbs +23 -1
- data/sig/openai/models/container_create_response.rbs +32 -3
- data/sig/openai/models/container_list_response.rbs +32 -3
- data/sig/openai/models/container_retrieve_response.rbs +32 -3
- data/sig/openai/models/realtime/input_audio_buffer_dtmf_event_received_event.rbs +32 -0
- data/sig/openai/models/realtime/realtime_server_event.rbs +1 -0
- data/sig/openai/models/reasoning_effort.rbs +2 -1
- data/sig/openai/models/responses/compacted_response.rbs +42 -0
- data/sig/openai/models/responses/response_compact_params.rbs +226 -0
- data/sig/openai/models/responses/response_compaction_item.rbs +39 -0
- data/sig/openai/models/responses/response_compaction_item_param.rbs +28 -0
- data/sig/openai/models/responses/response_input_item.rbs +1 -0
- data/sig/openai/models/responses/response_output_item.rbs +1 -0
- data/sig/openai/models/responses_model.rbs +2 -0
- data/sig/openai/resources/containers.rbs +1 -0
- data/sig/openai/resources/responses.rbs +8 -0
- metadata +31 -2
|
@@ -24,7 +24,7 @@ module OpenAI
|
|
|
24
24
|
# @!attribute input
|
|
25
25
|
# Text, image, or file inputs to the model, used to generate a response
|
|
26
26
|
#
|
|
27
|
-
# @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
|
|
27
|
+
# @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
|
|
28
28
|
optional :input, union: -> { OpenAI::Responses::InputTokenCountParams::Input }, nil?: true
|
|
29
29
|
|
|
30
30
|
# @!attribute instructions
|
|
@@ -109,7 +109,7 @@ module OpenAI
|
|
|
109
109
|
#
|
|
110
110
|
# @param conversation [String, OpenAI::Models::Responses::ResponseConversationParam, nil] The conversation that this response belongs to. Items from this conversation are
|
|
111
111
|
#
|
|
112
|
-
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Text, image, or file inputs to the model, used to generate a response
|
|
112
|
+
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Text, image, or file inputs to the model, used to generate a response
|
|
113
113
|
#
|
|
114
114
|
# @param instructions [String, nil] A system (or developer) message inserted into the model's context.
|
|
115
115
|
#
|
|
@@ -158,7 +158,7 @@ module OpenAI
|
|
|
158
158
|
variant -> { OpenAI::Models::Responses::InputTokenCountParams::Input::ResponseInputItemArray }
|
|
159
159
|
|
|
160
160
|
# @!method self.variants
|
|
161
|
-
# @return [Array(String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>)]
|
|
161
|
+
# @return [Array(String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>)]
|
|
162
162
|
|
|
163
163
|
# @type [OpenAI::Internal::Type::Converter]
|
|
164
164
|
ResponseInputItemArray =
|
|
@@ -262,7 +262,7 @@ module OpenAI
|
|
|
262
262
|
# Forces the model to call the apply_patch tool when executing a tool call.
|
|
263
263
|
variant -> { OpenAI::Responses::ToolChoiceApplyPatch }
|
|
264
264
|
|
|
265
|
-
# Forces the model to call the
|
|
265
|
+
# Forces the model to call the shell tool when a tool call is required.
|
|
266
266
|
variant -> { OpenAI::Responses::ToolChoiceShell }
|
|
267
267
|
|
|
268
268
|
# @!method self.variants
|
|
@@ -38,7 +38,7 @@ module OpenAI
|
|
|
38
38
|
# response will not be carried over to the next response. This makes it simple to
|
|
39
39
|
# swap out system (or developer) messages in new responses.
|
|
40
40
|
#
|
|
41
|
-
# @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
|
|
41
|
+
# @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
|
|
42
42
|
required :instructions, union: -> { OpenAI::Responses::Response::Instructions }, nil?: true
|
|
43
43
|
|
|
44
44
|
# @!attribute metadata
|
|
@@ -77,7 +77,7 @@ module OpenAI
|
|
|
77
77
|
# an `assistant` message with the content generated by the model, you might
|
|
78
78
|
# consider using the `output_text` property where supported in SDKs.
|
|
79
79
|
#
|
|
80
|
-
# @return [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseCustomToolCall>]
|
|
80
|
+
# @return [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseCustomToolCall>]
|
|
81
81
|
required :output, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseOutputItem] }
|
|
82
82
|
|
|
83
83
|
# @!attribute parallel_tool_calls
|
|
@@ -330,13 +330,13 @@ module OpenAI
|
|
|
330
330
|
#
|
|
331
331
|
# @param incomplete_details [OpenAI::Models::Responses::Response::IncompleteDetails, nil] Details about why the response is incomplete.
|
|
332
332
|
#
|
|
333
|
-
# @param instructions [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] A system (or developer) message inserted into the model's context.
|
|
333
|
+
# @param instructions [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] A system (or developer) message inserted into the model's context.
|
|
334
334
|
#
|
|
335
335
|
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
|
|
336
336
|
#
|
|
337
337
|
# @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI
|
|
338
338
|
#
|
|
339
|
-
# @param output [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseCustomToolCall>] An array of content items generated by the model.
|
|
339
|
+
# @param output [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseCustomToolCall>] An array of content items generated by the model.
|
|
340
340
|
#
|
|
341
341
|
# @param parallel_tool_calls [Boolean] Whether to allow the model to run tool calls in parallel.
|
|
342
342
|
#
|
|
@@ -430,7 +430,7 @@ module OpenAI
|
|
|
430
430
|
variant -> { OpenAI::Models::Responses::Response::Instructions::ResponseInputItemArray }
|
|
431
431
|
|
|
432
432
|
# @!method self.variants
|
|
433
|
-
# @return [Array(String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>)]
|
|
433
|
+
# @return [Array(String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>)]
|
|
434
434
|
|
|
435
435
|
# @type [OpenAI::Internal::Type::Converter]
|
|
436
436
|
ResponseInputItemArray =
|
|
@@ -474,7 +474,7 @@ module OpenAI
|
|
|
474
474
|
# Forces the model to call the apply_patch tool when executing a tool call.
|
|
475
475
|
variant -> { OpenAI::Responses::ToolChoiceApplyPatch }
|
|
476
476
|
|
|
477
|
-
# Forces the model to call the
|
|
477
|
+
# Forces the model to call the shell tool when a tool call is required.
|
|
478
478
|
variant -> { OpenAI::Responses::ToolChoiceShell }
|
|
479
479
|
|
|
480
480
|
# @!method self.variants
|
|
@@ -0,0 +1,344 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Responses
|
|
6
|
+
# @see OpenAI::Resources::Responses#compact
|
|
7
|
+
class ResponseCompactParams < OpenAI::Internal::Type::BaseModel
|
|
8
|
+
extend OpenAI::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include OpenAI::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute input
|
|
12
|
+
# Text, image, or file inputs to the model, used to generate a response
|
|
13
|
+
#
|
|
14
|
+
# @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
|
|
15
|
+
optional :input, union: -> { OpenAI::Responses::ResponseCompactParams::Input }, nil?: true
|
|
16
|
+
|
|
17
|
+
# @!attribute instructions
|
|
18
|
+
# A system (or developer) message inserted into the model's context. When used
|
|
19
|
+
# along with `previous_response_id`, the instructions from a previous response
|
|
20
|
+
# will not be carried over to the next response. This makes it simple to swap out
|
|
21
|
+
# system (or developer) messages in new responses.
|
|
22
|
+
#
|
|
23
|
+
# @return [String, nil]
|
|
24
|
+
optional :instructions, String, nil?: true
|
|
25
|
+
|
|
26
|
+
# @!attribute model
|
|
27
|
+
# Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a
|
|
28
|
+
# wide range of models with different capabilities, performance characteristics,
|
|
29
|
+
# and price points. Refer to the
|
|
30
|
+
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
31
|
+
# available models.
|
|
32
|
+
#
|
|
33
|
+
# @return [Symbol, String, OpenAI::Models::Responses::ResponseCompactParams::Model, nil]
|
|
34
|
+
optional :model, union: -> { OpenAI::Responses::ResponseCompactParams::Model }, nil?: true
|
|
35
|
+
|
|
36
|
+
# @!attribute previous_response_id
|
|
37
|
+
# The unique ID of the previous response to the model. Use this to create
|
|
38
|
+
# multi-turn conversations. Learn more about
|
|
39
|
+
# [conversation state](https://platform.openai.com/docs/guides/conversation-state).
|
|
40
|
+
# Cannot be used in conjunction with `conversation`.
|
|
41
|
+
#
|
|
42
|
+
# @return [String, nil]
|
|
43
|
+
optional :previous_response_id, String, nil?: true
|
|
44
|
+
|
|
45
|
+
# @!method initialize(input: nil, instructions: nil, model: nil, previous_response_id: nil, request_options: {})
|
|
46
|
+
# Some parameter documentations has been truncated, see
|
|
47
|
+
# {OpenAI::Models::Responses::ResponseCompactParams} for more details.
|
|
48
|
+
#
|
|
49
|
+
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Text, image, or file inputs to the model, used to generate a response
|
|
50
|
+
#
|
|
51
|
+
# @param instructions [String, nil] A system (or developer) message inserted into the model's context.
|
|
52
|
+
#
|
|
53
|
+
# @param model [Symbol, String, OpenAI::Models::Responses::ResponseCompactParams::Model, nil] Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wi
|
|
54
|
+
#
|
|
55
|
+
# @param previous_response_id [String, nil] The unique ID of the previous response to the model. Use this to create multi-tu
|
|
56
|
+
#
|
|
57
|
+
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
58
|
+
|
|
59
|
+
# Text, image, or file inputs to the model, used to generate a response
|
|
60
|
+
module Input
|
|
61
|
+
extend OpenAI::Internal::Type::Union
|
|
62
|
+
|
|
63
|
+
# A text input to the model, equivalent to a text input with the `user` role.
|
|
64
|
+
variant String
|
|
65
|
+
|
|
66
|
+
variant -> { OpenAI::Models::Responses::ResponseCompactParams::Input::ResponseInputItemArray }
|
|
67
|
+
|
|
68
|
+
# @!method self.variants
|
|
69
|
+
# @return [Array(String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>)]
|
|
70
|
+
|
|
71
|
+
# @type [OpenAI::Internal::Type::Converter]
|
|
72
|
+
ResponseInputItemArray =
|
|
73
|
+
OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::Responses::ResponseInputItem }]
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
# Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a
|
|
77
|
+
# wide range of models with different capabilities, performance characteristics,
|
|
78
|
+
# and price points. Refer to the
|
|
79
|
+
# [model guide](https://platform.openai.com/docs/models) to browse and compare
|
|
80
|
+
# available models.
|
|
81
|
+
module Model
|
|
82
|
+
extend OpenAI::Internal::Type::Union
|
|
83
|
+
|
|
84
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_1 }
|
|
85
|
+
|
|
86
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_1_2025_11_13 }
|
|
87
|
+
|
|
88
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_1_CODEX }
|
|
89
|
+
|
|
90
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_1_MINI }
|
|
91
|
+
|
|
92
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_1_CHAT_LATEST }
|
|
93
|
+
|
|
94
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5 }
|
|
95
|
+
|
|
96
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_MINI }
|
|
97
|
+
|
|
98
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_NANO }
|
|
99
|
+
|
|
100
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_2025_08_07 }
|
|
101
|
+
|
|
102
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_MINI_2025_08_07 }
|
|
103
|
+
|
|
104
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_NANO_2025_08_07 }
|
|
105
|
+
|
|
106
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_CHAT_LATEST }
|
|
107
|
+
|
|
108
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4_1 }
|
|
109
|
+
|
|
110
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4_1_MINI }
|
|
111
|
+
|
|
112
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4_1_NANO }
|
|
113
|
+
|
|
114
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4_1_2025_04_14 }
|
|
115
|
+
|
|
116
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4_1_MINI_2025_04_14 }
|
|
117
|
+
|
|
118
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4_1_NANO_2025_04_14 }
|
|
119
|
+
|
|
120
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O4_MINI }
|
|
121
|
+
|
|
122
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O4_MINI_2025_04_16 }
|
|
123
|
+
|
|
124
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O3 }
|
|
125
|
+
|
|
126
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O3_2025_04_16 }
|
|
127
|
+
|
|
128
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O3_MINI }
|
|
129
|
+
|
|
130
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O3_MINI_2025_01_31 }
|
|
131
|
+
|
|
132
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O1 }
|
|
133
|
+
|
|
134
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O1_2024_12_17 }
|
|
135
|
+
|
|
136
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O1_PREVIEW }
|
|
137
|
+
|
|
138
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O1_PREVIEW_2024_09_12 }
|
|
139
|
+
|
|
140
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O1_MINI }
|
|
141
|
+
|
|
142
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O1_MINI_2024_09_12 }
|
|
143
|
+
|
|
144
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4O }
|
|
145
|
+
|
|
146
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4O_2024_11_20 }
|
|
147
|
+
|
|
148
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4O_2024_08_06 }
|
|
149
|
+
|
|
150
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4O_2024_05_13 }
|
|
151
|
+
|
|
152
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4O_AUDIO_PREVIEW }
|
|
153
|
+
|
|
154
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4O_AUDIO_PREVIEW_2024_10_01 }
|
|
155
|
+
|
|
156
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4O_AUDIO_PREVIEW_2024_12_17 }
|
|
157
|
+
|
|
158
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4O_AUDIO_PREVIEW_2025_06_03 }
|
|
159
|
+
|
|
160
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4O_MINI_AUDIO_PREVIEW }
|
|
161
|
+
|
|
162
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17 }
|
|
163
|
+
|
|
164
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4O_SEARCH_PREVIEW }
|
|
165
|
+
|
|
166
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4O_MINI_SEARCH_PREVIEW }
|
|
167
|
+
|
|
168
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4O_SEARCH_PREVIEW_2025_03_11 }
|
|
169
|
+
|
|
170
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11 }
|
|
171
|
+
|
|
172
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::CHATGPT_4O_LATEST }
|
|
173
|
+
|
|
174
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::CODEX_MINI_LATEST }
|
|
175
|
+
|
|
176
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4O_MINI }
|
|
177
|
+
|
|
178
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4O_MINI_2024_07_18 }
|
|
179
|
+
|
|
180
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4_TURBO }
|
|
181
|
+
|
|
182
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4_TURBO_2024_04_09 }
|
|
183
|
+
|
|
184
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4_0125_PREVIEW }
|
|
185
|
+
|
|
186
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4_TURBO_PREVIEW }
|
|
187
|
+
|
|
188
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4_1106_PREVIEW }
|
|
189
|
+
|
|
190
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4_VISION_PREVIEW }
|
|
191
|
+
|
|
192
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4 }
|
|
193
|
+
|
|
194
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4_0314 }
|
|
195
|
+
|
|
196
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4_0613 }
|
|
197
|
+
|
|
198
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4_32K }
|
|
199
|
+
|
|
200
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4_32K_0314 }
|
|
201
|
+
|
|
202
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_4_32K_0613 }
|
|
203
|
+
|
|
204
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_3_5_TURBO }
|
|
205
|
+
|
|
206
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_3_5_TURBO_16K }
|
|
207
|
+
|
|
208
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_3_5_TURBO_0301 }
|
|
209
|
+
|
|
210
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_3_5_TURBO_0613 }
|
|
211
|
+
|
|
212
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_3_5_TURBO_1106 }
|
|
213
|
+
|
|
214
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_3_5_TURBO_0125 }
|
|
215
|
+
|
|
216
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_3_5_TURBO_16K_0613 }
|
|
217
|
+
|
|
218
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O1_PRO }
|
|
219
|
+
|
|
220
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O1_PRO_2025_03_19 }
|
|
221
|
+
|
|
222
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O3_PRO }
|
|
223
|
+
|
|
224
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O3_PRO_2025_06_10 }
|
|
225
|
+
|
|
226
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O3_DEEP_RESEARCH }
|
|
227
|
+
|
|
228
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O3_DEEP_RESEARCH_2025_06_26 }
|
|
229
|
+
|
|
230
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O4_MINI_DEEP_RESEARCH }
|
|
231
|
+
|
|
232
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::O4_MINI_DEEP_RESEARCH_2025_06_26 }
|
|
233
|
+
|
|
234
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::COMPUTER_USE_PREVIEW }
|
|
235
|
+
|
|
236
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::COMPUTER_USE_PREVIEW_2025_03_11 }
|
|
237
|
+
|
|
238
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_CODEX }
|
|
239
|
+
|
|
240
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_PRO }
|
|
241
|
+
|
|
242
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_PRO_2025_10_06 }
|
|
243
|
+
|
|
244
|
+
variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_5_1_CODEX_MAX }
|
|
245
|
+
|
|
246
|
+
variant String
|
|
247
|
+
|
|
248
|
+
# @!method self.variants
|
|
249
|
+
# @return [Array(Symbol, String)]
|
|
250
|
+
|
|
251
|
+
define_sorbet_constant!(:Variants) do
|
|
252
|
+
T.type_alias { T.any(OpenAI::Responses::ResponseCompactParams::Model::TaggedSymbol, String) }
|
|
253
|
+
end
|
|
254
|
+
|
|
255
|
+
# @!group
|
|
256
|
+
|
|
257
|
+
GPT_5_1 = :"gpt-5.1"
|
|
258
|
+
GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
|
|
259
|
+
GPT_5_1_CODEX = :"gpt-5.1-codex"
|
|
260
|
+
GPT_5_1_MINI = :"gpt-5.1-mini"
|
|
261
|
+
GPT_5_1_CHAT_LATEST = :"gpt-5.1-chat-latest"
|
|
262
|
+
GPT_5 = :"gpt-5"
|
|
263
|
+
GPT_5_MINI = :"gpt-5-mini"
|
|
264
|
+
GPT_5_NANO = :"gpt-5-nano"
|
|
265
|
+
GPT_5_2025_08_07 = :"gpt-5-2025-08-07"
|
|
266
|
+
GPT_5_MINI_2025_08_07 = :"gpt-5-mini-2025-08-07"
|
|
267
|
+
GPT_5_NANO_2025_08_07 = :"gpt-5-nano-2025-08-07"
|
|
268
|
+
GPT_5_CHAT_LATEST = :"gpt-5-chat-latest"
|
|
269
|
+
GPT_4_1 = :"gpt-4.1"
|
|
270
|
+
GPT_4_1_MINI = :"gpt-4.1-mini"
|
|
271
|
+
GPT_4_1_NANO = :"gpt-4.1-nano"
|
|
272
|
+
GPT_4_1_2025_04_14 = :"gpt-4.1-2025-04-14"
|
|
273
|
+
GPT_4_1_MINI_2025_04_14 = :"gpt-4.1-mini-2025-04-14"
|
|
274
|
+
GPT_4_1_NANO_2025_04_14 = :"gpt-4.1-nano-2025-04-14"
|
|
275
|
+
O4_MINI = :"o4-mini"
|
|
276
|
+
O4_MINI_2025_04_16 = :"o4-mini-2025-04-16"
|
|
277
|
+
O3 = :o3
|
|
278
|
+
O3_2025_04_16 = :"o3-2025-04-16"
|
|
279
|
+
O3_MINI = :"o3-mini"
|
|
280
|
+
O3_MINI_2025_01_31 = :"o3-mini-2025-01-31"
|
|
281
|
+
O1 = :o1
|
|
282
|
+
O1_2024_12_17 = :"o1-2024-12-17"
|
|
283
|
+
O1_PREVIEW = :"o1-preview"
|
|
284
|
+
O1_PREVIEW_2024_09_12 = :"o1-preview-2024-09-12"
|
|
285
|
+
O1_MINI = :"o1-mini"
|
|
286
|
+
O1_MINI_2024_09_12 = :"o1-mini-2024-09-12"
|
|
287
|
+
GPT_4O = :"gpt-4o"
|
|
288
|
+
GPT_4O_2024_11_20 = :"gpt-4o-2024-11-20"
|
|
289
|
+
GPT_4O_2024_08_06 = :"gpt-4o-2024-08-06"
|
|
290
|
+
GPT_4O_2024_05_13 = :"gpt-4o-2024-05-13"
|
|
291
|
+
GPT_4O_AUDIO_PREVIEW = :"gpt-4o-audio-preview"
|
|
292
|
+
GPT_4O_AUDIO_PREVIEW_2024_10_01 = :"gpt-4o-audio-preview-2024-10-01"
|
|
293
|
+
GPT_4O_AUDIO_PREVIEW_2024_12_17 = :"gpt-4o-audio-preview-2024-12-17"
|
|
294
|
+
GPT_4O_AUDIO_PREVIEW_2025_06_03 = :"gpt-4o-audio-preview-2025-06-03"
|
|
295
|
+
GPT_4O_MINI_AUDIO_PREVIEW = :"gpt-4o-mini-audio-preview"
|
|
296
|
+
GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17 = :"gpt-4o-mini-audio-preview-2024-12-17"
|
|
297
|
+
GPT_4O_SEARCH_PREVIEW = :"gpt-4o-search-preview"
|
|
298
|
+
GPT_4O_MINI_SEARCH_PREVIEW = :"gpt-4o-mini-search-preview"
|
|
299
|
+
GPT_4O_SEARCH_PREVIEW_2025_03_11 = :"gpt-4o-search-preview-2025-03-11"
|
|
300
|
+
GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11 = :"gpt-4o-mini-search-preview-2025-03-11"
|
|
301
|
+
CHATGPT_4O_LATEST = :"chatgpt-4o-latest"
|
|
302
|
+
CODEX_MINI_LATEST = :"codex-mini-latest"
|
|
303
|
+
GPT_4O_MINI = :"gpt-4o-mini"
|
|
304
|
+
GPT_4O_MINI_2024_07_18 = :"gpt-4o-mini-2024-07-18"
|
|
305
|
+
GPT_4_TURBO = :"gpt-4-turbo"
|
|
306
|
+
GPT_4_TURBO_2024_04_09 = :"gpt-4-turbo-2024-04-09"
|
|
307
|
+
GPT_4_0125_PREVIEW = :"gpt-4-0125-preview"
|
|
308
|
+
GPT_4_TURBO_PREVIEW = :"gpt-4-turbo-preview"
|
|
309
|
+
GPT_4_1106_PREVIEW = :"gpt-4-1106-preview"
|
|
310
|
+
GPT_4_VISION_PREVIEW = :"gpt-4-vision-preview"
|
|
311
|
+
GPT_4 = :"gpt-4"
|
|
312
|
+
GPT_4_0314 = :"gpt-4-0314"
|
|
313
|
+
GPT_4_0613 = :"gpt-4-0613"
|
|
314
|
+
GPT_4_32K = :"gpt-4-32k"
|
|
315
|
+
GPT_4_32K_0314 = :"gpt-4-32k-0314"
|
|
316
|
+
GPT_4_32K_0613 = :"gpt-4-32k-0613"
|
|
317
|
+
GPT_3_5_TURBO = :"gpt-3.5-turbo"
|
|
318
|
+
GPT_3_5_TURBO_16K = :"gpt-3.5-turbo-16k"
|
|
319
|
+
GPT_3_5_TURBO_0301 = :"gpt-3.5-turbo-0301"
|
|
320
|
+
GPT_3_5_TURBO_0613 = :"gpt-3.5-turbo-0613"
|
|
321
|
+
GPT_3_5_TURBO_1106 = :"gpt-3.5-turbo-1106"
|
|
322
|
+
GPT_3_5_TURBO_0125 = :"gpt-3.5-turbo-0125"
|
|
323
|
+
GPT_3_5_TURBO_16K_0613 = :"gpt-3.5-turbo-16k-0613"
|
|
324
|
+
O1_PRO = :"o1-pro"
|
|
325
|
+
O1_PRO_2025_03_19 = :"o1-pro-2025-03-19"
|
|
326
|
+
O3_PRO = :"o3-pro"
|
|
327
|
+
O3_PRO_2025_06_10 = :"o3-pro-2025-06-10"
|
|
328
|
+
O3_DEEP_RESEARCH = :"o3-deep-research"
|
|
329
|
+
O3_DEEP_RESEARCH_2025_06_26 = :"o3-deep-research-2025-06-26"
|
|
330
|
+
O4_MINI_DEEP_RESEARCH = :"o4-mini-deep-research"
|
|
331
|
+
O4_MINI_DEEP_RESEARCH_2025_06_26 = :"o4-mini-deep-research-2025-06-26"
|
|
332
|
+
COMPUTER_USE_PREVIEW = :"computer-use-preview"
|
|
333
|
+
COMPUTER_USE_PREVIEW_2025_03_11 = :"computer-use-preview-2025-03-11"
|
|
334
|
+
GPT_5_CODEX = :"gpt-5-codex"
|
|
335
|
+
GPT_5_PRO = :"gpt-5-pro"
|
|
336
|
+
GPT_5_PRO_2025_10_06 = :"gpt-5-pro-2025-10-06"
|
|
337
|
+
GPT_5_1_CODEX_MAX = :"gpt-5.1-codex-max"
|
|
338
|
+
|
|
339
|
+
# @!endgroup
|
|
340
|
+
end
|
|
341
|
+
end
|
|
342
|
+
end
|
|
343
|
+
end
|
|
344
|
+
end
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Responses
|
|
6
|
+
class ResponseCompactionItem < OpenAI::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The unique ID of the compaction item.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute encrypted_content
|
|
14
|
+
#
|
|
15
|
+
# @return [String]
|
|
16
|
+
required :encrypted_content, String
|
|
17
|
+
|
|
18
|
+
# @!attribute type
|
|
19
|
+
# The type of the item. Always `compaction`.
|
|
20
|
+
#
|
|
21
|
+
# @return [Symbol, :compaction]
|
|
22
|
+
required :type, const: :compaction
|
|
23
|
+
|
|
24
|
+
# @!attribute created_by
|
|
25
|
+
#
|
|
26
|
+
# @return [String, nil]
|
|
27
|
+
optional :created_by, String
|
|
28
|
+
|
|
29
|
+
# @!method initialize(id:, encrypted_content:, created_by: nil, type: :compaction)
|
|
30
|
+
# A compaction item generated by the
|
|
31
|
+
# [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact).
|
|
32
|
+
#
|
|
33
|
+
# @param id [String] The unique ID of the compaction item.
|
|
34
|
+
#
|
|
35
|
+
# @param encrypted_content [String]
|
|
36
|
+
#
|
|
37
|
+
# @param created_by [String]
|
|
38
|
+
#
|
|
39
|
+
# @param type [Symbol, :compaction] The type of the item. Always `compaction`.
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
end
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Responses
|
|
6
|
+
class ResponseCompactionItemParam < OpenAI::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute encrypted_content
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :encrypted_content, String
|
|
11
|
+
|
|
12
|
+
# @!attribute type
|
|
13
|
+
# The type of the item. Always `compaction`.
|
|
14
|
+
#
|
|
15
|
+
# @return [Symbol, :compaction]
|
|
16
|
+
required :type, const: :compaction
|
|
17
|
+
|
|
18
|
+
# @!attribute id
|
|
19
|
+
# The ID of the compaction item.
|
|
20
|
+
#
|
|
21
|
+
# @return [String, nil]
|
|
22
|
+
optional :id, String, nil?: true
|
|
23
|
+
|
|
24
|
+
# @!method initialize(encrypted_content:, id: nil, type: :compaction)
|
|
25
|
+
# A compaction item generated by the
|
|
26
|
+
# [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact).
|
|
27
|
+
#
|
|
28
|
+
# @param encrypted_content [String]
|
|
29
|
+
#
|
|
30
|
+
# @param id [String, nil] The ID of the compaction item.
|
|
31
|
+
#
|
|
32
|
+
# @param type [Symbol, :compaction] The type of the item. Always `compaction`.
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
@@ -66,7 +66,7 @@ module OpenAI
|
|
|
66
66
|
# - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
|
|
67
67
|
# - [Function calling](https://platform.openai.com/docs/guides/function-calling)
|
|
68
68
|
#
|
|
69
|
-
# @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
|
|
69
|
+
# @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
|
|
70
70
|
optional :input, union: -> { OpenAI::Responses::ResponseCreateParams::Input }
|
|
71
71
|
|
|
72
72
|
# @!attribute instructions
|
|
@@ -318,7 +318,7 @@ module OpenAI
|
|
|
318
318
|
#
|
|
319
319
|
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently suppo
|
|
320
320
|
#
|
|
321
|
-
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Text, image, or file inputs to the model, used to generate a response.
|
|
321
|
+
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Text, image, or file inputs to the model, used to generate a response.
|
|
322
322
|
#
|
|
323
323
|
# @param instructions [String, nil] A system (or developer) message inserted into the model's context.
|
|
324
324
|
#
|
|
@@ -406,7 +406,7 @@ module OpenAI
|
|
|
406
406
|
variant -> { OpenAI::Responses::ResponseInput }
|
|
407
407
|
|
|
408
408
|
# @!method self.variants
|
|
409
|
-
# @return [Array(String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>)]
|
|
409
|
+
# @return [Array(String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>)]
|
|
410
410
|
end
|
|
411
411
|
|
|
412
412
|
# The retention policy for the prompt cache. Set to `24h` to enable extended
|
|
@@ -509,7 +509,7 @@ module OpenAI
|
|
|
509
509
|
# Forces the model to call the apply_patch tool when executing a tool call.
|
|
510
510
|
variant -> { OpenAI::Responses::ToolChoiceApplyPatch }
|
|
511
511
|
|
|
512
|
-
# Forces the model to call the
|
|
512
|
+
# Forces the model to call the shell tool when a tool call is required.
|
|
513
513
|
variant -> { OpenAI::Responses::ToolChoiceShell }
|
|
514
514
|
|
|
515
515
|
# @!method self.variants
|