openai 0.98.0 → 0.99.0

data/rbi/openai/models/audio/voice_create_params.rbi

@@ -0,0 +1,321 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Audio
+
+      class VoiceCreateParams < OpenAI::Internal::Type::BaseModel
+
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Audio::VoiceCreateParams,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # Creates a voice from a consent recording and an audio sample. Requires
+        # multipart/form-data.
+        sig {
+          returns(
+            T.any(OpenAI::Audio::VoiceCreateParams::Body::AudioSample, OpenAI::Audio::VoiceCreateParams::Body::Prompt)
+          )
+        }
+        attr_accessor :body
+
+        sig do
+          params(
+
+            body: T.any(
+              OpenAI::Audio::VoiceCreateParams::Body::AudioSample::OrHash,
+              OpenAI::Audio::VoiceCreateParams::Body::Prompt::OrHash
+            ),
+
+            request_options: OpenAI::RequestOptions::OrHash
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # Creates a voice from a consent recording and an audio sample. Requires
+          # multipart/form-data.
+          body:,
+
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              body: T.any(
+                OpenAI::Audio::VoiceCreateParams::Body::AudioSample,
+                OpenAI::Audio::VoiceCreateParams::Body::Prompt
+              ),
+              request_options: OpenAI::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Creates a voice from a consent recording and an audio sample. Requires
+        # multipart/form-data.
+        module Body
+          extend OpenAI::Internal::Type::Union
+
+          Variants = T.type_alias {
+            T.any(OpenAI::Audio::VoiceCreateParams::Body::AudioSample, OpenAI::Audio::VoiceCreateParams::Body::Prompt)
+          }
+
+          class AudioSample < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Audio::VoiceCreateParams::Body::AudioSample,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # The sample audio recording file. Maximum size is 10 MiB.
+            #
+            # Supported MIME types: `audio/mpeg`, `audio/wav`, `audio/x-wav`, `audio/ogg`,
+            # `audio/aac`, `audio/flac`, `audio/webm`, `audio/mp4`.
+            #
+            # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+            # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+            # content type.
+            sig { returns(OpenAI::Internal::FileInput) }
+            attr_accessor :audio_sample
+
+            # The consent recording ID (for example, `cons_1234`).
+            sig { returns(String) }
+            attr_accessor :consent
+
+            # The name of the new voice.
+            sig { returns(String) }
+            attr_accessor :name
+
+            # The voice creation method. Defaults to `audio_sample` when omitted.
+            sig { returns(T.nilable(OpenAI::Audio::VoiceCreateParams::Body::AudioSample::Type::OrSymbol)) }
+            attr_reader :type
+
+            sig { params(type: OpenAI::Audio::VoiceCreateParams::Body::AudioSample::Type::OrSymbol).void }
+            attr_writer :type
+
+            # Creates a voice from a consent recording and an audio sample. Requires
+            # multipart/form-data.
+            sig do
+              params(
+
+                audio_sample: OpenAI::Internal::FileInput,
+
+                consent: String,
+
+                name: String,
+
+                type: OpenAI::Audio::VoiceCreateParams::Body::AudioSample::Type::OrSymbol
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # The sample audio recording file. Maximum size is 10 MiB.
+              #
+              # Supported MIME types: `audio/mpeg`, `audio/wav`, `audio/x-wav`, `audio/ogg`,
+              # `audio/aac`, `audio/flac`, `audio/webm`, `audio/mp4`.
+              #
+              # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+              # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+              # content type.
+              audio_sample:,
+
+              # The consent recording ID (for example, `cons_1234`).
+              consent:,
+
+              # The name of the new voice.
+              name:,
+
+              # The voice creation method. Defaults to `audio_sample` when omitted.
+
+              type: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  audio_sample: OpenAI::Internal::FileInput,
+                  consent: String,
+                  name: String,
+                  type: OpenAI::Audio::VoiceCreateParams::Body::AudioSample::Type::OrSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # The voice creation method. Defaults to `audio_sample` when omitted.
+            module Type
+              extend OpenAI::Internal::Type::Enum
+
+              TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Audio::VoiceCreateParams::Body::AudioSample::Type) }
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              AUDIO_SAMPLE = T.let(
+                :audio_sample,
+                OpenAI::Audio::VoiceCreateParams::Body::AudioSample::Type::TaggedSymbol
+              )
+
+              sig {
+                override.returns(T::Array[OpenAI::Audio::VoiceCreateParams::Body::AudioSample::Type::TaggedSymbol])
+              }
+              def self.values
+              end
+            end
+          end
+
+          class Prompt < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Audio::VoiceCreateParams::Body::Prompt,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # The name of the new voice.
+            sig { returns(String) }
+            attr_accessor :name
+
+            # A description of the desired voice. Must not contain only whitespace.
+            sig { returns(String) }
+            attr_accessor :prompt
+
+            # Set to `prompt` to create a voice from a text description.
+            sig { returns(OpenAI::Audio::VoiceCreateParams::Body::Prompt::Type::OrSymbol) }
+            attr_accessor :type
+
+            # The voice creation model to use. Defaults to `auto`.
+            sig { returns(T.nilable(T.any(String, OpenAI::Audio::VoiceCreateParams::Body::Prompt::Model::OrSymbol))) }
+            attr_reader :model
+
+            sig { params(model: T.any(String, OpenAI::Audio::VoiceCreateParams::Body::Prompt::Model::OrSymbol)).void }
+            attr_writer :model
+
+            # Optional text for the voice to speak during creation. If omitted, a script is
+            # generated from the prompt. Must not be blank after trimming whitespace; scripts
+            # that are too short are rejected.
+            sig { returns(T.nilable(String)) }
+            attr_reader :script_hint
+
+            sig { params(script_hint: String).void }
+            attr_writer :script_hint
+
+            # Creates a synthetic voice from a text description. Supports application/json or
+            # multipart/form-data.
+            sig do
+              params(
+
+                name: String,
+
+                prompt: String,
+
+                type: OpenAI::Audio::VoiceCreateParams::Body::Prompt::Type::OrSymbol,
+
+                model: T.any(String, OpenAI::Audio::VoiceCreateParams::Body::Prompt::Model::OrSymbol),
+
+                script_hint: String
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # The name of the new voice.
+              name:,
+
+              # A description of the desired voice. Must not contain only whitespace.
+              prompt:,
+
+              # Set to `prompt` to create a voice from a text description.
+              type:,
+
+              # The voice creation model to use. Defaults to `auto`.
+              model: nil,
+
+              # Optional text for the voice to speak during creation. If omitted, a script is
+              # generated from the prompt. Must not be blank after trimming whitespace; scripts
+              # that are too short are rejected.
+
+              script_hint: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  name: String,
+                  prompt: String,
+                  type: OpenAI::Audio::VoiceCreateParams::Body::Prompt::Type::OrSymbol,
+                  model: T.any(String, OpenAI::Audio::VoiceCreateParams::Body::Prompt::Model::OrSymbol),
+                  script_hint: String
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # Set to `prompt` to create a voice from a text description.
+            module Type
+              extend OpenAI::Internal::Type::Enum
+
+              TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Audio::VoiceCreateParams::Body::Prompt::Type) }
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              PROMPT = T.let(:prompt, OpenAI::Audio::VoiceCreateParams::Body::Prompt::Type::TaggedSymbol)
+
+              sig { override.returns(T::Array[OpenAI::Audio::VoiceCreateParams::Body::Prompt::Type::TaggedSymbol]) }
+              def self.values
+              end
+            end
+
+            # The voice creation model to use. Defaults to `auto`.
+            module Model
+              extend OpenAI::Internal::Type::Union
+
+              Variants = T.type_alias {
+                T.any(String, OpenAI::Audio::VoiceCreateParams::Body::Prompt::Model::TaggedSymbol)
+              }
+
+              sig { override.returns(T::Array[OpenAI::Audio::VoiceCreateParams::Body::Prompt::Model::Variants]) }
+              def self.variants
+              end
+
+              TaggedSymbol = T.type_alias do
+                T.all(Symbol, OpenAI::Audio::VoiceCreateParams::Body::Prompt::Model)
+              end
+
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              AUTO = T.let(:auto, OpenAI::Audio::VoiceCreateParams::Body::Prompt::Model::TaggedSymbol)
+              MODEL_2026_10_01 = T.let(
+                :"2026-10-01",
+                OpenAI::Audio::VoiceCreateParams::Body::Prompt::Model::TaggedSymbol
+              )
+
+            end
+          end
+
+          sig { override.returns(T::Array[OpenAI::Audio::VoiceCreateParams::Body::Variants]) }
+          def self.variants
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agent_create_params.rbi

@@ -206,9 +206,6 @@ module OpenAI
           # Uses the fast service tier.
           FAST = T.let(:fast, OpenAI::Beta::AgentCreateParams::ServiceTier::TaggedSymbol)
 
-          # Uses the ultrafast service tier.
-          ULTRAFAST = T.let(:ultrafast, OpenAI::Beta::AgentCreateParams::ServiceTier::TaggedSymbol)
-
           sig { override.returns(T::Array[OpenAI::Beta::AgentCreateParams::ServiceTier::TaggedSymbol]) }
           def self.values
           end

data/rbi/openai/models/beta/agent_update_params.rbi

@@ -217,9 +217,6 @@ module OpenAI
           # Uses the fast service tier.
           FAST = T.let(:fast, OpenAI::Beta::AgentUpdateParams::ServiceTier::TaggedSymbol)
 
-          # Uses the ultrafast service tier.
-          ULTRAFAST = T.let(:ultrafast, OpenAI::Beta::AgentUpdateParams::ServiceTier::TaggedSymbol)
-
           sig { override.returns(T::Array[OpenAI::Beta::AgentUpdateParams::ServiceTier::TaggedSymbol]) }
           def self.values
           end

data/rbi/openai/models/beta/agents/session_create_params.rbi

@@ -312,9 +312,6 @@ module OpenAI
               # Uses the fast service tier.
               FAST = T.let(:fast, OpenAI::Beta::Agents::SessionCreateParams::Agent::ServiceTier::TaggedSymbol)
 
-              # Uses the ultrafast service tier.
-              ULTRAFAST = T.let(:ultrafast, OpenAI::Beta::Agents::SessionCreateParams::Agent::ServiceTier::TaggedSymbol)
-
               sig {
                 override.returns(T::Array[OpenAI::Beta::Agents::SessionCreateParams::Agent::ServiceTier::TaggedSymbol])
               }

data/rbi/openai/models/beta/agents/session_update_params.rbi

@@ -234,9 +234,6 @@ module OpenAI
               # Uses the fast service tier.
               FAST = T.let(:fast, OpenAI::Beta::Agents::SessionUpdateParams::Agent::ServiceTier::TaggedSymbol)
 
-              # Uses the ultrafast service tier.
-              ULTRAFAST = T.let(:ultrafast, OpenAI::Beta::Agents::SessionUpdateParams::Agent::ServiceTier::TaggedSymbol)
-
               sig {
                 override.returns(T::Array[OpenAI::Beta::Agents::SessionUpdateParams::Agent::ServiceTier::TaggedSymbol])
               }

data/rbi/openai/models/beta/beta_tool.rbi

@@ -1050,9 +1050,7 @@ module OpenAI
           # the maximum supported resolution is `3840x2160`. The requested size must also
           # satisfy the model's current pixel and edge limits. The standard sizes
           # `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
-          # `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
-          # one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
-          # `1024x1024`, `1792x1024`, or `1024x1792`.
+          # `auto` is supported for models that allow automatic sizing.
           sig { returns(T.nilable(T.any(String, OpenAI::Beta::BetaTool::ImageGeneration::Size::OrSymbol))) }
           attr_reader :size
 
@@ -1150,9 +1148,7 @@ module OpenAI
             # the maximum supported resolution is `3840x2160`. The requested size must also
             # satisfy the model's current pixel and edge limits. The standard sizes
             # `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
-            # `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
-            # one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
-            # `1024x1024`, `1792x1024`, or `1024x1792`.
+            # `auto` is supported for models that allow automatic sizing.
             size: nil,
 
             # The type of the image generation tool. Always `image_generation`.
@@ -1407,9 +1403,7 @@ module OpenAI
           # the maximum supported resolution is `3840x2160`. The requested size must also
           # satisfy the model's current pixel and edge limits. The standard sizes
           # `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
-          # `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
-          # one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
-          # `1024x1024`, `1792x1024`, or `1024x1792`.
+          # `auto` is supported for models that allow automatic sizing.
           module Size
             extend OpenAI::Internal::Type::Union
 

data/rbi/openai/models/chat/chat_completion_audio_param.rbi

@@ -24,7 +24,8 @@ module OpenAI
         # The voice the model uses to respond. Supported built-in voices are `alloy`,
         # `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
         # `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
-        # for example `{ "id": "voice_1234" }`.
+        # for example `{ "id": "voice_1234" }`. Custom voices must be created from audio
+        # samples. Voices created from text prompts are supported only in Live.
         sig {
           returns(
             T.any(
@@ -61,7 +62,8 @@ module OpenAI
           # The voice the model uses to respond. Supported built-in voices are `alloy`,
           # `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
           # `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
-          # for example `{ "id": "voice_1234" }`.
+          # for example `{ "id": "voice_1234" }`. Custom voices must be created from audio
+          # samples. Voices created from text prompts are supported only in Live.
 
           voice:
         )
@@ -105,7 +107,8 @@ module OpenAI
         # The voice the model uses to respond. Supported built-in voices are `alloy`,
         # `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
         # `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
-        # for example `{ "id": "voice_1234" }`.
+        # for example `{ "id": "voice_1234" }`. Custom voices must be created from audio
+        # samples. Voices created from text prompts are supported only in Live.
         module Voice
           extend OpenAI::Internal::Type::Union
 

data/rbi/openai/models/image.rbi

@@ -12,25 +12,25 @@ module OpenAI
         )
       end
 
-      # The base64-encoded JSON of the generated image. Returned by default for the GPT
-      # image models, and only present if `response_format` is set to `b64_json` for
-      # `dall-e-2` and `dall-e-3`.
+      # The base64-encoded JSON of the generated image. Returned by default for GPT
+      # image models, or when `response_format` is set to `b64_json` for models that
+      # support that parameter.
       sig { returns(T.nilable(String)) }
       attr_reader :b64_json
 
       sig { params(b64_json: String).void }
       attr_writer :b64_json
 
-      # For `dall-e-3` only, the revised prompt that was used to generate the image.
+      # The revised prompt used to generate the image, for models that support prompt
+      # revision. Not returned by GPT image models.
       sig { returns(T.nilable(String)) }
       attr_reader :revised_prompt
 
       sig { params(revised_prompt: String).void }
       attr_writer :revised_prompt
 
-      # When using `dall-e-2` or `dall-e-3`, the URL of the generated image if
-      # `response_format` is set to `url` (default value). Unsupported for the GPT image
-      # models.
+      # The URL of the generated image when `response_format` is set to `url` for models
+      # that support that parameter. Unsupported for GPT image models.
       sig { returns(T.nilable(String)) }
       attr_reader :url
 
@@ -51,17 +51,17 @@ module OpenAI
       end
       def self.new(
 
-        # The base64-encoded JSON of the generated image. Returned by default for the GPT
-        # image models, and only present if `response_format` is set to `b64_json` for
-        # `dall-e-2` and `dall-e-3`.
+        # The base64-encoded JSON of the generated image. Returned by default for GPT
+        # image models, or when `response_format` is set to `b64_json` for models that
+        # support that parameter.
         b64_json: nil,
 
-        # For `dall-e-3` only, the revised prompt that was used to generate the image.
+        # The revised prompt used to generate the image, for models that support prompt
+        # revision. Not returned by GPT image models.
         revised_prompt: nil,
 
-        # When using `dall-e-2` or `dall-e-3`, the URL of the generated image if
-        # `response_format` is set to `url` (default value). Unsupported for the GPT image
-        # models.
+        # The URL of the generated image when `response_format` is set to `url` for models
+        # that support that parameter. Unsupported for GPT image models.
 
         url: nil
       )

data/rbi/openai/models/image_create_variation_params.rbi

@@ -24,8 +24,8 @@ module OpenAI
       sig { returns(OpenAI::Internal::FileInput) }
       attr_accessor :image
 
-      # The model to use for image generation. Only `dall-e-2` is supported at this
-      # time.
+      # The legacy model used by the retired image variations endpoint. This endpoint no
+      # longer accepts requests.
       sig { returns(T.nilable(T.any(String, OpenAI::ImageModel::OrSymbol))) }
       attr_accessor :model
 
@@ -82,8 +82,8 @@ module OpenAI
         # content type.
         image:,
 
-        # The model to use for image generation. Only `dall-e-2` is supported at this
-        # time.
+        # The legacy model used by the retired image variations endpoint. This endpoint no
+        # longer accepts requests.
         model: nil,
 
         # The number of images to generate. Must be between 1 and 10.
@@ -123,8 +123,8 @@ module OpenAI
       def to_hash
       end
 
-      # The model to use for image generation. Only `dall-e-2` is supported at this
-      # time.
+      # The legacy model used by the retired image variations endpoint. This endpoint no
+      # longer accepts requests.
       module Model
         extend OpenAI::Internal::Type::Union