openai 0.4.1 → 0.5.1

data/rbi/openai/models/fine_tuning/alpha/grader_run_params.rbi

@@ -30,17 +30,22 @@ module OpenAI
           end
           attr_accessor :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.
           sig { returns(String) }
           attr_accessor :model_sample
 
-          # The reference answer for the evaluation.
-          sig do
-            returns(
-              OpenAI::FineTuning::Alpha::GraderRunParams::ReferenceAnswer::Variants
-            )
-          end
-          attr_accessor :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.
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :item
+
+          sig { params(item: T.anything).void }
+          attr_writer :item
 
           sig do
             params(
@@ -53,18 +58,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(T.attached_class)
           end
           def self.new(
             # 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
@@ -81,8 +91,7 @@ module OpenAI
                     OpenAI::Graders::MultiGrader
                   ),
                 model_sample: String,
-                reference_answer:
-                  OpenAI::FineTuning::Alpha::GraderRunParams::ReferenceAnswer::Variants,
+                item: T.anything,
                 request_options: OpenAI::RequestOptions
               }
             )
@@ -115,34 +124,6 @@ module OpenAI
             def self.variants
             end
           end
-
-          # The reference answer for the evaluation.
-          module ReferenceAnswer
-            extend OpenAI::Internal::Type::Union
-
-            Variants =
-              T.type_alias do
-                T.any(String, T.anything, T::Array[T.anything], Float)
-              end
-
-            sig do
-              override.returns(
-                T::Array[
-                  OpenAI::FineTuning::Alpha::GraderRunParams::ReferenceAnswer::Variants
-                ]
-              )
-            end
-            def self.variants
-            end
-
-            UnionMember2Array =
-              T.let(
-                OpenAI::Internal::Type::ArrayOf[
-                  OpenAI::Internal::Type::Unknown
-                ],
-                OpenAI::Internal::Type::Converter
-              )
-          end
         end
       end
     end

data/rbi/openai/models/fine_tuning/fine_tuning_job.rbi

@@ -359,7 +359,7 @@ module OpenAI
           # returned when running `supervised` jobs.
           sig do
             params(
-              batch_size: T.nilable(T.any(T.anything, Symbol, Integer)),
+              batch_size: T.nilable(T.any(Symbol, Integer)),
               learning_rate_multiplier: T.any(Symbol, Float),
               n_epochs: T.any(Symbol, Integer)
             ).returns(T.attached_class)
@@ -399,8 +399,7 @@ module OpenAI
           module BatchSize
             extend OpenAI::Internal::Type::Union
 
-            Variants =
-              T.type_alias { T.nilable(T.any(T.anything, Symbol, Integer)) }
+            Variants = T.type_alias { T.any(Symbol, Integer) }
 
             sig do
               override.returns(

data/rbi/openai/models/graders/multi_grader.rbi

@@ -15,18 +15,17 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :calculate_output
 
+        # A StringCheckGrader object that performs a string comparison between input and
+        # reference using a specified operation.
         sig do
           returns(
-            T::Hash[
-              Symbol,
-              T.any(
-                OpenAI::Graders::StringCheckGrader,
-                OpenAI::Graders::TextSimilarityGrader,
-                OpenAI::Graders::PythonGrader,
-                OpenAI::Graders::ScoreModelGrader,
-                OpenAI::Graders::LabelModelGrader
-              )
-            ]
+            T.any(
+              OpenAI::Graders::StringCheckGrader,
+              OpenAI::Graders::TextSimilarityGrader,
+              OpenAI::Graders::PythonGrader,
+              OpenAI::Graders::ScoreModelGrader,
+              OpenAI::Graders::LabelModelGrader
+            )
           )
         end
         attr_accessor :graders
@@ -45,16 +44,13 @@ module OpenAI
           params(
             calculate_output: String,
             graders:
-              T::Hash[
-                Symbol,
-                T.any(
-                  OpenAI::Graders::StringCheckGrader::OrHash,
-                  OpenAI::Graders::TextSimilarityGrader::OrHash,
-                  OpenAI::Graders::PythonGrader::OrHash,
-                  OpenAI::Graders::ScoreModelGrader::OrHash,
-                  OpenAI::Graders::LabelModelGrader::OrHash
-                )
-              ],
+              T.any(
+                OpenAI::Graders::StringCheckGrader::OrHash,
+                OpenAI::Graders::TextSimilarityGrader::OrHash,
+                OpenAI::Graders::PythonGrader::OrHash,
+                OpenAI::Graders::ScoreModelGrader::OrHash,
+                OpenAI::Graders::LabelModelGrader::OrHash
+              ),
             name: String,
             type: Symbol
           ).returns(T.attached_class)
@@ -62,6 +58,8 @@ module OpenAI
         def self.new(
           # A formula to calculate the output based on grader results.
           calculate_output:,
+          # A StringCheckGrader object that performs a string comparison between input and
+          # reference using a specified operation.
           graders:,
           # The name of the grader.
           name:,
@@ -75,16 +73,13 @@ module OpenAI
             {
               calculate_output: String,
               graders:
-                T::Hash[
-                  Symbol,
-                  T.any(
-                    OpenAI::Graders::StringCheckGrader,
-                    OpenAI::Graders::TextSimilarityGrader,
-                    OpenAI::Graders::PythonGrader,
-                    OpenAI::Graders::ScoreModelGrader,
-                    OpenAI::Graders::LabelModelGrader
-                  )
-                ],
+                T.any(
+                  OpenAI::Graders::StringCheckGrader,
+                  OpenAI::Graders::TextSimilarityGrader,
+                  OpenAI::Graders::PythonGrader,
+                  OpenAI::Graders::ScoreModelGrader,
+                  OpenAI::Graders::LabelModelGrader
+                ),
               name: String,
               type: Symbol
             }
@@ -95,7 +90,7 @@ module OpenAI
 
         # A StringCheckGrader object that performs a string comparison between input and
         # reference using a specified operation.
-        module Grader
+        module Graders
           extend OpenAI::Internal::Type::Union
 
           Variants =
@@ -111,7 +106,7 @@ module OpenAI
 
           sig do
             override.returns(
-              T::Array[OpenAI::Graders::MultiGrader::Grader::Variants]
+              T::Array[OpenAI::Graders::MultiGrader::Graders::Variants]
             )
           end
           def self.variants

data/rbi/openai/models/image_edit_params.rbi

@@ -14,7 +14,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.
@@ -106,7 +106,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.
@@ -179,7 +179,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/models/responses/response.rbi

@@ -160,9 +160,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).
@@ -390,9 +390,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).
@@ -588,9 +588,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/models/responses/response_code_interpreter_call_code_delta_event.rbi

@@ -24,7 +24,7 @@ module OpenAI
         sig { returns(Integer) }
         attr_accessor :sequence_number
 
-        # The type of the event. Always `response.code_interpreter_call.code.delta`.
+        # The type of the event. Always `response.code_interpreter_call_code.delta`.
         sig { returns(Symbol) }
         attr_accessor :type
 
@@ -44,8 +44,8 @@ module OpenAI
           output_index:,
           # The sequence number of this event.
           sequence_number:,
-          # The type of the event. Always `response.code_interpreter_call.code.delta`.
-          type: :"response.code_interpreter_call.code.delta"
+          # The type of the event. Always `response.code_interpreter_call_code.delta`.
+          type: :"response.code_interpreter_call_code.delta"
         )
         end
 

data/rbi/openai/models/responses/response_code_interpreter_call_code_done_event.rbi

@@ -24,7 +24,7 @@ module OpenAI
         sig { returns(Integer) }
         attr_accessor :sequence_number
 
-        # The type of the event. Always `response.code_interpreter_call.code.done`.
+        # The type of the event. Always `response.code_interpreter_call_code.done`.
         sig { returns(Symbol) }
         attr_accessor :type
 
@@ -44,8 +44,8 @@ module OpenAI
           output_index:,
           # The sequence number of this event.
           sequence_number:,
-          # The type of the event. Always `response.code_interpreter_call.code.done`.
-          type: :"response.code_interpreter_call.code.done"
+          # The type of the event. Always `response.code_interpreter_call_code.done`.
+          type: :"response.code_interpreter_call_code.done"
         )
         end
 

data/rbi/openai/models/responses/response_create_params.rbi

@@ -63,6 +63,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.
         sig do
           returns(
             T.nilable(T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol])
@@ -121,9 +123,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).
@@ -372,6 +374,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.
@@ -409,9 +413,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).
@@ -570,9 +574,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/models/responses/response_includable.rbi

@@ -16,6 +16,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.
       module ResponseIncludable
         extend OpenAI::Internal::Type::Enum
 
@@ -43,6 +45,11 @@ module OpenAI
             :"reasoning.encrypted_content",
             OpenAI::Responses::ResponseIncludable::TaggedSymbol
           )
+        CODE_INTERPRETER_CALL_OUTPUTS =
+          T.let(
+            :"code_interpreter_call.outputs",
+            OpenAI::Responses::ResponseIncludable::TaggedSymbol
+          )
 
         sig do
           override.returns(

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

@@ -19,6 +19,7 @@ module OpenAI
               T.any(
                 OpenAI::Responses::ResponseOutputText::Annotation::FileCitation,
                 OpenAI::Responses::ResponseOutputText::Annotation::URLCitation,
+                OpenAI::Responses::ResponseOutputText::Annotation::ContainerFileCitation,
                 OpenAI::Responses::ResponseOutputText::Annotation::FilePath
               )
             ]
@@ -38,6 +39,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(
@@ -46,10 +62,13 @@ module OpenAI
                 T.any(
                   OpenAI::Responses::ResponseOutputText::Annotation::FileCitation::OrHash,
                   OpenAI::Responses::ResponseOutputText::Annotation::URLCitation::OrHash,
+                  OpenAI::Responses::ResponseOutputText::Annotation::ContainerFileCitation::OrHash,
                   OpenAI::Responses::ResponseOutputText::Annotation::FilePath::OrHash
                 )
               ],
             text: String,
+            logprobs:
+              T::Array[OpenAI::Responses::ResponseOutputText::Logprob::OrHash],
             type: Symbol
           ).returns(T.attached_class)
         end
@@ -58,6 +77,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
         )
@@ -71,11 +91,13 @@ module OpenAI
                   T.any(
                     OpenAI::Responses::ResponseOutputText::Annotation::FileCitation,
                     OpenAI::Responses::ResponseOutputText::Annotation::URLCitation,
+                    OpenAI::Responses::ResponseOutputText::Annotation::ContainerFileCitation,
                     OpenAI::Responses::ResponseOutputText::Annotation::FilePath
                   )
                 ],
               text: String,
-              type: Symbol
+              type: Symbol,
+              logprobs: T::Array[OpenAI::Responses::ResponseOutputText::Logprob]
             }
           )
         end
@@ -91,6 +113,7 @@ module OpenAI
               T.any(
                 OpenAI::Responses::ResponseOutputText::Annotation::FileCitation,
                 OpenAI::Responses::ResponseOutputText::Annotation::URLCitation,
+                OpenAI::Responses::ResponseOutputText::Annotation::ContainerFileCitation,
                 OpenAI::Responses::ResponseOutputText::Annotation::FilePath
               )
             end
@@ -209,6 +232,74 @@ module OpenAI
             end
           end
 
+          class ContainerFileCitation < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseOutputText::Annotation::ContainerFileCitation,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The ID of the container file.
+            sig { returns(String) }
+            attr_accessor :container_id
+
+            # The index of the last character of the container file citation in the message.
+            sig { returns(Integer) }
+            attr_accessor :end_index
+
+            # The ID of the file.
+            sig { returns(String) }
+            attr_accessor :file_id
+
+            # The index of the first character of the container file citation in the message.
+            sig { returns(Integer) }
+            attr_accessor :start_index
+
+            # The type of the container file citation. Always `container_file_citation`.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # A citation for a container file used to generate a model response.
+            sig do
+              params(
+                container_id: String,
+                end_index: Integer,
+                file_id: String,
+                start_index: Integer,
+                type: Symbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The ID of the container file.
+              container_id:,
+              # The index of the last character of the container file citation in the message.
+              end_index:,
+              # The ID of the file.
+              file_id:,
+              # The index of the first character of the container file citation in the message.
+              start_index:,
+              # The type of the container file citation. Always `container_file_citation`.
+              type: :container_file_citation
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  container_id: String,
+                  end_index: Integer,
+                  file_id: String,
+                  start_index: Integer,
+                  type: Symbol
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+
           class FilePath < OpenAI::Internal::Type::BaseModel
             OrHash =
               T.type_alias do
@@ -265,6 +356,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