openai 0.81.0 → 0.82.0

data/rbi/openai/resources/responses.rbi

@@ -396,7 +396,7 @@ module OpenAI
         )
           .returns(
             OpenAI::Internal::Stream[
-              OpenAI::Responses::ResponseStreamEvent::Variants
+              T.any(OpenAI::Responses::ResponseStreamEvent::Variants, OpenAI::Streaming::UnknownStreamEvent)
             ]
           )
       end
@@ -917,7 +917,7 @@ module OpenAI
         )
           .returns(
             OpenAI::Internal::Stream[
-              OpenAI::Responses::ResponseStreamEvent::Variants
+              T.any(OpenAI::Responses::ResponseStreamEvent::Variants, OpenAI::Streaming::UnknownStreamEvent)
             ]
           )
       end

data/rbi/openai/streaming.rbi

@@ -6,6 +6,7 @@ module OpenAI
     ResponseTextDoneEvent = OpenAI::Helpers::Streaming::ResponseTextDoneEvent
     ResponseFunctionCallArgumentsDeltaEvent = OpenAI::Helpers::Streaming::ResponseFunctionCallArgumentsDeltaEvent
     ResponseCompletedEvent = OpenAI::Helpers::Streaming::ResponseCompletedEvent
+    UnknownStreamEvent = OpenAI::Helpers::Streaming::UnknownStreamEvent
 
     ChatChunkEvent = OpenAI::Helpers::Streaming::ChatChunkEvent
     ChatContentDeltaEvent = OpenAI::Helpers::Streaming::ChatContentDeltaEvent

data/sig/openai/helpers/sorbet.rbs

@@ -0,0 +1,54 @@
+module OpenAI
+  module Helpers
+    module StructuredOutput
+      class SorbetAdapter
+        include OpenAI::Internal::Type::Converter
+
+        class HydrationError < ::TypeError
+        end
+
+        attr_reader name: String
+
+        def initialize: (::Class model) -> void
+
+        def to_json_schema: -> ::Hash[Symbol, untyped]
+
+        # @api private
+        def to_json_schema_inner: (
+          state: ::Hash[Symbol, untyped]
+        ) -> ::Hash[Symbol, untyped]
+
+        # @api private
+        def coerce: (untyped value, state: ::Hash[Symbol, untyped]) -> untyped
+      end
+
+      def self.from_sorbet: (::Class model) -> SorbetAdapter
+    end
+  end
+
+  module Resources
+    class Responses
+      def create:
+        (
+          text: OpenAI::Helpers::StructuredOutput::SorbetAdapter,
+          ?model: OpenAI::Models::responses_model,
+          ?input: OpenAI::Models::Responses::ResponseCreateParams::input,
+          **untyped
+        ) -> OpenAI::Responses::Response
+        | ...
+    end
+
+    class Chat
+      class Completions
+        def create:
+          (
+            model: OpenAI::Models::Chat::CompletionCreateParams::model,
+            messages: ::Array[OpenAI::Models::Chat::chat_completion_message_param],
+            response_format: OpenAI::Helpers::StructuredOutput::SorbetAdapter,
+            **untyped
+          ) -> OpenAI::Chat::ChatCompletion
+          | ...
+      end
+    end
+  end
+end

data/sig/openai/helpers/streaming/response_event_decoder.rbs

@@ -0,0 +1,16 @@
+module OpenAI
+  module Helpers
+    module Streaming
+      # @api private
+      class ResponseEventDecoder
+        def initialize: (model: untyped) -> void
+        def decode: (untyped data) -> untyped
+
+        private
+
+        def response_stream_model?: -> bool
+        def unknown_response_event?: (untyped data) -> bool
+      end
+    end
+  end
+end

data/sig/openai/helpers/streaming/unknown_stream_event.rbs

@@ -0,0 +1,15 @@
+module OpenAI
+  module Helpers
+    module Streaming
+      class UnknownStreamEvent
+        attr_reader type: Symbol
+        attr_reader sequence_number: Integer?
+        attr_reader data: ::Hash[Symbol, untyped]
+
+        # @api private
+        def initialize: (data: ::Hash[Symbol, untyped]) -> void
+        def to_h: -> ::Hash[Symbol, untyped]
+      end
+    end
+  end
+end

data/sig/openai/models/beta/beta_response_function_tool_call_output_item.rbs

@@ -6,11 +6,11 @@ module OpenAI
       type beta_response_function_tool_call_output_item =
         {
           id: String,
-          call_id: String,
           output: OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem::output,
           status: OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem::status,
           type: :function_call_output,
           agent: OpenAI::Beta::BetaResponseFunctionToolCallOutputItem::Agent?,
+          call_id: String,
           caller_: OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem::caller_?,
           created_by: String,
           name: String,
@@ -20,8 +20,6 @@ module OpenAI
       class BetaResponseFunctionToolCallOutputItem < OpenAI::Internal::Type::BaseModel
         attr_accessor id: String
 
-        attr_accessor call_id: String
-
         attr_accessor output: OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem::output
 
         attr_accessor status: OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem::status
@@ -30,6 +28,10 @@ module OpenAI
 
         attr_accessor agent: OpenAI::Beta::BetaResponseFunctionToolCallOutputItem::Agent?
 
+        attr_reader call_id: String?
+
+        def call_id=: (String) -> String
+
         attr_accessor caller_: OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem::caller_?
 
         attr_reader created_by: String?
@@ -46,10 +48,10 @@ module OpenAI
 
         def initialize: (
           id: String,
-          call_id: String,
           output: OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem::output,
           status: OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem::status,
           ?agent: OpenAI::Beta::BetaResponseFunctionToolCallOutputItem::Agent?,
+          ?call_id: String,
           ?caller_: OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem::caller_?,
           ?created_by: String,
           ?name: String,
@@ -59,11 +61,11 @@ module OpenAI
 
         def to_hash: -> {
           id: String,
-          call_id: String,
           output: OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem::output,
           status: OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem::status,
           type: :function_call_output,
           agent: OpenAI::Beta::BetaResponseFunctionToolCallOutputItem::Agent?,
+          call_id: String,
           caller_: OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem::caller_?,
           created_by: String,
           name: String,

data/sig/openai/models/beta/beta_response_input_item.rbs

@@ -222,11 +222,11 @@ module OpenAI
 
         type function_call_output =
           {
-            call_id: String,
             output: OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::output,
             type: :function_call_output,
             id: String?,
             agent: OpenAI::Beta::BetaResponseInputItem::FunctionCallOutput::Agent?,
+            call_id: String?,
             caller_: OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::caller_?,
             name: String?,
             namespace: String?,
@@ -234,8 +234,6 @@ module OpenAI
           }
 
         class FunctionCallOutput < OpenAI::Internal::Type::BaseModel
-          attr_accessor call_id: String
-
           attr_accessor output: OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::output
 
           attr_accessor type: :function_call_output
@@ -244,6 +242,8 @@ module OpenAI
 
           attr_accessor agent: OpenAI::Beta::BetaResponseInputItem::FunctionCallOutput::Agent?
 
+          attr_accessor call_id: String?
+
           attr_accessor caller_: OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::caller_?
 
           attr_accessor name: String?
@@ -253,10 +253,10 @@ module OpenAI
           attr_accessor status: OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::status?
 
           def initialize: (
-            call_id: String,
             output: OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::output,
             ?id: String?,
             ?agent: OpenAI::Beta::BetaResponseInputItem::FunctionCallOutput::Agent?,
+            ?call_id: String?,
             ?caller_: OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::caller_?,
             ?name: String?,
             ?namespace: String?,
@@ -265,11 +265,11 @@ module OpenAI
           ) -> void
 
           def to_hash: -> {
-            call_id: String,
             output: OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::output,
             type: :function_call_output,
             id: String?,
             agent: OpenAI::Beta::BetaResponseInputItem::FunctionCallOutput::Agent?,
+            call_id: String?,
             caller_: OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput::caller_?,
             name: String?,
             namespace: String?,

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

@@ -4,10 +4,10 @@ module OpenAI
       type response_function_tool_call_output_item =
         {
           id: String,
-          call_id: String,
           output: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::output,
           status: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::status,
           type: :function_call_output,
+          call_id: String,
           caller_: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::caller_?,
           created_by: String,
           name: String,
@@ -17,14 +17,16 @@ module OpenAI
       class ResponseFunctionToolCallOutputItem < OpenAI::Internal::Type::BaseModel
         attr_accessor id: String
 
-        attr_accessor call_id: String
-
         attr_accessor output: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::output
 
         attr_accessor status: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::status
 
         attr_accessor type: :function_call_output
 
+        attr_reader call_id: String?
+
+        def call_id=: (String) -> String
+
         attr_accessor caller_: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::caller_?
 
         attr_reader created_by: String?
@@ -41,9 +43,9 @@ module OpenAI
 
         def initialize: (
           id: String,
-          call_id: String,
           output: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::output,
           status: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::status,
+          ?call_id: String,
           ?caller_: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::caller_?,
           ?created_by: String,
           ?name: String,
@@ -53,10 +55,10 @@ module OpenAI
 
         def to_hash: -> {
           id: String,
-          call_id: String,
           output: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::output,
           status: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::status,
           type: :function_call_output,
+          call_id: String,
           caller_: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::caller_?,
           created_by: String,
           name: String,

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

@@ -187,10 +187,10 @@ module OpenAI
 
         type function_call_output =
           {
-            call_id: String,
             output: OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::output,
             type: :function_call_output,
             id: String?,
+            call_id: String?,
             caller_: OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::caller_?,
             name: String?,
             namespace: String?,
@@ -198,14 +198,14 @@ module OpenAI
           }
 
         class FunctionCallOutput < OpenAI::Internal::Type::BaseModel
-          attr_accessor call_id: String
-
           attr_accessor output: OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::output
 
           attr_accessor type: :function_call_output
 
           attr_accessor id: String?
 
+          attr_accessor call_id: String?
+
           attr_accessor caller_: OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::caller_?
 
           attr_accessor name: String?
@@ -215,9 +215,9 @@ module OpenAI
           attr_accessor status: OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::status?
 
           def initialize: (
-            call_id: String,
             output: OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::output,
             ?id: String?,
+            ?call_id: String?,
             ?caller_: OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::caller_?,
             ?name: String?,
             ?namespace: String?,
@@ -226,10 +226,10 @@ module OpenAI
           ) -> void
 
           def to_hash: -> {
-            call_id: String,
             output: OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::output,
             type: :function_call_output,
             id: String?,
+            call_id: String?,
             caller_: OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput::caller_?,
             name: String?,
             namespace: String?,

data/sig/openai/resources/beta/responses.rbs

@@ -76,7 +76,8 @@ module OpenAI
           ?user: String,
           ?betas: ::Array[OpenAI::Models::Beta::ResponseCreateParams::beta],
           ?request_options: OpenAI::request_opts
-        ) -> OpenAI::Internal::Stream[OpenAI::Models::Beta::beta_response_stream_event]
+        ) -> OpenAI::Internal::Stream[(OpenAI::Models::Beta::beta_response_stream_event
+        | OpenAI::Streaming::UnknownStreamEvent)]
 
         def retrieve: (
           String response_id,
@@ -94,7 +95,8 @@ module OpenAI
           ?starting_after: Integer,
           ?betas: ::Array[OpenAI::Models::Beta::ResponseRetrieveParams::beta],
           ?request_options: OpenAI::request_opts
-        ) -> OpenAI::Internal::Stream[OpenAI::Models::Beta::beta_response_stream_event]
+        ) -> OpenAI::Internal::Stream[(OpenAI::Models::Beta::beta_response_stream_event
+        | OpenAI::Streaming::UnknownStreamEvent)]
 
         def delete: (
           String response_id,

data/sig/openai/resources/responses.rbs

@@ -71,7 +71,8 @@ module OpenAI
         ?truncation: OpenAI::Models::Responses::ResponseCreateParams::truncation?,
         ?user: String,
         ?request_options: OpenAI::request_opts
-      ) -> OpenAI::Internal::Stream[OpenAI::Models::Responses::response_stream_event]
+      ) -> OpenAI::Internal::Stream[(OpenAI::Models::Responses::response_stream_event
+      | OpenAI::Streaming::UnknownStreamEvent)]
 
       def stream: (
         ?background: bool?,
@@ -99,7 +100,8 @@ module OpenAI
         ?truncation: OpenAI::Models::Responses::ResponseCreateParams::truncation?,
         ?user: String,
         ?request_options: OpenAI::request_opts
-      ) -> OpenAI::Internal::Stream[OpenAI::Models::Responses::response_stream_event]
+      ) -> OpenAI::Internal::Stream[(OpenAI::Models::Responses::response_stream_event
+      | OpenAI::Streaming::UnknownStreamEvent)]
 
       def retrieve: (
         String response_id,
@@ -115,7 +117,8 @@ module OpenAI
         ?include_obfuscation: bool,
         ?starting_after: Integer,
         ?request_options: OpenAI::request_opts
-      ) -> OpenAI::Internal::Stream[OpenAI::Models::Responses::response_stream_event]
+      ) -> OpenAI::Internal::Stream[(OpenAI::Models::Responses::response_stream_event
+      | OpenAI::Streaming::UnknownStreamEvent)]
 
       def delete: (
         String response_id,

data/sig/openai/streaming.rbs

@@ -0,0 +1,5 @@
+module OpenAI
+  module Streaming
+    class UnknownStreamEvent = Helpers::Streaming::UnknownStreamEvent
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openai
 version: !ruby/object:Gem::Version
-  version: 0.81.0
+  version: 0.82.0
 platform: ruby
 authors:
 - OpenAI
@@ -93,11 +93,14 @@ files:
 - lib/openai/helpers/realtime/transports/async_websocket.rb
 - lib/openai/helpers/realtime/unknown_server_event.rb
 - lib/openai/helpers/resource_polling.rb
+- lib/openai/helpers/sorbet.rb
 - lib/openai/helpers/streaming/chat_completion_stream.rb
 - lib/openai/helpers/streaming/chat_events.rb
 - lib/openai/helpers/streaming/exceptions.rb
+- lib/openai/helpers/streaming/response_event_decoder.rb
 - lib/openai/helpers/streaming/response_events.rb
 - lib/openai/helpers/streaming/response_stream.rb
+- lib/openai/helpers/streaming/unknown_stream_event.rb
 - lib/openai/helpers/structured_output.rb
 - lib/openai/helpers/structured_output/array_of.rb
 - lib/openai/helpers/structured_output/base_model.rb
@@ -1357,8 +1360,11 @@ files:
 - rbi/openai/helpers/realtime/transports/async_websocket.rbi
 - rbi/openai/helpers/realtime/unknown_server_event.rbi
 - rbi/openai/helpers/resource_polling.rbi
+- rbi/openai/helpers/sorbet.rbi
 - rbi/openai/helpers/streaming/events.rbi
+- rbi/openai/helpers/streaming/response_event_decoder.rbi
 - rbi/openai/helpers/streaming/response_stream.rbi
+- rbi/openai/helpers/streaming/unknown_stream_event.rbi
 - rbi/openai/helpers/structured_output.rbi
 - rbi/openai/helpers/structured_output/array_of.rbi
 - rbi/openai/helpers/structured_output/base_model.rbi
@@ -2615,6 +2621,9 @@ files:
 - sig/openai/helpers/realtime/transports/async_websocket.rbs
 - sig/openai/helpers/realtime/unknown_server_event.rbs
 - sig/openai/helpers/resource_polling.rbs
+- sig/openai/helpers/sorbet.rbs
+- sig/openai/helpers/streaming/response_event_decoder.rbs
+- sig/openai/helpers/streaming/unknown_stream_event.rbs
 - sig/openai/helpers/structured_output/chat_completion_parser.rbs
 - sig/openai/helpers/structured_output/response_parser.rbs
 - sig/openai/http_client.rbs
@@ -3843,6 +3852,7 @@ files:
 - sig/openai/resources/vector_stores/files.rbs
 - sig/openai/resources/videos.rbs
 - sig/openai/resources/webhooks.rbs
+- sig/openai/streaming.rbs
 - sig/openai/version.rbs
 homepage: https://gemdocs.org/gems/openai
 licenses: