openai 0.52.0 → 0.53.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 +8 -0
- data/README.md +1 -1
- data/lib/openai/models/evals/run_cancel_response.rb +2 -2
- data/lib/openai/models/evals/run_create_params.rb +2 -2
- data/lib/openai/models/evals/run_create_response.rb +2 -2
- data/lib/openai/models/evals/run_list_response.rb +2 -2
- data/lib/openai/models/evals/run_retrieve_response.rb +2 -2
- data/lib/openai/models/responses/computer_tool.rb +5 -45
- data/lib/openai/models/responses/computer_use_preview_tool.rb +61 -0
- data/lib/openai/models/responses/input_token_count_params.rb +2 -2
- data/lib/openai/models/responses/response.rb +2 -2
- data/lib/openai/models/responses/response_create_params.rb +2 -2
- data/lib/openai/models/responses/response_tool_search_output_item.rb +2 -2
- data/lib/openai/models/responses/response_tool_search_output_item_param.rb +2 -2
- data/lib/openai/models/responses/responses_client_event.rb +2 -2
- data/lib/openai/models/responses/tool.rb +3 -3
- data/lib/openai/resources/responses/input_tokens.rb +1 -1
- data/lib/openai/resources/responses.rb +2 -2
- data/lib/openai/version.rb +1 -1
- data/lib/openai.rb +1 -1
- data/rbi/openai/models/evals/run_cancel_response.rbi +2 -2
- data/rbi/openai/models/evals/run_create_params.rbi +4 -4
- data/rbi/openai/models/evals/run_create_response.rbi +2 -2
- data/rbi/openai/models/evals/run_list_response.rbi +2 -2
- data/rbi/openai/models/evals/run_retrieve_response.rbi +2 -2
- data/rbi/openai/models/responses/computer_tool.rbi +5 -87
- data/rbi/openai/models/responses/computer_use_preview_tool.rbi +124 -0
- data/rbi/openai/models/responses/input_token_count_params.rbi +3 -3
- data/rbi/openai/models/responses/response.rbi +1 -1
- data/rbi/openai/models/responses/response_create_params.rbi +4 -4
- data/rbi/openai/models/responses/response_tool_search_output_item.rbi +1 -1
- data/rbi/openai/models/responses/response_tool_search_output_item_param.rbi +3 -3
- data/rbi/openai/models/responses/responses_client_event.rbi +4 -4
- data/rbi/openai/models/responses/tool.rbi +1 -1
- data/rbi/openai/resources/responses/input_tokens.rbi +1 -1
- data/rbi/openai/resources/responses.rbi +2 -2
- data/sig/openai/models/responses/computer_tool.rbs +4 -40
- data/sig/openai/models/responses/computer_use_preview_tool.rbs +51 -0
- data/sig/openai/models/responses/tool.rbs +1 -1
- metadata +4 -4
- data/lib/openai/models/responses/computer_use_tool.rb +0 -21
- data/rbi/openai/models/responses/computer_use_tool.rbi +0 -31
- data/sig/openai/models/responses/computer_use_tool.rbs +0 -15
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3b766e29a63caac40f46433aca7cf7624c2f2f19b74e4948afab86e27bb8d6e3
|
|
4
|
+
data.tar.gz: '070255620935603f097a6bedfe7430ba91877b4fb603b5530899b8380ef6ce35'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8d8d216165e0f85bafb298a5ea2aee7938a07a44258b2f2521f8dec6ef7319b4a6026c2aa4989ad99f3aa3b9dd712f42984103d8b78a092483d0bff175b04168
|
|
7
|
+
data.tar.gz: aa9d16013208f0c29398f428f9af76f29da7307be8fe15389879748fbc8fc2d379a7adf4eac3a4933aa3d8de9c13c8ed6c1f99b1699b7e95d0b7ecad002879be
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.53.0 (2026-03-05)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.52.0...v0.53.0](https://github.com/openai/openai-ruby/compare/v0.52.0...v0.53.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** The GA ComputerTool now uses the CompuerTool class. The 'computer_use_preview' tool is moved to ComputerUsePreview ([154455d](https://github.com/openai/openai-ruby/commit/154455d7ac02a6fc8a940acdb6d615c59cbce4a7))
|
|
10
|
+
|
|
3
11
|
## 0.52.0 (2026-03-05)
|
|
4
12
|
|
|
5
13
|
Full Changelog: [v0.51.0...v0.52.0](https://github.com/openai/openai-ruby/compare/v0.51.0...v0.52.0)
|
data/README.md
CHANGED
|
@@ -718,7 +718,7 @@ module OpenAI
|
|
|
718
718
|
# the model to call your own code. Learn more about
|
|
719
719
|
# [function calling](https://platform.openai.com/docs/guides/function-calling).
|
|
720
720
|
#
|
|
721
|
-
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
721
|
+
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil]
|
|
722
722
|
optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
|
|
723
723
|
|
|
724
724
|
# @!attribute top_p
|
|
@@ -742,7 +742,7 @@ module OpenAI
|
|
|
742
742
|
#
|
|
743
743
|
# @param text [OpenAI::Models::Evals::RunCancelResponse::DataSource::Responses::SamplingParams::Text] Configuration options for a text response from the model. Can be plain
|
|
744
744
|
#
|
|
745
|
-
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
745
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
|
|
746
746
|
#
|
|
747
747
|
# @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
|
|
748
748
|
|
|
@@ -653,7 +653,7 @@ module OpenAI
|
|
|
653
653
|
# the model to call your own code. Learn more about
|
|
654
654
|
# [function calling](https://platform.openai.com/docs/guides/function-calling).
|
|
655
655
|
#
|
|
656
|
-
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
656
|
+
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil]
|
|
657
657
|
optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
|
|
658
658
|
|
|
659
659
|
# @!attribute top_p
|
|
@@ -677,7 +677,7 @@ module OpenAI
|
|
|
677
677
|
#
|
|
678
678
|
# @param text [OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text] Configuration options for a text response from the model. Can be plain
|
|
679
679
|
#
|
|
680
|
-
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
680
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
|
|
681
681
|
#
|
|
682
682
|
# @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
|
|
683
683
|
|
|
@@ -718,7 +718,7 @@ module OpenAI
|
|
|
718
718
|
# the model to call your own code. Learn more about
|
|
719
719
|
# [function calling](https://platform.openai.com/docs/guides/function-calling).
|
|
720
720
|
#
|
|
721
|
-
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
721
|
+
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil]
|
|
722
722
|
optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
|
|
723
723
|
|
|
724
724
|
# @!attribute top_p
|
|
@@ -742,7 +742,7 @@ module OpenAI
|
|
|
742
742
|
#
|
|
743
743
|
# @param text [OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::SamplingParams::Text] Configuration options for a text response from the model. Can be plain
|
|
744
744
|
#
|
|
745
|
-
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
745
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
|
|
746
746
|
#
|
|
747
747
|
# @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
|
|
748
748
|
|
|
@@ -717,7 +717,7 @@ module OpenAI
|
|
|
717
717
|
# the model to call your own code. Learn more about
|
|
718
718
|
# [function calling](https://platform.openai.com/docs/guides/function-calling).
|
|
719
719
|
#
|
|
720
|
-
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
720
|
+
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil]
|
|
721
721
|
optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
|
|
722
722
|
|
|
723
723
|
# @!attribute top_p
|
|
@@ -741,7 +741,7 @@ module OpenAI
|
|
|
741
741
|
#
|
|
742
742
|
# @param text [OpenAI::Models::Evals::RunListResponse::DataSource::Responses::SamplingParams::Text] Configuration options for a text response from the model. Can be plain
|
|
743
743
|
#
|
|
744
|
-
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
744
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
|
|
745
745
|
#
|
|
746
746
|
# @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
|
|
747
747
|
|
|
@@ -722,7 +722,7 @@ module OpenAI
|
|
|
722
722
|
# the model to call your own code. Learn more about
|
|
723
723
|
# [function calling](https://platform.openai.com/docs/guides/function-calling).
|
|
724
724
|
#
|
|
725
|
-
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
725
|
+
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil]
|
|
726
726
|
optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
|
|
727
727
|
|
|
728
728
|
# @!attribute top_p
|
|
@@ -746,7 +746,7 @@ module OpenAI
|
|
|
746
746
|
#
|
|
747
747
|
# @param text [OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::SamplingParams::Text] Configuration options for a text response from the model. Can be plain
|
|
748
748
|
#
|
|
749
|
-
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
749
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
|
|
750
750
|
#
|
|
751
751
|
# @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
|
|
752
752
|
|
|
@@ -4,57 +4,17 @@ module OpenAI
|
|
|
4
4
|
module Models
|
|
5
5
|
module Responses
|
|
6
6
|
class ComputerTool < OpenAI::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute display_height
|
|
8
|
-
# The height of the computer display.
|
|
9
|
-
#
|
|
10
|
-
# @return [Integer]
|
|
11
|
-
required :display_height, Integer
|
|
12
|
-
|
|
13
|
-
# @!attribute display_width
|
|
14
|
-
# The width of the computer display.
|
|
15
|
-
#
|
|
16
|
-
# @return [Integer]
|
|
17
|
-
required :display_width, Integer
|
|
18
|
-
|
|
19
|
-
# @!attribute environment
|
|
20
|
-
# The type of computer environment to control.
|
|
21
|
-
#
|
|
22
|
-
# @return [Symbol, OpenAI::Models::Responses::ComputerTool::Environment]
|
|
23
|
-
required :environment, enum: -> { OpenAI::Responses::ComputerTool::Environment }
|
|
24
|
-
|
|
25
7
|
# @!attribute type
|
|
26
|
-
# The type of the computer
|
|
8
|
+
# The type of the computer tool. Always `computer`.
|
|
27
9
|
#
|
|
28
|
-
# @return [Symbol, :
|
|
29
|
-
required :type, const: :
|
|
10
|
+
# @return [Symbol, :computer]
|
|
11
|
+
required :type, const: :computer
|
|
30
12
|
|
|
31
|
-
# @!method initialize(
|
|
13
|
+
# @!method initialize(type: :computer)
|
|
32
14
|
# A tool that controls a virtual computer. Learn more about the
|
|
33
15
|
# [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
|
|
34
16
|
#
|
|
35
|
-
# @param
|
|
36
|
-
#
|
|
37
|
-
# @param display_width [Integer] The width of the computer display.
|
|
38
|
-
#
|
|
39
|
-
# @param environment [Symbol, OpenAI::Models::Responses::ComputerTool::Environment] The type of computer environment to control.
|
|
40
|
-
#
|
|
41
|
-
# @param type [Symbol, :computer_use_preview] The type of the computer use tool. Always `computer_use_preview`.
|
|
42
|
-
|
|
43
|
-
# The type of computer environment to control.
|
|
44
|
-
#
|
|
45
|
-
# @see OpenAI::Models::Responses::ComputerTool#environment
|
|
46
|
-
module Environment
|
|
47
|
-
extend OpenAI::Internal::Type::Enum
|
|
48
|
-
|
|
49
|
-
WINDOWS = :windows
|
|
50
|
-
MAC = :mac
|
|
51
|
-
LINUX = :linux
|
|
52
|
-
UBUNTU = :ubuntu
|
|
53
|
-
BROWSER = :browser
|
|
54
|
-
|
|
55
|
-
# @!method self.values
|
|
56
|
-
# @return [Array<Symbol>]
|
|
57
|
-
end
|
|
17
|
+
# @param type [Symbol, :computer] The type of the computer tool. Always `computer`.
|
|
58
18
|
end
|
|
59
19
|
end
|
|
60
20
|
end
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module OpenAI
|
|
4
|
+
module Models
|
|
5
|
+
module Responses
|
|
6
|
+
class ComputerUsePreviewTool < OpenAI::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute display_height
|
|
8
|
+
# The height of the computer display.
|
|
9
|
+
#
|
|
10
|
+
# @return [Integer]
|
|
11
|
+
required :display_height, Integer
|
|
12
|
+
|
|
13
|
+
# @!attribute display_width
|
|
14
|
+
# The width of the computer display.
|
|
15
|
+
#
|
|
16
|
+
# @return [Integer]
|
|
17
|
+
required :display_width, Integer
|
|
18
|
+
|
|
19
|
+
# @!attribute environment
|
|
20
|
+
# The type of computer environment to control.
|
|
21
|
+
#
|
|
22
|
+
# @return [Symbol, OpenAI::Models::Responses::ComputerUsePreviewTool::Environment]
|
|
23
|
+
required :environment, enum: -> { OpenAI::Responses::ComputerUsePreviewTool::Environment }
|
|
24
|
+
|
|
25
|
+
# @!attribute type
|
|
26
|
+
# The type of the computer use tool. Always `computer_use_preview`.
|
|
27
|
+
#
|
|
28
|
+
# @return [Symbol, :computer_use_preview]
|
|
29
|
+
required :type, const: :computer_use_preview
|
|
30
|
+
|
|
31
|
+
# @!method initialize(display_height:, display_width:, environment:, type: :computer_use_preview)
|
|
32
|
+
# A tool that controls a virtual computer. Learn more about the
|
|
33
|
+
# [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
|
|
34
|
+
#
|
|
35
|
+
# @param display_height [Integer] The height of the computer display.
|
|
36
|
+
#
|
|
37
|
+
# @param display_width [Integer] The width of the computer display.
|
|
38
|
+
#
|
|
39
|
+
# @param environment [Symbol, OpenAI::Models::Responses::ComputerUsePreviewTool::Environment] The type of computer environment to control.
|
|
40
|
+
#
|
|
41
|
+
# @param type [Symbol, :computer_use_preview] The type of the computer use tool. Always `computer_use_preview`.
|
|
42
|
+
|
|
43
|
+
# The type of computer environment to control.
|
|
44
|
+
#
|
|
45
|
+
# @see OpenAI::Models::Responses::ComputerUsePreviewTool#environment
|
|
46
|
+
module Environment
|
|
47
|
+
extend OpenAI::Internal::Type::Enum
|
|
48
|
+
|
|
49
|
+
WINDOWS = :windows
|
|
50
|
+
MAC = :mac
|
|
51
|
+
LINUX = :linux
|
|
52
|
+
UBUNTU = :ubuntu
|
|
53
|
+
BROWSER = :browser
|
|
54
|
+
|
|
55
|
+
# @!method self.values
|
|
56
|
+
# @return [Array<Symbol>]
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
end
|
|
61
|
+
end
|
|
@@ -88,7 +88,7 @@ module OpenAI
|
|
|
88
88
|
# An array of tools the model may call while generating a response. You can
|
|
89
89
|
# specify which tool to use by setting the `tool_choice` parameter.
|
|
90
90
|
#
|
|
91
|
-
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
91
|
+
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil]
|
|
92
92
|
optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }, nil?: true
|
|
93
93
|
|
|
94
94
|
# @!attribute truncation
|
|
@@ -123,7 +123,7 @@ module OpenAI
|
|
|
123
123
|
#
|
|
124
124
|
# @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, OpenAI::Models::Responses::ToolChoiceCustom, OpenAI::Models::Responses::ToolChoiceApplyPatch, OpenAI::Models::Responses::ToolChoiceShell, nil] Controls which tool the model should use, if any.
|
|
125
125
|
#
|
|
126
|
-
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
126
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil] An array of tools the model may call while generating a response. You can specif
|
|
127
127
|
#
|
|
128
128
|
# @param truncation [Symbol, OpenAI::Models::Responses::InputTokenCountParams::Truncation] The truncation strategy to use for the model response. - `auto`: If the input to
|
|
129
129
|
#
|
|
@@ -124,7 +124,7 @@ module OpenAI
|
|
|
124
124
|
# [function calling](https://platform.openai.com/docs/guides/function-calling).
|
|
125
125
|
# You can also use custom tools to call your own code.
|
|
126
126
|
#
|
|
127
|
-
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
127
|
+
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>]
|
|
128
128
|
required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
|
|
129
129
|
|
|
130
130
|
# @!attribute top_p
|
|
@@ -352,7 +352,7 @@ module OpenAI
|
|
|
352
352
|
#
|
|
353
353
|
# @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, OpenAI::Models::Responses::ToolChoiceCustom, OpenAI::Models::Responses::ToolChoiceApplyPatch, OpenAI::Models::Responses::ToolChoiceShell] How the model should select which tool (or tools) to use when generating
|
|
354
354
|
#
|
|
355
|
-
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
355
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
|
|
356
356
|
#
|
|
357
357
|
# @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling,
|
|
358
358
|
#
|
|
@@ -275,7 +275,7 @@ module OpenAI
|
|
|
275
275
|
# [function calling](https://platform.openai.com/docs/guides/function-calling).
|
|
276
276
|
# You can also use custom tools to call your own code.
|
|
277
277
|
#
|
|
278
|
-
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
278
|
+
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil]
|
|
279
279
|
optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
|
|
280
280
|
|
|
281
281
|
# @!attribute top_logprobs
|
|
@@ -369,7 +369,7 @@ module OpenAI
|
|
|
369
369
|
#
|
|
370
370
|
# @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, OpenAI::Models::Responses::ToolChoiceCustom, OpenAI::Models::Responses::ToolChoiceApplyPatch, OpenAI::Models::Responses::ToolChoiceShell] How the model should select which tool (or tools) to use when generating
|
|
371
371
|
#
|
|
372
|
-
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
372
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
|
|
373
373
|
#
|
|
374
374
|
# @param top_logprobs [Integer, nil] An integer between 0 and 20 specifying the number of most likely tokens to
|
|
375
375
|
#
|
|
@@ -31,7 +31,7 @@ module OpenAI
|
|
|
31
31
|
# @!attribute tools
|
|
32
32
|
# The loaded tool definitions returned by tool search.
|
|
33
33
|
#
|
|
34
|
-
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
34
|
+
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>]
|
|
35
35
|
required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
|
|
36
36
|
|
|
37
37
|
# @!attribute type
|
|
@@ -55,7 +55,7 @@ module OpenAI
|
|
|
55
55
|
#
|
|
56
56
|
# @param status [Symbol, OpenAI::Models::Responses::ResponseToolSearchOutputItem::Status] The status of the tool search output item that was recorded.
|
|
57
57
|
#
|
|
58
|
-
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
58
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] The loaded tool definitions returned by tool search.
|
|
59
59
|
#
|
|
60
60
|
# @param created_by [String] The identifier of the actor that created the item.
|
|
61
61
|
#
|
|
@@ -7,7 +7,7 @@ module OpenAI
|
|
|
7
7
|
# @!attribute tools
|
|
8
8
|
# The loaded tool definitions returned by the tool search output.
|
|
9
9
|
#
|
|
10
|
-
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
10
|
+
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>]
|
|
11
11
|
required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
|
|
12
12
|
|
|
13
13
|
# @!attribute type
|
|
@@ -45,7 +45,7 @@ module OpenAI
|
|
|
45
45
|
nil?: true
|
|
46
46
|
|
|
47
47
|
# @!method initialize(tools:, id: nil, call_id: nil, execution: nil, status: nil, type: :tool_search_output)
|
|
48
|
-
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
48
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] The loaded tool definitions returned by the tool search output.
|
|
49
49
|
#
|
|
50
50
|
# @param id [String, nil] The unique ID of this tool search output.
|
|
51
51
|
#
|
|
@@ -280,7 +280,7 @@ module OpenAI
|
|
|
280
280
|
# [function calling](https://platform.openai.com/docs/guides/function-calling).
|
|
281
281
|
# You can also use custom tools to call your own code.
|
|
282
282
|
#
|
|
283
|
-
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
283
|
+
# @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil]
|
|
284
284
|
optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
|
|
285
285
|
|
|
286
286
|
# @!attribute top_logprobs
|
|
@@ -376,7 +376,7 @@ module OpenAI
|
|
|
376
376
|
#
|
|
377
377
|
# @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, OpenAI::Models::Responses::ToolChoiceCustom, OpenAI::Models::Responses::ToolChoiceApplyPatch, OpenAI::Models::Responses::ToolChoiceShell] How the model should select which tool (or tools) to use when generating
|
|
378
378
|
#
|
|
379
|
-
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
379
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
|
|
380
380
|
#
|
|
381
381
|
# @param top_logprobs [Integer, nil] An integer between 0 and 20 specifying the number of most likely tokens to
|
|
382
382
|
#
|
|
@@ -18,10 +18,10 @@ module OpenAI
|
|
|
18
18
|
variant :file_search, -> { OpenAI::Responses::FileSearchTool }
|
|
19
19
|
|
|
20
20
|
# A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
|
|
21
|
-
variant :computer, -> { OpenAI::Responses::
|
|
21
|
+
variant :computer, -> { OpenAI::Responses::ComputerTool }
|
|
22
22
|
|
|
23
23
|
# A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
|
|
24
|
-
variant :computer_use_preview, -> { OpenAI::Responses::
|
|
24
|
+
variant :computer_use_preview, -> { OpenAI::Responses::ComputerUsePreviewTool }
|
|
25
25
|
|
|
26
26
|
# Give the model access to additional tools via remote Model Context Protocol
|
|
27
27
|
# (MCP) servers. [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
|
|
@@ -774,7 +774,7 @@ module OpenAI
|
|
|
774
774
|
end
|
|
775
775
|
|
|
776
776
|
# @!method self.variants
|
|
777
|
-
# @return [Array(OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
777
|
+
# @return [Array(OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool)]
|
|
778
778
|
end
|
|
779
779
|
end
|
|
780
780
|
end
|
|
@@ -32,7 +32,7 @@ module OpenAI
|
|
|
32
32
|
#
|
|
33
33
|
# @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, OpenAI::Models::Responses::ToolChoiceCustom, OpenAI::Models::Responses::ToolChoiceApplyPatch, OpenAI::Models::Responses::ToolChoiceShell, nil] Controls which tool the model should use, if any.
|
|
34
34
|
#
|
|
35
|
-
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
35
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil] An array of tools the model may call while generating a response. You can specif
|
|
36
36
|
#
|
|
37
37
|
# @param truncation [Symbol, OpenAI::Models::Responses::InputTokenCountParams::Truncation] The truncation strategy to use for the model response. - `auto`: If the input to
|
|
38
38
|
#
|
|
@@ -74,7 +74,7 @@ module OpenAI
|
|
|
74
74
|
#
|
|
75
75
|
# @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, OpenAI::Models::Responses::ToolChoiceCustom, OpenAI::Models::Responses::ToolChoiceApplyPatch, OpenAI::Models::Responses::ToolChoiceShell] How the model should select which tool (or tools) to use when generating
|
|
76
76
|
#
|
|
77
|
-
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
77
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
|
|
78
78
|
#
|
|
79
79
|
# @param top_logprobs [Integer, nil] An integer between 0 and 20 specifying the number of most likely tokens to
|
|
80
80
|
#
|
|
@@ -295,7 +295,7 @@ module OpenAI
|
|
|
295
295
|
#
|
|
296
296
|
# @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, OpenAI::Models::Responses::ToolChoiceCustom, OpenAI::Models::Responses::ToolChoiceApplyPatch, OpenAI::Models::Responses::ToolChoiceShell] How the model should select which tool (or tools) to use when generating
|
|
297
297
|
#
|
|
298
|
-
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::
|
|
298
|
+
# @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::ComputerUsePreviewTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::NamespaceTool, OpenAI::Models::Responses::ToolSearchTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
|
|
299
299
|
#
|
|
300
300
|
# @param top_logprobs [Integer, nil] An integer between 0 and 20 specifying the number of most likely tokens to
|
|
301
301
|
#
|
data/lib/openai/version.rb
CHANGED
data/lib/openai.rb
CHANGED
|
@@ -540,7 +540,7 @@ require_relative "openai/models/responses/compacted_response"
|
|
|
540
540
|
require_relative "openai/models/responses/computer_action"
|
|
541
541
|
require_relative "openai/models/responses/computer_action_list"
|
|
542
542
|
require_relative "openai/models/responses/computer_tool"
|
|
543
|
-
require_relative "openai/models/responses/
|
|
543
|
+
require_relative "openai/models/responses/computer_use_preview_tool"
|
|
544
544
|
require_relative "openai/models/responses/container_auto"
|
|
545
545
|
require_relative "openai/models/responses/container_network_policy_allowlist"
|
|
546
546
|
require_relative "openai/models/responses/container_network_policy_disabled"
|
|
@@ -1212,8 +1212,8 @@ module OpenAI
|
|
|
1212
1212
|
T.any(
|
|
1213
1213
|
OpenAI::Responses::FunctionTool::OrHash,
|
|
1214
1214
|
OpenAI::Responses::FileSearchTool::OrHash,
|
|
1215
|
-
OpenAI::Responses::ComputerUseTool::OrHash,
|
|
1216
1215
|
OpenAI::Responses::ComputerTool::OrHash,
|
|
1216
|
+
OpenAI::Responses::ComputerUsePreviewTool::OrHash,
|
|
1217
1217
|
OpenAI::Responses::Tool::Mcp::OrHash,
|
|
1218
1218
|
OpenAI::Responses::Tool::CodeInterpreter::OrHash,
|
|
1219
1219
|
OpenAI::Responses::Tool::ImageGeneration::OrHash,
|
|
@@ -1252,8 +1252,8 @@ module OpenAI
|
|
|
1252
1252
|
T.any(
|
|
1253
1253
|
OpenAI::Responses::FunctionTool::OrHash,
|
|
1254
1254
|
OpenAI::Responses::FileSearchTool::OrHash,
|
|
1255
|
-
OpenAI::Responses::ComputerUseTool::OrHash,
|
|
1256
1255
|
OpenAI::Responses::ComputerTool::OrHash,
|
|
1256
|
+
OpenAI::Responses::ComputerUsePreviewTool::OrHash,
|
|
1257
1257
|
OpenAI::Responses::Tool::Mcp::OrHash,
|
|
1258
1258
|
OpenAI::Responses::Tool::CodeInterpreter::OrHash,
|
|
1259
1259
|
OpenAI::Responses::Tool::ImageGeneration::OrHash,
|
|
@@ -1187,8 +1187,8 @@ module OpenAI
|
|
|
1187
1187
|
T.any(
|
|
1188
1188
|
OpenAI::Responses::FunctionTool,
|
|
1189
1189
|
OpenAI::Responses::FileSearchTool,
|
|
1190
|
-
OpenAI::Responses::ComputerUseTool,
|
|
1191
1190
|
OpenAI::Responses::ComputerTool,
|
|
1191
|
+
OpenAI::Responses::ComputerUsePreviewTool,
|
|
1192
1192
|
OpenAI::Responses::Tool::Mcp,
|
|
1193
1193
|
OpenAI::Responses::Tool::CodeInterpreter,
|
|
1194
1194
|
OpenAI::Responses::Tool::ImageGeneration,
|
|
@@ -1214,8 +1214,8 @@ module OpenAI
|
|
|
1214
1214
|
T.any(
|
|
1215
1215
|
OpenAI::Responses::FunctionTool::OrHash,
|
|
1216
1216
|
OpenAI::Responses::FileSearchTool::OrHash,
|
|
1217
|
-
OpenAI::Responses::ComputerUseTool::OrHash,
|
|
1218
1217
|
OpenAI::Responses::ComputerTool::OrHash,
|
|
1218
|
+
OpenAI::Responses::ComputerUsePreviewTool::OrHash,
|
|
1219
1219
|
OpenAI::Responses::Tool::Mcp::OrHash,
|
|
1220
1220
|
OpenAI::Responses::Tool::CodeInterpreter::OrHash,
|
|
1221
1221
|
OpenAI::Responses::Tool::ImageGeneration::OrHash,
|
|
@@ -1254,8 +1254,8 @@ module OpenAI
|
|
|
1254
1254
|
T.any(
|
|
1255
1255
|
OpenAI::Responses::FunctionTool::OrHash,
|
|
1256
1256
|
OpenAI::Responses::FileSearchTool::OrHash,
|
|
1257
|
-
OpenAI::Responses::ComputerUseTool::OrHash,
|
|
1258
1257
|
OpenAI::Responses::ComputerTool::OrHash,
|
|
1258
|
+
OpenAI::Responses::ComputerUsePreviewTool::OrHash,
|
|
1259
1259
|
OpenAI::Responses::Tool::Mcp::OrHash,
|
|
1260
1260
|
OpenAI::Responses::Tool::CodeInterpreter::OrHash,
|
|
1261
1261
|
OpenAI::Responses::Tool::ImageGeneration::OrHash,
|
|
@@ -1334,8 +1334,8 @@ module OpenAI
|
|
|
1334
1334
|
T.any(
|
|
1335
1335
|
OpenAI::Responses::FunctionTool,
|
|
1336
1336
|
OpenAI::Responses::FileSearchTool,
|
|
1337
|
-
OpenAI::Responses::ComputerUseTool,
|
|
1338
1337
|
OpenAI::Responses::ComputerTool,
|
|
1338
|
+
OpenAI::Responses::ComputerUsePreviewTool,
|
|
1339
1339
|
OpenAI::Responses::Tool::Mcp,
|
|
1340
1340
|
OpenAI::Responses::Tool::CodeInterpreter,
|
|
1341
1341
|
OpenAI::Responses::Tool::ImageGeneration,
|
|
@@ -1212,8 +1212,8 @@ module OpenAI
|
|
|
1212
1212
|
T.any(
|
|
1213
1213
|
OpenAI::Responses::FunctionTool::OrHash,
|
|
1214
1214
|
OpenAI::Responses::FileSearchTool::OrHash,
|
|
1215
|
-
OpenAI::Responses::ComputerUseTool::OrHash,
|
|
1216
1215
|
OpenAI::Responses::ComputerTool::OrHash,
|
|
1216
|
+
OpenAI::Responses::ComputerUsePreviewTool::OrHash,
|
|
1217
1217
|
OpenAI::Responses::Tool::Mcp::OrHash,
|
|
1218
1218
|
OpenAI::Responses::Tool::CodeInterpreter::OrHash,
|
|
1219
1219
|
OpenAI::Responses::Tool::ImageGeneration::OrHash,
|
|
@@ -1252,8 +1252,8 @@ module OpenAI
|
|
|
1252
1252
|
T.any(
|
|
1253
1253
|
OpenAI::Responses::FunctionTool::OrHash,
|
|
1254
1254
|
OpenAI::Responses::FileSearchTool::OrHash,
|
|
1255
|
-
OpenAI::Responses::ComputerUseTool::OrHash,
|
|
1256
1255
|
OpenAI::Responses::ComputerTool::OrHash,
|
|
1256
|
+
OpenAI::Responses::ComputerUsePreviewTool::OrHash,
|
|
1257
1257
|
OpenAI::Responses::Tool::Mcp::OrHash,
|
|
1258
1258
|
OpenAI::Responses::Tool::CodeInterpreter::OrHash,
|
|
1259
1259
|
OpenAI::Responses::Tool::ImageGeneration::OrHash,
|
|
@@ -1208,8 +1208,8 @@ module OpenAI
|
|
|
1208
1208
|
T.any(
|
|
1209
1209
|
OpenAI::Responses::FunctionTool::OrHash,
|
|
1210
1210
|
OpenAI::Responses::FileSearchTool::OrHash,
|
|
1211
|
-
OpenAI::Responses::ComputerUseTool::OrHash,
|
|
1212
1211
|
OpenAI::Responses::ComputerTool::OrHash,
|
|
1212
|
+
OpenAI::Responses::ComputerUsePreviewTool::OrHash,
|
|
1213
1213
|
OpenAI::Responses::Tool::Mcp::OrHash,
|
|
1214
1214
|
OpenAI::Responses::Tool::CodeInterpreter::OrHash,
|
|
1215
1215
|
OpenAI::Responses::Tool::ImageGeneration::OrHash,
|
|
@@ -1248,8 +1248,8 @@ module OpenAI
|
|
|
1248
1248
|
T.any(
|
|
1249
1249
|
OpenAI::Responses::FunctionTool::OrHash,
|
|
1250
1250
|
OpenAI::Responses::FileSearchTool::OrHash,
|
|
1251
|
-
OpenAI::Responses::ComputerUseTool::OrHash,
|
|
1252
1251
|
OpenAI::Responses::ComputerTool::OrHash,
|
|
1252
|
+
OpenAI::Responses::ComputerUsePreviewTool::OrHash,
|
|
1253
1253
|
OpenAI::Responses::Tool::Mcp::OrHash,
|
|
1254
1254
|
OpenAI::Responses::Tool::CodeInterpreter::OrHash,
|
|
1255
1255
|
OpenAI::Responses::Tool::ImageGeneration::OrHash,
|