openai 0.97.0 → 0.99.0

data/lib/openai/models/all_models.rb

@@ -14,21 +14,63 @@ module OpenAI
       module ResponsesOnlyModel
         extend OpenAI::Internal::Type::Enum
 
+        # @deprecated Announced shutdown date: 2026-10-23. See
+        # https://developers.openai.com/api/docs/deprecations for details and recommended
+        # replacements.
         O1_PRO = :"o1-pro"
+        # @deprecated Announced shutdown date: 2026-10-23. See
+        # https://developers.openai.com/api/docs/deprecations for details and recommended
+        # replacements.
         O1_PRO_2025_03_19 = :"o1-pro-2025-03-19"
+        # @deprecated Announced shutdown date: 2026-12-11. See
+        # https://developers.openai.com/api/docs/deprecations for details and recommended
+        # replacements.
         O3_PRO = :"o3-pro"
+        # @deprecated Announced shutdown date: 2026-12-11. See
+        # https://developers.openai.com/api/docs/deprecations for details and recommended
+        # replacements.
         O3_PRO_2025_06_10 = :"o3-pro-2025-06-10"
+        # @deprecated Announced shutdown date: 2026-07-23. See
+        # https://developers.openai.com/api/docs/deprecations for details and recommended
+        # replacements.
         O3_DEEP_RESEARCH = :"o3-deep-research"
+        # @deprecated Announced shutdown date: 2026-07-23. See
+        # https://developers.openai.com/api/docs/deprecations for details and recommended
+        # replacements.
         O3_DEEP_RESEARCH_2025_06_26 = :"o3-deep-research-2025-06-26"
+        # @deprecated Announced shutdown date: 2026-07-23. See
+        # https://developers.openai.com/api/docs/deprecations for details and recommended
+        # replacements.
         O4_MINI_DEEP_RESEARCH = :"o4-mini-deep-research"
+        # @deprecated Announced shutdown date: 2026-07-23. See
+        # https://developers.openai.com/api/docs/deprecations for details and recommended
+        # replacements.
         O4_MINI_DEEP_RESEARCH_2025_06_26 = :"o4-mini-deep-research-2025-06-26"
+        # @deprecated Announced shutdown date: 2026-07-23. See
+        # https://developers.openai.com/api/docs/deprecations for details and recommended
+        # replacements.
         COMPUTER_USE_PREVIEW = :"computer-use-preview"
+        # @deprecated Announced shutdown date: 2026-07-23. See
+        # https://developers.openai.com/api/docs/deprecations for details and recommended
+        # replacements.
         COMPUTER_USE_PREVIEW_2025_03_11 = :"computer-use-preview-2025-03-11"
         GPT_5_5_PRO = :"gpt-5.5-pro"
         GPT_5_5_PRO_2026_04_23 = :"gpt-5.5-pro-2026-04-23"
+        # @deprecated Announced shutdown date: 2026-07-23. See
+        # https://developers.openai.com/api/docs/deprecations for details and recommended
+        # replacements.
         GPT_5_CODEX = :"gpt-5-codex"
+        # @deprecated Announced shutdown date: 2026-12-11. See
+        # https://developers.openai.com/api/docs/deprecations for details and recommended
+        # replacements.
         GPT_5_PRO = :"gpt-5-pro"
+        # @deprecated Announced shutdown date: 2026-12-11. See
+        # https://developers.openai.com/api/docs/deprecations for details and recommended
+        # replacements.
         GPT_5_PRO_2025_10_06 = :"gpt-5-pro-2025-10-06"
+        # @deprecated Announced shutdown date: 2026-07-23. See
+        # https://developers.openai.com/api/docs/deprecations for details and recommended
+        # replacements.
         GPT_5_1_CODEX_MAX = :"gpt-5.1-codex-max"
         GPT_DAYBREAK_BLUE_LATEST = :"gpt-daybreak-blue-latest"
         GPT_DAYBREAK_RED_LATEST = :"gpt-daybreak-red-latest"

data/lib/openai/models/audio/speech_create_params.rb

@@ -29,6 +29,8 @@ module OpenAI
         #   object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
         #   voices are available in the
         #   [Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).
+        #   Custom voices must be created from audio samples. Voices created from text
+        #   prompts are supported only in Live.
         #
         #   @return [String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice::ID, OpenAI::Models::Audio::SpeechCreateParams::Voice]
         required :voice, union: -> { OpenAI::Audio::SpeechCreateParams::Voice }
@@ -77,6 +79,8 @@ module OpenAI
         #     object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
         #     voices are available in the
         #     [Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).
+        #     Custom voices must be created from audio samples. Voices created from text
+        #     prompts are supported only in Live.
         #
         #   @param instructions [String]
         #     Control the voice of your generated audio with additional instructions. Does not
@@ -117,6 +121,8 @@ module OpenAI
         # object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
         # voices are available in the
         # [Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).
+        # 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/lib/openai/models/audio/voice.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Audio
+      # @see OpenAI::Resources::Audio::Voices#create
+      class Voice < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The voice identifier, which can be referenced in API endpoints.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The Unix timestamp (in seconds) for when the voice was created.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute name
+        #   The name of the voice.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute object
+        #   The object type, which is always `audio.voice`.
+        #
+        #   @return [Symbol, :"audio.voice"]
+        required :object, const: :"audio.voice"
+
+        # @!attribute type
+        #   How the voice was created. Voices created from text prompts are supported only
+        #   in Live.
+        #
+        #   @return [Symbol, OpenAI::Models::Audio::Voice::Type]
+        required :type, enum: -> { OpenAI::Audio::Voice::Type }
+
+        # @!method initialize(id:, created_at:, name:, type:, object: :"audio.voice")
+        #   A custom voice that can be used for audio output. Voices created from text
+        #   prompts are supported only in Live.
+        #
+        #   @param id [String]
+        #     The voice identifier, which can be referenced in API endpoints.
+        #
+        #   @param created_at [Integer]
+        #     The Unix timestamp (in seconds) for when the voice was created.
+        #
+        #   @param name [String]
+        #     The name of the voice.
+        #
+        #   @param type [Symbol, OpenAI::Models::Audio::Voice::Type]
+        #     How the voice was created. Voices created from text prompts are supported only
+        #     in Live.
+        #
+        #   @param object [Symbol, :"audio.voice"]
+        #     The object type, which is always `audio.voice`.
+
+        # How the voice was created. Voices created from text prompts are supported only
+        # in Live.
+        #
+        # @see OpenAI::Models::Audio::Voice#type
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          AUDIO_SAMPLE = :audio_sample
+          PROMPT = :prompt
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/audio/voice_create_params.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Audio
+      # @see OpenAI::Resources::Audio::Voices#create
+      class VoiceCreateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!attribute body
+        #   Creates a voice from a consent recording and an audio sample. Requires
+        #   multipart/form-data.
+        #
+        #   @return [OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample, OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt]
+        required :body, union: -> { OpenAI::Audio::VoiceCreateParams::Body }
+
+        # @!method initialize(body:, request_options: {})
+        #   @param body [OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample, OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt]
+        #     Creates a voice from a consent recording and an audio sample. Requires
+        #     multipart/form-data.
+        #
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+        # Creates a voice from a consent recording and an audio sample. Requires
+        # multipart/form-data.
+        module Body
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          # @api private
+          def self.resolve_variant(value, state: nil)
+            if value.is_a?(Hash) && !value.key?(:type) && !value.key?("type")
+              OpenAI::Audio::VoiceCreateParams::Body::AudioSample
+            else
+              super
+            end
+          end
+
+          private_class_method :resolve_variant
+
+          # Creates a voice from a consent recording and an audio sample. Requires multipart/form-data.
+          variant :audio_sample, -> { OpenAI::Audio::VoiceCreateParams::Body::AudioSample }
+
+          # Creates a synthetic voice from a text description. Supports application/json or multipart/form-data.
+          variant :prompt, -> { OpenAI::Audio::VoiceCreateParams::Body::Prompt }
+
+          class AudioSample < OpenAI::Internal::Type::BaseModel
+            # @!attribute audio_sample
+            #   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.
+            #
+            #   @return [Pathname, StringIO, IO, String, OpenAI::FilePart]
+            required :audio_sample, OpenAI::Internal::Type::FileInput
+
+            # @!attribute consent
+            #   The consent recording ID (for example, `cons_1234`).
+            #
+            #   @return [String]
+            required :consent, String
+
+            # @!attribute name
+            #   The name of the new voice.
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute type
+            #   The voice creation method. Defaults to `audio_sample` when omitted.
+            #
+            #   @return [Symbol, OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample::Type, nil]
+            optional :type, enum: -> { OpenAI::Audio::VoiceCreateParams::Body::AudioSample::Type }
+
+            # @!method initialize(audio_sample:, consent:, name:, type: nil)
+            #   Creates a voice from a consent recording and an audio sample. Requires
+            #   multipart/form-data.
+            #
+            #   @param audio_sample [Pathname, StringIO, IO, String, OpenAI::FilePart]
+            #     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.
+            #
+            #   @param consent [String]
+            #     The consent recording ID (for example, `cons_1234`).
+            #
+            #   @param name [String]
+            #     The name of the new voice.
+            #
+            #   @param type [Symbol, OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample::Type]
+            #     The voice creation method. Defaults to `audio_sample` when omitted.
+
+            # The voice creation method. Defaults to `audio_sample` when omitted.
+            #
+            # @see OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample#type
+            module Type
+              extend OpenAI::Internal::Type::Enum
+
+              AUDIO_SAMPLE = :audio_sample
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          class Prompt < OpenAI::Internal::Type::BaseModel
+            # @!attribute name
+            #   The name of the new voice.
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute prompt
+            #   A description of the desired voice. Must not contain only whitespace.
+            #
+            #   @return [String]
+            required :prompt, String
+
+            # @!attribute type
+            #   Set to `prompt` to create a voice from a text description.
+            #
+            #   @return [Symbol, OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::Type]
+            required :type, enum: -> { OpenAI::Audio::VoiceCreateParams::Body::Prompt::Type }
+
+            # @!attribute model
+            #   The voice creation model to use. Defaults to `auto`.
+            #
+            #   @return [String, Symbol, OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::Model, nil]
+            optional :model, union: -> { OpenAI::Audio::VoiceCreateParams::Body::Prompt::Model }
+
+            # @!attribute script_hint
+            #   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.
+            #
+            #   @return [String, nil]
+            optional :script_hint, String
+
+            # @!method initialize(name:, prompt:, type:, model: nil, script_hint: nil)
+            #   Creates a synthetic voice from a text description. Supports application/json or
+            #   multipart/form-data.
+            #
+            #   @param name [String]
+            #     The name of the new voice.
+            #
+            #   @param prompt [String]
+            #     A description of the desired voice. Must not contain only whitespace.
+            #
+            #   @param type [Symbol, OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::Type]
+            #     Set to `prompt` to create a voice from a text description.
+            #
+            #   @param model [String, Symbol, OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::Model]
+            #     The voice creation model to use. Defaults to `auto`.
+            #
+            #   @param script_hint [String]
+            #     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.
+
+            # Set to `prompt` to create a voice from a text description.
+            #
+            # @see OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt#type
+            module Type
+              extend OpenAI::Internal::Type::Enum
+
+              PROMPT = :prompt
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # The voice creation model to use. Defaults to `auto`.
+            #
+            # @see OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt#model
+            module Model
+              extend OpenAI::Internal::Type::Union
+
+              variant String
+
+              variant const: -> { OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::Model::AUTO }
+
+              variant const: -> { OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt::Model::MODEL_2026_10_01 }
+
+              # @!method self.variants
+              #   @return [Array(String, Symbol)]
+
+              define_sorbet_constant!(:Variants) do
+                T.type_alias { T.any(String, OpenAI::Audio::VoiceCreateParams::Body::Prompt::Model::TaggedSymbol) }
+              end
+
+              # @!group
+
+              AUTO = :auto
+              MODEL_2026_10_01 = :"2026-10-01"
+
+              # @!endgroup
+            end
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample, OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt)]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agent_create_params.rb

@@ -123,9 +123,6 @@ module OpenAI
           # Uses the fast service tier.
           FAST = :fast
 
-          # Uses the ultrafast service tier.
-          ULTRAFAST = :ultrafast
-
           # @!method self.values
           #   @return [Array<Symbol>]
         end

data/lib/openai/models/beta/agent_update_params.rb

@@ -130,9 +130,6 @@ module OpenAI
           # Uses the fast service tier.
           FAST = :fast
 
-          # Uses the ultrafast service tier.
-          ULTRAFAST = :ultrafast
-
           # @!method self.values
           #   @return [Array<Symbol>]
         end

data/lib/openai/models/beta/agents/session_create_params.rb

@@ -183,9 +183,6 @@ module OpenAI
               # Uses the fast service tier.
               FAST = :fast
 
-              # Uses the ultrafast service tier.
-              ULTRAFAST = :ultrafast
-
               # @!method self.values
               #   @return [Array<Symbol>]
             end

data/lib/openai/models/beta/agents/session_update_params.rb

@@ -134,9 +134,6 @@ module OpenAI
               # Uses the fast service tier.
               FAST = :fast
 
-              # Uses the ultrafast service tier.
-              ULTRAFAST = :ultrafast
-
               # @!method self.values
               #   @return [Array<Symbol>]
             end

data/lib/openai/models/beta/agents/sessions/session_trace.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Sessions
+          # @see OpenAI::Resources::Beta::Agents::Sessions::Traces#list
+          class SessionTrace < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   The root turn ID. Use this ID as the pagination anchor.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute created_at
+            #   The Unix timestamp in seconds when the root turn was created.
+            #
+            #   @return [Integer]
+            required :created_at, Integer
+
+            # @!attribute object
+            #   The object type, which is always `agent.session.trace`.
+            #
+            #   @return [Symbol, :"agent.session.trace"]
+            required :object, const: :"agent.session.trace"
+
+            # @!attribute otlp
+            #   An OTLP JSON ExportTraceServiceRequest containing resourceSpans. Only currently
+            #   published data is returned; later trace updates are not awaited.
+            #
+            #   @return [Hash{Symbol=>Object}]
+            required :otlp, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]
+
+            # @!attribute session_id
+            #   The session that owns this trace.
+            #
+            #   @return [String]
+            required :session_id, String
+
+            # @!method initialize(id:, created_at:, otlp:, session_id:, object: :"agent.session.trace")
+            #   @param id [String]
+            #     The root turn ID. Use this ID as the pagination anchor.
+            #
+            #   @param created_at [Integer]
+            #     The Unix timestamp in seconds when the root turn was created.
+            #
+            #   @param otlp [Hash{Symbol=>Object}]
+            #     An OTLP JSON ExportTraceServiceRequest containing resourceSpans. Only currently
+            #     published data is returned; later trace updates are not awaited.
+            #
+            #   @param session_id [String]
+            #     The session that owns this trace.
+            #
+            #   @param object [Symbol, :"agent.session.trace"]
+            #     The object type, which is always `agent.session.trace`.
+          end
+        end
+
+        SessionTrace = Sessions::SessionTrace
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/sessions/trace_list_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Sessions
+          # @see OpenAI::Resources::Beta::Agents::Sessions::Traces#list
+          class TraceListParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            # @!attribute session_id
+            #
+            #   @return [String]
+            required :session_id, String
+
+            # @!attribute after
+            #   Return resources after this resource ID in the selected order.
+            #
+            #   @return [String, nil]
+            optional :after, String
+
+            # @!attribute limit
+            #   The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            #
+            #   @return [Integer, nil]
+            optional :limit, Integer
+
+            # @!attribute order
+            #   The order in which resources are returned. Defaults to `desc`.
+            #
+            #   @return [Symbol, OpenAI::Models::Beta::Agents::Sessions::TraceListParams::Order, nil]
+            optional :order, enum: -> { OpenAI::Beta::Agents::Sessions::TraceListParams::Order }
+
+            # @!method initialize(session_id:, after: nil, limit: nil, order: nil, request_options: {})
+            #   @param session_id [String]
+            #
+            #   @param after [String]
+            #     Return resources after this resource ID in the selected order.
+            #
+            #   @param limit [Integer]
+            #     The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            #
+            #   @param order [Symbol, OpenAI::Models::Beta::Agents::Sessions::TraceListParams::Order]
+            #     The order in which resources are returned. Defaults to `desc`.
+            #
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+            # The order in which resources are returned. Defaults to `desc`.
+            module Order
+              extend OpenAI::Internal::Type::Enum
+
+              # Returns resources in ascending order.
+              ASC = :asc
+
+              # Returns resources in descending order.
+              DESC = :desc
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/vaults/credential.rb

@@ -55,7 +55,11 @@ module OpenAI
             #   @return [String]
             required :vault_id, String
 
-            # @!method initialize(id:, auth:, created_at:, metadata:, name:, updated_at:, vault_id:, object: :"vault.credential")
+            def initialize(data = {})
+              super({metadata: {}, **data})
+            end
+
+            # @!method initialize(id:, auth:, created_at:, name:, updated_at:, vault_id:, metadata: {}, object: :"vault.credential")
             #   Metadata for a stored credential. Secret values are never returned.
             #
             #   @param id [String]
@@ -67,9 +71,6 @@ module OpenAI
             #   @param created_at [Integer]
             #     The Unix timestamp, in seconds, when the credential was created.
             #
-            #   @param metadata [Hash{Symbol=>String}]
-            #     Application-defined key-value pairs associated with this credential.
-            #
             #   @param name [String]
             #     The human-readable name of the credential.
             #
@@ -79,6 +80,9 @@ module OpenAI
             #   @param vault_id [String]
             #     The ID of the vault containing this credential.
             #
+            #   @param metadata [Hash{Symbol=>String}]
+            #     Application-defined key-value pairs associated with this credential.
+            #
             #   @param object [Symbol, :"vault.credential"]
             #     The object type. Always `vault.credential`.
           end