openai 0.36.0 → 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 +22 -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_apply_patch_tool_call.rb +23 -23
- data/lib/openai/models/responses/response_apply_patch_tool_call_output.rb +9 -9
- 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 +22 -19
- 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_apply_patch_tool_call.rbi +53 -67
- data/rbi/openai/models/responses/response_apply_patch_tool_call_output.rbi +9 -9
- 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 +21 -23
- 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_apply_patch_tool_call.rbs +18 -22
- data/sig/openai/models/responses/response_apply_patch_tool_call_output.rbs +7 -7
- 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 +5 -6
- 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
|
@@ -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
|
|
@@ -5,33 +5,33 @@ module OpenAI
|
|
|
5
5
|
module Responses
|
|
6
6
|
class ResponseFunctionShellCallOutputContent < OpenAI::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute outcome
|
|
8
|
-
# The exit or timeout outcome associated with this
|
|
8
|
+
# The exit or timeout outcome associated with this shell call.
|
|
9
9
|
#
|
|
10
10
|
# @return [OpenAI::Models::Responses::ResponseFunctionShellCallOutputContent::Outcome::Timeout, OpenAI::Models::Responses::ResponseFunctionShellCallOutputContent::Outcome::Exit]
|
|
11
11
|
required :outcome, union: -> { OpenAI::Responses::ResponseFunctionShellCallOutputContent::Outcome }
|
|
12
12
|
|
|
13
13
|
# @!attribute stderr
|
|
14
|
-
# Captured stderr output for
|
|
14
|
+
# Captured stderr output for the shell call.
|
|
15
15
|
#
|
|
16
16
|
# @return [String]
|
|
17
17
|
required :stderr, String
|
|
18
18
|
|
|
19
19
|
# @!attribute stdout
|
|
20
|
-
# Captured stdout output for
|
|
20
|
+
# Captured stdout output for the shell call.
|
|
21
21
|
#
|
|
22
22
|
# @return [String]
|
|
23
23
|
required :stdout, String
|
|
24
24
|
|
|
25
25
|
# @!method initialize(outcome:, stderr:, stdout:)
|
|
26
|
-
# Captured stdout and stderr for a portion of a
|
|
26
|
+
# Captured stdout and stderr for a portion of a shell tool call output.
|
|
27
27
|
#
|
|
28
|
-
# @param outcome [OpenAI::Models::Responses::ResponseFunctionShellCallOutputContent::Outcome::Timeout, OpenAI::Models::Responses::ResponseFunctionShellCallOutputContent::Outcome::Exit] The exit or timeout outcome associated with this
|
|
28
|
+
# @param outcome [OpenAI::Models::Responses::ResponseFunctionShellCallOutputContent::Outcome::Timeout, OpenAI::Models::Responses::ResponseFunctionShellCallOutputContent::Outcome::Exit] The exit or timeout outcome associated with this shell call.
|
|
29
29
|
#
|
|
30
|
-
# @param stderr [String] Captured stderr output for
|
|
30
|
+
# @param stderr [String] Captured stderr output for the shell call.
|
|
31
31
|
#
|
|
32
|
-
# @param stdout [String] Captured stdout output for
|
|
32
|
+
# @param stdout [String] Captured stdout output for the shell call.
|
|
33
33
|
|
|
34
|
-
# The exit or timeout outcome associated with this
|
|
34
|
+
# The exit or timeout outcome associated with this shell call.
|
|
35
35
|
#
|
|
36
36
|
# @see OpenAI::Models::Responses::ResponseFunctionShellCallOutputContent#outcome
|
|
37
37
|
module Outcome
|
|
@@ -39,7 +39,7 @@ module OpenAI
|
|
|
39
39
|
|
|
40
40
|
discriminator :type
|
|
41
41
|
|
|
42
|
-
# Indicates that the
|
|
42
|
+
# Indicates that the shell call exceeded its configured time limit.
|
|
43
43
|
variant :timeout, -> { OpenAI::Responses::ResponseFunctionShellCallOutputContent::Outcome::Timeout }
|
|
44
44
|
|
|
45
45
|
# Indicates that the shell commands finished and returned an exit code.
|
|
@@ -53,7 +53,7 @@ module OpenAI
|
|
|
53
53
|
required :type, const: :timeout
|
|
54
54
|
|
|
55
55
|
# @!method initialize(type: :timeout)
|
|
56
|
-
# Indicates that the
|
|
56
|
+
# Indicates that the shell call exceeded its configured time limit.
|
|
57
57
|
#
|
|
58
58
|
# @param type [Symbol, :timeout] The outcome type. Always `timeout`.
|
|
59
59
|
end
|
|
@@ -5,8 +5,8 @@ module OpenAI
|
|
|
5
5
|
module Responses
|
|
6
6
|
class ResponseFunctionShellToolCall < OpenAI::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute id
|
|
8
|
-
# The unique ID of the
|
|
9
|
-
#
|
|
8
|
+
# The unique ID of the shell tool call. Populated when this item is returned via
|
|
9
|
+
# API.
|
|
10
10
|
#
|
|
11
11
|
# @return [String]
|
|
12
12
|
required :id, String
|
|
@@ -18,7 +18,7 @@ module OpenAI
|
|
|
18
18
|
required :action, -> { OpenAI::Responses::ResponseFunctionShellToolCall::Action }
|
|
19
19
|
|
|
20
20
|
# @!attribute call_id
|
|
21
|
-
# The unique ID of the
|
|
21
|
+
# The unique ID of the shell tool call generated by the model.
|
|
22
22
|
#
|
|
23
23
|
# @return [String]
|
|
24
24
|
required :call_id, String
|
|
@@ -48,11 +48,11 @@ module OpenAI
|
|
|
48
48
|
#
|
|
49
49
|
# A tool call that executes one or more shell commands in a managed environment.
|
|
50
50
|
#
|
|
51
|
-
# @param id [String] The unique ID of the
|
|
51
|
+
# @param id [String] The unique ID of the shell tool call. Populated when this item is returned via A
|
|
52
52
|
#
|
|
53
53
|
# @param action [OpenAI::Models::Responses::ResponseFunctionShellToolCall::Action] The shell commands and limits that describe how to run the tool call.
|
|
54
54
|
#
|
|
55
|
-
# @param call_id [String] The unique ID of the
|
|
55
|
+
# @param call_id [String] The unique ID of the shell tool call generated by the model.
|
|
56
56
|
#
|
|
57
57
|
# @param status [Symbol, OpenAI::Models::Responses::ResponseFunctionShellToolCall::Status] The status of the shell call. One of `in_progress`, `completed`, or `incomplete`
|
|
58
58
|
#
|
|
@@ -108,7 +108,7 @@ module OpenAI
|
|
|
108
108
|
|
|
109
109
|
discriminator :type
|
|
110
110
|
|
|
111
|
-
# Indicates that the
|
|
111
|
+
# Indicates that the shell call exceeded its configured time limit.
|
|
112
112
|
variant :timeout, -> { OpenAI::Responses::ResponseFunctionShellToolCallOutput::Output::Outcome::Timeout }
|
|
113
113
|
|
|
114
114
|
# Indicates that the shell commands finished and returned an exit code.
|
|
@@ -122,7 +122,7 @@ module OpenAI
|
|
|
122
122
|
required :type, const: :timeout
|
|
123
123
|
|
|
124
124
|
# @!method initialize(type: :timeout)
|
|
125
|
-
# Indicates that the
|
|
125
|
+
# Indicates that the shell call exceeded its configured time limit.
|
|
126
126
|
#
|
|
127
127
|
# @param type [Symbol, :timeout] The outcome type. Always `timeout`.
|
|
128
128
|
end
|
|
@@ -56,6 +56,9 @@ module OpenAI
|
|
|
56
56
|
# [managing context](https://platform.openai.com/docs/guides/conversation-state).
|
|
57
57
|
variant :reasoning, -> { OpenAI::Responses::ResponseReasoningItem }
|
|
58
58
|
|
|
59
|
+
# A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact).
|
|
60
|
+
variant :compaction, -> { OpenAI::Responses::ResponseCompactionItemParam }
|
|
61
|
+
|
|
59
62
|
# An image generation request made by the model.
|
|
60
63
|
variant :image_generation_call, -> { OpenAI::Responses::ResponseInputItem::ImageGenerationCall }
|
|
61
64
|
|
|
@@ -71,7 +74,7 @@ module OpenAI
|
|
|
71
74
|
# A tool representing a request to execute one or more shell commands.
|
|
72
75
|
variant :shell_call, -> { OpenAI::Responses::ResponseInputItem::ShellCall }
|
|
73
76
|
|
|
74
|
-
# The streamed output items emitted by a
|
|
77
|
+
# The streamed output items emitted by a shell tool call.
|
|
75
78
|
variant :shell_call_output, -> { OpenAI::Responses::ResponseInputItem::ShellCallOutput }
|
|
76
79
|
|
|
77
80
|
# A tool call representing a request to create, delete, or update files using diff patches.
|
|
@@ -615,20 +618,20 @@ module OpenAI
|
|
|
615
618
|
required :action, -> { OpenAI::Responses::ResponseInputItem::ShellCall::Action }
|
|
616
619
|
|
|
617
620
|
# @!attribute call_id
|
|
618
|
-
# The unique ID of the
|
|
621
|
+
# The unique ID of the shell tool call generated by the model.
|
|
619
622
|
#
|
|
620
623
|
# @return [String]
|
|
621
624
|
required :call_id, String
|
|
622
625
|
|
|
623
626
|
# @!attribute type
|
|
624
|
-
# The type of the item. Always `
|
|
627
|
+
# The type of the item. Always `shell_call`.
|
|
625
628
|
#
|
|
626
629
|
# @return [Symbol, :shell_call]
|
|
627
630
|
required :type, const: :shell_call
|
|
628
631
|
|
|
629
632
|
# @!attribute id
|
|
630
|
-
# The unique ID of the
|
|
631
|
-
#
|
|
633
|
+
# The unique ID of the shell tool call. Populated when this item is returned via
|
|
634
|
+
# API.
|
|
632
635
|
#
|
|
633
636
|
# @return [String, nil]
|
|
634
637
|
optional :id, String, nil?: true
|
|
@@ -648,13 +651,13 @@ module OpenAI
|
|
|
648
651
|
#
|
|
649
652
|
# @param action [OpenAI::Models::Responses::ResponseInputItem::ShellCall::Action] The shell commands and limits that describe how to run the tool call.
|
|
650
653
|
#
|
|
651
|
-
# @param call_id [String] The unique ID of the
|
|
654
|
+
# @param call_id [String] The unique ID of the shell tool call generated by the model.
|
|
652
655
|
#
|
|
653
|
-
# @param id [String, nil] The unique ID of the
|
|
656
|
+
# @param id [String, nil] The unique ID of the shell tool call. Populated when this item is returned via A
|
|
654
657
|
#
|
|
655
658
|
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::ShellCall::Status, nil] The status of the shell call. One of `in_progress`, `completed`, or `incomplete`
|
|
656
659
|
#
|
|
657
|
-
# @param type [Symbol, :shell_call] The type of the item. Always `
|
|
660
|
+
# @param type [Symbol, :shell_call] The type of the item. Always `shell_call`.
|
|
658
661
|
|
|
659
662
|
# @see OpenAI::Models::Responses::ResponseInputItem::ShellCall#action
|
|
660
663
|
class Action < OpenAI::Internal::Type::BaseModel
|
|
@@ -709,7 +712,7 @@ module OpenAI
|
|
|
709
712
|
|
|
710
713
|
class ShellCallOutput < OpenAI::Internal::Type::BaseModel
|
|
711
714
|
# @!attribute call_id
|
|
712
|
-
# The unique ID of the
|
|
715
|
+
# The unique ID of the shell tool call generated by the model.
|
|
713
716
|
#
|
|
714
717
|
# @return [String]
|
|
715
718
|
required :call_id, String
|
|
@@ -723,14 +726,14 @@ module OpenAI
|
|
|
723
726
|
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseFunctionShellCallOutputContent] }
|
|
724
727
|
|
|
725
728
|
# @!attribute type
|
|
726
|
-
# The type of the item. Always `
|
|
729
|
+
# The type of the item. Always `shell_call_output`.
|
|
727
730
|
#
|
|
728
731
|
# @return [Symbol, :shell_call_output]
|
|
729
732
|
required :type, const: :shell_call_output
|
|
730
733
|
|
|
731
734
|
# @!attribute id
|
|
732
|
-
# The unique ID of the
|
|
733
|
-
#
|
|
735
|
+
# The unique ID of the shell tool call output. Populated when this item is
|
|
736
|
+
# returned via API.
|
|
734
737
|
#
|
|
735
738
|
# @return [String, nil]
|
|
736
739
|
optional :id, String, nil?: true
|
|
@@ -747,17 +750,17 @@ module OpenAI
|
|
|
747
750
|
# {OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput} for more
|
|
748
751
|
# details.
|
|
749
752
|
#
|
|
750
|
-
# The streamed output items emitted by a
|
|
753
|
+
# The streamed output items emitted by a shell tool call.
|
|
751
754
|
#
|
|
752
|
-
# @param call_id [String] The unique ID of the
|
|
755
|
+
# @param call_id [String] The unique ID of the shell tool call generated by the model.
|
|
753
756
|
#
|
|
754
757
|
# @param output [Array<OpenAI::Models::Responses::ResponseFunctionShellCallOutputContent>] Captured chunks of stdout and stderr output, along with their associated outcome
|
|
755
758
|
#
|
|
756
|
-
# @param id [String, nil] The unique ID of the
|
|
759
|
+
# @param id [String, nil] The unique ID of the shell tool call output. Populated when this item is returne
|
|
757
760
|
#
|
|
758
761
|
# @param max_output_length [Integer, nil] The maximum number of UTF-8 characters captured for this shell call's combined o
|
|
759
762
|
#
|
|
760
|
-
# @param type [Symbol, :shell_call_output] The type of the item. Always `
|
|
763
|
+
# @param type [Symbol, :shell_call_output] The type of the item. Always `shell_call_output`.
|
|
761
764
|
end
|
|
762
765
|
|
|
763
766
|
class ApplyPatchCall < OpenAI::Internal::Type::BaseModel
|
|
@@ -956,7 +959,7 @@ module OpenAI
|
|
|
956
959
|
# or errors).
|
|
957
960
|
#
|
|
958
961
|
# @return [String, nil]
|
|
959
|
-
optional :output, String
|
|
962
|
+
optional :output, String, nil?: true
|
|
960
963
|
|
|
961
964
|
# @!method initialize(call_id:, status:, id: nil, output: nil, type: :apply_patch_call_output)
|
|
962
965
|
# Some parameter documentations has been truncated, see
|
|
@@ -971,7 +974,7 @@ module OpenAI
|
|
|
971
974
|
#
|
|
972
975
|
# @param id [String, nil] The unique ID of the apply patch tool call output. Populated when this item is r
|
|
973
976
|
#
|
|
974
|
-
# @param output [String] Optional human-readable log text from the apply patch tool (e.g., patch results
|
|
977
|
+
# @param output [String, nil] Optional human-readable log text from the apply patch tool (e.g., patch results
|
|
975
978
|
#
|
|
976
979
|
# @param type [Symbol, :apply_patch_call_output] The type of the item. Always `apply_patch_call_output`.
|
|
977
980
|
|
|
@@ -1311,7 +1314,7 @@ module OpenAI
|
|
|
1311
1314
|
end
|
|
1312
1315
|
|
|
1313
1316
|
# @!method self.variants
|
|
1314
|
-
# @return [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)]
|
|
1317
|
+
# @return [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)]
|
|
1315
1318
|
end
|
|
1316
1319
|
end
|
|
1317
1320
|
end
|
|
@@ -34,6 +34,9 @@ module OpenAI
|
|
|
34
34
|
# [managing context](https://platform.openai.com/docs/guides/conversation-state).
|
|
35
35
|
variant :reasoning, -> { OpenAI::Responses::ResponseReasoningItem }
|
|
36
36
|
|
|
37
|
+
# A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact).
|
|
38
|
+
variant :compaction, -> { OpenAI::Responses::ResponseCompactionItem }
|
|
39
|
+
|
|
37
40
|
# An image generation request made by the model.
|
|
38
41
|
variant :image_generation_call, -> { OpenAI::Responses::ResponseOutputItem::ImageGenerationCall }
|
|
39
42
|
|
|
@@ -480,7 +483,7 @@ module OpenAI
|
|
|
480
483
|
end
|
|
481
484
|
|
|
482
485
|
# @!method self.variants
|
|
483
|
-
# @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)]
|
|
486
|
+
# @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)]
|
|
484
487
|
end
|
|
485
488
|
end
|
|
486
489
|
end
|
|
@@ -7,7 +7,7 @@ module OpenAI
|
|
|
7
7
|
# @!attribute item
|
|
8
8
|
# The output item that was added.
|
|
9
9
|
#
|
|
10
|
-
# @return [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]
|
|
10
|
+
# @return [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]
|
|
11
11
|
required :item, union: -> { OpenAI::Responses::ResponseOutputItem }
|
|
12
12
|
|
|
13
13
|
# @!attribute output_index
|
|
@@ -34,7 +34,7 @@ module OpenAI
|
|
|
34
34
|
#
|
|
35
35
|
# Emitted when a new output item is added.
|
|
36
36
|
#
|
|
37
|
-
# @param item [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] The output item that was added.
|
|
37
|
+
# @param item [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] The output item that was added.
|
|
38
38
|
#
|
|
39
39
|
# @param output_index [Integer] The index of the output item that was added.
|
|
40
40
|
#
|
|
@@ -7,7 +7,7 @@ module OpenAI
|
|
|
7
7
|
# @!attribute item
|
|
8
8
|
# The output item that was marked done.
|
|
9
9
|
#
|
|
10
|
-
# @return [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]
|
|
10
|
+
# @return [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]
|
|
11
11
|
required :item, union: -> { OpenAI::Responses::ResponseOutputItem }
|
|
12
12
|
|
|
13
13
|
# @!attribute output_index
|
|
@@ -34,7 +34,7 @@ module OpenAI
|
|
|
34
34
|
#
|
|
35
35
|
# Emitted when an output item is marked done.
|
|
36
36
|
#
|
|
37
|
-
# @param item [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] The output item that was marked done.
|
|
37
|
+
# @param item [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] The output item that was marked done.
|
|
38
38
|
#
|
|
39
39
|
# @param output_index [Integer] The index of the output item that was marked done.
|
|
40
40
|
#
|
|
@@ -349,7 +349,8 @@ module OpenAI
|
|
|
349
349
|
class CodeInterpreter < OpenAI::Internal::Type::BaseModel
|
|
350
350
|
# @!attribute container
|
|
351
351
|
# The code interpreter container. Can be a container ID or an object that
|
|
352
|
-
# specifies uploaded file IDs to make available to your code
|
|
352
|
+
# specifies uploaded file IDs to make available to your code, along with an
|
|
353
|
+
# optional `memory_limit` setting.
|
|
353
354
|
#
|
|
354
355
|
# @return [String, OpenAI::Models::Responses::Tool::CodeInterpreter::Container::CodeInterpreterToolAuto]
|
|
355
356
|
required :container, union: -> { OpenAI::Responses::Tool::CodeInterpreter::Container }
|
|
@@ -371,7 +372,8 @@ module OpenAI
|
|
|
371
372
|
# @param type [Symbol, :code_interpreter] The type of the code interpreter tool. Always `code_interpreter`.
|
|
372
373
|
|
|
373
374
|
# The code interpreter container. Can be a container ID or an object that
|
|
374
|
-
# specifies uploaded file IDs to make available to your code
|
|
375
|
+
# specifies uploaded file IDs to make available to your code, along with an
|
|
376
|
+
# optional `memory_limit` setting.
|
|
375
377
|
#
|
|
376
378
|
# @see OpenAI::Models::Responses::Tool::CodeInterpreter#container
|
|
377
379
|
module Container
|
|
@@ -11,7 +11,7 @@ module OpenAI
|
|
|
11
11
|
required :type, const: :shell
|
|
12
12
|
|
|
13
13
|
# @!method initialize(type: :shell)
|
|
14
|
-
# Forces the model to call the
|
|
14
|
+
# Forces the model to call the shell tool when a tool call is required.
|
|
15
15
|
#
|
|
16
16
|
# @param type [Symbol, :shell] The tool to call. Always `shell`.
|
|
17
17
|
end
|
|
@@ -20,33 +20,38 @@ module OpenAI
|
|
|
20
20
|
optional :input_reference, OpenAI::Internal::Type::FileInput
|
|
21
21
|
|
|
22
22
|
# @!attribute model
|
|
23
|
-
# The video generation model to use
|
|
23
|
+
# The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults
|
|
24
|
+
# to `sora-2`.
|
|
24
25
|
#
|
|
25
26
|
# @return [Symbol, OpenAI::Models::VideoModel, nil]
|
|
26
27
|
optional :model, enum: -> { OpenAI::VideoModel }
|
|
27
28
|
|
|
28
29
|
# @!attribute seconds
|
|
29
|
-
# Clip duration in seconds. Defaults to 4 seconds.
|
|
30
|
+
# Clip duration in seconds (allowed values: 4, 8, 12). Defaults to 4 seconds.
|
|
30
31
|
#
|
|
31
32
|
# @return [Symbol, OpenAI::Models::VideoSeconds, nil]
|
|
32
33
|
optional :seconds, enum: -> { OpenAI::VideoSeconds }
|
|
33
34
|
|
|
34
35
|
# @!attribute size
|
|
35
|
-
# Output resolution formatted as width x height
|
|
36
|
+
# Output resolution formatted as width x height (allowed values: 720x1280,
|
|
37
|
+
# 1280x720, 1024x1792, 1792x1024). Defaults to 720x1280.
|
|
36
38
|
#
|
|
37
39
|
# @return [Symbol, OpenAI::Models::VideoSize, nil]
|
|
38
40
|
optional :size, enum: -> { OpenAI::VideoSize }
|
|
39
41
|
|
|
40
42
|
# @!method initialize(prompt:, input_reference: nil, model: nil, seconds: nil, size: nil, request_options: {})
|
|
43
|
+
# Some parameter documentations has been truncated, see
|
|
44
|
+
# {OpenAI::Models::VideoCreateParams} for more details.
|
|
45
|
+
#
|
|
41
46
|
# @param prompt [String] Text prompt that describes the video to generate.
|
|
42
47
|
#
|
|
43
48
|
# @param input_reference [Pathname, StringIO, IO, String, OpenAI::FilePart] Optional image reference that guides generation.
|
|
44
49
|
#
|
|
45
|
-
# @param model [Symbol, OpenAI::Models::VideoModel] The video generation model to use
|
|
50
|
+
# @param model [Symbol, OpenAI::Models::VideoModel] The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults
|
|
46
51
|
#
|
|
47
|
-
# @param seconds [Symbol, OpenAI::Models::VideoSeconds] Clip duration in seconds. Defaults to 4 seconds.
|
|
52
|
+
# @param seconds [Symbol, OpenAI::Models::VideoSeconds] Clip duration in seconds (allowed values: 4, 8, 12). Defaults to 4 seconds.
|
|
48
53
|
#
|
|
49
|
-
# @param size [Symbol, OpenAI::Models::VideoSize] Output resolution formatted as width x height
|
|
54
|
+
# @param size [Symbol, OpenAI::Models::VideoSize] Output resolution formatted as width x height (allowed values: 720x1280, 1280x72
|
|
50
55
|
#
|
|
51
56
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
|
|
52
57
|
end
|
|
@@ -8,7 +8,7 @@ module OpenAI
|
|
|
8
8
|
|
|
9
9
|
# Create Container
|
|
10
10
|
#
|
|
11
|
-
# @overload create(name:, expires_after: nil, file_ids: nil, request_options: {})
|
|
11
|
+
# @overload create(name:, expires_after: nil, file_ids: nil, memory_limit: nil, request_options: {})
|
|
12
12
|
#
|
|
13
13
|
# @param name [String] Name of the container to create.
|
|
14
14
|
#
|
|
@@ -16,6 +16,8 @@ module OpenAI
|
|
|
16
16
|
#
|
|
17
17
|
# @param file_ids [Array<String>] IDs of files to copy to the container.
|
|
18
18
|
#
|
|
19
|
+
# @param memory_limit [Symbol, OpenAI::Models::ContainerCreateParams::MemoryLimit] Optional memory limit for the container. Defaults to "1g".
|
|
20
|
+
#
|
|
19
21
|
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
20
22
|
#
|
|
21
23
|
# @return [OpenAI::Models::ContainerCreateResponse]
|
|
@@ -13,7 +13,7 @@ module OpenAI
|
|
|
13
13
|
#
|
|
14
14
|
# @param conversation_id [String] Path param: The ID of the conversation to add the item to.
|
|
15
15
|
#
|
|
16
|
-
# @param items [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>] Body param: The items to add to the conversation. You may add up to 20 items at
|
|
16
|
+
# @param items [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>] Body param: The items to add to the conversation. You may add up to 20 items at
|
|
17
17
|
#
|
|
18
18
|
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Query param: Additional fields to include in the response. See the `include`
|
|
19
19
|
#
|
|
@@ -13,7 +13,7 @@ module OpenAI
|
|
|
13
13
|
#
|
|
14
14
|
# @overload create(items: nil, metadata: nil, request_options: {})
|
|
15
15
|
#
|
|
16
|
-
# @param items [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] Initial items to include in the conversation context. You may add up to 20 items
|
|
16
|
+
# @param items [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] Initial items to include in the conversation context. You may add up to 20 items
|
|
17
17
|
#
|
|
18
18
|
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
|
|
19
19
|
#
|
|
@@ -13,7 +13,7 @@ module OpenAI
|
|
|
13
13
|
#
|
|
14
14
|
# @param conversation [String, OpenAI::Models::Responses::ResponseConversationParam, nil] The conversation that this response belongs to. Items from this conversation are
|
|
15
15
|
#
|
|
16
|
-
# @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
|
|
16
|
+
# @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
|
|
17
17
|
#
|
|
18
18
|
# @param instructions [String, nil] A system (or developer) message inserted into the model's context.
|
|
19
19
|
#
|