openai 0.8.0 → 0.10.0

data/rbi/openai/models/responses/response_prompt.rbi

@@ -0,0 +1,120 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponsePrompt < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Responses::ResponsePrompt, OpenAI::Internal::AnyHash)
+          end
+
+        # The unique identifier of the prompt template to use.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Optional map of values to substitute in for variables in your prompt. The
+        # substitution values can either be strings, or other Response input types like
+        # images or files.
+        sig do
+          returns(
+            T.nilable(
+              T::Hash[
+                Symbol,
+                T.any(
+                  String,
+                  OpenAI::Responses::ResponseInputText,
+                  OpenAI::Responses::ResponseInputImage,
+                  OpenAI::Responses::ResponseInputFile
+                )
+              ]
+            )
+          )
+        end
+        attr_accessor :variables
+
+        # Optional version of the prompt template.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :version
+
+        # Reference to a prompt template and its variables.
+        # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+        sig do
+          params(
+            id: String,
+            variables:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    String,
+                    OpenAI::Responses::ResponseInputText::OrHash,
+                    OpenAI::Responses::ResponseInputImage::OrHash,
+                    OpenAI::Responses::ResponseInputFile::OrHash
+                  )
+                ]
+              ),
+            version: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier of the prompt template to use.
+          id:,
+          # Optional map of values to substitute in for variables in your prompt. The
+          # substitution values can either be strings, or other Response input types like
+          # images or files.
+          variables: nil,
+          # Optional version of the prompt template.
+          version: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              variables:
+                T.nilable(
+                  T::Hash[
+                    Symbol,
+                    T.any(
+                      String,
+                      OpenAI::Responses::ResponseInputText,
+                      OpenAI::Responses::ResponseInputImage,
+                      OpenAI::Responses::ResponseInputFile
+                    )
+                  ]
+                ),
+              version: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # A text input to the model.
+        module Variable
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                String,
+                OpenAI::Responses::ResponseInputText,
+                OpenAI::Responses::ResponseInputImage,
+                OpenAI::Responses::ResponseInputFile
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[OpenAI::Responses::ResponsePrompt::Variable::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/resources/audio/speech.rbi

@@ -15,6 +15,8 @@ module OpenAI
             response_format:
               OpenAI::Audio::SpeechCreateParams::ResponseFormat::OrSymbol,
             speed: Float,
+            stream_format:
+              OpenAI::Audio::SpeechCreateParams::StreamFormat::OrSymbol,
             request_options: OpenAI::RequestOptions::OrHash
           ).returns(StringIO)
         end
@@ -36,8 +38,11 @@ module OpenAI
           # `wav`, and `pcm`.
           response_format: nil,
           # The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is
-          # the default. Does not work with `gpt-4o-mini-tts`.
+          # the default.
           speed: nil,
+          # The format to stream the audio in. Supported formats are `sse` and `audio`.
+          # `sse` is not supported for `tts-1` or `tts-1-hd`.
+          stream_format: nil,
           request_options: {}
         )
         end

data/rbi/openai/resources/fine_tuning/jobs.rbi

@@ -13,7 +13,7 @@ module OpenAI
         # Response includes details of the enqueued job including job status and the name
         # of the fine-tuned models once complete.
         #
-        # [Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning)
+        # [Learn more about fine-tuning](https://platform.openai.com/docs/guides/model-optimization)
         sig do
           params(
             model:
@@ -57,7 +57,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
@@ -94,7 +95,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: {}
@@ -103,7 +105,7 @@ module OpenAI
 
         # Get info about a fine-tuning job.
         #
-        # [Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning)
+        # [Learn more about fine-tuning](https://platform.openai.com/docs/guides/model-optimization)
         sig do
           params(
             fine_tuning_job_id: String,

data/rbi/openai/resources/images.rbi

@@ -52,6 +52,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),
@@ -91,6 +94,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`.

data/rbi/openai/resources/responses.rbi

@@ -21,23 +21,24 @@ module OpenAI
       # your own data as input for the model's response.
       sig do
         params(
-          input: OpenAI::Responses::ResponseCreateParams::Input::Variants,
-          model:
-            T.any(
-              String,
-              OpenAI::ChatModel::OrSymbol,
-              OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
-            ),
           background: T.nilable(T::Boolean),
           include:
             T.nilable(
               T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]
             ),
+          input: OpenAI::Responses::ResponseCreateParams::Input::Variants,
           instructions: T.nilable(String),
           max_output_tokens: T.nilable(Integer),
           metadata: T.nilable(T::Hash[Symbol, String]),
+          model:
+            T.any(
+              String,
+              OpenAI::ChatModel::OrSymbol,
+              OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
+            ),
           parallel_tool_calls: T.nilable(T::Boolean),
           previous_response_id: T.nilable(String),
+          prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
           reasoning: T.nilable(OpenAI::Reasoning::OrHash),
           service_tier:
             T.nilable(
@@ -80,22 +81,6 @@ module OpenAI
         ).returns(OpenAI::Responses::Response)
       end
       def create(
-        # Text, image, or file inputs to the model, used to generate a response.
-        #
-        # Learn more:
-        #
-        # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
-        # - [Image inputs](https://platform.openai.com/docs/guides/images)
-        # - [File inputs](https://platform.openai.com/docs/guides/pdf-files)
-        # - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
-        # - [Function calling](https://platform.openai.com/docs/guides/function-calling)
-        input:,
-        # Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
-        # wide range of models with different capabilities, performance characteristics,
-        # and price points. Refer to the
-        # [model guide](https://platform.openai.com/docs/models) to browse and compare
-        # available models.
-        model:,
         # Whether to run the model response in the background.
         # [Learn more](https://platform.openai.com/docs/guides/background).
         background: nil,
@@ -115,8 +100,17 @@ module OpenAI
         # - `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.
+        # Text, image, or file inputs to the model, used to generate a response.
+        #
+        # Learn more:
+        #
+        # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
+        # - [Image inputs](https://platform.openai.com/docs/guides/images)
+        # - [File inputs](https://platform.openai.com/docs/guides/pdf-files)
+        # - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
+        # - [Function calling](https://platform.openai.com/docs/guides/function-calling)
+        input: nil,
+        # A system (or developer) message inserted into the model's context.
         #
         # When using along with `previous_response_id`, the instructions from a previous
         # response will not be carried over to the next response. This makes it simple to
@@ -133,12 +127,21 @@ module OpenAI
         # Keys are strings with a maximum length of 64 characters. Values are strings with
         # a maximum length of 512 characters.
         metadata: nil,
+        # Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
+        # wide range of models with different capabilities, performance characteristics,
+        # and price points. Refer to the
+        # [model guide](https://platform.openai.com/docs/models) to browse and compare
+        # available models.
+        model: nil,
         # Whether to allow the model to run tool calls in parallel.
         parallel_tool_calls: nil,
         # The unique ID of the previous response to the model. Use this to create
         # multi-turn conversations. Learn more about
         # [conversation state](https://platform.openai.com/docs/guides/conversation-state).
         previous_response_id: nil,
+        # Reference to a prompt template and its variables.
+        # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+        prompt: nil,
         # **o-series models only**
         #
         # Configuration options for
@@ -234,23 +237,24 @@ module OpenAI
       # your own data as input for the model's response.
       sig do
         params(
-          input: OpenAI::Responses::ResponseCreateParams::Input::Variants,
-          model:
-            T.any(
-              String,
-              OpenAI::ChatModel::OrSymbol,
-              OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
-            ),
           background: T.nilable(T::Boolean),
           include:
             T.nilable(
               T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]
             ),
+          input: OpenAI::Responses::ResponseCreateParams::Input::Variants,
           instructions: T.nilable(String),
           max_output_tokens: T.nilable(Integer),
           metadata: T.nilable(T::Hash[Symbol, String]),
+          model:
+            T.any(
+              String,
+              OpenAI::ChatModel::OrSymbol,
+              OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
+            ),
           parallel_tool_calls: T.nilable(T::Boolean),
           previous_response_id: T.nilable(String),
+          prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
           reasoning: T.nilable(OpenAI::Reasoning::OrHash),
           service_tier:
             T.nilable(
@@ -293,22 +297,6 @@ module OpenAI
         )
       end
       def stream_raw(
-        # Text, image, or file inputs to the model, used to generate a response.
-        #
-        # Learn more:
-        #
-        # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
-        # - [Image inputs](https://platform.openai.com/docs/guides/images)
-        # - [File inputs](https://platform.openai.com/docs/guides/pdf-files)
-        # - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
-        # - [Function calling](https://platform.openai.com/docs/guides/function-calling)
-        input:,
-        # Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
-        # wide range of models with different capabilities, performance characteristics,
-        # and price points. Refer to the
-        # [model guide](https://platform.openai.com/docs/models) to browse and compare
-        # available models.
-        model:,
         # Whether to run the model response in the background.
         # [Learn more](https://platform.openai.com/docs/guides/background).
         background: nil,
@@ -328,8 +316,17 @@ module OpenAI
         # - `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.
+        # Text, image, or file inputs to the model, used to generate a response.
+        #
+        # Learn more:
+        #
+        # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
+        # - [Image inputs](https://platform.openai.com/docs/guides/images)
+        # - [File inputs](https://platform.openai.com/docs/guides/pdf-files)
+        # - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
+        # - [Function calling](https://platform.openai.com/docs/guides/function-calling)
+        input: nil,
+        # A system (or developer) message inserted into the model's context.
         #
         # When using along with `previous_response_id`, the instructions from a previous
         # response will not be carried over to the next response. This makes it simple to
@@ -346,12 +343,21 @@ module OpenAI
         # Keys are strings with a maximum length of 64 characters. Values are strings with
         # a maximum length of 512 characters.
         metadata: nil,
+        # Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
+        # wide range of models with different capabilities, performance characteristics,
+        # and price points. Refer to the
+        # [model guide](https://platform.openai.com/docs/models) to browse and compare
+        # available models.
+        model: nil,
         # Whether to allow the model to run tool calls in parallel.
         parallel_tool_calls: nil,
         # The unique ID of the previous response to the model. Use this to create
         # multi-turn conversations. Learn more about
         # [conversation state](https://platform.openai.com/docs/guides/conversation-state).
         previous_response_id: nil,
+        # Reference to a prompt template and its variables.
+        # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+        prompt: nil,
         # **o-series models only**
         #
         # Configuration options for

data/sig/openai/errors.rbs

@@ -5,6 +5,15 @@ module OpenAI
     end
 
     class ConversionError < OpenAI::Errors::Error
+      def cause: -> StandardError?
+
+      def initialize: (
+        on: Class,
+        method: Symbol,
+        target: top,
+        value: top,
+        ?cause: StandardError?
+      ) -> void
     end
 
     class APIError < OpenAI::Errors::Error

data/sig/openai/internal/type/converter.rbs

@@ -8,8 +8,10 @@ module OpenAI
 
         type coerce_state =
           {
-            strictness: bool | :strong,
+            translate_names: bool,
+            strictness: bool,
             exactness: { yes: Integer, no: Integer, maybe: Integer },
+            error: Class,
             branched: Integer
           }
 
@@ -37,6 +39,10 @@ module OpenAI
           | OpenAI::Internal::Type::Converter::input spec
         ) -> (^-> top)
 
+        def self.new_coerce_state: (
+          ?translate_names: bool
+        ) -> OpenAI::Internal::Type::Converter::coerce_state
+
         def self.coerce: (
           OpenAI::Internal::Type::Converter::input target,
           top value,

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

@@ -8,7 +8,8 @@ module OpenAI
           voice: OpenAI::Models::Audio::SpeechCreateParams::voice,
           instructions: String,
           response_format: OpenAI::Models::Audio::SpeechCreateParams::response_format,
-          speed: Float
+          speed: Float,
+          stream_format: OpenAI::Models::Audio::SpeechCreateParams::stream_format
         }
         & OpenAI::Internal::Type::request_parameters
 
@@ -36,6 +37,12 @@ module OpenAI
 
         def speed=: (Float) -> Float
 
+        attr_reader stream_format: OpenAI::Models::Audio::SpeechCreateParams::stream_format?
+
+        def stream_format=: (
+          OpenAI::Models::Audio::SpeechCreateParams::stream_format
+        ) -> OpenAI::Models::Audio::SpeechCreateParams::stream_format
+
         def initialize: (
           input: String,
           model: OpenAI::Models::Audio::SpeechCreateParams::model,
@@ -43,6 +50,7 @@ module OpenAI
           ?instructions: String,
           ?response_format: OpenAI::Models::Audio::SpeechCreateParams::response_format,
           ?speed: Float,
+          ?stream_format: OpenAI::Models::Audio::SpeechCreateParams::stream_format,
           ?request_options: OpenAI::request_opts
         ) -> void
 
@@ -53,6 +61,7 @@ module OpenAI
           instructions: String,
           response_format: OpenAI::Models::Audio::SpeechCreateParams::response_format,
           speed: Float,
+          stream_format: OpenAI::Models::Audio::SpeechCreateParams::stream_format,
           request_options: OpenAI::RequestOptions
         }
 
@@ -110,6 +119,17 @@ module OpenAI
 
           def self?.values: -> ::Array[OpenAI::Models::Audio::SpeechCreateParams::response_format]
         end
+
+        type stream_format = :sse | :audio
+
+        module StreamFormat
+          extend OpenAI::Internal::Type::Enum
+
+          SSE: :sse
+          AUDIO: :audio
+
+          def self?.values: -> ::Array[OpenAI::Models::Audio::SpeechCreateParams::stream_format]
+        end
       end
     end
   end

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

@@ -4,7 +4,8 @@ module OpenAI
       type transcription =
         {
           text: String,
-          logprobs: ::Array[OpenAI::Audio::Transcription::Logprob]
+          logprobs: ::Array[OpenAI::Audio::Transcription::Logprob],
+          usage: OpenAI::Models::Audio::Transcription::usage
         }
 
       class Transcription < OpenAI::Internal::Type::BaseModel
@@ -16,14 +17,22 @@ module OpenAI
           ::Array[OpenAI::Audio::Transcription::Logprob]
         ) -> ::Array[OpenAI::Audio::Transcription::Logprob]
 
+        attr_reader usage: OpenAI::Models::Audio::Transcription::usage?
+
+        def usage=: (
+          OpenAI::Models::Audio::Transcription::usage
+        ) -> OpenAI::Models::Audio::Transcription::usage
+
         def initialize: (
           text: String,
-          ?logprobs: ::Array[OpenAI::Audio::Transcription::Logprob]
+          ?logprobs: ::Array[OpenAI::Audio::Transcription::Logprob],
+          ?usage: OpenAI::Models::Audio::Transcription::usage
         ) -> void
 
         def to_hash: -> {
           text: String,
-          logprobs: ::Array[OpenAI::Audio::Transcription::Logprob]
+          logprobs: ::Array[OpenAI::Audio::Transcription::Logprob],
+          usage: OpenAI::Models::Audio::Transcription::usage
         }
 
         type logprob = { token: String, bytes: ::Array[Float], logprob: Float }
@@ -53,6 +62,89 @@ module OpenAI
             logprob: Float
           }
         end
+
+        type usage =
+          OpenAI::Audio::Transcription::Usage::Tokens
+          | OpenAI::Audio::Transcription::Usage::Duration
+
+        module Usage
+          extend OpenAI::Internal::Type::Union
+
+          type tokens =
+            {
+              input_tokens: Integer,
+              output_tokens: Integer,
+              total_tokens: Integer,
+              type: :tokens,
+              input_token_details: OpenAI::Audio::Transcription::Usage::Tokens::InputTokenDetails
+            }
+
+          class Tokens < OpenAI::Internal::Type::BaseModel
+            attr_accessor input_tokens: Integer
+
+            attr_accessor output_tokens: Integer
+
+            attr_accessor total_tokens: Integer
+
+            attr_accessor type: :tokens
+
+            attr_reader input_token_details: OpenAI::Audio::Transcription::Usage::Tokens::InputTokenDetails?
+
+            def input_token_details=: (
+              OpenAI::Audio::Transcription::Usage::Tokens::InputTokenDetails
+            ) -> OpenAI::Audio::Transcription::Usage::Tokens::InputTokenDetails
+
+            def initialize: (
+              input_tokens: Integer,
+              output_tokens: Integer,
+              total_tokens: Integer,
+              ?input_token_details: OpenAI::Audio::Transcription::Usage::Tokens::InputTokenDetails,
+              ?type: :tokens
+            ) -> void
+
+            def to_hash: -> {
+              input_tokens: Integer,
+              output_tokens: Integer,
+              total_tokens: Integer,
+              type: :tokens,
+              input_token_details: OpenAI::Audio::Transcription::Usage::Tokens::InputTokenDetails
+            }
+
+            type input_token_details =
+              { audio_tokens: Integer, text_tokens: Integer }
+
+            class InputTokenDetails < OpenAI::Internal::Type::BaseModel
+              attr_reader audio_tokens: Integer?
+
+              def audio_tokens=: (Integer) -> Integer
+
+              attr_reader text_tokens: Integer?
+
+              def text_tokens=: (Integer) -> Integer
+
+              def initialize: (
+                ?audio_tokens: Integer,
+                ?text_tokens: Integer
+              ) -> void
+
+              def to_hash: -> { audio_tokens: Integer, text_tokens: Integer }
+            end
+          end
+
+          type duration = { duration: Float, type: :duration }
+
+          class Duration < OpenAI::Internal::Type::BaseModel
+            attr_accessor duration: Float
+
+            attr_accessor type: :duration
+
+            def initialize: (duration: Float, ?type: :duration) -> void
+
+            def to_hash: -> { duration: Float, type: :duration }
+          end
+
+          def self?.variants: -> ::Array[OpenAI::Models::Audio::Transcription::usage]
+        end
       end
     end
   end