openai 0.8.0 → 0.10.0

data/rbi/openai/models/audio/transcription.rbi

@@ -28,12 +28,34 @@ module OpenAI
         end
         attr_writer :logprobs
 
+        # Token usage statistics for the request.
+        sig do
+          returns(T.nilable(OpenAI::Audio::Transcription::Usage::Variants))
+        end
+        attr_reader :usage
+
+        sig do
+          params(
+            usage:
+              T.any(
+                OpenAI::Audio::Transcription::Usage::Tokens::OrHash,
+                OpenAI::Audio::Transcription::Usage::Duration::OrHash
+              )
+          ).void
+        end
+        attr_writer :usage
+
         # Represents a transcription response returned by model, based on the provided
         # input.
         sig do
           params(
             text: String,
-            logprobs: T::Array[OpenAI::Audio::Transcription::Logprob::OrHash]
+            logprobs: T::Array[OpenAI::Audio::Transcription::Logprob::OrHash],
+            usage:
+              T.any(
+                OpenAI::Audio::Transcription::Usage::Tokens::OrHash,
+                OpenAI::Audio::Transcription::Usage::Duration::OrHash
+              )
           ).returns(T.attached_class)
         end
         def self.new(
@@ -42,7 +64,9 @@ module OpenAI
           # The log probabilities of the tokens in the transcription. Only returned with the
           # models `gpt-4o-transcribe` and `gpt-4o-mini-transcribe` if `logprobs` is added
           # to the `include` array.
-          logprobs: nil
+          logprobs: nil,
+          # Token usage statistics for the request.
+          usage: nil
         )
         end
 
@@ -50,7 +74,8 @@ module OpenAI
           override.returns(
             {
               text: String,
-              logprobs: T::Array[OpenAI::Audio::Transcription::Logprob]
+              logprobs: T::Array[OpenAI::Audio::Transcription::Logprob],
+              usage: OpenAI::Audio::Transcription::Usage::Variants
             }
           )
         end
@@ -112,6 +137,191 @@ module OpenAI
           def to_hash
           end
         end
+
+        # Token usage statistics for the request.
+        module Usage
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                OpenAI::Audio::Transcription::Usage::Tokens,
+                OpenAI::Audio::Transcription::Usage::Duration
+              )
+            end
+
+          class Tokens < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Audio::Transcription::Usage::Tokens,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Number of input tokens billed for this request.
+            sig { returns(Integer) }
+            attr_accessor :input_tokens
+
+            # Number of output tokens generated.
+            sig { returns(Integer) }
+            attr_accessor :output_tokens
+
+            # Total number of tokens used (input + output).
+            sig { returns(Integer) }
+            attr_accessor :total_tokens
+
+            # The type of the usage object. Always `tokens` for this variant.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # Details about the input tokens billed for this request.
+            sig do
+              returns(
+                T.nilable(
+                  OpenAI::Audio::Transcription::Usage::Tokens::InputTokenDetails
+                )
+              )
+            end
+            attr_reader :input_token_details
+
+            sig do
+              params(
+                input_token_details:
+                  OpenAI::Audio::Transcription::Usage::Tokens::InputTokenDetails::OrHash
+              ).void
+            end
+            attr_writer :input_token_details
+
+            # Usage statistics for models billed by token usage.
+            sig do
+              params(
+                input_tokens: Integer,
+                output_tokens: Integer,
+                total_tokens: Integer,
+                input_token_details:
+                  OpenAI::Audio::Transcription::Usage::Tokens::InputTokenDetails::OrHash,
+                type: Symbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Number of input tokens billed for this request.
+              input_tokens:,
+              # Number of output tokens generated.
+              output_tokens:,
+              # Total number of tokens used (input + output).
+              total_tokens:,
+              # Details about the input tokens billed for this request.
+              input_token_details: nil,
+              # The type of the usage object. Always `tokens` for this variant.
+              type: :tokens
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  input_tokens: Integer,
+                  output_tokens: Integer,
+                  total_tokens: Integer,
+                  type: Symbol,
+                  input_token_details:
+                    OpenAI::Audio::Transcription::Usage::Tokens::InputTokenDetails
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class InputTokenDetails < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Audio::Transcription::Usage::Tokens::InputTokenDetails,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # Number of audio tokens billed for this request.
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :audio_tokens
+
+              sig { params(audio_tokens: Integer).void }
+              attr_writer :audio_tokens
+
+              # Number of text tokens billed for this request.
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :text_tokens
+
+              sig { params(text_tokens: Integer).void }
+              attr_writer :text_tokens
+
+              # Details about the input tokens billed for this request.
+              sig do
+                params(audio_tokens: Integer, text_tokens: Integer).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                # Number of audio tokens billed for this request.
+                audio_tokens: nil,
+                # Number of text tokens billed for this request.
+                text_tokens: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  { audio_tokens: Integer, text_tokens: Integer }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+
+          class Duration < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Audio::Transcription::Usage::Duration,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Duration of the input audio in seconds.
+            sig { returns(Float) }
+            attr_accessor :duration
+
+            # The type of the usage object. Always `duration` for this variant.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # Usage statistics for models billed by audio input duration.
+            sig do
+              params(duration: Float, type: Symbol).returns(T.attached_class)
+            end
+            def self.new(
+              # Duration of the input audio in seconds.
+              duration:,
+              # The type of the usage object. Always `duration` for this variant.
+              type: :duration
+            )
+            end
+
+            sig { override.returns({ duration: Float, type: Symbol }) }
+            def to_hash
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[OpenAI::Audio::Transcription::Usage::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
       end
     end
   end

data/rbi/openai/models/audio/transcription_text_done_event.rbi

@@ -43,6 +43,19 @@ module OpenAI
         end
         attr_writer :logprobs
 
+        # Usage statistics for models billed by token usage.
+        sig do
+          returns(T.nilable(OpenAI::Audio::TranscriptionTextDoneEvent::Usage))
+        end
+        attr_reader :usage
+
+        sig do
+          params(
+            usage: OpenAI::Audio::TranscriptionTextDoneEvent::Usage::OrHash
+          ).void
+        end
+        attr_writer :usage
+
         # Emitted when the transcription is complete. Contains the complete transcription
         # text. Only emitted when you
         # [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription)
@@ -54,6 +67,7 @@ module OpenAI
               T::Array[
                 OpenAI::Audio::TranscriptionTextDoneEvent::Logprob::OrHash
               ],
+            usage: OpenAI::Audio::TranscriptionTextDoneEvent::Usage::OrHash,
             type: Symbol
           ).returns(T.attached_class)
         end
@@ -65,6 +79,8 @@ module OpenAI
           # [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription)
           # with the `include[]` parameter set to `logprobs`.
           logprobs: nil,
+          # Usage statistics for models billed by token usage.
+          usage: nil,
           # The type of the event. Always `transcript.text.done`.
           type: :"transcript.text.done"
         )
@@ -76,7 +92,8 @@ module OpenAI
               text: String,
               type: Symbol,
               logprobs:
-                T::Array[OpenAI::Audio::TranscriptionTextDoneEvent::Logprob]
+                T::Array[OpenAI::Audio::TranscriptionTextDoneEvent::Logprob],
+              usage: OpenAI::Audio::TranscriptionTextDoneEvent::Usage
             }
           )
         end
@@ -138,6 +155,134 @@ module OpenAI
           def to_hash
           end
         end
+
+        class Usage < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Audio::TranscriptionTextDoneEvent::Usage,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Number of input tokens billed for this request.
+          sig { returns(Integer) }
+          attr_accessor :input_tokens
+
+          # Number of output tokens generated.
+          sig { returns(Integer) }
+          attr_accessor :output_tokens
+
+          # Total number of tokens used (input + output).
+          sig { returns(Integer) }
+          attr_accessor :total_tokens
+
+          # The type of the usage object. Always `tokens` for this variant.
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # Details about the input tokens billed for this request.
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Audio::TranscriptionTextDoneEvent::Usage::InputTokenDetails
+              )
+            )
+          end
+          attr_reader :input_token_details
+
+          sig do
+            params(
+              input_token_details:
+                OpenAI::Audio::TranscriptionTextDoneEvent::Usage::InputTokenDetails::OrHash
+            ).void
+          end
+          attr_writer :input_token_details
+
+          # Usage statistics for models billed by token usage.
+          sig do
+            params(
+              input_tokens: Integer,
+              output_tokens: Integer,
+              total_tokens: Integer,
+              input_token_details:
+                OpenAI::Audio::TranscriptionTextDoneEvent::Usage::InputTokenDetails::OrHash,
+              type: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Number of input tokens billed for this request.
+            input_tokens:,
+            # Number of output tokens generated.
+            output_tokens:,
+            # Total number of tokens used (input + output).
+            total_tokens:,
+            # Details about the input tokens billed for this request.
+            input_token_details: nil,
+            # The type of the usage object. Always `tokens` for this variant.
+            type: :tokens
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                input_tokens: Integer,
+                output_tokens: Integer,
+                total_tokens: Integer,
+                type: Symbol,
+                input_token_details:
+                  OpenAI::Audio::TranscriptionTextDoneEvent::Usage::InputTokenDetails
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class InputTokenDetails < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Audio::TranscriptionTextDoneEvent::Usage::InputTokenDetails,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Number of audio tokens billed for this request.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :audio_tokens
+
+            sig { params(audio_tokens: Integer).void }
+            attr_writer :audio_tokens
+
+            # Number of text tokens billed for this request.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :text_tokens
+
+            sig { params(text_tokens: Integer).void }
+            attr_writer :text_tokens
+
+            # Details about the input tokens billed for this request.
+            sig do
+              params(audio_tokens: Integer, text_tokens: Integer).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # Number of audio tokens billed for this request.
+              audio_tokens: nil,
+              # Number of text tokens billed for this request.
+              text_tokens: nil
+            )
+            end
+
+            sig do
+              override.returns({ audio_tokens: Integer, text_tokens: Integer })
+            end
+            def to_hash
+            end
+          end
+        end
       end
     end
   end

data/rbi/openai/models/audio/transcription_verbose.rbi

@@ -37,6 +37,15 @@ module OpenAI
         end
         attr_writer :segments
 
+        # Usage statistics for models billed by audio input duration.
+        sig { returns(T.nilable(OpenAI::Audio::TranscriptionVerbose::Usage)) }
+        attr_reader :usage
+
+        sig do
+          params(usage: OpenAI::Audio::TranscriptionVerbose::Usage::OrHash).void
+        end
+        attr_writer :usage
+
         # Extracted words and their corresponding timestamps.
         sig { returns(T.nilable(T::Array[OpenAI::Audio::TranscriptionWord])) }
         attr_reader :words
@@ -54,6 +63,7 @@ module OpenAI
             language: String,
             text: String,
             segments: T::Array[OpenAI::Audio::TranscriptionSegment::OrHash],
+            usage: OpenAI::Audio::TranscriptionVerbose::Usage::OrHash,
             words: T::Array[OpenAI::Audio::TranscriptionWord::OrHash]
           ).returns(T.attached_class)
         end
@@ -66,6 +76,8 @@ module OpenAI
           text:,
           # Segments of the transcribed text and their corresponding details.
           segments: nil,
+          # Usage statistics for models billed by audio input duration.
+          usage: nil,
           # Extracted words and their corresponding timestamps.
           words: nil
         )
@@ -78,12 +90,47 @@ module OpenAI
               language: String,
               text: String,
               segments: T::Array[OpenAI::Audio::TranscriptionSegment],
+              usage: OpenAI::Audio::TranscriptionVerbose::Usage,
               words: T::Array[OpenAI::Audio::TranscriptionWord]
             }
           )
         end
         def to_hash
         end
+
+        class Usage < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Audio::TranscriptionVerbose::Usage,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Duration of the input audio in seconds.
+          sig { returns(Float) }
+          attr_accessor :duration
+
+          # The type of the usage object. Always `duration` for this variant.
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # Usage statistics for models billed by audio input duration.
+          sig do
+            params(duration: Float, type: Symbol).returns(T.attached_class)
+          end
+          def self.new(
+            # Duration of the input audio in seconds.
+            duration:,
+            # The type of the usage object. Always `duration` for this variant.
+            type: :duration
+          )
+          end
+
+          sig { override.returns({ duration: Float, type: Symbol }) }
+          def to_hash
+          end
+        end
       end
     end
   end

data/rbi/openai/models/chat/chat_completion.rbi

@@ -404,6 +404,11 @@ module OpenAI
               :flex,
               OpenAI::Chat::ChatCompletion::ServiceTier::TaggedSymbol
             )
+          SCALE =
+            T.let(
+              :scale,
+              OpenAI::Chat::ChatCompletion::ServiceTier::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/openai/models/chat/chat_completion_chunk.rbi

@@ -824,6 +824,11 @@ module OpenAI
               :flex,
               OpenAI::Chat::ChatCompletionChunk::ServiceTier::TaggedSymbol
             )
+          SCALE =
+            T.let(
+              :scale,
+              OpenAI::Chat::ChatCompletionChunk::ServiceTier::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/openai/models/chat/completion_create_params.rbi

@@ -1049,6 +1049,11 @@ module OpenAI
               :flex,
               OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol
             )
+          SCALE =
+            T.let(
+              :scale,
+              OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/openai/models/fine_tuning/job_create_params.rbi

@@ -39,7 +39,8 @@ module OpenAI
         # [preference](https://platform.openai.com/docs/api-reference/fine-tuning/preference-input)
         # format.
         #
-        # See the [fine-tuning guide](https://platform.openai.com/docs/guides/fine-tuning)
+        # See the
+        # [fine-tuning guide](https://platform.openai.com/docs/guides/model-optimization)
         # for more details.
         sig { returns(String) }
         attr_accessor :training_file
@@ -115,7 +116,8 @@ module OpenAI
         # Your dataset must be formatted as a JSONL file. You must upload your file with
         # the purpose `fine-tune`.
         #
-        # See the [fine-tuning guide](https://platform.openai.com/docs/guides/fine-tuning)
+        # See the
+        # [fine-tuning guide](https://platform.openai.com/docs/guides/model-optimization)
         # for more details.
         sig { returns(T.nilable(String)) }
         attr_accessor :validation_file
@@ -163,7 +165,8 @@ module OpenAI
           # [preference](https://platform.openai.com/docs/api-reference/fine-tuning/preference-input)
           # format.
           #
-          # See the [fine-tuning guide](https://platform.openai.com/docs/guides/fine-tuning)
+          # See the
+          # [fine-tuning guide](https://platform.openai.com/docs/guides/model-optimization)
           # for more details.
           training_file:,
           # The hyperparameters used for the fine-tuning job. This value is now deprecated
@@ -200,7 +203,8 @@ module OpenAI
           # Your dataset must be formatted as a JSONL file. You must upload your file with
           # the purpose `fine-tune`.
           #
-          # See the [fine-tuning guide](https://platform.openai.com/docs/guides/fine-tuning)
+          # See the
+          # [fine-tuning guide](https://platform.openai.com/docs/guides/model-optimization)
           # for more details.
           validation_file: nil,
           request_options: {}

data/rbi/openai/models/image_edit_params.rbi

@@ -56,6 +56,20 @@ module OpenAI
       sig { returns(T.nilable(Integer)) }
       attr_accessor :n
 
+      # The compression level (0-100%) for the generated images. This parameter is only
+      # supported for `gpt-image-1` with the `webp` or `jpeg` output formats, and
+      # defaults to 100.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :output_compression
+
+      # The format in which the generated images are returned. This parameter is only
+      # supported for `gpt-image-1`. Must be one of `png`, `jpeg`, or `webp`. The
+      # default value is `png`.
+      sig do
+        returns(T.nilable(OpenAI::ImageEditParams::OutputFormat::OrSymbol))
+      end
+      attr_accessor :output_format
+
       # The quality of the image that will be generated. `high`, `medium` and `low` are
       # only supported for `gpt-image-1`. `dall-e-2` only supports `standard` quality.
       # Defaults to `auto`.
@@ -94,6 +108,9 @@ module OpenAI
           mask: OpenAI::Internal::FileInput,
           model: T.nilable(T.any(String, OpenAI::ImageModel::OrSymbol)),
           n: T.nilable(Integer),
+          output_compression: T.nilable(Integer),
+          output_format:
+            T.nilable(OpenAI::ImageEditParams::OutputFormat::OrSymbol),
           quality: T.nilable(OpenAI::ImageEditParams::Quality::OrSymbol),
           response_format:
             T.nilable(OpenAI::ImageEditParams::ResponseFormat::OrSymbol),
@@ -133,6 +150,14 @@ module OpenAI
         model: nil,
         # The number of images to generate. Must be between 1 and 10.
         n: nil,
+        # The compression level (0-100%) for the generated images. This parameter is only
+        # supported for `gpt-image-1` with the `webp` or `jpeg` output formats, and
+        # defaults to 100.
+        output_compression: nil,
+        # The format in which the generated images are returned. This parameter is only
+        # supported for `gpt-image-1`. Must be one of `png`, `jpeg`, or `webp`. The
+        # default value is `png`.
+        output_format: nil,
         # The quality of the image that will be generated. `high`, `medium` and `low` are
         # only supported for `gpt-image-1`. `dall-e-2` only supports `standard` quality.
         # Defaults to `auto`.
@@ -164,6 +189,9 @@ module OpenAI
             mask: OpenAI::Internal::FileInput,
             model: T.nilable(T.any(String, OpenAI::ImageModel::OrSymbol)),
             n: T.nilable(Integer),
+            output_compression: T.nilable(Integer),
+            output_format:
+              T.nilable(OpenAI::ImageEditParams::OutputFormat::OrSymbol),
             quality: T.nilable(OpenAI::ImageEditParams::Quality::OrSymbol),
             response_format:
               T.nilable(OpenAI::ImageEditParams::ResponseFormat::OrSymbol),
@@ -246,6 +274,29 @@ module OpenAI
         end
       end
 
+      # The format in which the generated images are returned. This parameter is only
+      # supported for `gpt-image-1`. Must be one of `png`, `jpeg`, or `webp`. The
+      # default value is `png`.
+      module OutputFormat
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, OpenAI::ImageEditParams::OutputFormat) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PNG = T.let(:png, OpenAI::ImageEditParams::OutputFormat::TaggedSymbol)
+        JPEG = T.let(:jpeg, OpenAI::ImageEditParams::OutputFormat::TaggedSymbol)
+        WEBP = T.let(:webp, OpenAI::ImageEditParams::OutputFormat::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::ImageEditParams::OutputFormat::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
       # The quality of the image that will be generated. `high`, `medium` and `low` are
       # only supported for `gpt-image-1`. `dall-e-2` only supports `standard` quality.
       # Defaults to `auto`.