feat(api): Config update for pakrym-stream-param

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 109
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-fc64d7c2c8f51f750813375356c3f3fdfc7fc1b1b34f19c20a5410279d445d37.yml
-openapi_spec_hash: 618285fc70199ee32b9ebe4bf72f7e4c
-config_hash: 3b590818075ca4b54949578b97494525
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-d4bcffecf0cdadf746faa6708ed1ec81fac451f9b857deabbab26f0a343b9314.yml
+openapi_spec_hash: 7c54a18b4381248bda7cc34c52142615
+config_hash: 2102e4b25bbcab5d32d5ffa5d34daa0c

lib/openai/models/responses/response_output_text.rb

@@ -31,13 +31,23 @@ class ResponseOutputText < OpenAI::Internal::Type::BaseModel
         #   @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 @@ class FilePath < OpenAI::Internal::Type::BaseModel
           # @!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

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 @@ class ResponseRetrieveParams < OpenAI::Internal::Type::BaseModel
         #   @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

lib/openai/resources/responses.rb

@@ -242,24 +242,32 @@ def stream_raw(params)
         )
       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]
       #
       # @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 @@ def retrieve(response_id, params = {})
         )
       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: {})

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

rbi/openai/models/responses/response_retrieve_params.rbi

@@ -31,16 +31,26 @@ 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
         def self.new(
           # 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
             }
           )