openai 0.11.0 → 0.13.0

data/rbi/openai/models/audio/transcription_verbose.rbi

@@ -109,25 +109,23 @@ module OpenAI
 
           # Duration of the input audio in seconds.
           sig { returns(Float) }
-          attr_accessor :duration
+          attr_accessor :seconds
 
           # The type of the usage object. Always `duration` for this variant.
           sig { returns(Symbol) }
           attr_accessor :type
 
           # Usage statistics for models billed by audio input duration.
-          sig do
-            params(duration: Float, type: Symbol).returns(T.attached_class)
-          end
+          sig { params(seconds: Float, type: Symbol).returns(T.attached_class) }
           def self.new(
             # Duration of the input audio in seconds.
-            duration:,
+            seconds:,
             # The type of the usage object. Always `duration` for this variant.
             type: :duration
           )
           end
 
-          sig { override.returns({ duration: Float, type: Symbol }) }
+          sig { override.returns({ seconds: Float, type: Symbol }) }
           def to_hash
           end
         end

data/rbi/openai/models/file_object.rbi

@@ -27,8 +27,8 @@ module OpenAI
       attr_accessor :object
 
       # The intended purpose of the file. Supported values are `assistants`,
-      # `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`
-      # and `vision`.
+      # `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`,
+      # `vision`, and `user_data`.
       sig { returns(OpenAI::FileObject::Purpose::TaggedSymbol) }
       attr_accessor :purpose
 
@@ -76,8 +76,8 @@ module OpenAI
         # The name of the file.
         filename:,
         # The intended purpose of the file. Supported values are `assistants`,
-        # `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`
-        # and `vision`.
+        # `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`,
+        # `vision`, and `user_data`.
         purpose:,
         # Deprecated. The current status of the file, which can be either `uploaded`,
         # `processed`, or `error`.
@@ -111,8 +111,8 @@ module OpenAI
       end
 
       # The intended purpose of the file. Supported values are `assistants`,
-      # `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`
-      # and `vision`.
+      # `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`,
+      # `vision`, and `user_data`.
       module Purpose
         extend OpenAI::Internal::Type::Enum
 
@@ -132,6 +132,7 @@ module OpenAI
         FINE_TUNE_RESULTS =
           T.let(:"fine-tune-results", OpenAI::FileObject::Purpose::TaggedSymbol)
         VISION = T.let(:vision, OpenAI::FileObject::Purpose::TaggedSymbol)
+        USER_DATA = T.let(:user_data, OpenAI::FileObject::Purpose::TaggedSymbol)
 
         sig do
           override.returns(T::Array[OpenAI::FileObject::Purpose::TaggedSymbol])

data/rbi/openai/models/responses/response_input_file.rbi

@@ -27,6 +27,13 @@ module OpenAI
         sig { returns(T.nilable(String)) }
         attr_accessor :file_id
 
+        # The URL of the file to be sent to the model.
+        sig { returns(T.nilable(String)) }
+        attr_reader :file_url
+
+        sig { params(file_url: String).void }
+        attr_writer :file_url
+
         # The name of the file to be sent to the model.
         sig { returns(T.nilable(String)) }
         attr_reader :filename
@@ -39,6 +46,7 @@ module OpenAI
           params(
             file_data: String,
             file_id: T.nilable(String),
+            file_url: String,
             filename: String,
             type: Symbol
           ).returns(T.attached_class)
@@ -48,6 +56,8 @@ module OpenAI
           file_data: nil,
           # The ID of the file to be sent to the model.
           file_id: nil,
+          # The URL of the file to be sent to the model.
+          file_url: nil,
           # The name of the file to be sent to the model.
           filename: nil,
           # The type of the input item. Always `input_file`.
@@ -61,6 +71,7 @@ module OpenAI
               type: Symbol,
               file_data: String,
               file_id: T.nilable(String),
+              file_url: String,
               filename: String
             }
           )

data/rbi/openai/models/responses/response_mcp_call_arguments_delta_event.rbi

@@ -28,7 +28,7 @@ module OpenAI
         sig { returns(Integer) }
         attr_accessor :sequence_number
 
-        # The type of the event. Always 'response.mcp_call.arguments_delta'.
+        # The type of the event. Always 'response.mcp_call_arguments.delta'.
         sig { returns(Symbol) }
         attr_accessor :type
 
@@ -52,8 +52,8 @@ module OpenAI
           output_index:,
           # The sequence number of this event.
           sequence_number:,
-          # The type of the event. Always 'response.mcp_call.arguments_delta'.
-          type: :"response.mcp_call.arguments_delta"
+          # The type of the event. Always 'response.mcp_call_arguments.delta'.
+          type: :"response.mcp_call_arguments.delta"
         )
         end
 

data/rbi/openai/models/responses/response_mcp_call_arguments_done_event.rbi

@@ -28,7 +28,7 @@ module OpenAI
         sig { returns(Integer) }
         attr_accessor :sequence_number
 
-        # The type of the event. Always 'response.mcp_call.arguments_done'.
+        # The type of the event. Always 'response.mcp_call_arguments.done'.
         sig { returns(Symbol) }
         attr_accessor :type
 
@@ -51,8 +51,8 @@ module OpenAI
           output_index:,
           # The sequence number of this event.
           sequence_number:,
-          # The type of the event. Always 'response.mcp_call.arguments_done'.
-          type: :"response.mcp_call.arguments_done"
+          # The type of the event. Always 'response.mcp_call_arguments.done'.
+          type: :"response.mcp_call_arguments.done"
         )
         end
 

data/rbi/openai/models/responses/response_output_text_annotation_added_event.rbi

@@ -36,7 +36,7 @@ module OpenAI
         sig { returns(Integer) }
         attr_accessor :sequence_number
 
-        # The type of the event. Always 'response.output_text_annotation.added'.
+        # The type of the event. Always 'response.output_text.annotation.added'.
         sig { returns(Symbol) }
         attr_accessor :type
 
@@ -65,8 +65,8 @@ module OpenAI
           output_index:,
           # The sequence number of this event.
           sequence_number:,
-          # The type of the event. Always 'response.output_text_annotation.added'.
-          type: :"response.output_text_annotation.added"
+          # The type of the event. Always 'response.output_text.annotation.added'.
+          type: :"response.output_text.annotation.added"
         )
         end
 

data/rbi/openai/models/responses/tool.rbi

@@ -70,6 +70,13 @@ module OpenAI
           end
           attr_accessor :require_approval
 
+          # Optional description of the MCP server, used to provide more context.
+          sig { returns(T.nilable(String)) }
+          attr_reader :server_description
+
+          sig { params(server_description: String).void }
+          attr_writer :server_description
+
           # Give the model access to additional tools via remote Model Context Protocol
           # (MCP) servers.
           # [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
@@ -92,6 +99,7 @@ module OpenAI
                     OpenAI::Responses::Tool::Mcp::RequireApproval::McpToolApprovalSetting::OrSymbol
                   )
                 ),
+              server_description: String,
               type: Symbol
             ).returns(T.attached_class)
           end
@@ -107,6 +115,8 @@ module OpenAI
             headers: nil,
             # Specify which of the MCP server's tools require approval.
             require_approval: nil,
+            # Optional description of the MCP server, used to provide more context.
+            server_description: nil,
             # The type of the MCP tool. Always `mcp`.
             type: :mcp
           )
@@ -132,7 +142,8 @@ module OpenAI
                       OpenAI::Responses::Tool::Mcp::RequireApproval::McpToolApprovalFilter,
                       OpenAI::Responses::Tool::Mcp::RequireApproval::McpToolApprovalSetting::OrSymbol
                     )
-                  )
+                  ),
+                server_description: String
               }
             )
           end

data/rbi/openai/resources/responses.rbi

@@ -275,7 +275,13 @@ module OpenAI
             ),
           store: T.nilable(T::Boolean),
           temperature: T.nilable(Float),
-          text: OpenAI::Responses::ResponseTextConfig::OrHash,
+          text:
+            T.nilable(
+              T.any(
+                OpenAI::Responses::ResponseTextConfig::OrHash,
+                OpenAI::StructuredOutput::JsonSchemaConverter
+              )
+            ),
           tool_choice:
             T.any(
               OpenAI::Responses::ToolChoiceOptions::OrSymbol,
@@ -462,6 +468,125 @@ module OpenAI
       )
       end
 
+      # See {OpenAI::Resources::Responses#create} for non-streaming counterpart.
+      #
+      # Creates a model response with a higher-level streaming interface that provides
+      # helper methods for processing events and aggregating stream outputs.
+      sig do
+        params(
+          input:
+            T.nilable(OpenAI::Responses::ResponseCreateParams::Input::Variants),
+          model:
+            T.nilable(
+              T.any(
+                String,
+                OpenAI::ChatModel::OrSymbol,
+                OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
+              )
+            ),
+          background: T.nilable(T::Boolean),
+          include:
+            T.nilable(
+              T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]
+            ),
+          instructions: T.nilable(String),
+          max_output_tokens: T.nilable(Integer),
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          parallel_tool_calls: T.nilable(T::Boolean),
+          previous_response_id: T.nilable(String),
+          prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
+          reasoning: T.nilable(OpenAI::Reasoning::OrHash),
+          service_tier:
+            T.nilable(
+              OpenAI::Responses::ResponseCreateParams::ServiceTier::OrSymbol
+            ),
+          store: T.nilable(T::Boolean),
+          temperature: T.nilable(Float),
+          text:
+            T.any(
+              OpenAI::Responses::ResponseTextConfig::OrHash,
+              OpenAI::StructuredOutput::JsonSchemaConverter
+            ),
+          tool_choice:
+            T.any(
+              OpenAI::Responses::ToolChoiceOptions::OrSymbol,
+              OpenAI::Responses::ToolChoiceTypes::OrHash,
+              OpenAI::Responses::ToolChoiceFunction::OrHash
+            ),
+          tools:
+            T.nilable(
+              T::Array[
+                T.any(
+                  OpenAI::Responses::FunctionTool::OrHash,
+                  OpenAI::Responses::FileSearchTool::OrHash,
+                  OpenAI::Responses::ComputerTool::OrHash,
+                  OpenAI::Responses::Tool::Mcp::OrHash,
+                  OpenAI::Responses::Tool::CodeInterpreter::OrHash,
+                  OpenAI::Responses::Tool::ImageGeneration::OrHash,
+                  OpenAI::Responses::Tool::LocalShell::OrHash,
+                  OpenAI::Responses::WebSearchTool::OrHash,
+                  OpenAI::StructuredOutput::JsonSchemaConverter
+                )
+              ]
+            ),
+          top_p: T.nilable(Float),
+          truncation:
+            T.nilable(
+              OpenAI::Responses::ResponseCreateParams::Truncation::OrSymbol
+            ),
+          user: T.nilable(String),
+          starting_after: T.nilable(Integer),
+          request_options: T.nilable(OpenAI::RequestOptions::OrHash)
+        ).returns(OpenAI::Streaming::ResponseStream)
+      end
+      def stream(
+        # Text, image, or file inputs to the model, used to generate a response.
+        input: nil,
+        # Model ID used to generate the response, like `gpt-4o` or `o3`.
+        model: nil,
+        # Whether to run the model response in the background.
+        background: nil,
+        # Specify additional output data to include in the model response.
+        include: nil,
+        # A system (or developer) message inserted into the model's context.
+        instructions: nil,
+        # An upper bound for the number of tokens that can be generated for a response.
+        max_output_tokens: nil,
+        # Set of 16 key-value pairs that can be attached to an object.
+        metadata: nil,
+        # Whether to allow the model to run tool calls in parallel.
+        parallel_tool_calls: nil,
+        # The unique ID of the previous response to the model. Use this to create
+        # multi-turn conversations.
+        previous_response_id: nil,
+        # Reference to a prompt template and its variables.
+        prompt: nil,
+        # Configuration options for reasoning models.
+        reasoning: nil,
+        # Specifies the latency tier to use for processing the request.
+        service_tier: nil,
+        # Whether to store the generated model response for later retrieval via API.
+        store: nil,
+        # What sampling temperature to use, between 0 and 2.
+        temperature: nil,
+        # Configuration options for a text response from the model.
+        text: nil,
+        # How the model should select which tool (or tools) to use when generating a response.
+        tool_choice: nil,
+        # An array of tools the model may call while generating a response.
+        tools: nil,
+        # An alternative to sampling with temperature, called nucleus sampling.
+        top_p: nil,
+        # The truncation strategy to use for the model response.
+        truncation: nil,
+        # A stable identifier for your end-users.
+        user: nil,
+        # The sequence number of the event after which to start streaming (for resuming streams).
+        starting_after: nil,
+        request_options: {}
+      )
+      end
+
       # See {OpenAI::Resources::Responses#retrieve_streaming} for streaming counterpart.
       #
       # Retrieves a model response with the given ID.

data/rbi/openai/streaming.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module OpenAI
+  Streaming = OpenAI::Helpers::Streaming
+end

data/sig/openai/internal/type/base_stream.rbs

@@ -23,6 +23,10 @@ module OpenAI
           url: URI::Generic,
           status: Integer,
           response: top,
+          unwrap: Symbol
+          | Integer
+          | ::Array[Symbol | Integer]
+          | ^(top arg0) -> top,
           stream: Enumerable[Message]
         ) -> void
 

data/sig/openai/models/audio/transcription.rbs

@@ -131,16 +131,16 @@ module OpenAI
             end
           end
 
-          type duration = { duration: Float, type: :duration }
+          type duration = { seconds: Float, type: :duration }
 
           class Duration < OpenAI::Internal::Type::BaseModel
-            attr_accessor duration: Float
+            attr_accessor seconds: Float
 
             attr_accessor type: :duration
 
-            def initialize: (duration: Float, ?type: :duration) -> void
+            def initialize: (seconds: Float, ?type: :duration) -> void
 
-            def to_hash: -> { duration: Float, type: :duration }
+            def to_hash: -> { seconds: Float, type: :duration }
           end
 
           def self?.variants: -> ::Array[OpenAI::Models::Audio::Transcription::usage]

data/sig/openai/models/audio/transcription_verbose.rbs

@@ -54,16 +54,16 @@ module OpenAI
           words: ::Array[OpenAI::Audio::TranscriptionWord]
         }
 
-        type usage = { duration: Float, type: :duration }
+        type usage = { seconds: Float, type: :duration }
 
         class Usage < OpenAI::Internal::Type::BaseModel
-          attr_accessor duration: Float
+          attr_accessor seconds: Float
 
           attr_accessor type: :duration
 
-          def initialize: (duration: Float, ?type: :duration) -> void
+          def initialize: (seconds: Float, ?type: :duration) -> void
 
-          def to_hash: -> { duration: Float, type: :duration }
+          def to_hash: -> { seconds: Float, type: :duration }
         end
       end
     end

data/sig/openai/models/file_object.rbs

@@ -68,6 +68,7 @@ module OpenAI
         | :"fine-tune"
         | :"fine-tune-results"
         | :vision
+        | :user_data
 
       module Purpose
         extend OpenAI::Internal::Type::Enum
@@ -79,6 +80,7 @@ module OpenAI
         FINE_TUNE: :"fine-tune"
         FINE_TUNE_RESULTS: :"fine-tune-results"
         VISION: :vision
+        USER_DATA: :user_data
 
         def self?.values: -> ::Array[OpenAI::Models::FileObject::purpose]
       end

data/sig/openai/models/responses/response_input_file.rbs

@@ -6,6 +6,7 @@ module OpenAI
           type: :input_file,
           file_data: String,
           file_id: String?,
+          file_url: String,
           filename: String
         }
 
@@ -18,6 +19,10 @@ module OpenAI
 
         attr_accessor file_id: String?
 
+        attr_reader file_url: String?
+
+        def file_url=: (String) -> String
+
         attr_reader filename: String?
 
         def filename=: (String) -> String
@@ -25,6 +30,7 @@ module OpenAI
         def initialize: (
           ?file_data: String,
           ?file_id: String?,
+          ?file_url: String,
           ?filename: String,
           ?type: :input_file
         ) -> void
@@ -33,6 +39,7 @@ module OpenAI
           type: :input_file,
           file_data: String,
           file_id: String?,
+          file_url: String,
           filename: String
         }
       end

data/sig/openai/models/responses/response_mcp_call_arguments_delta_event.rbs

@@ -7,7 +7,7 @@ module OpenAI
           item_id: String,
           output_index: Integer,
           sequence_number: Integer,
-          type: :"response.mcp_call.arguments_delta"
+          type: :"response.mcp_call_arguments.delta"
         }
 
       class ResponseMcpCallArgumentsDeltaEvent < OpenAI::Internal::Type::BaseModel
@@ -19,14 +19,14 @@ module OpenAI
 
         attr_accessor sequence_number: Integer
 
-        attr_accessor type: :"response.mcp_call.arguments_delta"
+        attr_accessor type: :"response.mcp_call_arguments.delta"
 
         def initialize: (
           delta: top,
           item_id: String,
           output_index: Integer,
           sequence_number: Integer,
-          ?type: :"response.mcp_call.arguments_delta"
+          ?type: :"response.mcp_call_arguments.delta"
         ) -> void
 
         def to_hash: -> {
@@ -34,7 +34,7 @@ module OpenAI
           item_id: String,
           output_index: Integer,
           sequence_number: Integer,
-          type: :"response.mcp_call.arguments_delta"
+          type: :"response.mcp_call_arguments.delta"
         }
       end
     end

data/sig/openai/models/responses/response_mcp_call_arguments_done_event.rbs

@@ -7,7 +7,7 @@ module OpenAI
           item_id: String,
           output_index: Integer,
           sequence_number: Integer,
-          type: :"response.mcp_call.arguments_done"
+          type: :"response.mcp_call_arguments.done"
         }
 
       class ResponseMcpCallArgumentsDoneEvent < OpenAI::Internal::Type::BaseModel
@@ -19,14 +19,14 @@ module OpenAI
 
         attr_accessor sequence_number: Integer
 
-        attr_accessor type: :"response.mcp_call.arguments_done"
+        attr_accessor type: :"response.mcp_call_arguments.done"
 
         def initialize: (
           arguments: top,
           item_id: String,
           output_index: Integer,
           sequence_number: Integer,
-          ?type: :"response.mcp_call.arguments_done"
+          ?type: :"response.mcp_call_arguments.done"
         ) -> void
 
         def to_hash: -> {
@@ -34,7 +34,7 @@ module OpenAI
           item_id: String,
           output_index: Integer,
           sequence_number: Integer,
-          type: :"response.mcp_call.arguments_done"
+          type: :"response.mcp_call_arguments.done"
         }
       end
     end

data/sig/openai/models/responses/response_output_text_annotation_added_event.rbs

@@ -9,7 +9,7 @@ module OpenAI
           item_id: String,
           output_index: Integer,
           sequence_number: Integer,
-          type: :"response.output_text_annotation.added"
+          type: :"response.output_text.annotation.added"
         }
 
       class ResponseOutputTextAnnotationAddedEvent < OpenAI::Internal::Type::BaseModel
@@ -25,7 +25,7 @@ module OpenAI
 
         attr_accessor sequence_number: Integer
 
-        attr_accessor type: :"response.output_text_annotation.added"
+        attr_accessor type: :"response.output_text.annotation.added"
 
         def initialize: (
           annotation: top,
@@ -34,7 +34,7 @@ module OpenAI
           item_id: String,
           output_index: Integer,
           sequence_number: Integer,
-          ?type: :"response.output_text_annotation.added"
+          ?type: :"response.output_text.annotation.added"
         ) -> void
 
         def to_hash: -> {
@@ -44,7 +44,7 @@ module OpenAI
           item_id: String,
           output_index: Integer,
           sequence_number: Integer,
-          type: :"response.output_text_annotation.added"
+          type: :"response.output_text.annotation.added"
         }
       end
     end

data/sig/openai/models/responses/tool.rbs

@@ -21,7 +21,8 @@ module OpenAI
             type: :mcp,
             allowed_tools: OpenAI::Models::Responses::Tool::Mcp::allowed_tools?,
             headers: ::Hash[Symbol, String]?,
-            require_approval: OpenAI::Models::Responses::Tool::Mcp::require_approval?
+            require_approval: OpenAI::Models::Responses::Tool::Mcp::require_approval?,
+            server_description: String
           }
 
         class Mcp < OpenAI::Internal::Type::BaseModel
@@ -37,12 +38,17 @@ module OpenAI
 
           attr_accessor require_approval: OpenAI::Models::Responses::Tool::Mcp::require_approval?
 
+          attr_reader server_description: String?
+
+          def server_description=: (String) -> String
+
           def initialize: (
             server_label: String,
             server_url: String,
             ?allowed_tools: OpenAI::Models::Responses::Tool::Mcp::allowed_tools?,
             ?headers: ::Hash[Symbol, String]?,
             ?require_approval: OpenAI::Models::Responses::Tool::Mcp::require_approval?,
+            ?server_description: String,
             ?type: :mcp
           ) -> void
 
@@ -52,7 +58,8 @@ module OpenAI
             type: :mcp,
             allowed_tools: OpenAI::Models::Responses::Tool::Mcp::allowed_tools?,
             headers: ::Hash[Symbol, String]?,
-            require_approval: OpenAI::Models::Responses::Tool::Mcp::require_approval?
+            require_approval: OpenAI::Models::Responses::Tool::Mcp::require_approval?,
+            server_description: String
           }
 
           type allowed_tools =

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openai
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.0
 platform: ruby
 authors:
 - OpenAI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-26 00:00:00.000000000 Z
+date: 2025-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -39,12 +39,15 @@ files:
 - lib/openai/client.rb
 - lib/openai/errors.rb
 - lib/openai/file_part.rb
+- lib/openai/helpers/streaming/events.rb
+- lib/openai/helpers/streaming/response_stream.rb
 - lib/openai/helpers/structured_output.rb
 - lib/openai/helpers/structured_output/array_of.rb
 - lib/openai/helpers/structured_output/base_model.rb
 - lib/openai/helpers/structured_output/boolean.rb
 - lib/openai/helpers/structured_output/enum_of.rb
 - lib/openai/helpers/structured_output/json_schema_converter.rb
+- lib/openai/helpers/structured_output/parsed_json.rb
 - lib/openai/helpers/structured_output/union_of.rb
 - lib/openai/internal.rb
 - lib/openai/internal/cursor_page.rb
@@ -547,12 +550,15 @@ files:
 - lib/openai/resources/vector_stores/file_batches.rb
 - lib/openai/resources/vector_stores/files.rb
 - lib/openai/resources/webhooks.rb
+- lib/openai/streaming.rb
 - lib/openai/structured_output.rb
 - lib/openai/version.rb
 - manifest.yaml
 - rbi/openai/client.rbi
 - rbi/openai/errors.rbi
 - rbi/openai/file_part.rbi
+- rbi/openai/helpers/streaming/events.rbi
+- rbi/openai/helpers/streaming/response_stream.rbi
 - rbi/openai/helpers/structured_output.rbi
 - rbi/openai/helpers/structured_output/array_of.rbi
 - rbi/openai/helpers/structured_output/base_model.rbi
@@ -1061,6 +1067,7 @@ files:
 - rbi/openai/resources/vector_stores/file_batches.rbi
 - rbi/openai/resources/vector_stores/files.rbi
 - rbi/openai/resources/webhooks.rbi
+- rbi/openai/streaming.rbi
 - rbi/openai/structured_output.rbi
 - rbi/openai/version.rbi
 - sig/openai/client.rbs