openai 0.18.1 → 0.20.0

data/rbi/openai/models/responses/response_create_params.rbi

@@ -20,9 +20,24 @@ module OpenAI
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :background
 
+        # The conversation that this response belongs to. Items from this conversation are
+        # prepended to `input_items` for this response request. Input items and output
+        # items from this response are automatically added to this conversation after this
+        # response completes.
+        sig do
+          returns(
+            T.nilable(
+              T.any(String, OpenAI::Responses::ResponseConversationParam)
+            )
+          )
+        end
+        attr_accessor :conversation
+
         # 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
@@ -133,6 +148,7 @@ module OpenAI
         # The unique ID of the previous response to the model. Use this to create
         # multi-turn conversations. Learn more about
         # [conversation state](https://platform.openai.com/docs/guides/conversation-state).
+        # Cannot be used in conjunction with `conversation`.
         sig { returns(T.nilable(String)) }
         attr_accessor :previous_response_id
 
@@ -314,6 +330,7 @@ module OpenAI
                   OpenAI::Responses::Tool::ImageGeneration,
                   OpenAI::Responses::Tool::LocalShell,
                   OpenAI::Responses::CustomTool,
+                  OpenAI::Responses::Tool::WebSearchTool,
                   OpenAI::Responses::WebSearchTool
                 )
               ]
@@ -335,6 +352,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
                 )
               ]
@@ -385,6 +403,13 @@ module OpenAI
         sig do
           params(
             background: T.nilable(T::Boolean),
+            conversation:
+              T.nilable(
+                T.any(
+                  String,
+                  OpenAI::Responses::ResponseConversationParam::OrHash
+                )
+              ),
             include:
               T.nilable(
                 T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]
@@ -437,6 +462,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
                 )
               ],
@@ -454,9 +480,16 @@ module OpenAI
           # Whether to run the model response in the background.
           # [Learn more](https://platform.openai.com/docs/guides/background).
           background: nil,
+          # The conversation that this response belongs to. Items from this conversation are
+          # prepended to `input_items` for this response request. Input items and output
+          # items from this response are automatically added to this conversation after this
+          # response completes.
+          conversation: nil,
           # 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
@@ -514,6 +547,7 @@ module OpenAI
           # The unique ID of the previous response to the model. Use this to create
           # multi-turn conversations. Learn more about
           # [conversation state](https://platform.openai.com/docs/guides/conversation-state).
+          # Cannot be used in conjunction with `conversation`.
           previous_response_id: nil,
           # Reference to a prompt template and its variables.
           # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
@@ -617,6 +651,10 @@ module OpenAI
           override.returns(
             {
               background: T.nilable(T::Boolean),
+              conversation:
+                T.nilable(
+                  T.any(String, OpenAI::Responses::ResponseConversationParam)
+                ),
               include:
                 T.nilable(
                   T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]
@@ -669,6 +707,7 @@ module OpenAI
                     OpenAI::Responses::Tool::ImageGeneration,
                     OpenAI::Responses::Tool::LocalShell,
                     OpenAI::Responses::CustomTool,
+                    OpenAI::Responses::Tool::WebSearchTool,
                     OpenAI::Responses::WebSearchTool
                   )
                 ],
@@ -686,6 +725,29 @@ module OpenAI
         def to_hash
         end
 
+        # The conversation that this response belongs to. Items from this conversation are
+        # prepended to `input_items` for this response request. Input items and output
+        # items from this response are automatically added to this conversation after this
+        # response completes.
+        module Conversation
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(String, OpenAI::Responses::ResponseConversationParam)
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseCreateParams::Conversation::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+
         # Text, image, or file inputs to the model, used to generate a response.
         #
         # Learn more:

data/rbi/openai/models/responses/response_function_web_search.rbi

@@ -121,21 +121,97 @@ module OpenAI
             sig { returns(Symbol) }
             attr_accessor :type
 
+            # The sources used in the search.
+            sig do
+              returns(
+                T.nilable(
+                  T::Array[
+                    OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source
+                  ]
+                )
+              )
+            end
+            attr_reader :sources
+
+            sig do
+              params(
+                sources:
+                  T::Array[
+                    OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source::OrHash
+                  ]
+              ).void
+            end
+            attr_writer :sources
+
             # Action type "search" - Performs a web search query.
             sig do
-              params(query: String, type: Symbol).returns(T.attached_class)
+              params(
+                query: String,
+                sources:
+                  T::Array[
+                    OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source::OrHash
+                  ],
+                type: Symbol
+              ).returns(T.attached_class)
             end
             def self.new(
               # The search query.
               query:,
+              # The sources used in the search.
+              sources: nil,
               # The action type.
               type: :search
             )
             end
 
-            sig { override.returns({ query: String, type: Symbol }) }
+            sig do
+              override.returns(
+                {
+                  query: String,
+                  type: Symbol,
+                  sources:
+                    T::Array[
+                      OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source
+                    ]
+                }
+              )
+            end
             def to_hash
             end
+
+            class Source < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # The type of source. Always `url`.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # The URL of the source.
+              sig { returns(String) }
+              attr_accessor :url
+
+              # A source used in the search.
+              sig do
+                params(url: String, type: Symbol).returns(T.attached_class)
+              end
+              def self.new(
+                # The URL of the source.
+                url:,
+                # The type of source. Always `url`.
+                type: :url
+              )
+              end
+
+              sig { override.returns({ type: Symbol, url: String }) }
+              def to_hash
+              end
+            end
           end
 
           class OpenPage < OpenAI::Internal::Type::BaseModel

data/rbi/openai/models/responses/response_includable.rbi

@@ -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