openai 0.97.0 → 0.98.0

data/rbi/openai/internal/transport/base_client.rbi

@@ -409,6 +409,18 @@ module OpenAI
         )
         end
 
+        # @api private
+        sig {
+          params(
+            req: T.untyped,
+            on_response: T.nilable(T.proc.returns(T.untyped)),
+            blk: T.proc.params(chunk: String).returns(T.untyped)
+          )
+            .void
+        }
+        def request_streaming_body(req, on_response = nil, &blk)
+        end
+
         # @api private
         sig do
           params(

data/rbi/openai/internal/type/base_model.rbi

@@ -51,7 +51,7 @@ module OpenAI
 
           # @api private
           sig do
-            returns(
+            params(state: T.nilable(OpenAI::Internal::Type::Converter::CoerceState)).returns(
               T::Hash[
                 Symbol,
                 T.all(
@@ -61,7 +61,7 @@ module OpenAI
               ]
             )
           end
-          def fields
+          def fields(state: nil)
           end
 
           # @api private

data/rbi/openai/internal/type/converter.rbi

@@ -22,7 +22,8 @@ module OpenAI
               maybe: Integer
             },
             error: T.nilable(StandardError),
-            branched: Integer
+            branched: Integer,
+            memo: T.nilable(T::Hash[T.untyped, T.untyped])
           }
         end
 
@@ -123,11 +124,28 @@ module OpenAI
 
           # @api private
           sig do
-            params(translate_names: T::Boolean, request_only: T::Boolean).returns(
+            params(translate_names: T::Boolean, request_only: T::Boolean, memoize: T::Boolean).returns(
               OpenAI::Internal::Type::Converter::CoerceState
             )
           end
-          def self.new_coerce_state(translate_names: true, request_only: false)
+          def self.new_coerce_state(translate_names: true, request_only: false, memoize: false)
+          end
+
+          # @api private
+          sig {
+            params(type_fn: T.proc.returns(T.untyped), state: T.nilable(OpenAI::Internal::Type::Converter::CoerceState))
+              .returns(T.untyped)
+          }
+          def self.resolve_type(type_fn, state: nil)
+          end
+
+          # @api private
+          sig {
+            params(target: T.untyped, value: T.untyped, state: OpenAI::Internal::Type::Converter::CoerceState).returns(
+              T.untyped
+            )
+          }
+          def self.coerce_cached(target, value, state:)
           end
 
           # @api private

data/rbi/openai/internal/type/union.rbi

@@ -65,8 +65,12 @@ module OpenAI
         end
 
         # @api private
-        sig { params(value: T.anything).returns(T.nilable(T.anything)) }
-        private def resolve_variant(value)
+        sig {
+          params(value: T.anything, state: T.nilable(OpenAI::Internal::Type::Converter::CoerceState)).returns(
+            T.nilable(T.anything)
+          )
+        }
+        private def resolve_variant(value, state: nil)
         end
 
         sig { params(other: T.anything).returns(T::Boolean) }

data/rbi/openai/models/beta/agents/sessions/session_trace.rbi

@@ -0,0 +1,97 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      module Agents
+
+        SessionTrace = Sessions::SessionTrace
+
+        module Sessions
+
+          class SessionTrace < OpenAI::Internal::Type::BaseModel
+
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Beta::Agents::Sessions::SessionTrace,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # The root turn ID. Use this ID as the pagination anchor.
+            sig { returns(String) }
+            attr_accessor :id
+
+            # The Unix timestamp in seconds when the root turn was created.
+            sig { returns(Integer) }
+            attr_accessor :created_at
+
+            # The object type, which is always `agent.session.trace`.
+            sig { returns(Symbol) }
+            attr_accessor :object
+
+            # An OTLP JSON ExportTraceServiceRequest containing resourceSpans. Only currently
+            # published data is returned; later trace updates are not awaited.
+            sig { returns(T::Hash[Symbol, T.anything]) }
+            attr_accessor :otlp
+
+            # The session that owns this trace.
+            sig { returns(String) }
+            attr_accessor :session_id
+
+            sig do
+              params(
+
+                id: String,
+
+                created_at: Integer,
+
+                otlp: T::Hash[Symbol, T.anything],
+
+                session_id: String,
+
+                object: Symbol
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # The root turn ID. Use this ID as the pagination anchor.
+              id:,
+
+              # The Unix timestamp in seconds when the root turn was created.
+              created_at:,
+
+              # An OTLP JSON ExportTraceServiceRequest containing resourceSpans. Only currently
+              # published data is returned; later trace updates are not awaited.
+              otlp:,
+
+              # The session that owns this trace.
+              session_id:,
+
+              # The object type, which is always `agent.session.trace`.
+
+              object: :"agent.session.trace"
+            )
+            end
+
+            sig do
+              override.returns(
+                {id: String, created_at: Integer, object: Symbol, otlp: T::Hash[Symbol, T.anything], session_id: String}
+              )
+            end
+            def to_hash
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agents/sessions/trace_list_params.rbi

@@ -0,0 +1,121 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      module Agents
+
+        module Sessions
+
+          class TraceListParams < 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::TraceListParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            sig { returns(String) }
+            attr_accessor :session_id
+
+            # Return resources after this resource ID in the selected order.
+            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::TraceListParams::Order::OrSymbol)) }
+            attr_reader :order
+
+            sig { params(order: OpenAI::Beta::Agents::Sessions::TraceListParams::Order::OrSymbol).void }
+            attr_writer :order
+
+            sig do
+              params(
+
+                session_id: String,
+
+                after: String,
+
+                limit: Integer,
+
+                order: OpenAI::Beta::Agents::Sessions::TraceListParams::Order::OrSymbol,
+
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              session_id:,
+
+              # Return resources after this resource ID in the selected order.
+              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,
+                  after: String,
+                  limit: Integer,
+                  order: OpenAI::Beta::Agents::Sessions::TraceListParams::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::TraceListParams::Order) }
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              # Returns resources in ascending order.
+              ASC = T.let(:asc, OpenAI::Beta::Agents::Sessions::TraceListParams::Order::TaggedSymbol)
+
+              # Returns resources in descending order.
+              DESC = T.let(:desc, OpenAI::Beta::Agents::Sessions::TraceListParams::Order::TaggedSymbol)
+
+              sig { override.returns(T::Array[OpenAI::Beta::Agents::Sessions::TraceListParams::Order::TaggedSymbol]) }
+              def self.values
+              end
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agents/vaults/credential.rbi

@@ -64,14 +64,14 @@ module OpenAI
 
                 created_at: Integer,
 
-                metadata: T::Hash[Symbol, String],
-
                 name: String,
 
                 updated_at: Integer,
 
                 vault_id: String,
 
+                metadata: T::Hash[Symbol, String],
+
                 object: Symbol
               )
                 .returns(T.attached_class)
@@ -87,9 +87,6 @@ module OpenAI
               # The Unix timestamp, in seconds, when the credential was created.
               created_at:,
 
-              # Application-defined key-value pairs associated with this credential.
-              metadata:,
-
               # The human-readable name of the credential.
               name:,
 
@@ -99,6 +96,9 @@ module OpenAI
               # The ID of the vault containing this credential.
               vault_id:,
 
+              # Application-defined key-value pairs associated with this credential.
+              metadata: {},
+
               # The object type. Always `vault.credential`.
 
               object: :"vault.credential"

data/rbi/openai/models/beta/beta_response_output_text.rbi

@@ -131,7 +131,7 @@ module OpenAI
             sig { returns(String) }
             attr_accessor :filename
 
-            # The index of the file in the list of files.
+            # The index in the output text at which to insert the file citation.
             sig { returns(Integer) }
             attr_accessor :index
 
@@ -161,7 +161,7 @@ module OpenAI
               # The filename of the file cited.
               filename:,
 
-              # The index of the file in the list of files.
+              # The index in the output text at which to insert the file citation.
               index:,
 
               # The type of the file citation. Always `file_citation`.

data/rbi/openai/models/beta/beta_response_output_text_annotation_added_event.rbi

@@ -155,7 +155,7 @@ module OpenAI
             sig { returns(String) }
             attr_accessor :filename
 
-            # The index of the file in the list of files.
+            # The index in the output text at which to insert the file citation.
             sig { returns(Integer) }
             attr_accessor :index
 
@@ -185,7 +185,7 @@ module OpenAI
               # The filename of the file cited.
               filename:,
 
-              # The index of the file in the list of files.
+              # The index in the output text at which to insert the file citation.
               index:,
 
               # The type of the file citation. Always `file_citation`.

data/rbi/openai/models/beta/environment.rbi

@@ -102,6 +102,11 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # The effective CPU and memory tier, or null when unknown or outside the public
+          # tiers.
+          sig { returns(T.nilable(OpenAI::Beta::Environment::OpenAIHosted::ContainerSize::TaggedSymbol)) }
+          attr_accessor :container_size
+
           # The effective desktop configuration.
           sig { returns(T.nilable(OpenAI::Beta::Environment::OpenAIHosted::Desktop)) }
           attr_reader :desktop
@@ -134,6 +139,8 @@ module OpenAI
                 T.any(OpenAI::Beta::HostedSkillReference::OrHash, OpenAI::Beta::HostedSkill::Inline::OrHash)
               ],
 
+              container_size: T.nilable(OpenAI::Beta::Environment::OpenAIHosted::ContainerSize::OrSymbol),
+
               desktop: OpenAI::Beta::Environment::OpenAIHosted::Desktop::OrHash,
 
               type: Symbol
@@ -163,6 +170,10 @@ module OpenAI
             # Skills installed in the environment, excluding their archive contents.
             skills:,
 
+            # The effective CPU and memory tier, or null when unknown or outside the public
+            # tiers.
+            container_size: nil,
+
             # The effective desktop configuration.
             desktop: nil,
 
@@ -183,6 +194,7 @@ module OpenAI
                 plugins: T::Array[OpenAI::Beta::HostedPlugin],
                 skills: T::Array[OpenAI::Beta::HostedSkill::Variants],
                 type: Symbol,
+                container_size: T.nilable(OpenAI::Beta::Environment::OpenAIHosted::ContainerSize::TaggedSymbol),
                 desktop: OpenAI::Beta::Environment::OpenAIHosted::Desktop
               }
             )
@@ -318,6 +330,23 @@ module OpenAI
 
           end
 
+          # The effective CPU and memory tier, or null when unknown or outside the public
+          # tiers.
+          module ContainerSize
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Beta::Environment::OpenAIHosted::ContainerSize) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            SMALL = T.let(:small, OpenAI::Beta::Environment::OpenAIHosted::ContainerSize::TaggedSymbol)
+            MEDIUM = T.let(:medium, OpenAI::Beta::Environment::OpenAIHosted::ContainerSize::TaggedSymbol)
+            LARGE = T.let(:large, OpenAI::Beta::Environment::OpenAIHosted::ContainerSize::TaggedSymbol)
+
+            sig { override.returns(T::Array[OpenAI::Beta::Environment::OpenAIHosted::ContainerSize::TaggedSymbol]) }
+            def self.values
+            end
+          end
+
           class Desktop < OpenAI::Internal::Type::BaseModel
             OrHash = T.type_alias do
               T.any(

data/rbi/openai/models/beta/environment_param.rbi

@@ -72,6 +72,13 @@ module OpenAI
           sig { returns(T.nilable(T::Array[String])) }
           attr_accessor :capability_directories
 
+          # The hosted container size. Omission selects the medium tier.
+          sig { returns(T.nilable(OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize::OrSymbol)) }
+          attr_reader :container_size
+
+          sig { params(container_size: OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize::OrSymbol).void }
+          attr_writer :container_size
+
           # Desktop provisioning. Omission or null inherits the template setting, or
           # defaults to disabled.
           sig { returns(T.nilable(OpenAI::Beta::EnvironmentParam::OpenAIHosted::Desktop)) }
@@ -148,6 +155,8 @@ module OpenAI
 
               capability_directories: T.nilable(T::Array[String]),
 
+              container_size: OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize::OrSymbol,
+
               desktop: T.nilable(OpenAI::Beta::EnvironmentParam::OpenAIHosted::Desktop::OrHash),
 
               env: T.nilable(T::Hash[Symbol, String]),
@@ -190,6 +199,9 @@ module OpenAI
             # list.
             capability_directories: nil,
 
+            # The hosted container size. Omission selects the medium tier.
+            container_size: nil,
+
             # Desktop provisioning. Omission or null inherits the template setting, or
             # defaults to disabled.
             desktop: nil,
@@ -232,6 +244,7 @@ module OpenAI
               {
                 type: Symbol,
                 capability_directories: T.nilable(T::Array[String]),
+                container_size: OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize::OrSymbol,
                 desktop: T.nilable(OpenAI::Beta::EnvironmentParam::OpenAIHosted::Desktop),
                 env: T.nilable(T::Hash[Symbol, String]),
                 environment_template_id: String,
@@ -258,6 +271,24 @@ module OpenAI
           def to_hash
           end
 
+          # The hosted container size. Omission selects the medium tier.
+          module ContainerSize
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            SMALL = T.let(:small, OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize::TaggedSymbol)
+            MEDIUM = T.let(:medium, OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize::TaggedSymbol)
+            LARGE = T.let(:large, OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize::TaggedSymbol)
+
+            sig {
+              override.returns(T::Array[OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize::TaggedSymbol])
+            }
+            def self.values
+            end
+          end
+
           class Desktop < OpenAI::Internal::Type::BaseModel
             OrHash = T.type_alias do
               T.any(

data/rbi/openai/models/beta/session_turn_error.rbi

@@ -76,6 +76,9 @@ module OpenAI
           # The request exceeds the available rate limit.
           RATE_LIMIT_EXCEEDED = T.let(:rate_limit_exceeded, OpenAI::Beta::SessionTurnError::Code::TaggedSymbol)
 
+          # Flex processing is temporarily unavailable.
+          FLEX_UNAVAILABLE = T.let(:flex_unavailable, OpenAI::Beta::SessionTurnError::Code::TaggedSymbol)
+
           # The model service is temporarily overloaded.
           SERVER_OVERLOADED = T.let(:server_overloaded, OpenAI::Beta::SessionTurnError::Code::TaggedSymbol)
 

data/rbi/openai/models/chat/chat_completion_content_part_image.rbi

@@ -140,6 +140,7 @@ module OpenAI
             AUTO = T.let(:auto, OpenAI::Chat::ChatCompletionContentPartImage::ImageURL::Detail::TaggedSymbol)
             LOW = T.let(:low, OpenAI::Chat::ChatCompletionContentPartImage::ImageURL::Detail::TaggedSymbol)
             HIGH = T.let(:high, OpenAI::Chat::ChatCompletionContentPartImage::ImageURL::Detail::TaggedSymbol)
+            ORIGINAL = T.let(:original, OpenAI::Chat::ChatCompletionContentPartImage::ImageURL::Detail::TaggedSymbol)
 
             sig {
               override.returns(T::Array[OpenAI::Chat::ChatCompletionContentPartImage::ImageURL::Detail::TaggedSymbol])

data/rbi/openai/models/live/fork_server_event.rbi

@@ -159,7 +159,14 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :type
 
-          # A SIP DTMF keypress successfully sent by the hosted tool. Delivered only to
+          # The event_id of the client command, when supplied.
+          sig { returns(T.nilable(String)) }
+          attr_reader :client_event_id
+
+          sig { params(client_event_id: String).void }
+          attr_writer :client_event_id
+
+          # A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to
           # sideband observers; this is not a client command.
           sig do
             params(
@@ -168,6 +175,8 @@ module OpenAI
 
               event_id: String,
 
+              client_event_id: String,
+
               type: Symbol
             )
               .returns(T.attached_class)
@@ -178,13 +187,16 @@ module OpenAI
 
             event_id:,
 
+            # The event_id of the client command, when supplied.
+            client_event_id: nil,
+
             type: :"transport.dtmf.send"
           )
           end
 
           sig do
             override.returns(
-              {event: String, event_id: String, type: Symbol}
+              {event: String, event_id: String, type: Symbol, client_event_id: T.nilable(String)}
             )
           end
           def to_hash

data/rbi/openai/models/live/server_event.rbi

@@ -159,7 +159,14 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :type
 
-          # A SIP DTMF keypress successfully sent by the hosted tool. Delivered only to
+          # The event_id of the client command, when supplied.
+          sig { returns(T.nilable(String)) }
+          attr_reader :client_event_id
+
+          sig { params(client_event_id: String).void }
+          attr_writer :client_event_id
+
+          # A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to
           # sideband observers; this is not a client command.
           sig do
             params(
@@ -168,6 +175,8 @@ module OpenAI
 
               event_id: String,
 
+              client_event_id: String,
+
               type: Symbol
             )
               .returns(T.attached_class)
@@ -178,13 +187,16 @@ module OpenAI
 
             event_id:,
 
+            # The event_id of the client command, when supplied.
+            client_event_id: nil,
+
             type: :"transport.dtmf.send"
           )
           end
 
           sig do
             override.returns(
-              {event: String, event_id: String, type: Symbol}
+              {event: String, event_id: String, type: Symbol, client_event_id: T.nilable(String)}
             )
           end
           def to_hash

data/rbi/openai/models/realtime/translations/client_secret_create_params.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Realtime
+
+      module Translations
+
+        class ClientSecretCreateParams < OpenAI::Models::Realtime::RealtimeTranslationClientSecretCreateRequest
+
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Realtime::Translations::ClientSecretCreateParams,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          sig do
+            params(
+
+              session: OpenAI::Realtime::RealtimeTranslationSessionCreateRequest::OrHash,
+
+              expires_after: OpenAI::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter::OrHash,
+
+              request_options: OpenAI::RequestOptions::OrHash
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # Realtime translation session configuration. Translation sessions stream source
+            # audio in and translated audio plus transcript deltas out continuously.
+            session:,
+
+            # Configuration for the client secret expiration. Expiration refers to the time
+            # after which a client secret will no longer be valid for creating sessions. The
+            # session itself may continue after that time once started. A secret can be used
+            # to create multiple sessions until it expires.
+            expires_after: nil,
+
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                session: OpenAI::Realtime::RealtimeTranslationSessionCreateRequest,
+                expires_after: OpenAI::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter,
+                request_options: OpenAI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end