openai 0.52.0 → 0.54.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.
Files changed (82) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +25 -0
  3. data/README.md +1 -1
  4. data/lib/openai/models/evals/run_cancel_response.rb +2 -2
  5. data/lib/openai/models/evals/run_create_params.rb +2 -2
  6. data/lib/openai/models/evals/run_create_response.rb +2 -2
  7. data/lib/openai/models/evals/run_list_response.rb +2 -2
  8. data/lib/openai/models/evals/run_retrieve_response.rb +2 -2
  9. data/lib/openai/models/image_input_reference_param.rb +23 -0
  10. data/lib/openai/models/responses/computer_tool.rb +5 -45
  11. data/lib/openai/models/responses/computer_use_preview_tool.rb +61 -0
  12. data/lib/openai/models/responses/input_token_count_params.rb +2 -2
  13. data/lib/openai/models/responses/response.rb +2 -2
  14. data/lib/openai/models/responses/response_create_params.rb +2 -2
  15. data/lib/openai/models/responses/response_input_file.rb +1 -24
  16. data/lib/openai/models/responses/response_input_file_content.rb +1 -27
  17. data/lib/openai/models/responses/response_tool_search_output_item.rb +2 -2
  18. data/lib/openai/models/responses/response_tool_search_output_item_param.rb +2 -2
  19. data/lib/openai/models/responses/responses_client_event.rb +2 -2
  20. data/lib/openai/models/responses/tool.rb +3 -3
  21. data/lib/openai/models/video_create_character_params.rb +30 -0
  22. data/lib/openai/models/video_create_character_response.rb +33 -0
  23. data/lib/openai/models/video_create_params.rb +17 -4
  24. data/lib/openai/models/video_edit_params.rb +57 -0
  25. data/lib/openai/models/video_extend_params.rb +69 -0
  26. data/lib/openai/models/video_get_character_params.rb +20 -0
  27. data/lib/openai/models/video_get_character_response.rb +33 -0
  28. data/lib/openai/models.rb +10 -0
  29. data/lib/openai/resources/responses/input_tokens.rb +1 -1
  30. data/lib/openai/resources/responses.rb +2 -2
  31. data/lib/openai/resources/videos.rb +102 -1
  32. data/lib/openai/version.rb +1 -1
  33. data/lib/openai.rb +8 -1
  34. data/rbi/openai/client.rbi +6 -0
  35. data/rbi/openai/models/evals/run_cancel_response.rbi +2 -2
  36. data/rbi/openai/models/evals/run_create_params.rbi +4 -4
  37. data/rbi/openai/models/evals/run_create_response.rbi +2 -2
  38. data/rbi/openai/models/evals/run_list_response.rbi +2 -2
  39. data/rbi/openai/models/evals/run_retrieve_response.rbi +2 -2
  40. data/rbi/openai/models/image_input_reference_param.rbi +39 -0
  41. data/rbi/openai/models/responses/computer_tool.rbi +5 -87
  42. data/rbi/openai/models/responses/computer_use_preview_tool.rbi +124 -0
  43. data/rbi/openai/models/responses/input_token_count_params.rbi +3 -3
  44. data/rbi/openai/models/responses/response.rbi +1 -1
  45. data/rbi/openai/models/responses/response_create_params.rbi +4 -4
  46. data/rbi/openai/models/responses/response_input_file.rbi +0 -54
  47. data/rbi/openai/models/responses/response_input_file_content.rbi +0 -59
  48. data/rbi/openai/models/responses/response_tool_search_output_item.rbi +1 -1
  49. data/rbi/openai/models/responses/response_tool_search_output_item_param.rbi +3 -3
  50. data/rbi/openai/models/responses/responses_client_event.rbi +4 -4
  51. data/rbi/openai/models/responses/tool.rbi +1 -1
  52. data/rbi/openai/models/video_create_character_params.rbi +51 -0
  53. data/rbi/openai/models/video_create_character_response.rbi +56 -0
  54. data/rbi/openai/models/video_create_params.rbi +44 -6
  55. data/rbi/openai/models/video_edit_params.rbi +111 -0
  56. data/rbi/openai/models/video_extend_params.rbi +121 -0
  57. data/rbi/openai/models/video_get_character_params.rbi +35 -0
  58. data/rbi/openai/models/video_get_character_response.rbi +56 -0
  59. data/rbi/openai/models.rbi +10 -0
  60. data/rbi/openai/resources/responses/input_tokens.rbi +1 -1
  61. data/rbi/openai/resources/responses.rbi +2 -2
  62. data/rbi/openai/resources/videos.rbi +84 -2
  63. data/sig/openai/client.rbs +3 -0
  64. data/sig/openai/models/image_input_reference_param.rbs +19 -0
  65. data/sig/openai/models/responses/computer_tool.rbs +4 -40
  66. data/sig/openai/models/responses/computer_use_preview_tool.rbs +51 -0
  67. data/sig/openai/models/responses/response_input_file.rbs +0 -20
  68. data/sig/openai/models/responses/response_input_file_content.rbs +0 -20
  69. data/sig/openai/models/responses/tool.rbs +1 -1
  70. data/sig/openai/models/video_create_character_params.rbs +28 -0
  71. data/sig/openai/models/video_create_character_response.rbs +18 -0
  72. data/sig/openai/models/video_create_params.rbs +15 -6
  73. data/sig/openai/models/video_edit_params.rbs +48 -0
  74. data/sig/openai/models/video_extend_params.rbs +56 -0
  75. data/sig/openai/models/video_get_character_params.rbs +23 -0
  76. data/sig/openai/models/video_get_character_response.rbs +18 -0
  77. data/sig/openai/models.rbs +10 -0
  78. data/sig/openai/resources/videos.rbs +25 -1
  79. metadata +26 -5
  80. data/lib/openai/models/responses/computer_use_tool.rb +0 -21
  81. data/rbi/openai/models/responses/computer_use_tool.rbi +0 -31
  82. 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: c21fe8d5023582f2aa3ee07216c1eacfc3a1f2123abbeb4b10505695a5db3fd3
4
- data.tar.gz: 5c2ed66344801a2fded78a3065cbd7b225d42dc82c5984a717cc13462b86286f
3
+ metadata.gz: 83d02aadc8a7e6f7b37049c3d9f4aeaea7431550be5d59b39125caac69dc0b8d
4
+ data.tar.gz: 65952c4730694ec1d6d8e94975574830caaa4b00af59102004c22193eeddd084
5
5
  SHA512:
6
- metadata.gz: b2e7315d276787ecec496163984da7916ac83dad16c6f83ce625261f812c9609306b9f1d4fb3494c030bb08db70bb4d4a844fab65e25126a7a3d9d3f9f27a438
7
- data.tar.gz: 512dfaa1743141ac8c80d484f0dd298dc02f18150975a06b9e3b6bad1ce7d212902e62b267d0dc783995d761d03ddea455d5df39d4a438a92175997d3b9261ff
6
+ metadata.gz: 0cdf744110926dcc10a24efcb6d945f23da0390a72827434ab6b0cd9308e1e5a9f64e6d7f8d304c206c146caf10fc8d06c242c3f6447ed7d052bb60f302f905a
7
+ data.tar.gz: 5cc663414eead8566eaefb21714a5fad8e1bbaa5ed5f8b297d4af45909b4cc0ea34d96fa273cc85e587f4fa41cc263b0c5b88db67e4c22e24a10cbb48822165b
data/CHANGELOG.md CHANGED
@@ -1,5 +1,30 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.54.0 (2026-03-13)
4
+
5
+ Full Changelog: [v0.53.0...v0.54.0](https://github.com/openai/openai-ruby/compare/v0.53.0...v0.54.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([235124c](https://github.com/openai/openai-ruby/commit/235124c18886d02e2373c8075354cd19cf928a1d))
10
+ * **api:** manual updates ([d1ee93f](https://github.com/openai/openai-ruby/commit/d1ee93fd53b18ba7a6c38d75ecac9ab6b6eade9f))
11
+ * **api:** manual updates ([8f13ded](https://github.com/openai/openai-ruby/commit/8f13ded017186651bbfaf679e429d7436183f8c0))
12
+ * **api:** sora api improvements: character api, video extensions/edits, higher resolution exports. ([58a8c4d](https://github.com/openai/openai-ruby/commit/58a8c4d13897c6be6735e5255e4e7308c9a7cc44))
13
+ * **client:** add webhook support ([3a2425f](https://github.com/openai/openai-ruby/commit/3a2425ff3ac8cfb883e38e56c1c76585ce6a8ab5))
14
+
15
+
16
+ ### Chores
17
+
18
+ * **internal:** codegen related update ([2100fc4](https://github.com/openai/openai-ruby/commit/2100fc4105da779d09e15723c9ad22eb7a6ad307))
19
+
20
+ ## 0.53.0 (2026-03-05)
21
+
22
+ Full Changelog: [v0.52.0...v0.53.0](https://github.com/openai/openai-ruby/compare/v0.52.0...v0.53.0)
23
+
24
+ ### Features
25
+
26
+ * **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))
27
+
3
28
  ## 0.52.0 (2026-03-05)
4
29
 
5
30
  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
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "openai", "~> 0.52.0"
18
+ gem "openai", "~> 0.54.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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
+ # @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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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
+ # @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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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]
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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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
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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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
+ # @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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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
+ # @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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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]
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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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
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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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]
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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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
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
 
@@ -0,0 +1,23 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ class ImageInputReferenceParam < OpenAI::Internal::Type::BaseModel
6
+ # @!attribute file_id
7
+ #
8
+ # @return [String, nil]
9
+ optional :file_id, String
10
+
11
+ # @!attribute image_url
12
+ # A fully qualified URL or base64-encoded data URL.
13
+ #
14
+ # @return [String, nil]
15
+ optional :image_url, String
16
+
17
+ # @!method initialize(file_id: nil, image_url: nil)
18
+ # @param file_id [String]
19
+ #
20
+ # @param image_url [String] A fully qualified URL or base64-encoded data URL.
21
+ end
22
+ end
23
+ end
@@ -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 use tool. Always `computer_use_preview`.
8
+ # The type of the computer tool. Always `computer`.
27
9
  #
28
- # @return [Symbol, :computer_use_preview]
29
- required :type, const: :computer_use_preview
10
+ # @return [Symbol, :computer]
11
+ required :type, const: :computer
30
12
 
31
- # @!method initialize(display_height:, display_width:, environment:, type: :computer_use_preview)
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 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::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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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]
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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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
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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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>]
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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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
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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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]
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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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
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
  #
@@ -10,13 +10,6 @@ module OpenAI
10
10
  # @return [Symbol, :input_file]
11
11
  required :type, const: :input_file
12
12
 
13
- # @!attribute detail
14
- # The detail level of the file to be sent to the model. One of `high` or `low`.
15
- # Defaults to `high`.
16
- #
17
- # @return [Symbol, OpenAI::Models::Responses::ResponseInputFile::Detail, nil]
18
- optional :detail, enum: -> { OpenAI::Responses::ResponseInputFile::Detail }
19
-
20
13
  # @!attribute file_data
21
14
  # The content of the file to be sent to the model.
22
15
  #
@@ -41,14 +34,12 @@ module OpenAI
41
34
  # @return [String, nil]
42
35
  optional :filename, String
43
36
 
44
- # @!method initialize(detail: nil, file_data: nil, file_id: nil, file_url: nil, filename: nil, type: :input_file)
37
+ # @!method initialize(file_data: nil, file_id: nil, file_url: nil, filename: nil, type: :input_file)
45
38
  # Some parameter documentations has been truncated, see
46
39
  # {OpenAI::Models::Responses::ResponseInputFile} for more details.
47
40
  #
48
41
  # A file input to the model.
49
42
  #
50
- # @param detail [Symbol, OpenAI::Models::Responses::ResponseInputFile::Detail] The detail level of the file to be sent to the model. One of `high` or `low`. De
51
- #
52
43
  # @param file_data [String] The content of the file to be sent to the model.
53
44
  #
54
45
  # @param file_id [String, nil] The ID of the file to be sent to the model.
@@ -58,20 +49,6 @@ module OpenAI
58
49
  # @param filename [String] The name of the file to be sent to the model.
59
50
  #
60
51
  # @param type [Symbol, :input_file] The type of the input item. Always `input_file`.
61
-
62
- # The detail level of the file to be sent to the model. One of `high` or `low`.
63
- # Defaults to `high`.
64
- #
65
- # @see OpenAI::Models::Responses::ResponseInputFile#detail
66
- module Detail
67
- extend OpenAI::Internal::Type::Enum
68
-
69
- LOW = :low
70
- HIGH = :high
71
-
72
- # @!method self.values
73
- # @return [Array<Symbol>]
74
- end
75
52
  end
76
53
  end
77
54
  end
@@ -10,13 +10,6 @@ module OpenAI
10
10
  # @return [Symbol, :input_file]
11
11
  required :type, const: :input_file
12
12
 
13
- # @!attribute detail
14
- # The detail level of the file to be sent to the model. One of `high` or `low`.
15
- # Defaults to `high`.
16
- #
17
- # @return [Symbol, OpenAI::Models::Responses::ResponseInputFileContent::Detail, nil]
18
- optional :detail, enum: -> { OpenAI::Responses::ResponseInputFileContent::Detail }
19
-
20
13
  # @!attribute file_data
21
14
  # The base64-encoded data of the file to be sent to the model.
22
15
  #
@@ -41,14 +34,9 @@ module OpenAI
41
34
  # @return [String, nil]
42
35
  optional :filename, String, nil?: true
43
36
 
44
- # @!method initialize(detail: nil, file_data: nil, file_id: nil, file_url: nil, filename: nil, type: :input_file)
45
- # Some parameter documentations has been truncated, see
46
- # {OpenAI::Models::Responses::ResponseInputFileContent} for more details.
47
- #
37
+ # @!method initialize(file_data: nil, file_id: nil, file_url: nil, filename: nil, type: :input_file)
48
38
  # A file input to the model.
49
39
  #
50
- # @param detail [Symbol, OpenAI::Models::Responses::ResponseInputFileContent::Detail] The detail level of the file to be sent to the model. One of `high` or `low`. De
51
- #
52
40
  # @param file_data [String, nil] The base64-encoded data of the file to be sent to the model.
53
41
  #
54
42
  # @param file_id [String, nil] The ID of the file to be sent to the model.
@@ -58,20 +46,6 @@ module OpenAI
58
46
  # @param filename [String, nil] The name of the file to be sent to the model.
59
47
  #
60
48
  # @param type [Symbol, :input_file] The type of the input item. Always `input_file`.
61
-
62
- # The detail level of the file to be sent to the model. One of `high` or `low`.
63
- # Defaults to `high`.
64
- #
65
- # @see OpenAI::Models::Responses::ResponseInputFileContent#detail
66
- module Detail
67
- extend OpenAI::Internal::Type::Enum
68
-
69
- HIGH = :high
70
- LOW = :low
71
-
72
- # @!method self.values
73
- # @return [Array<Symbol>]
74
- end
75
49
  end
76
50
  end
77
51
  end
@@ -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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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>]
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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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.
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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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>]
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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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.
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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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]
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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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
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::ComputerUseTool }
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::ComputerTool }
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::ComputerUseTool, OpenAI::Models::Responses::ComputerTool, 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)]
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
@@ -0,0 +1,30 @@
1
+ # frozen_string_literal: true
2
+
3
+ module OpenAI
4
+ module Models
5
+ # @see OpenAI::Resources::Videos#create_character
6
+ class VideoCreateCharacterParams < OpenAI::Internal::Type::BaseModel
7
+ extend OpenAI::Internal::Type::RequestParameters::Converter
8
+ include OpenAI::Internal::Type::RequestParameters
9
+
10
+ # @!attribute name
11
+ # Display name for this API character.
12
+ #
13
+ # @return [String]
14
+ required :name, String
15
+
16
+ # @!attribute video
17
+ # Video file used to create a character.
18
+ #
19
+ # @return [Pathname, StringIO, IO, String, OpenAI::FilePart]
20
+ required :video, OpenAI::Internal::Type::FileInput
21
+
22
+ # @!method initialize(name:, video:, request_options: {})
23
+ # @param name [String] Display name for this API character.
24
+ #
25
+ # @param video [Pathname, StringIO, IO, String, OpenAI::FilePart] Video file used to create a character.
26
+ #
27
+ # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
28
+ end
29
+ end
30
+ end