openai 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c07c6ffe0bed902c877c2c49c557a4f85cc8c6b5f291ed4534a3bb9052347e14
-  data.tar.gz: bcaf9ac1e1d62e51b0c17af965887ccc8e479278e79bfcd932b84b92dc180778
+  metadata.gz: 47fb7720e93045ef9ea453bfa010f7c371e787bbef29cd4a030b4022f9402cae
+  data.tar.gz: f055a7952e0aef69b1b7c55ed9b388c3c96c870022bc2f24b199fce4d15cd029
 SHA512:
-  metadata.gz: 8582a8bf14c6f8639f4301d5c35cc012fb56cb4cc7b16b496f57013e3da8945296857de33c7b8e651726d4ea334b718a23c77dd4c3375c4a230b34e6742787a9
-  data.tar.gz: 8e91eac55ebe1a1d4c08de1cf2d90a97526d84ed229143cfa73845cc231a7b2cd4f25d5dc91b3ed0295c5470bc4b96da6a99508ab557ba9ac8c4b084ebcdeb59
+  metadata.gz: 05d0d579d341ae49f9e37afce59d8231490ba4e97c0f7015223ae66b22ea70243a3dc4ea4f58cd3214f49550bef85f71916f67056a2d0bdc22884733172414bf
+  data.tar.gz: f808c8aa99ec25fcd98bdfc7cba0a2736e2c495a8c84c1cdeea59709b29a498c469d1e3a8611c00aa7bb6453c00ea2c1c60ee86d7cc21b574d58f31ac3bcb484

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## 0.5.0 (2025-05-29)
+
+Full Changelog: [v0.4.1...v0.5.0](https://github.com/openai/openai-ruby/compare/v0.4.1...v0.5.0)
+
+### Features
+
+* **api:** Config update for pakrym-stream-param ([214e516](https://github.com/openai/openai-ruby/commit/214e516f286a026e5b040ffd76b930cad7d5eabf))
+
+
+### Bug Fixes
+
+* **client:** return binary content from `get /containers/{container_id}/files/{file_id}/content` ([2b7122a](https://github.com/openai/openai-ruby/commit/2b7122ad724620269c3b403d5a584d710bed5b5c))
+* sorbet types for enums, and make tapioca detection ignore `tapioca dsl` ([0e24b3e](https://github.com/openai/openai-ruby/commit/0e24b3e0a574de5c0544067c53b9e693e4cec3b1))
+
+
+### Chores
+
+* deprecate Assistants API ([4ce7530](https://github.com/openai/openai-ruby/commit/4ce753088e18a3331fccf6608889243809ce187b))
+
 ## 0.4.1 (2025-05-23)
 
 Full Changelog: [v0.4.0-beta.1...v0.4.1](https://github.com/openai/openai-ruby/compare/v0.4.0-beta.1...v0.4.1)

data/README.md

@@ -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.4.1"
+gem "openai", "~> 0.5.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/openai/internal/util.rb

@@ -875,8 +875,12 @@ module OpenAI
             case type
             in OpenAI::Internal::Util::SorbetRuntimeSupport
               type.to_sorbet_type
-            else
+            in Class | Module
               type
+            in true | false
+              T::Boolean
+            else
+              type.class
             end
           end
         end

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

@@ -31,13 +31,23 @@ module OpenAI
         #   @return [Symbol, :output_text]
         required :type, const: :output_text
 
-        # @!method initialize(annotations:, text:, type: :output_text)
+        # @!attribute logprobs
+        #
+        #   @return [Array<OpenAI::Models::Responses::ResponseOutputText::Logprob>, nil]
+        optional :logprobs,
+                 -> {
+                   OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseOutputText::Logprob]
+                 }
+
+        # @!method initialize(annotations:, text:, logprobs: nil, type: :output_text)
         #   A text output from the model.
         #
         #   @param annotations [Array<OpenAI::Models::Responses::ResponseOutputText::Annotation::FileCitation, OpenAI::Models::Responses::ResponseOutputText::Annotation::URLCitation, OpenAI::Models::Responses::ResponseOutputText::Annotation::FilePath>] The annotations of the text output.
         #
         #   @param text [String] The text output from the model.
         #
+        #   @param logprobs [Array<OpenAI::Models::Responses::ResponseOutputText::Logprob>]
+        #
         #   @param type [Symbol, :output_text] The type of the output text. Always `output_text`.
 
         # A citation to a file.
@@ -165,6 +175,63 @@ module OpenAI
           # @!method self.variants
           #   @return [Array(OpenAI::Models::Responses::ResponseOutputText::Annotation::FileCitation, OpenAI::Models::Responses::ResponseOutputText::Annotation::URLCitation, OpenAI::Models::Responses::ResponseOutputText::Annotation::FilePath)]
         end
+
+        class Logprob < OpenAI::Internal::Type::BaseModel
+          # @!attribute token
+          #
+          #   @return [String]
+          required :token, String
+
+          # @!attribute bytes
+          #
+          #   @return [Array<Integer>]
+          required :bytes, OpenAI::Internal::Type::ArrayOf[Integer]
+
+          # @!attribute logprob
+          #
+          #   @return [Float]
+          required :logprob, Float
+
+          # @!attribute top_logprobs
+          #
+          #   @return [Array<OpenAI::Models::Responses::ResponseOutputText::Logprob::TopLogprob>]
+          required :top_logprobs,
+                   -> {
+                     OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseOutputText::Logprob::TopLogprob]
+                   }
+
+          # @!method initialize(token:, bytes:, logprob:, top_logprobs:)
+          #   The log probability of a token.
+          #
+          #   @param token [String]
+          #   @param bytes [Array<Integer>]
+          #   @param logprob [Float]
+          #   @param top_logprobs [Array<OpenAI::Models::Responses::ResponseOutputText::Logprob::TopLogprob>]
+
+          class TopLogprob < OpenAI::Internal::Type::BaseModel
+            # @!attribute token
+            #
+            #   @return [String]
+            required :token, String
+
+            # @!attribute bytes
+            #
+            #   @return [Array<Integer>]
+            required :bytes, OpenAI::Internal::Type::ArrayOf[Integer]
+
+            # @!attribute logprob
+            #
+            #   @return [Float]
+            required :logprob, Float
+
+            # @!method initialize(token:, bytes:, logprob:)
+            #   The top log probability of a token.
+            #
+            #   @param token [String]
+            #   @param bytes [Array<Integer>]
+            #   @param logprob [Float]
+          end
+        end
       end
     end
   end

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

@@ -4,6 +4,8 @@ module OpenAI
   module Models
     module Responses
       # @see OpenAI::Resources::Responses#retrieve
+      #
+      # @see OpenAI::Resources::Responses#retrieve_streaming
       class ResponseRetrieveParams < OpenAI::Internal::Type::BaseModel
         extend OpenAI::Internal::Type::RequestParameters::Converter
         include OpenAI::Internal::Type::RequestParameters
@@ -15,12 +17,20 @@ module OpenAI
         #   @return [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil]
         optional :include, -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Responses::ResponseIncludable] }
 
-        # @!method initialize(include: nil, request_options: {})
+        # @!attribute starting_after
+        #   The sequence number of the event after which to start streaming.
+        #
+        #   @return [Integer, nil]
+        optional :starting_after, Integer
+
+        # @!method initialize(include: nil, starting_after: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseRetrieveParams} for more details.
         #
         #   @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Additional fields to include in the response. See the `include`
         #
+        #   @param starting_after [Integer] The sequence number of the event after which to start streaming.
+        #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/openai/resources/beta/threads/messages.rb

@@ -4,7 +4,10 @@ module OpenAI
   module Resources
     class Beta
       class Threads
+        # @deprecated The Assistants API is deprecated in favor of the Responses API
         class Messages
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # Some parameter documentations has been truncated, see
           # {OpenAI::Models::Beta::Threads::MessageCreateParams} for more details.
           #
@@ -38,6 +41,8 @@ module OpenAI
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # Some parameter documentations has been truncated, see
           # {OpenAI::Models::Beta::Threads::MessageRetrieveParams} for more details.
           #
@@ -68,6 +73,8 @@ module OpenAI
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # Some parameter documentations has been truncated, see
           # {OpenAI::Models::Beta::Threads::MessageUpdateParams} for more details.
           #
@@ -101,6 +108,8 @@ module OpenAI
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # Some parameter documentations has been truncated, see
           # {OpenAI::Models::Beta::Threads::MessageListParams} for more details.
           #
@@ -137,6 +146,8 @@ module OpenAI
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # Deletes a message.
           #
           # @overload delete(message_id, thread_id:, request_options: {})

data/lib/openai/resources/beta/threads/runs/steps.rb

@@ -5,7 +5,10 @@ module OpenAI
     class Beta
       class Threads
         class Runs
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
           class Steps
+            # @deprecated The Assistants API is deprecated in favor of the Responses API
+            #
             # Some parameter documentations has been truncated, see
             # {OpenAI::Models::Beta::Threads::Runs::StepRetrieveParams} for more details.
             #
@@ -45,6 +48,8 @@ module OpenAI
               )
             end
 
+            # @deprecated The Assistants API is deprecated in favor of the Responses API
+            #
             # Some parameter documentations has been truncated, see
             # {OpenAI::Models::Beta::Threads::Runs::StepListParams} for more details.
             #

data/lib/openai/resources/beta/threads/runs.rb

@@ -4,10 +4,13 @@ module OpenAI
   module Resources
     class Beta
       class Threads
+        # @deprecated The Assistants API is deprecated in favor of the Responses API
         class Runs
           # @return [OpenAI::Resources::Beta::Threads::Runs::Steps]
           attr_reader :steps
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # See {OpenAI::Resources::Beta::Threads::Runs#create_stream_raw} for streaming
           # counterpart.
           #
@@ -76,6 +79,8 @@ module OpenAI
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # See {OpenAI::Resources::Beta::Threads::Runs#create} for non-streaming
           # counterpart.
           #
@@ -147,6 +152,8 @@ module OpenAI
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # Some parameter documentations has been truncated, see
           # {OpenAI::Models::Beta::Threads::RunRetrieveParams} for more details.
           #
@@ -177,6 +184,8 @@ module OpenAI
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # Some parameter documentations has been truncated, see
           # {OpenAI::Models::Beta::Threads::RunUpdateParams} for more details.
           #
@@ -210,6 +219,8 @@ module OpenAI
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # Some parameter documentations has been truncated, see
           # {OpenAI::Models::Beta::Threads::RunListParams} for more details.
           #
@@ -244,6 +255,8 @@ module OpenAI
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # Cancels a run that is `in_progress`.
           #
           # @overload cancel(run_id, thread_id:, request_options: {})
@@ -271,6 +284,8 @@ module OpenAI
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # See {OpenAI::Resources::Beta::Threads::Runs#submit_tool_outputs_stream_raw} for
           # streaming counterpart.
           #
@@ -314,6 +329,8 @@ module OpenAI
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # See {OpenAI::Resources::Beta::Threads::Runs#submit_tool_outputs} for
           # non-streaming counterpart.
           #

data/lib/openai/resources/beta/threads.rb

@@ -3,6 +3,7 @@
 module OpenAI
   module Resources
     class Beta
+      # @deprecated The Assistants API is deprecated in favor of the Responses API
       class Threads
         # @return [OpenAI::Resources::Beta::Threads::Runs]
         attr_reader :runs
@@ -10,6 +11,8 @@ module OpenAI
         # @return [OpenAI::Resources::Beta::Threads::Messages]
         attr_reader :messages
 
+        # @deprecated The Assistants API is deprecated in favor of the Responses API
+        #
         # Some parameter documentations has been truncated, see
         # {OpenAI::Models::Beta::ThreadCreateParams} for more details.
         #
@@ -39,6 +42,8 @@ module OpenAI
           )
         end
 
+        # @deprecated The Assistants API is deprecated in favor of the Responses API
+        #
         # Retrieves a thread.
         #
         # @overload retrieve(thread_id, request_options: {})
@@ -59,6 +64,8 @@ module OpenAI
           )
         end
 
+        # @deprecated The Assistants API is deprecated in favor of the Responses API
+        #
         # Some parameter documentations has been truncated, see
         # {OpenAI::Models::Beta::ThreadUpdateParams} for more details.
         #
@@ -88,6 +95,8 @@ module OpenAI
           )
         end
 
+        # @deprecated The Assistants API is deprecated in favor of the Responses API
+        #
         # Delete a thread.
         #
         # @overload delete(thread_id, request_options: {})
@@ -108,6 +117,8 @@ module OpenAI
           )
         end
 
+        # @deprecated The Assistants API is deprecated in favor of the Responses API
+        #
         # See {OpenAI::Resources::Beta::Threads#stream_raw} for streaming counterpart.
         #
         # Some parameter documentations has been truncated, see
@@ -166,11 +177,13 @@ module OpenAI
             options: {extra_headers: {"OpenAI-Beta" => "assistants=v2"}, **options}
           )
         end
-
+        
         def stream
           raise NotImplementedError.new("higher level helpers are coming soon!")
         end
-
+        
+        # @deprecated The Assistants API is deprecated in favor of the Responses API
+        #
         # See {OpenAI::Resources::Beta::Threads#create_and_run} for non-streaming
         # counterpart.
         #

data/lib/openai/resources/containers/files/content.rb

@@ -13,7 +13,7 @@ module OpenAI
           # @param container_id [String]
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [nil]
+          # @return [StringIO]
           #
           # @see OpenAI::Models::Containers::Files::ContentRetrieveParams
           def retrieve(file_id, params)
@@ -25,7 +25,8 @@ module OpenAI
             @client.request(
               method: :get,
               path: ["containers/%1$s/files/%2$s/content", container_id, file_id],
-              model: NilClass,
+              headers: {"accept" => "application/binary"},
+              model: StringIO,
               options: options
             )
           end

data/lib/openai/resources/responses.rb

@@ -242,17 +242,21 @@ module OpenAI
         )
       end
 
+      # See {OpenAI::Resources::Responses#retrieve_streaming} for streaming counterpart.
+      #
       # Some parameter documentations has been truncated, see
       # {OpenAI::Models::Responses::ResponseRetrieveParams} for more details.
       #
       # Retrieves a model response with the given ID.
       #
-      # @overload retrieve(response_id, include: nil, request_options: {})
+      # @overload retrieve(response_id, include: nil, starting_after: nil, request_options: {})
       #
       # @param response_id [String] The ID of the response to retrieve.
       #
       # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Additional fields to include in the response. See the `include`
       #
+      # @param starting_after [Integer] The sequence number of the event after which to start streaming.
+      #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [OpenAI::Models::Responses::Response]
@@ -260,6 +264,10 @@ module OpenAI
       # @see OpenAI::Models::Responses::ResponseRetrieveParams
       def retrieve(response_id, params = {})
         parsed, options = OpenAI::Responses::ResponseRetrieveParams.dump_request(params)
+        if parsed[:stream]
+          message = "Please use `#retrieve_streaming` for the streaming use case."
+          raise ArgumentError.new(message)
+        end
         @client.request(
           method: :get,
           path: ["responses/%1$s", response_id],
@@ -269,6 +277,44 @@ module OpenAI
         )
       end
 
+      # See {OpenAI::Resources::Responses#retrieve} for non-streaming counterpart.
+      #
+      # Some parameter documentations has been truncated, see
+      # {OpenAI::Models::Responses::ResponseRetrieveParams} for more details.
+      #
+      # Retrieves a model response with the given ID.
+      #
+      # @overload retrieve_streaming(response_id, include: nil, starting_after: nil, request_options: {})
+      #
+      # @param response_id [String] The ID of the response to retrieve.
+      #
+      # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Additional fields to include in the response. See the `include`
+      #
+      # @param starting_after [Integer] The sequence number of the event after which to start streaming.
+      #
+      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [OpenAI::Internal::Stream<OpenAI::Models::Responses::ResponseAudioDeltaEvent, OpenAI::Models::Responses::ResponseAudioDoneEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDeltaEvent, OpenAI::Models::Responses::ResponseAudioTranscriptDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDeltaEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCodeDoneEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallCompletedEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInProgressEvent, OpenAI::Models::Responses::ResponseCodeInterpreterCallInterpretingEvent, OpenAI::Models::Responses::ResponseCompletedEvent, OpenAI::Models::Responses::ResponseContentPartAddedEvent, OpenAI::Models::Responses::ResponseContentPartDoneEvent, OpenAI::Models::Responses::ResponseCreatedEvent, OpenAI::Models::Responses::ResponseErrorEvent, OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseFileSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseFileSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseFunctionCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseInProgressEvent, OpenAI::Models::Responses::ResponseFailedEvent, OpenAI::Models::Responses::ResponseIncompleteEvent, OpenAI::Models::Responses::ResponseOutputItemAddedEvent, OpenAI::Models::Responses::ResponseOutputItemDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartAddedEvent, OpenAI::Models::Responses::ResponseReasoningSummaryPartDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryTextDoneEvent, OpenAI::Models::Responses::ResponseRefusalDeltaEvent, OpenAI::Models::Responses::ResponseRefusalDoneEvent, OpenAI::Models::Responses::ResponseTextDeltaEvent, OpenAI::Models::Responses::ResponseTextDoneEvent, OpenAI::Models::Responses::ResponseWebSearchCallCompletedEvent, OpenAI::Models::Responses::ResponseWebSearchCallInProgressEvent, OpenAI::Models::Responses::ResponseWebSearchCallSearchingEvent, OpenAI::Models::Responses::ResponseImageGenCallCompletedEvent, OpenAI::Models::Responses::ResponseImageGenCallGeneratingEvent, OpenAI::Models::Responses::ResponseImageGenCallInProgressEvent, OpenAI::Models::Responses::ResponseImageGenCallPartialImageEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDeltaEvent, OpenAI::Models::Responses::ResponseMcpCallArgumentsDoneEvent, OpenAI::Models::Responses::ResponseMcpCallCompletedEvent, OpenAI::Models::Responses::ResponseMcpCallFailedEvent, OpenAI::Models::Responses::ResponseMcpCallInProgressEvent, OpenAI::Models::Responses::ResponseMcpListToolsCompletedEvent, OpenAI::Models::Responses::ResponseMcpListToolsFailedEvent, OpenAI::Models::Responses::ResponseMcpListToolsInProgressEvent, OpenAI::Models::Responses::ResponseOutputTextAnnotationAddedEvent, OpenAI::Models::Responses::ResponseQueuedEvent, OpenAI::Models::Responses::ResponseReasoningDeltaEvent, OpenAI::Models::Responses::ResponseReasoningDoneEvent, OpenAI::Models::Responses::ResponseReasoningSummaryDeltaEvent, OpenAI::Models::Responses::ResponseReasoningSummaryDoneEvent>]
+      #
+      # @see OpenAI::Models::Responses::ResponseRetrieveParams
+      def retrieve_streaming(response_id, params = {})
+        parsed, options = OpenAI::Responses::ResponseRetrieveParams.dump_request(params)
+        unless parsed.fetch(:stream, true)
+          message = "Please use `#retrieve` for the non-streaming use case."
+          raise ArgumentError.new(message)
+        end
+        parsed.store(:stream, true)
+        @client.request(
+          method: :get,
+          path: ["responses/%1$s", response_id],
+          query: parsed,
+          headers: {"accept" => "text/event-stream"},
+          stream: OpenAI::Internal::Stream,
+          model: OpenAI::Responses::ResponseStreamEvent,
+          options: options
+        )
+      end
+
       # Deletes a model response with the given ID.
       #
       # @overload delete(response_id, request_options: {})

data/lib/openai/version.rb

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

data/lib/openai.rb

@@ -16,7 +16,9 @@ require "time"
 require "uri"
 # We already ship the preferred sorbet manifests in the package itself.
 # `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
-if Object.const_defined?(:Tapioca) && caller.chain([$PROGRAM_NAME]).chain(ARGV).grep(/tapioca/)
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
   return
 end
 

data/rbi/openai/models/responses/response_output_text.rbi

@@ -38,6 +38,21 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
+        sig do
+          returns(
+            T.nilable(T::Array[OpenAI::Responses::ResponseOutputText::Logprob])
+          )
+        end
+        attr_reader :logprobs
+
+        sig do
+          params(
+            logprobs:
+              T::Array[OpenAI::Responses::ResponseOutputText::Logprob::OrHash]
+          ).void
+        end
+        attr_writer :logprobs
+
         # A text output from the model.
         sig do
           params(
@@ -50,6 +65,8 @@ module OpenAI
                 )
               ],
             text: String,
+            logprobs:
+              T::Array[OpenAI::Responses::ResponseOutputText::Logprob::OrHash],
             type: Symbol
           ).returns(T.attached_class)
         end
@@ -58,6 +75,7 @@ module OpenAI
           annotations:,
           # The text output from the model.
           text:,
+          logprobs: nil,
           # The type of the output text. Always `output_text`.
           type: :output_text
         )
@@ -75,7 +93,8 @@ module OpenAI
                   )
                 ],
               text: String,
-              type: Symbol
+              type: Symbol,
+              logprobs: T::Array[OpenAI::Responses::ResponseOutputText::Logprob]
             }
           )
         end
@@ -265,6 +284,103 @@ module OpenAI
           def self.variants
           end
         end
+
+        class Logprob < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Responses::ResponseOutputText::Logprob,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :token
+
+          sig { returns(T::Array[Integer]) }
+          attr_accessor :bytes
+
+          sig { returns(Float) }
+          attr_accessor :logprob
+
+          sig do
+            returns(
+              T::Array[
+                OpenAI::Responses::ResponseOutputText::Logprob::TopLogprob
+              ]
+            )
+          end
+          attr_accessor :top_logprobs
+
+          # The log probability of a token.
+          sig do
+            params(
+              token: String,
+              bytes: T::Array[Integer],
+              logprob: Float,
+              top_logprobs:
+                T::Array[
+                  OpenAI::Responses::ResponseOutputText::Logprob::TopLogprob::OrHash
+                ]
+            ).returns(T.attached_class)
+          end
+          def self.new(token:, bytes:, logprob:, top_logprobs:)
+          end
+
+          sig do
+            override.returns(
+              {
+                token: String,
+                bytes: T::Array[Integer],
+                logprob: Float,
+                top_logprobs:
+                  T::Array[
+                    OpenAI::Responses::ResponseOutputText::Logprob::TopLogprob
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class TopLogprob < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseOutputText::Logprob::TopLogprob,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :token
+
+            sig { returns(T::Array[Integer]) }
+            attr_accessor :bytes
+
+            sig { returns(Float) }
+            attr_accessor :logprob
+
+            # The top log probability of a token.
+            sig do
+              params(
+                token: String,
+                bytes: T::Array[Integer],
+                logprob: Float
+              ).returns(T.attached_class)
+            end
+            def self.new(token:, bytes:, logprob:)
+            end
+
+            sig do
+              override.returns(
+                { token: String, bytes: T::Array[Integer], logprob: Float }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
       end
     end
   end

data/rbi/openai/models/responses/response_retrieve_params.rbi

@@ -31,9 +31,17 @@ module OpenAI
         end
         attr_writer :include
 
+        # The sequence number of the event after which to start streaming.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :starting_after
+
+        sig { params(starting_after: Integer).void }
+        attr_writer :starting_after
+
         sig do
           params(
             include: T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol],
+            starting_after: Integer,
             request_options: OpenAI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -41,6 +49,8 @@ module OpenAI
           # Additional fields to include in the response. See the `include` parameter for
           # Response creation above for more information.
           include: nil,
+          # The sequence number of the event after which to start streaming.
+          starting_after: nil,
           request_options: {}
         )
         end
@@ -50,6 +60,7 @@ module OpenAI
             {
               include:
                 T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol],
+              starting_after: Integer,
               request_options: OpenAI::RequestOptions
             }
           )

data/rbi/openai/resources/containers/files/content.rbi

@@ -11,7 +11,7 @@ module OpenAI
               file_id: String,
               container_id: String,
               request_options: OpenAI::RequestOptions::OrHash
-            ).void
+            ).returns(StringIO)
           end
           def retrieve(file_id, container_id:, request_options: {})
           end

data/rbi/openai/resources/responses.rbi

@@ -428,11 +428,15 @@ module OpenAI
       )
       end
 
+      # See {OpenAI::Resources::Responses#retrieve_streaming} for streaming counterpart.
+      #
       # Retrieves a model response with the given ID.
       sig do
         params(
           response_id: String,
           include: T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol],
+          starting_after: Integer,
+          stream: T.noreturn,
           request_options: OpenAI::RequestOptions::OrHash
         ).returns(OpenAI::Responses::Response)
       end
@@ -442,6 +446,42 @@ module OpenAI
         # Additional fields to include in the response. See the `include` parameter for
         # Response creation above for more information.
         include: nil,
+        # The sequence number of the event after which to start streaming.
+        starting_after: nil,
+        # There is no need to provide `stream:`. Instead, use `#retrieve_streaming` or
+        # `#retrieve` for streaming and non-streaming use cases, respectively.
+        stream: false,
+        request_options: {}
+      )
+      end
+
+      # See {OpenAI::Resources::Responses#retrieve} for non-streaming counterpart.
+      #
+      # Retrieves a model response with the given ID.
+      sig do
+        params(
+          response_id: String,
+          include: T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol],
+          starting_after: Integer,
+          stream: T.noreturn,
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(
+          OpenAI::Internal::Stream[
+            OpenAI::Responses::ResponseStreamEvent::Variants
+          ]
+        )
+      end
+      def retrieve_streaming(
+        # The ID of the response to retrieve.
+        response_id,
+        # Additional fields to include in the response. See the `include` parameter for
+        # Response creation above for more information.
+        include: nil,
+        # The sequence number of the event after which to start streaming.
+        starting_after: nil,
+        # There is no need to provide `stream:`. Instead, use `#retrieve_streaming` or
+        # `#retrieve` for streaming and non-streaming use cases, respectively.
+        stream: true,
         request_options: {}
       )
       end

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

@@ -5,7 +5,8 @@ module OpenAI
         {
           annotations: ::Array[OpenAI::Models::Responses::ResponseOutputText::annotation],
           text: String,
-          type: :output_text
+          type: :output_text,
+          logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob]
         }
 
       class ResponseOutputText < OpenAI::Internal::Type::BaseModel
@@ -15,16 +16,24 @@ module OpenAI
 
         attr_accessor type: :output_text
 
+        attr_reader logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob]?
+
+        def logprobs=: (
+          ::Array[OpenAI::Responses::ResponseOutputText::Logprob]
+        ) -> ::Array[OpenAI::Responses::ResponseOutputText::Logprob]
+
         def initialize: (
           annotations: ::Array[OpenAI::Models::Responses::ResponseOutputText::annotation],
           text: String,
+          ?logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob],
           ?type: :output_text
         ) -> void
 
         def to_hash: -> {
           annotations: ::Array[OpenAI::Models::Responses::ResponseOutputText::annotation],
           text: String,
-          type: :output_text
+          type: :output_text,
+          logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob]
         }
 
         type annotation =
@@ -119,6 +128,61 @@ module OpenAI
 
           def self?.variants: -> ::Array[OpenAI::Models::Responses::ResponseOutputText::annotation]
         end
+
+        type logprob =
+          {
+            token: String,
+            bytes: ::Array[Integer],
+            logprob: Float,
+            top_logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob::TopLogprob]
+          }
+
+        class Logprob < OpenAI::Internal::Type::BaseModel
+          attr_accessor token: String
+
+          attr_accessor bytes: ::Array[Integer]
+
+          attr_accessor logprob: Float
+
+          attr_accessor top_logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob::TopLogprob]
+
+          def initialize: (
+            token: String,
+            bytes: ::Array[Integer],
+            logprob: Float,
+            top_logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob::TopLogprob]
+          ) -> void
+
+          def to_hash: -> {
+            token: String,
+            bytes: ::Array[Integer],
+            logprob: Float,
+            top_logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob::TopLogprob]
+          }
+
+          type top_logprob =
+            { token: String, bytes: ::Array[Integer], logprob: Float }
+
+          class TopLogprob < OpenAI::Internal::Type::BaseModel
+            attr_accessor token: String
+
+            attr_accessor bytes: ::Array[Integer]
+
+            attr_accessor logprob: Float
+
+            def initialize: (
+              token: String,
+              bytes: ::Array[Integer],
+              logprob: Float
+            ) -> void
+
+            def to_hash: -> {
+              token: String,
+              bytes: ::Array[Integer],
+              logprob: Float
+            }
+          end
+        end
       end
     end
   end

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

@@ -2,7 +2,10 @@ module OpenAI
   module Models
     module Responses
       type response_retrieve_params =
-        { include: ::Array[OpenAI::Models::Responses::response_includable] }
+        {
+          include: ::Array[OpenAI::Models::Responses::response_includable],
+          starting_after: Integer
+        }
         & OpenAI::Internal::Type::request_parameters
 
       class ResponseRetrieveParams < OpenAI::Internal::Type::BaseModel
@@ -15,13 +18,19 @@ module OpenAI
           ::Array[OpenAI::Models::Responses::response_includable]
         ) -> ::Array[OpenAI::Models::Responses::response_includable]
 
+        attr_reader starting_after: Integer?
+
+        def starting_after=: (Integer) -> Integer
+
         def initialize: (
           ?include: ::Array[OpenAI::Models::Responses::response_includable],
+          ?starting_after: Integer,
           ?request_options: OpenAI::request_opts
         ) -> void
 
         def to_hash: -> {
           include: ::Array[OpenAI::Models::Responses::response_includable],
+          starting_after: Integer,
           request_options: OpenAI::RequestOptions
         }
       end

data/sig/openai/resources/containers/files/content.rbs

@@ -7,7 +7,7 @@ module OpenAI
             String file_id,
             container_id: String,
             ?request_options: OpenAI::request_opts
-          ) -> nil
+          ) -> StringIO
 
           def initialize: (client: OpenAI::Client) -> void
         end

data/sig/openai/resources/responses.rbs

@@ -52,9 +52,17 @@ module OpenAI
       def retrieve: (
         String response_id,
         ?include: ::Array[OpenAI::Models::Responses::response_includable],
+        ?starting_after: Integer,
         ?request_options: OpenAI::request_opts
       ) -> OpenAI::Responses::Response
 
+      def retrieve_streaming: (
+        String response_id,
+        ?include: ::Array[OpenAI::Models::Responses::response_includable],
+        ?starting_after: Integer,
+        ?request_options: OpenAI::request_opts
+      ) -> OpenAI::Internal::Stream[OpenAI::Models::Responses::response_stream_event]
+
       def delete: (
         String response_id,
         ?request_options: OpenAI::request_opts

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openai
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - OpenAI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-23 00:00:00.000000000 Z
+date: 2025-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool