RubyGems - openai - Versions diffs - 0.19.0 → 0.20.0 - Mend

openai 0.19.0 → 0.20.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 (38) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac4ed9093113e0eba0188cabba2c4ba6bc349ea0a3d03ada3ed2c091634eeed9
-  data.tar.gz: e20b7e18c4ddcfdefcb9dffc209a975d73e85f1203d0feac5f9cf120efa7dc09
+  metadata.gz: 4c6dd691067d679cc3e1fb922b6187850c4857704511bd48f6a0b182f212e72d
+  data.tar.gz: a885e6d50f931ab851dddb2f592f3d0e3a93eaefc985ae55c9962f6ea724e2ca
 SHA512:
-  metadata.gz: a4caaa4c1f5a0ce634d6161f42867592da4df7a1d011ac79133304ba3f18f6fae564744f89062bf062c4167c0e22bedadf9b9f05f9416d9921311f0019f2cf9e
-  data.tar.gz: 3ab46d651e729aa986a3befb934300fcd05badc4a44cc0a61bcd08041d9d1e166f2820d9854f133fce94b77ff8d7158cf88982571ccaaa683adcc8f9a541b1b6
+  metadata.gz: 8673a1b9933ba901c41811123d34d73217344d1589e2d4d4f2741cc7cf0732d6843ba387e27edffa9b60fdfbee032bdb839ce97f2c849032181432b86c021e31
+  data.tar.gz: a20ea6be9a122f849567e0e0f734f188f950b302acc1494dc15d302deb6874f8be0032758bae5ecd49aae84b5d98a347f0d05b9e05d1971abb03d237142758a4

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,20 @@
 # Changelog
+## 0.20.0 (2025-08-26)
+Full Changelog: [v0.19.0...v0.20.0](https://github.com/openai/openai-ruby/compare/v0.19.0...v0.20.0)
+### Features
+* **api:** add web search filters ([3b84ccf](https://github.com/openai/openai-ruby/commit/3b84ccfc4073237232eff453ee33cbc15ad96c5d))
+### Chores
+* add example for using openai-ruby with Azure OpenAI ([#185](https://github.com/openai/openai-ruby/issues/185)) ([9a9338f](https://github.com/openai/openai-ruby/commit/9a9338fe333d81de3113ba4495b9b08c982e730b))
+* add json schema comment for rubocop.yml ([1f85c0d](https://github.com/openai/openai-ruby/commit/1f85c0dcf5659e9b4bb995b2c7af40e79d28e376))
+* annotate structured output parsed responses with `response_only` ([#814](https://github.com/openai/openai-ruby/issues/814)) ([320b726](https://github.com/openai/openai-ruby/commit/320b726deec82b34e06fbaa909c9fcc90dbe4d96))
 ## 0.19.0 (2025-08-21)
 Full Changelog: [v0.18.1...v0.19.0](https://github.com/openai/openai-ruby/compare/v0.18.1...v0.19.0)

data/README.md CHANGED Viewed

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 ```ruby
-gem "openai", "~> 0.19.0"
+gem "openai", "~> 0.20.0"
 ```
 <!-- x-release-please-end -->

data/lib/openai/models/chat/chat_completion_message.rb CHANGED Viewed

@@ -10,11 +10,13 @@ module OpenAI
         #   @return [String, nil]
         required :content, String, nil?: true
-        # @!attribute parsed
-        #   The parsed contents of the message, if JSON schema is specified.
-        #
-        #   @return [Object, nil]
-        optional :parsed, OpenAI::StructuredOutput::ParsedJson
+        response_only do
+          # @!attribute parsed
+          #   The parsed contents of the message, if JSON schema is specified.
+          #
+          #   @return [Object, nil]
+          optional :parsed, OpenAI::StructuredOutput::ParsedJson
+        end
         # @!attribute refusal
         #   The refusal message generated by the model.

data/lib/openai/models/chat/chat_completion_message_function_tool_call.rb CHANGED Viewed

@@ -42,11 +42,13 @@ module OpenAI
           #   @return [String]
           required :arguments, String
-          # @!attribute parsed
-          #   The parsed contents of the arguments.
-          #
-          #   @return [Object, nil]
-          required :parsed, OpenAI::StructuredOutput::ParsedJson
+          response_only do
+            # @!attribute parsed
+            #   The parsed contents of the arguments.
+            #
+            #   @return [Object, nil]
+            required :parsed, OpenAI::StructuredOutput::ParsedJson
+          end
           # @!attribute name
           #   The name of the function to call.

data/lib/openai/models/conversations/item_list_params.rb CHANGED Viewed

@@ -18,6 +18,8 @@ module OpenAI
         #   Specify additional output data to include in the model response. Currently
         #   supported values are:
         #
+        #   - `web_search_call.action.sources`: Include the sources of the web search tool
+        #     call.
         #   - `code_interpreter_call.outputs`: Includes the outputs of python code execution
         #     in code interpreter tool call items.
         #   - `computer_call_output.output.image_url`: Include image urls from the computer

data/lib/openai/models/evals/run_cancel_response.rb CHANGED Viewed

@@ -686,7 +686,7 @@ module OpenAI
               #     the model to call your own code. Learn more about
               #     [function calling](https://platform.openai.com/docs/guides/function-calling).
               #
-              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::WebSearchTool>, nil]
+              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>, nil]
               optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
               # @!attribute top_p
@@ -708,7 +708,7 @@ module OpenAI
               #
               #   @param text [OpenAI::Models::Evals::RunCancelResponse::DataSource::Responses::SamplingParams::Text] Configuration options for a text response from the model. Can be plain
               #
-              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
+              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
               #
               #   @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.

data/lib/openai/models/evals/run_create_params.rb CHANGED Viewed

@@ -614,7 +614,7 @@ module OpenAI
               #     the model to call your own code. Learn more about
               #     [function calling](https://platform.openai.com/docs/guides/function-calling).
               #
-              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::WebSearchTool>, nil]
+              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>, nil]
               optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
               # @!attribute top_p
@@ -636,7 +636,7 @@ module OpenAI
               #
               #   @param text [OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text] Configuration options for a text response from the model. Can be plain
               #
-              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
+              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
               #
               #   @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.

data/lib/openai/models/evals/run_create_response.rb CHANGED Viewed

@@ -686,7 +686,7 @@ module OpenAI
               #     the model to call your own code. Learn more about
               #     [function calling](https://platform.openai.com/docs/guides/function-calling).
               #
-              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::WebSearchTool>, nil]
+              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>, nil]
               optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
               # @!attribute top_p
@@ -708,7 +708,7 @@ module OpenAI
               #
               #   @param text [OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::SamplingParams::Text] Configuration options for a text response from the model. Can be plain
               #
-              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
+              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
               #
               #   @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.

data/lib/openai/models/evals/run_list_response.rb CHANGED Viewed

@@ -685,7 +685,7 @@ module OpenAI
               #     the model to call your own code. Learn more about
               #     [function calling](https://platform.openai.com/docs/guides/function-calling).
               #
-              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::WebSearchTool>, nil]
+              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>, nil]
               optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
               # @!attribute top_p
@@ -707,7 +707,7 @@ module OpenAI
               #
               #   @param text [OpenAI::Models::Evals::RunListResponse::DataSource::Responses::SamplingParams::Text] Configuration options for a text response from the model. Can be plain
               #
-              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
+              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
               #
               #   @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.

data/lib/openai/models/evals/run_retrieve_response.rb CHANGED Viewed

@@ -690,7 +690,7 @@ module OpenAI
               #     the model to call your own code. Learn more about
               #     [function calling](https://platform.openai.com/docs/guides/function-calling).
               #
-              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::WebSearchTool>, nil]
+              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>, nil]
               optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
               # @!attribute top_p
@@ -712,7 +712,7 @@ module OpenAI
               #
               #   @param text [OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::SamplingParams::Text] Configuration options for a text response from the model. Can be plain
               #
-              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
+              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
               #
               #   @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.

data/lib/openai/models/responses/response.rb CHANGED Viewed

@@ -121,7 +121,7 @@ module OpenAI
         #     [function calling](https://platform.openai.com/docs/guides/function-calling).
         #     You can also use custom tools to call your own code.
         #
-        #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::WebSearchTool>]
+        #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>]
         required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
         # @!attribute top_p
@@ -330,7 +330,7 @@ module OpenAI
         #
         #   @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] How the model should select which tool (or tools) to use when generating
         #
-        #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
+        #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
         #
         #   @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling,
         #

data/lib/openai/models/responses/response_create_params.rb CHANGED Viewed

@@ -34,6 +34,8 @@ module OpenAI
         #   Specify additional output data to include in the model response. Currently
         #   supported values are:
         #
+        #   - `web_search_call.action.sources`: Include the sources of the web search tool
+        #     call.
         #   - `code_interpreter_call.outputs`: Includes the outputs of python code execution
         #     in code interpreter tool call items.
         #   - `computer_call_output.output.image_url`: Include image urls from the computer
@@ -248,7 +250,7 @@ module OpenAI
         #     [function calling](https://platform.openai.com/docs/guides/function-calling).
         #     You can also use custom tools to call your own code.
         #
-        #   @return [Array<OpenAI::StructuredOutput::JsonSchemaConverter, OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::WebSearchTool>, nil]
+        #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>, nil]
         optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
         # @!attribute top_logprobs
@@ -338,7 +340,7 @@ module OpenAI
         #
         #   @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] How the model should select which tool (or tools) to use when generating
         #
-        #   @param tools [Array<OpenAI::StructuredOutput::JsonSchemaConverter, OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
+        #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
         #
         #   @param top_logprobs [Integer, nil] An integer between 0 and 20 specifying the number of most likely tokens to
         #

data/lib/openai/models/responses/response_function_tool_call.rb CHANGED Viewed

@@ -10,11 +10,13 @@ module OpenAI
         #   @return [String]
         required :arguments, String
-        # @!attribute parsed
-        #   The parsed contents of the arguments.
-        #
-        #   @return [Object, nil]
-        required :parsed, OpenAI::StructuredOutput::ParsedJson
+        response_only do
+          # @!attribute parsed
+          #   The parsed contents of the arguments.
+          #
+          #   @return [Object, nil]
+          required :parsed, OpenAI::StructuredOutput::ParsedJson
+        end
         # @!attribute call_id
         #   The unique ID of the function tool call generated by the model.

data/lib/openai/models/responses/response_function_web_search.rb CHANGED Viewed

@@ -76,7 +76,14 @@ module OpenAI
             #   @return [Symbol, :search]
             required :type, const: :search
-            # @!method initialize(query:, type: :search)
+            # @!attribute sources
+            #   The sources used in the search.
+            #
+            #   @return [Array<OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Search::Source>, nil]
+            optional :sources,
+                     -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source] }
+            # @!method initialize(query:, sources: nil, type: :search)
             #   Some parameter documentations has been truncated, see
             #   {OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Search} for more
             #   details.
@@ -85,7 +92,34 @@ module OpenAI
             #
             #   @param query [String] The search query.
             #
+            #   @param sources [Array<OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Search::Source>] The sources used in the search.
+            #
             #   @param type [Symbol, :search] The action type.
+            class Source < OpenAI::Internal::Type::BaseModel
+              # @!attribute type
+              #   The type of source. Always `url`.
+              #
+              #   @return [Symbol, :url]
+              required :type, const: :url
+              # @!attribute url
+              #   The URL of the source.
+              #
+              #   @return [String]
+              required :url, String
+              # @!method initialize(url:, type: :url)
+              #   Some parameter documentations has been truncated, see
+              #   {OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Search::Source}
+              #   for more details.
+              #
+              #   A source used in the search.
+              #
+              #   @param url [String] The URL of the source.
+              #
+              #   @param type [Symbol, :url] The type of source. Always `url`.
+            end
           end
           class OpenPage < OpenAI::Internal::Type::BaseModel

data/lib/openai/models/responses/response_includable.rb CHANGED Viewed

@@ -6,6 +6,8 @@ module OpenAI
       # Specify additional output data to include in the model response. Currently
       # supported values are:
       #
+      # - `web_search_call.action.sources`: Include the sources of the web search tool
+      #   call.
       # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
       #   in code interpreter tool call items.
       # - `computer_call_output.output.image_url`: Include image urls from the computer

data/lib/openai/models/responses/response_output_text.rb CHANGED Viewed

@@ -17,11 +17,13 @@ module OpenAI
         #   @return [String]
         required :text, String
-        # @!attribute parsed
-        #   The parsed contents of the output, if JSON schema is specified.
-        #
-        #   @return [Object, nil]
-        optional :parsed, OpenAI::StructuredOutput::ParsedJson
+        response_only do
+          # @!attribute parsed
+          #   The parsed contents of the output, if JSON schema is specified.
+          #
+          #   @return [Object, nil]
+          optional :parsed, OpenAI::StructuredOutput::ParsedJson
+        end
         # @!attribute type
         #   The type of the output text. Always `output_text`.

data/lib/openai/models/responses/tool.rb CHANGED Viewed

@@ -37,9 +37,166 @@ module OpenAI
         # [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools).
         variant :custom, -> { OpenAI::Responses::CustomTool }
+        # Search the Internet for sources related to the prompt. Learn more about the
+        # [web search tool](https://platform.openai.com/docs/guides/tools-web-search).
+        variant -> { OpenAI::Responses::Tool::WebSearchTool }
         # This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search).
         variant -> { OpenAI::Responses::WebSearchTool }
+        class WebSearchTool < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::Tool::WebSearchTool::Type]
+          required :type, enum: -> { OpenAI::Responses::Tool::WebSearchTool::Type }
+          # @!attribute filters
+          #   Filters for the search.
+          #
+          #   @return [OpenAI::Models::Responses::Tool::WebSearchTool::Filters, nil]
+          optional :filters, -> { OpenAI::Responses::Tool::WebSearchTool::Filters }, nil?: true
+          # @!attribute search_context_size
+          #   High level guidance for the amount of context window space to use for the
+          #   search. One of `low`, `medium`, or `high`. `medium` is the default.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::Tool::WebSearchTool::SearchContextSize, nil]
+          optional :search_context_size, enum: -> { OpenAI::Responses::Tool::WebSearchTool::SearchContextSize }
+          # @!attribute user_location
+          #   The approximate location of the user.
+          #
+          #   @return [OpenAI::Models::Responses::Tool::WebSearchTool::UserLocation, nil]
+          optional :user_location, -> { OpenAI::Responses::Tool::WebSearchTool::UserLocation }, nil?: true
+          # @!method initialize(type:, filters: nil, search_context_size: nil, user_location: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Responses::Tool::WebSearchTool} for more details.
+          #
+          #   Search the Internet for sources related to the prompt. Learn more about the
+          #   [web search tool](https://platform.openai.com/docs/guides/tools-web-search).
+          #
+          #   @param type [Symbol, OpenAI::Models::Responses::Tool::WebSearchTool::Type] The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
+          #
+          #   @param filters [OpenAI::Models::Responses::Tool::WebSearchTool::Filters, nil] Filters for the search.
+          #
+          #   @param search_context_size [Symbol, OpenAI::Models::Responses::Tool::WebSearchTool::SearchContextSize] High level guidance for the amount of context window space to use for the search
+          #
+          #   @param user_location [OpenAI::Models::Responses::Tool::WebSearchTool::UserLocation, nil] The approximate location of the user.
+          # The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
+          #
+          # @see OpenAI::Models::Responses::Tool::WebSearchTool#type
+          module Type
+            extend OpenAI::Internal::Type::Enum
+            WEB_SEARCH = :web_search
+            WEB_SEARCH_2025_08_26 = :web_search_2025_08_26
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+          # @see OpenAI::Models::Responses::Tool::WebSearchTool#filters
+          class Filters < OpenAI::Internal::Type::BaseModel
+            # @!attribute allowed_domains
+            #   Allowed domains for the search. If not provided, all domains are allowed.
+            #   Subdomains of the provided domains are allowed as well.
+            #
+            #   Example: `["pubmed.ncbi.nlm.nih.gov"]`
+            #
+            #   @return [Array<String>, nil]
+            optional :allowed_domains, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+            # @!method initialize(allowed_domains: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {OpenAI::Models::Responses::Tool::WebSearchTool::Filters} for more details.
+            #
+            #   Filters for the search.
+            #
+            #   @param allowed_domains [Array<String>, nil] Allowed domains for the search. If not provided, all domains are allowed.
+          end
+          # High level guidance for the amount of context window space to use for the
+          # search. One of `low`, `medium`, or `high`. `medium` is the default.
+          #
+          # @see OpenAI::Models::Responses::Tool::WebSearchTool#search_context_size
+          module SearchContextSize
+            extend OpenAI::Internal::Type::Enum
+            LOW = :low
+            MEDIUM = :medium
+            HIGH = :high
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+          # @see OpenAI::Models::Responses::Tool::WebSearchTool#user_location
+          class UserLocation < OpenAI::Internal::Type::BaseModel
+            # @!attribute city
+            #   Free text input for the city of the user, e.g. `San Francisco`.
+            #
+            #   @return [String, nil]
+            optional :city, String, nil?: true
+            # @!attribute country
+            #   The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
+            #   the user, e.g. `US`.
+            #
+            #   @return [String, nil]
+            optional :country, String, nil?: true
+            # @!attribute region
+            #   Free text input for the region of the user, e.g. `California`.
+            #
+            #   @return [String, nil]
+            optional :region, String, nil?: true
+            # @!attribute timezone
+            #   The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
+            #   user, e.g. `America/Los_Angeles`.
+            #
+            #   @return [String, nil]
+            optional :timezone, String, nil?: true
+            # @!attribute type
+            #   The type of location approximation. Always `approximate`.
+            #
+            #   @return [Symbol, OpenAI::Models::Responses::Tool::WebSearchTool::UserLocation::Type, nil]
+            optional :type, enum: -> { OpenAI::Responses::Tool::WebSearchTool::UserLocation::Type }
+            # @!method initialize(city: nil, country: nil, region: nil, timezone: nil, type: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {OpenAI::Models::Responses::Tool::WebSearchTool::UserLocation} for more details.
+            #
+            #   The approximate location of the user.
+            #
+            #   @param city [String, nil] Free text input for the city of the user, e.g. `San Francisco`.
+            #
+            #   @param country [String, nil] The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of t
+            #
+            #   @param region [String, nil] Free text input for the region of the user, e.g. `California`.
+            #
+            #   @param timezone [String, nil] The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user
+            #
+            #   @param type [Symbol, OpenAI::Models::Responses::Tool::WebSearchTool::UserLocation::Type] The type of location approximation. Always `approximate`.
+            # The type of location approximation. Always `approximate`.
+            #
+            # @see OpenAI::Models::Responses::Tool::WebSearchTool::UserLocation#type
+            module Type
+              extend OpenAI::Internal::Type::Enum
+              APPROXIMATE = :approximate
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
         class Mcp < OpenAI::Internal::Type::BaseModel
           # @!attribute server_label
           #   A label for this MCP server, used to identify it in tool calls.
@@ -657,7 +814,7 @@ module OpenAI
         end
         # @!method self.variants
-        #   @return [Array(OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::WebSearchTool)]
+        #   @return [Array(OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool)]
       end
     end
   end

data/lib/openai/resources/conversations.rb CHANGED Viewed

@@ -9,7 +9,7 @@ module OpenAI
       # Some parameter documentations has been truncated, see
       # {OpenAI::Models::Conversations::ConversationCreateParams} for more details.
       #
-      # Create a conversation with the given ID.
+      # Create a conversation.
       #
       # @overload create(items: nil, metadata: nil, request_options: {})
       #

data/lib/openai/resources/responses.rb CHANGED Viewed

@@ -67,7 +67,7 @@ module OpenAI
       #
       # @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] How the model should select which tool (or tools) to use when generating
       #
-      # @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
+      # @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
       #
       # @param top_logprobs [Integer, nil] An integer between 0 and 20 specifying the number of most likely tokens to
       #
@@ -284,7 +284,7 @@ module OpenAI
       #
       # @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] How the model should select which tool (or tools) to use when generating
       #
-      # @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
+      # @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, 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::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
       #
       # @param top_logprobs [Integer, nil] An integer between 0 and 20 specifying the number of most likely tokens to
       #

data/lib/openai/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module OpenAI
-  VERSION = "0.19.0"
+  VERSION = "0.20.0"
 end

data/rbi/openai/models/conversations/item_list_params.rbi CHANGED Viewed

@@ -25,6 +25,8 @@ module OpenAI
         # Specify additional output data to include in the model response. Currently
         # supported values are:
         #
+        # - `web_search_call.action.sources`: Include the sources of the web search tool
+        #   call.
         # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
         #   in code interpreter tool call items.
         # - `computer_call_output.output.image_url`: Include image urls from the computer
@@ -93,6 +95,8 @@ module OpenAI
           # Specify additional output data to include in the model response. Currently
           # supported values are:
           #
+          # - `web_search_call.action.sources`: Include the sources of the web search tool
+          #   call.
           # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
           #   in code interpreter tool call items.
           # - `computer_call_output.output.image_url`: Include image urls from the computer

data/rbi/openai/models/evals/run_cancel_response.rbi CHANGED Viewed

@@ -1175,6 +1175,7 @@ module OpenAI
                         OpenAI::Responses::Tool::ImageGeneration::OrHash,
                         OpenAI::Responses::Tool::LocalShell::OrHash,
                         OpenAI::Responses::CustomTool::OrHash,
+                        OpenAI::Responses::Tool::WebSearchTool::OrHash,
                         OpenAI::Responses::WebSearchTool::OrHash
                       )
                     ]
@@ -1207,6 +1208,7 @@ module OpenAI
                         OpenAI::Responses::Tool::ImageGeneration::OrHash,
                         OpenAI::Responses::Tool::LocalShell::OrHash,
                         OpenAI::Responses::CustomTool::OrHash,
+                        OpenAI::Responses::Tool::WebSearchTool::OrHash,
                         OpenAI::Responses::WebSearchTool::OrHash
                       )
                     ],