openai 0.98.0 → 0.100.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/environments/template_create_params.rbi

@@ -59,8 +59,8 @@ module OpenAI
             sig { returns(T.nilable(String)) }
             attr_accessor :name
 
-            # Network access policy for the environment. Defaults to disabled for GA requests
-            # and enabled for beta requests.
+            # Network access policy for the environment. If omitted, the API version
+            # determines whether network access is enabled or disabled.
             sig { returns(T.nilable(OpenAI::Beta::Agents::Environments::TemplateCreateParams::Network)) }
             attr_reader :network
 
@@ -160,8 +160,8 @@ module OpenAI
               # An optional human-readable display name for the template.
               name: nil,
 
-              # Network access policy for the environment. Defaults to disabled for GA requests
-              # and enabled for beta requests.
+              # Network access policy for the environment. If omitted, the API version
+              # determines whether network access is enabled or disabled.
               network: nil,
 
               # Packages to install in the environment. Defaults to empty package lists.
@@ -273,8 +273,8 @@ module OpenAI
               sig { returns(T.nilable(T::Array[String])) }
               attr_accessor :blocked_domains
 
-              # Network access policy for the environment. Defaults to disabled for GA requests
-              # and enabled for beta requests.
+              # Network access policy for the environment. If omitted, the API version
+              # determines whether network access is enabled or disabled.
               sig do
                 params(
 

data/rbi/openai/models/beta/agents/environments/template_update_params.rbi

@@ -61,8 +61,7 @@ module OpenAI
             attr_accessor :name
 
             # Network access available after setup completes. Omit to preserve the current
-            # policy, or pass `null` to reset to disabled for GA requests or enabled for beta
-            # requests.
+            # policy, or pass `null` to reset to the default policy.
             sig { returns(T.nilable(OpenAI::Beta::Agents::Environments::TemplateUpdateParams::Network)) }
             attr_reader :network
 
@@ -164,8 +163,7 @@ module OpenAI
               name: nil,
 
               # Network access available after setup completes. Omit to preserve the current
-              # policy, or pass `null` to reset to disabled for GA requests or enabled for beta
-              # requests.
+              # policy, or pass `null` to reset to the default policy.
               network: nil,
 
               # Packages installed before the runtime network policy applies.
@@ -277,8 +275,7 @@ module OpenAI
               attr_accessor :blocked_domains
 
               # Network access available after setup completes. Omit to preserve the current
-              # policy, or pass `null` to reset to disabled for GA requests or enabled for beta
-              # requests.
+              # policy, or pass `null` to reset to the default policy.
               sig do
                 params(
 

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/agents/sessions/turns/item_list_params.rbi

@@ -0,0 +1,139 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      module Agents
+
+        module Sessions
+
+          module Turns
+
+            class ItemListParams < OpenAI::Internal::Type::BaseModel
+
+              extend OpenAI::Internal::Type::RequestParameters::Converter
+              include OpenAI::Internal::Type::RequestParameters
+
+              OrHash = T.type_alias do
+                T.any(
+                  OpenAI::Beta::Agents::Sessions::Turns::ItemListParams,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+              sig { returns(String) }
+              attr_accessor :session_id
+
+              sig { returns(String) }
+              attr_accessor :turn_id
+
+              # Return items after this cursor in the selected order. Pass the previous
+              # response's last_id, which can differ from the last item's ID.
+              sig { returns(T.nilable(String)) }
+              attr_reader :after
+
+              sig { params(after: String).void }
+              attr_writer :after
+
+              # The maximum number of resources to return, between 1 and 100. Defaults to 20.
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :limit
+
+              sig { params(limit: Integer).void }
+              attr_writer :limit
+
+              # The order in which resources are returned. Defaults to `desc`.
+              sig { returns(T.nilable(OpenAI::Beta::Agents::Sessions::Turns::ItemListParams::Order::OrSymbol)) }
+              attr_reader :order
+
+              sig { params(order: OpenAI::Beta::Agents::Sessions::Turns::ItemListParams::Order::OrSymbol).void }
+              attr_writer :order
+
+              sig do
+                params(
+
+                  session_id: String,
+
+                  turn_id: String,
+
+                  after: String,
+
+                  limit: Integer,
+
+                  order: OpenAI::Beta::Agents::Sessions::Turns::ItemListParams::Order::OrSymbol,
+
+                  request_options: OpenAI::RequestOptions::OrHash
+                )
+                  .returns(T.attached_class)
+              end
+              def self.new(
+
+                session_id:,
+
+                turn_id:,
+
+                # Return items after this cursor in the selected order. Pass the previous
+                # response's last_id, which can differ from the last item's ID.
+                after: nil,
+
+                # The maximum number of resources to return, between 1 and 100. Defaults to 20.
+                limit: nil,
+
+                # The order in which resources are returned. Defaults to `desc`.
+                order: nil,
+
+                request_options: {}
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    session_id: String,
+                    turn_id: String,
+                    after: String,
+                    limit: Integer,
+                    order: OpenAI::Beta::Agents::Sessions::Turns::ItemListParams::Order::OrSymbol,
+                    request_options: OpenAI::RequestOptions
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              # The order in which resources are returned. Defaults to `desc`.
+              module Order
+                extend OpenAI::Internal::Type::Enum
+
+                TaggedSymbol = T.type_alias {
+                  T.all(Symbol, OpenAI::Beta::Agents::Sessions::Turns::ItemListParams::Order)
+                }
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                # Returns resources in ascending order.
+                ASC = T.let(:asc, OpenAI::Beta::Agents::Sessions::Turns::ItemListParams::Order::TaggedSymbol)
+
+                # Returns resources in descending order.
+                DESC = T.let(:desc, OpenAI::Beta::Agents::Sessions::Turns::ItemListParams::Order::TaggedSymbol)
+
+                sig {
+                  override.returns(T::Array[OpenAI::Beta::Agents::Sessions::Turns::ItemListParams::Order::TaggedSymbol])
+                }
+                def self.values
+                end
+              end
+
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/beta_response_computer_tool_call_output_item.rbi

@@ -16,7 +16,7 @@ module OpenAI
           )
         end
 
-        # The unique ID of the computer call tool output.
+        # The ID of the computer tool call output.
         sig { returns(String) }
         attr_accessor :id
 
@@ -96,7 +96,7 @@ module OpenAI
         end
         def self.new(
 
-          # The unique ID of the computer call tool output.
+          # The ID of the computer tool call output.
           id:,
 
           # The ID of the computer tool call that produced the output.

data/rbi/openai/models/beta/beta_response_error.rbi

@@ -136,6 +136,11 @@ module OpenAI
           }
           attr_writer :error_type
 
+          # An opaque target for explicitly continuing this review, or null when
+          # unavailable.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :review_target
+
           # An optional public continuation instruction.
           sig { returns(T.nilable(OpenAI::Beta::BetaResponseError::Misalignment::Steer)) }
           attr_reader :steer
@@ -150,6 +155,8 @@ module OpenAI
 
               error_type: T.any(String, OpenAI::Beta::BetaResponseError::Misalignment::ErrorType::OrSymbol),
 
+              review_target: T.nilable(String),
+
               steer: OpenAI::Beta::BetaResponseError::Misalignment::Steer::OrHash
             )
               .returns(T.attached_class)
@@ -162,6 +169,10 @@ module OpenAI
             # An optional classification; clients must accept additional values.
             error_type: nil,
 
+            # An opaque target for explicitly continuing this review, or null when
+            # unavailable.
+            review_target: nil,
+
             # An optional public continuation instruction.
 
             steer: nil
@@ -173,6 +184,7 @@ module OpenAI
               {
                 detailed_explanation: String,
                 error_type: OpenAI::Beta::BetaResponseError::Misalignment::ErrorType::Variants,
+                review_target: T.nilable(String),
                 steer: OpenAI::Beta::BetaResponseError::Misalignment::Steer
               }
             )

data/rbi/openai/models/beta/beta_responses_server_event.rbi

@@ -5009,6 +5009,11 @@ module OpenAI
               }
               attr_writer :error_type
 
+              # An opaque target for explicitly continuing this review, or null when
+              # unavailable.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :review_target
+
               # An optional public continuation instruction.
               sig {
                 returns(
@@ -5035,6 +5040,8 @@ module OpenAI
                     OpenAI::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::ErrorType::OrSymbol
                   ),
 
+                  review_target: T.nilable(String),
+
                   steer: OpenAI::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::Steer::OrHash
                 )
                   .returns(T.attached_class)
@@ -5047,6 +5054,10 @@ module OpenAI
                 # An optional classification; clients must accept additional values.
                 error_type: nil,
 
+                # An opaque target for explicitly continuing this review, or null when
+                # unavailable.
+                review_target: nil,
+
                 # An optional public continuation instruction.
 
                 steer: nil
@@ -5060,6 +5071,7 @@ module OpenAI
                     error_type: T.nilable(
                       OpenAI::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::ErrorType::Variants
                     ),
+                    review_target: T.nilable(String),
                     steer: T.nilable(
                       OpenAI::Beta::BetaResponsesServerEvent::BetaResponseWsError::Error::Misalignment::Steer
                     )