openai 0.4.1 → 0.5.1

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/chat/completions.rbi

@@ -235,9 +235,9 @@ module OpenAI
           #   utilize scale tier credits until they are exhausted.
           # - If set to 'auto', and the Project is not Scale tier enabled, the request will
           #   be processed using the default service tier with a lower uptime SLA and no
-          #   latency guarentee.
+          #   latency guarantee.
           # - If set to 'default', the request will be processed using the default service
-          #   tier with a lower uptime SLA and no latency guarentee.
+          #   tier with a lower uptime SLA and no latency guarantee.
           # - If set to 'flex', the request will be processed with the Flex Processing
           #   service tier.
           #   [Learn more](https://platform.openai.com/docs/guides/flex-processing).
@@ -522,9 +522,9 @@ module OpenAI
           #   utilize scale tier credits until they are exhausted.
           # - If set to 'auto', and the Project is not Scale tier enabled, the request will
           #   be processed using the default service tier with a lower uptime SLA and no
-          #   latency guarentee.
+          #   latency guarantee.
           # - If set to 'default', the request will be processed using the default service
-          #   tier with a lower uptime SLA and no latency guarentee.
+          #   tier with a lower uptime SLA and no latency guarantee.
           # - If set to 'flex', the request will be processed with the Flex Processing
           #   service tier.
           #   [Learn more](https://platform.openai.com/docs/guides/flex-processing).

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/fine_tuning/alpha/graders.rbi

@@ -17,18 +17,23 @@ module OpenAI
                   OpenAI::Graders::MultiGrader::OrHash
                 ),
               model_sample: String,
-              reference_answer:
-                OpenAI::FineTuning::Alpha::GraderRunParams::ReferenceAnswer::Variants,
+              item: T.anything,
               request_options: OpenAI::RequestOptions::OrHash
             ).returns(OpenAI::Models::FineTuning::Alpha::GraderRunResponse)
           end
           def run(
             # The grader used for the fine-tuning job.
             grader:,
-            # The model sample to be evaluated.
+            # The model sample to be evaluated. This value will be used to populate the
+            # `sample` namespace. See
+            # [the guide](https://platform.openai.com/docs/guides/graders) for more details.
+            # The `output_json` variable will be populated if the model sample is a valid JSON
+            # string.
             model_sample:,
-            # The reference answer for the evaluation.
-            reference_answer:,
+            # The dataset item provided to the grader. This will be used to populate the
+            # `item` namespace. See
+            # [the guide](https://platform.openai.com/docs/guides/graders) for more details.
+            item: nil,
             request_options: {}
           )
           end

data/rbi/openai/resources/images.rbi

@@ -64,7 +64,7 @@ module OpenAI
         # The image(s) to edit. Must be a supported image file or an array of images.
         #
         # For `gpt-image-1`, each image should be a `png`, `webp`, or `jpg` file less than
-        # 25MB. You can provide up to 16 images.
+        # 50MB. You can provide up to 16 images.
         #
         # For `dall-e-2`, you can only provide one image, and it should be a square `png`
         # file less than 4MB.

data/rbi/openai/resources/responses.rbi

@@ -112,6 +112,8 @@ module OpenAI
         #   multi-turn conversations when using the Responses API statelessly (like when
         #   the `store` parameter is set to `false`, or when an organization is enrolled
         #   in the zero data retention program).
+        # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
+        #   in code interpreter tool call items.
         include: nil,
         # Inserts a system (or developer) message as the first item in the model's
         # context.
@@ -149,9 +151,9 @@ module OpenAI
         #   utilize scale tier credits until they are exhausted.
         # - If set to 'auto', and the Project is not Scale tier enabled, the request will
         #   be processed using the default service tier with a lower uptime SLA and no
-        #   latency guarentee.
+        #   latency guarantee.
         # - If set to 'default', the request will be processed using the default service
-        #   tier with a lower uptime SLA and no latency guarentee.
+        #   tier with a lower uptime SLA and no latency guarantee.
         # - If set to 'flex', the request will be processed with the Flex Processing
         #   service tier.
         #   [Learn more](https://platform.openai.com/docs/guides/flex-processing).
@@ -323,6 +325,8 @@ module OpenAI
         #   multi-turn conversations when using the Responses API statelessly (like when
         #   the `store` parameter is set to `false`, or when an organization is enrolled
         #   in the zero data retention program).
+        # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
+        #   in code interpreter tool call items.
         include: nil,
         # Inserts a system (or developer) message as the first item in the model's
         # context.
@@ -360,9 +364,9 @@ module OpenAI
         #   utilize scale tier credits until they are exhausted.
         # - If set to 'auto', and the Project is not Scale tier enabled, the request will
         #   be processed using the default service tier with a lower uptime SLA and no
-        #   latency guarentee.
+        #   latency guarantee.
         # - If set to 'default', the request will be processed using the default service
-        #   tier with a lower uptime SLA and no latency guarentee.
+        #   tier with a lower uptime SLA and no latency guarantee.
         # - If set to 'flex', the request will be processed with the Flex Processing
         #   service tier.
         #   [Learn more](https://platform.openai.com/docs/guides/flex-processing).
@@ -428,11 +432,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 +450,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
@@ -467,7 +511,7 @@ module OpenAI
         params(
           response_id: String,
           request_options: OpenAI::RequestOptions::OrHash
-        ).void
+        ).returns(OpenAI::Responses::Response)
       end
       def cancel(
         # The ID of the response to cancel.

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

@@ -31,16 +31,17 @@ module OpenAI
           logprobs: ::Array[OpenAI::Audio::TranscriptionTextDeltaEvent::Logprob]
         }
 
-        type logprob = { token: String, bytes: ::Array[top], logprob: Float }
+        type logprob =
+          { token: String, bytes: ::Array[Integer], logprob: Float }
 
         class Logprob < OpenAI::Internal::Type::BaseModel
           attr_reader token: String?
 
           def token=: (String) -> String
 
-          attr_reader bytes: ::Array[top]?
+          attr_reader bytes: ::Array[Integer]?
 
-          def bytes=: (::Array[top]) -> ::Array[top]
+          def bytes=: (::Array[Integer]) -> ::Array[Integer]
 
           attr_reader logprob: Float?
 
@@ -48,11 +49,15 @@ module OpenAI
 
           def initialize: (
             ?token: String,
-            ?bytes: ::Array[top],
+            ?bytes: ::Array[Integer],
             ?logprob: Float
           ) -> void
 
-          def to_hash: -> { token: String, bytes: ::Array[top], logprob: Float }
+          def to_hash: -> {
+            token: String,
+            bytes: ::Array[Integer],
+            logprob: Float
+          }
         end
       end
     end

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

@@ -31,16 +31,17 @@ module OpenAI
           logprobs: ::Array[OpenAI::Audio::TranscriptionTextDoneEvent::Logprob]
         }
 
-        type logprob = { token: String, bytes: ::Array[top], logprob: Float }
+        type logprob =
+          { token: String, bytes: ::Array[Integer], logprob: Float }
 
         class Logprob < OpenAI::Internal::Type::BaseModel
           attr_reader token: String?
 
           def token=: (String) -> String
 
-          attr_reader bytes: ::Array[top]?
+          attr_reader bytes: ::Array[Integer]?
 
-          def bytes=: (::Array[top]) -> ::Array[top]
+          def bytes=: (::Array[Integer]) -> ::Array[Integer]
 
           attr_reader logprob: Float?
 
@@ -48,11 +49,15 @@ module OpenAI
 
           def initialize: (
             ?token: String,
-            ?bytes: ::Array[top],
+            ?bytes: ::Array[Integer],
             ?logprob: Float
           ) -> void
 
-          def to_hash: -> { token: String, bytes: ::Array[top], logprob: Float }
+          def to_hash: -> {
+            token: String,
+            bytes: ::Array[Integer],
+            logprob: Float
+          }
         end
       end
     end

data/sig/openai/models/fine_tuning/alpha/grader_run_params.rbs

@@ -6,7 +6,7 @@ module OpenAI
           {
             grader: OpenAI::Models::FineTuning::Alpha::GraderRunParams::grader,
             model_sample: String,
-            reference_answer: OpenAI::Models::FineTuning::Alpha::GraderRunParams::reference_answer
+            item: top
           }
           & OpenAI::Internal::Type::request_parameters
 
@@ -18,19 +18,21 @@ module OpenAI
 
           attr_accessor model_sample: String
 
-          attr_accessor reference_answer: OpenAI::Models::FineTuning::Alpha::GraderRunParams::reference_answer
+          attr_reader item: top?
+
+          def item=: (top) -> top
 
           def initialize: (
             grader: OpenAI::Models::FineTuning::Alpha::GraderRunParams::grader,
             model_sample: String,
-            reference_answer: OpenAI::Models::FineTuning::Alpha::GraderRunParams::reference_answer,
+            ?item: top,
             ?request_options: OpenAI::request_opts
           ) -> void
 
           def to_hash: -> {
             grader: OpenAI::Models::FineTuning::Alpha::GraderRunParams::grader,
             model_sample: String,
-            reference_answer: OpenAI::Models::FineTuning::Alpha::GraderRunParams::reference_answer,
+            item: top,
             request_options: OpenAI::RequestOptions
           }
 
@@ -46,16 +48,6 @@ module OpenAI
 
             def self?.variants: -> ::Array[OpenAI::Models::FineTuning::Alpha::GraderRunParams::grader]
           end
-
-          type reference_answer = String | top | ::Array[top] | Float
-
-          module ReferenceAnswer
-            extend OpenAI::Internal::Type::Union
-
-            def self?.variants: -> ::Array[OpenAI::Models::FineTuning::Alpha::GraderRunParams::reference_answer]
-
-            UnionMember2Array: OpenAI::Internal::Type::Converter
-          end
         end
       end
     end

data/sig/openai/models/fine_tuning/fine_tuning_job.rbs

@@ -165,7 +165,7 @@ module OpenAI
             n_epochs: OpenAI::Models::FineTuning::FineTuningJob::Hyperparameters::n_epochs
           }
 
-          type batch_size = (top | :auto | Integer)?
+          type batch_size = :auto | Integer
 
           module BatchSize
             extend OpenAI::Internal::Type::Union

data/sig/openai/models/graders/multi_grader.rbs

@@ -6,7 +6,7 @@ module OpenAI
       type multi_grader =
         {
           calculate_output: String,
-          graders: ::Hash[Symbol, OpenAI::Models::Graders::MultiGrader::grader],
+          graders: OpenAI::Models::Graders::MultiGrader::graders,
           name: String,
           type: :multi
         }
@@ -14,7 +14,7 @@ module OpenAI
       class MultiGrader < OpenAI::Internal::Type::BaseModel
         attr_accessor calculate_output: String
 
-        attr_accessor graders: ::Hash[Symbol, OpenAI::Models::Graders::MultiGrader::grader]
+        attr_accessor graders: OpenAI::Models::Graders::MultiGrader::graders
 
         attr_accessor name: String
 
@@ -22,29 +22,29 @@ module OpenAI
 
         def initialize: (
           calculate_output: String,
-          graders: ::Hash[Symbol, OpenAI::Models::Graders::MultiGrader::grader],
+          graders: OpenAI::Models::Graders::MultiGrader::graders,
           name: String,
           ?type: :multi
         ) -> void
 
         def to_hash: -> {
           calculate_output: String,
-          graders: ::Hash[Symbol, OpenAI::Models::Graders::MultiGrader::grader],
+          graders: OpenAI::Models::Graders::MultiGrader::graders,
           name: String,
           type: :multi
         }
 
-        type grader =
+        type graders =
           OpenAI::Graders::StringCheckGrader
           | OpenAI::Graders::TextSimilarityGrader
           | OpenAI::Graders::PythonGrader
           | OpenAI::Graders::ScoreModelGrader
           | OpenAI::Graders::LabelModelGrader
 
-        module Grader
+        module Graders
           extend OpenAI::Internal::Type::Union
 
-          def self?.variants: -> ::Array[OpenAI::Models::Graders::MultiGrader::grader]
+          def self?.variants: -> ::Array[OpenAI::Models::Graders::MultiGrader::graders]
         end
       end
     end

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

@@ -6,7 +6,7 @@ module OpenAI
           delta: String,
           output_index: Integer,
           sequence_number: Integer,
-          type: :"response.code_interpreter_call.code.delta"
+          type: :"response.code_interpreter_call_code.delta"
         }
 
       class ResponseCodeInterpreterCallCodeDeltaEvent < OpenAI::Internal::Type::BaseModel
@@ -16,20 +16,20 @@ module OpenAI
 
         attr_accessor sequence_number: Integer
 
-        attr_accessor type: :"response.code_interpreter_call.code.delta"
+        attr_accessor type: :"response.code_interpreter_call_code.delta"
 
         def initialize: (
           delta: String,
           output_index: Integer,
           sequence_number: Integer,
-          ?type: :"response.code_interpreter_call.code.delta"
+          ?type: :"response.code_interpreter_call_code.delta"
         ) -> void
 
         def to_hash: -> {
           delta: String,
           output_index: Integer,
           sequence_number: Integer,
-          type: :"response.code_interpreter_call.code.delta"
+          type: :"response.code_interpreter_call_code.delta"
         }
       end
     end

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

@@ -6,7 +6,7 @@ module OpenAI
           code: String,
           output_index: Integer,
           sequence_number: Integer,
-          type: :"response.code_interpreter_call.code.done"
+          type: :"response.code_interpreter_call_code.done"
         }
 
       class ResponseCodeInterpreterCallCodeDoneEvent < OpenAI::Internal::Type::BaseModel
@@ -16,20 +16,20 @@ module OpenAI
 
         attr_accessor sequence_number: Integer
 
-        attr_accessor type: :"response.code_interpreter_call.code.done"
+        attr_accessor type: :"response.code_interpreter_call_code.done"
 
         def initialize: (
           code: String,
           output_index: Integer,
           sequence_number: Integer,
-          ?type: :"response.code_interpreter_call.code.done"
+          ?type: :"response.code_interpreter_call_code.done"
         ) -> void
 
         def to_hash: -> {
           code: String,
           output_index: Integer,
           sequence_number: Integer,
-          type: :"response.code_interpreter_call.code.done"
+          type: :"response.code_interpreter_call_code.done"
         }
       end
     end

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

@@ -6,6 +6,7 @@ module OpenAI
         | :"message.input_image.image_url"
         | :"computer_call_output.output.image_url"
         | :"reasoning.encrypted_content"
+        | :"code_interpreter_call.outputs"
 
       module ResponseIncludable
         extend OpenAI::Internal::Type::Enum
@@ -14,6 +15,7 @@ module OpenAI
         MESSAGE_INPUT_IMAGE_IMAGE_URL: :"message.input_image.image_url"
         COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL: :"computer_call_output.output.image_url"
         REASONING_ENCRYPTED_CONTENT: :"reasoning.encrypted_content"
+        CODE_INTERPRETER_CALL_OUTPUTS: :"code_interpreter_call.outputs"
 
         def self?.values: -> ::Array[OpenAI::Models::Responses::response_includable]
       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,21 +16,30 @@ 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 =
           OpenAI::Responses::ResponseOutputText::Annotation::FileCitation
           | OpenAI::Responses::ResponseOutputText::Annotation::URLCitation
+          | OpenAI::Responses::ResponseOutputText::Annotation::ContainerFileCitation
           | OpenAI::Responses::ResponseOutputText::Annotation::FilePath
 
         module Annotation
@@ -95,6 +105,43 @@ module OpenAI
             }
           end
 
+          type container_file_citation =
+            {
+              container_id: String,
+              end_index: Integer,
+              file_id: String,
+              start_index: Integer,
+              type: :container_file_citation
+            }
+
+          class ContainerFileCitation < OpenAI::Internal::Type::BaseModel
+            attr_accessor container_id: String
+
+            attr_accessor end_index: Integer
+
+            attr_accessor file_id: String
+
+            attr_accessor start_index: Integer
+
+            attr_accessor type: :container_file_citation
+
+            def initialize: (
+              container_id: String,
+              end_index: Integer,
+              file_id: String,
+              start_index: Integer,
+              ?type: :container_file_citation
+            ) -> void
+
+            def to_hash: -> {
+              container_id: String,
+              end_index: Integer,
+              file_id: String,
+              start_index: Integer,
+              type: :container_file_citation
+            }
+          end
+
           type file_path = { file_id: String, index: Integer, type: :file_path }
 
           class FilePath < OpenAI::Internal::Type::BaseModel
@@ -119,6 +166,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