openai 0.19.0 → 0.21.0

data/lib/openai/models/realtime/transcription_session_updated_event.rb

@@ -0,0 +1,279 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class TranscriptionSessionUpdatedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute session
+        #   A Realtime transcription session configuration object.
+        #
+        #   @return [OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session]
+        required :session, -> { OpenAI::Realtime::TranscriptionSessionUpdatedEvent::Session }
+
+        # @!attribute type
+        #   The event type, must be `transcription_session.updated`.
+        #
+        #   @return [Symbol, :"transcription_session.updated"]
+        required :type, const: :"transcription_session.updated"
+
+        # @!method initialize(event_id:, session:, type: :"transcription_session.updated")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent} for more details.
+        #
+        #   Returned when a transcription session is updated with a
+        #   `transcription_session.update` event, unless there is an error.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param session [OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session] A Realtime transcription session configuration object.
+        #
+        #   @param type [Symbol, :"transcription_session.updated"] The event type, must be `transcription_session.updated`.
+
+        # @see OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent#session
+        class Session < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   Unique identifier for the session that looks like `sess_1234567890abcdef`.
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute audio
+          #   Configuration for input audio for the session.
+          #
+          #   @return [OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio, nil]
+          optional :audio, -> { OpenAI::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio }
+
+          # @!attribute expires_at
+          #   Expiration timestamp for the session, in seconds since epoch.
+          #
+          #   @return [Integer, nil]
+          optional :expires_at, Integer
+
+          # @!attribute include
+          #   Additional fields to include in server outputs.
+          #
+          #   - `item.input_audio_transcription.logprobs`: Include logprobs for input audio
+          #     transcription.
+          #
+          #   @return [Array<Symbol, OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Include>, nil]
+          optional :include,
+                   -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Realtime::TranscriptionSessionUpdatedEvent::Session::Include] }
+
+          # @!attribute object
+          #   The object type. Always `realtime.transcription_session`.
+          #
+          #   @return [String, nil]
+          optional :object, String
+
+          # @!method initialize(id: nil, audio: nil, expires_at: nil, include: nil, object: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session} for more
+          #   details.
+          #
+          #   A Realtime transcription session configuration object.
+          #
+          #   @param id [String] Unique identifier for the session that looks like `sess_1234567890abcdef`.
+          #
+          #   @param audio [OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio] Configuration for input audio for the session.
+          #
+          #   @param expires_at [Integer] Expiration timestamp for the session, in seconds since epoch.
+          #
+          #   @param include [Array<Symbol, OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Include>] Additional fields to include in server outputs.
+          #
+          #   @param object [String] The object type. Always `realtime.transcription_session`.
+
+          # @see OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session#audio
+          class Audio < OpenAI::Internal::Type::BaseModel
+            # @!attribute input
+            #
+            #   @return [OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input, nil]
+            optional :input, -> { OpenAI::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input }
+
+            # @!method initialize(input: nil)
+            #   Configuration for input audio for the session.
+            #
+            #   @param input [OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input]
+
+            # @see OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio#input
+            class Input < OpenAI::Internal::Type::BaseModel
+              # @!attribute format_
+              #   The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.
+              #
+              #   @return [String, nil]
+              optional :format_, String, api_name: :format
+
+              # @!attribute noise_reduction
+              #   Configuration for input audio noise reduction.
+              #
+              #   @return [OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::NoiseReduction, nil]
+              optional :noise_reduction,
+                       -> { OpenAI::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::NoiseReduction }
+
+              # @!attribute transcription
+              #   Configuration of the transcription model.
+              #
+              #   @return [OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::Transcription, nil]
+              optional :transcription,
+                       -> { OpenAI::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::Transcription }
+
+              # @!attribute turn_detection
+              #   Configuration for turn detection.
+              #
+              #   @return [OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::TurnDetection, nil]
+              optional :turn_detection,
+                       -> { OpenAI::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::TurnDetection }
+
+              # @!method initialize(format_: nil, noise_reduction: nil, transcription: nil, turn_detection: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input}
+              #   for more details.
+              #
+              #   @param format_ [String] The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.
+              #
+              #   @param noise_reduction [OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::NoiseReduction] Configuration for input audio noise reduction.
+              #
+              #   @param transcription [OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::Transcription] Configuration of the transcription model.
+              #
+              #   @param turn_detection [OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::TurnDetection] Configuration for turn detection.
+
+              # @see OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input#noise_reduction
+              class NoiseReduction < OpenAI::Internal::Type::BaseModel
+                # @!attribute type
+                #
+                #   @return [Symbol, OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::NoiseReduction::Type, nil]
+                optional :type,
+                         enum: -> { OpenAI::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::NoiseReduction::Type }
+
+                # @!method initialize(type: nil)
+                #   Configuration for input audio noise reduction.
+                #
+                #   @param type [Symbol, OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::NoiseReduction::Type]
+
+                # @see OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::NoiseReduction#type
+                module Type
+                  extend OpenAI::Internal::Type::Enum
+
+                  NEAR_FIELD = :near_field
+                  FAR_FIELD = :far_field
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
+
+              # @see OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input#transcription
+              class Transcription < OpenAI::Internal::Type::BaseModel
+                # @!attribute language
+                #   The language of the input audio. Supplying the input language in
+                #   [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`)
+                #   format will improve accuracy and latency.
+                #
+                #   @return [String, nil]
+                optional :language, String
+
+                # @!attribute model
+                #   The model to use for transcription. Can be `gpt-4o-transcribe`,
+                #   `gpt-4o-mini-transcribe`, or `whisper-1`.
+                #
+                #   @return [Symbol, OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::Transcription::Model, nil]
+                optional :model,
+                         enum: -> { OpenAI::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::Transcription::Model }
+
+                # @!attribute prompt
+                #   An optional text to guide the model's style or continue a previous audio
+                #   segment. The
+                #   [prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting)
+                #   should match the audio language.
+                #
+                #   @return [String, nil]
+                optional :prompt, String
+
+                # @!method initialize(language: nil, model: nil, prompt: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::Transcription}
+                #   for more details.
+                #
+                #   Configuration of the transcription model.
+                #
+                #   @param language [String] The language of the input audio. Supplying the input language in
+                #
+                #   @param model [Symbol, OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::Transcription::Model] The model to use for transcription. Can be `gpt-4o-transcribe`, `gpt-4o-mini-tra
+                #
+                #   @param prompt [String] An optional text to guide the model's style or continue a previous audio segment
+
+                # The model to use for transcription. Can be `gpt-4o-transcribe`,
+                # `gpt-4o-mini-transcribe`, or `whisper-1`.
+                #
+                # @see OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::Transcription#model
+                module Model
+                  extend OpenAI::Internal::Type::Enum
+
+                  GPT_4O_TRANSCRIBE = :"gpt-4o-transcribe"
+                  GPT_4O_MINI_TRANSCRIBE = :"gpt-4o-mini-transcribe"
+                  WHISPER_1 = :"whisper-1"
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
+
+              # @see OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input#turn_detection
+              class TurnDetection < OpenAI::Internal::Type::BaseModel
+                # @!attribute prefix_padding_ms
+                #
+                #   @return [Integer, nil]
+                optional :prefix_padding_ms, Integer
+
+                # @!attribute silence_duration_ms
+                #
+                #   @return [Integer, nil]
+                optional :silence_duration_ms, Integer
+
+                # @!attribute threshold
+                #
+                #   @return [Float, nil]
+                optional :threshold, Float
+
+                # @!attribute type
+                #   Type of turn detection, only `server_vad` is currently supported.
+                #
+                #   @return [String, nil]
+                optional :type, String
+
+                # @!method initialize(prefix_padding_ms: nil, silence_duration_ms: nil, threshold: nil, type: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Audio::Input::TurnDetection}
+                #   for more details.
+                #
+                #   Configuration for turn detection.
+                #
+                #   @param prefix_padding_ms [Integer]
+                #
+                #   @param silence_duration_ms [Integer]
+                #
+                #   @param threshold [Float]
+                #
+                #   @param type [String] Type of turn detection, only `server_vad` is currently supported.
+              end
+            end
+          end
+
+          module Include
+            extend OpenAI::Internal::Type::Enum
+
+            ITEM_INPUT_AUDIO_TRANSCRIPTION_LOGPROBS = :"item.input_audio_transcription.logprobs"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -107,7 +107,7 @@ module OpenAI
         #   An array of tools the model may call while generating a response. You can
         #   specify which tool to use by setting the `tool_choice` parameter.
         #
-        #   The two categories of tools you can provide the model are:
+        #   We support the following categories of tools:
         #
         #   - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
         #     capabilities, like
@@ -115,13 +115,16 @@ module OpenAI
         #     [file search](https://platform.openai.com/docs/guides/tools-file-search).
         #     Learn more about
         #     [built-in tools](https://platform.openai.com/docs/guides/tools).
+        #   - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
+        #     predefined connectors such as Google Drive and Notion. Learn more about
+        #     [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp).
         #   - **Function calls (custom tools)**: Functions that are defined by you, enabling
         #     the model to call your own code with strongly typed arguments and outputs.
         #     Learn more about
         #     [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::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>]
         required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
 
         # @!attribute top_p
@@ -330,7 +333,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::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] 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

@@ -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
@@ -234,7 +236,7 @@ module OpenAI
         #   An array of tools the model may call while generating a response. You can
         #   specify which tool to use by setting the `tool_choice` parameter.
         #
-        #   The two categories of tools you can provide the model are:
+        #   We support the following categories of tools:
         #
         #   - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
         #     capabilities, like
@@ -242,13 +244,16 @@ module OpenAI
         #     [file search](https://platform.openai.com/docs/guides/tools-file-search).
         #     Learn more about
         #     [built-in tools](https://platform.openai.com/docs/guides/tools).
+        #   - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
+        #     predefined connectors such as Google Drive and Notion. Learn more about
+        #     [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp).
         #   - **Function calls (custom tools)**: Functions that are defined by you, enabling
         #     the model to call your own code with strongly typed arguments and outputs.
         #     Learn more about
         #     [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::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil]
         optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
 
         # @!attribute top_logprobs
@@ -338,7 +343,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::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] 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

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

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

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

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

@@ -37,9 +37,13 @@ module OpenAI
         # [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools).
         variant :custom, -> { OpenAI::Responses::CustomTool }
 
-        # 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).
+        # 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::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::WebSearchPreviewTool }
+
         class Mcp < OpenAI::Internal::Type::BaseModel
           # @!attribute server_label
           #   A label for this MCP server, used to identify it in tool calls.
@@ -657,7 +661,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::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool)]
       end
     end
   end

data/lib/openai/models/responses/web_search_preview_tool.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class WebSearchPreviewTool < OpenAI::Internal::Type::BaseModel
+        # @!attribute type
+        #   The type of the web search tool. One of `web_search_preview` or
+        #   `web_search_preview_2025_03_11`.
+        #
+        #   @return [Symbol, OpenAI::Models::Responses::WebSearchPreviewTool::Type]
+        required :type, enum: -> { OpenAI::Responses::WebSearchPreviewTool::Type }
+
+        # @!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::WebSearchPreviewTool::SearchContextSize, nil]
+        optional :search_context_size, enum: -> { OpenAI::Responses::WebSearchPreviewTool::SearchContextSize }
+
+        # @!attribute user_location
+        #   The user's location.
+        #
+        #   @return [OpenAI::Models::Responses::WebSearchPreviewTool::UserLocation, nil]
+        optional :user_location, -> { OpenAI::Responses::WebSearchPreviewTool::UserLocation }, nil?: true
+
+        # @!method initialize(type:, search_context_size: nil, user_location: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Responses::WebSearchPreviewTool} for more details.
+        #
+        #   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).
+        #
+        #   @param type [Symbol, OpenAI::Models::Responses::WebSearchPreviewTool::Type] The type of the web search tool. One of `web_search_preview` or `web_search_prev
+        #
+        #   @param search_context_size [Symbol, OpenAI::Models::Responses::WebSearchPreviewTool::SearchContextSize] High level guidance for the amount of context window space to use for the search
+        #
+        #   @param user_location [OpenAI::Models::Responses::WebSearchPreviewTool::UserLocation, nil] The user's location.
+
+        # The type of the web search tool. One of `web_search_preview` or
+        # `web_search_preview_2025_03_11`.
+        #
+        # @see OpenAI::Models::Responses::WebSearchPreviewTool#type
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          WEB_SEARCH_PREVIEW = :web_search_preview
+          WEB_SEARCH_PREVIEW_2025_03_11 = :web_search_preview_2025_03_11
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        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::WebSearchPreviewTool#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::WebSearchPreviewTool#user_location
+        class UserLocation < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of location approximation. Always `approximate`.
+          #
+          #   @return [Symbol, :approximate]
+          required :type, const: :approximate
+
+          # @!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
+
+          # @!method initialize(city: nil, country: nil, region: nil, timezone: nil, type: :approximate)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Responses::WebSearchPreviewTool::UserLocation} for more
+          #   details.
+          #
+          #   The user's location.
+          #
+          #   @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, :approximate] The type of location approximation. Always `approximate`.
+        end
+      end
+    end
+  end
+end