openai 0.107.0 → 0.108.0

data/rbi/openai/helpers/chat/tool_runner.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module OpenAI
+  module Helpers
+    module Chat
+      class ToolRunner
+        Handler = T.type_alias { T.proc.params(arguments: T::Hash[String, T.untyped]).returns(T.untyped) }
+
+        class Error < StandardError
+        end
+
+        class MaxRoundsError < Error
+        end
+
+        # @api private
+        sig do
+          params(
+            completions: OpenAI::Resources::Chat::Completions,
+            params: T::Hash[Symbol, T.untyped],
+            tool_handlers: T::Hash[String, Handler],
+            max_rounds: Integer
+          )
+            .void
+        end
+        def initialize(completions:, params:, tool_handlers:, max_rounds:)
+        end
+
+        # @api private
+        sig { returns(OpenAI::Chat::ChatCompletion) }
+        def run
+        end
+      end
+    end
+  end
+
+  module Resources
+    class Chat
+      class Completions
+        # @api private
+        sig { params(params: T::Hash[Symbol, T.untyped]).returns(OpenAI::Chat::ChatCompletion) }
+        def create_for_tool_runner(params)
+        end
+
+        sig do
+          params(
+            model: T.any(String, OpenAI::ChatModel::OrSymbol),
+            messages: T::Array[
+              T.any(
+                OpenAI::Chat::ChatCompletionDeveloperMessageParam::OrHash,
+                OpenAI::Chat::ChatCompletionSystemMessageParam::OrHash,
+                OpenAI::Chat::ChatCompletionUserMessageParam::OrHash,
+                OpenAI::Chat::ChatCompletionAssistantMessageParam::OrHash,
+                OpenAI::Chat::ChatCompletionToolMessageParam::OrHash,
+                OpenAI::Chat::ChatCompletionFunctionMessageParam::OrHash
+              )
+            ],
+            tools: T::Array[
+              T.any(
+                OpenAI::StructuredOutput::JsonSchemaConverter,
+                OpenAI::Chat::ChatCompletionFunctionTool::OrHash
+              )
+            ],
+            tool_handlers: T::Hash[String, OpenAI::Helpers::Chat::ToolRunner::Handler],
+            max_rounds: Integer,
+            params: T.untyped
+          )
+            .returns(OpenAI::Chat::ChatCompletion)
+        end
+        def run_tools(model:, messages:, tools:, tool_handlers:, max_rounds: 10, **params)
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/usage_audio_speeches_response.rbi

@@ -232,8 +232,8 @@ module OpenAI
                 sig { returns(T.nilable(Integer)) }
                 attr_accessor :input_cache_write_30m_tokens
 
-                # The aggregated number of input tokens written to the cache with a 30-minute
-                # retention period.
+                # The aggregated number of input tokens written to the cache across 30-minute and
+                # 12-hour retention periods.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -431,8 +431,8 @@ module OpenAI
                   # retention period. May be absent or null for older responses.
                   input_cache_write_30m_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache with a 30-minute
-                  # retention period.
+                  # The aggregated number of input tokens written to the cache across 30-minute and
+                  # 12-hour retention periods.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.

data/rbi/openai/models/admin/organization/usage_audio_transcriptions_response.rbi

@@ -234,8 +234,8 @@ module OpenAI
                 sig { returns(T.nilable(Integer)) }
                 attr_accessor :input_cache_write_30m_tokens
 
-                # The aggregated number of input tokens written to the cache with a 30-minute
-                # retention period.
+                # The aggregated number of input tokens written to the cache across 30-minute and
+                # 12-hour retention periods.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -433,8 +433,8 @@ module OpenAI
                   # retention period. May be absent or null for older responses.
                   input_cache_write_30m_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache with a 30-minute
-                  # retention period.
+                  # The aggregated number of input tokens written to the cache across 30-minute and
+                  # 12-hour retention periods.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.

data/rbi/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbi

@@ -236,8 +236,8 @@ module OpenAI
                 sig { returns(T.nilable(Integer)) }
                 attr_accessor :input_cache_write_30m_tokens
 
-                # The aggregated number of input tokens written to the cache with a 30-minute
-                # retention period.
+                # The aggregated number of input tokens written to the cache across 30-minute and
+                # 12-hour retention periods.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -435,8 +435,8 @@ module OpenAI
                   # retention period. May be absent or null for older responses.
                   input_cache_write_30m_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache with a 30-minute
-                  # retention period.
+                  # The aggregated number of input tokens written to the cache across 30-minute and
+                  # 12-hour retention periods.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.

data/rbi/openai/models/admin/organization/usage_completions_response.rbi

@@ -232,8 +232,8 @@ module OpenAI
                 sig { returns(T.nilable(Integer)) }
                 attr_accessor :input_cache_write_30m_tokens
 
-                # The aggregated number of input tokens written to the cache with a 30-minute
-                # retention period.
+                # The aggregated number of input tokens written to the cache across 30-minute and
+                # 12-hour retention periods.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -431,8 +431,8 @@ module OpenAI
                   # retention period. May be absent or null for older responses.
                   input_cache_write_30m_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache with a 30-minute
-                  # retention period.
+                  # The aggregated number of input tokens written to the cache across 30-minute and
+                  # 12-hour retention periods.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.

data/rbi/openai/models/admin/organization/usage_costs_response.rbi

@@ -228,8 +228,8 @@ module OpenAI
                 sig { returns(T.nilable(Integer)) }
                 attr_accessor :input_cache_write_30m_tokens
 
-                # The aggregated number of input tokens written to the cache with a 30-minute
-                # retention period.
+                # The aggregated number of input tokens written to the cache across 30-minute and
+                # 12-hour retention periods.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -427,8 +427,8 @@ module OpenAI
                   # retention period. May be absent or null for older responses.
                   input_cache_write_30m_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache with a 30-minute
-                  # retention period.
+                  # The aggregated number of input tokens written to the cache across 30-minute and
+                  # 12-hour retention periods.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.

data/rbi/openai/models/admin/organization/usage_decisions_response.rbi

@@ -188,8 +188,8 @@ module OpenAI
               sig { returns(T.nilable(Integer)) }
               attr_accessor :input_cache_write_30m_tokens
 
-              # The aggregated number of input tokens written to the cache with a 30-minute
-              # retention period.
+              # The aggregated number of input tokens written to the cache across 30-minute and
+              # 12-hour retention periods.
               sig { returns(T.nilable(Integer)) }
               attr_accessor :input_cache_write_tokens
 
@@ -354,8 +354,8 @@ module OpenAI
                 # retention period.
                 input_cache_write_30m_tokens: nil,
 
-                # The aggregated number of input tokens written to the cache with a 30-minute
-                # retention period.
+                # The aggregated number of input tokens written to the cache across 30-minute and
+                # 12-hour retention periods.
                 input_cache_write_tokens: nil,
 
                 # The aggregated number of cached audio input tokens used.

data/rbi/openai/models/admin/organization/usage_embeddings_response.rbi

@@ -232,8 +232,8 @@ module OpenAI
                 sig { returns(T.nilable(Integer)) }
                 attr_accessor :input_cache_write_30m_tokens
 
-                # The aggregated number of input tokens written to the cache with a 30-minute
-                # retention period.
+                # The aggregated number of input tokens written to the cache across 30-minute and
+                # 12-hour retention periods.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -431,8 +431,8 @@ module OpenAI
                   # retention period. May be absent or null for older responses.
                   input_cache_write_30m_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache with a 30-minute
-                  # retention period.
+                  # The aggregated number of input tokens written to the cache across 30-minute and
+                  # 12-hour retention periods.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.

data/rbi/openai/models/admin/organization/usage_file_search_calls_response.rbi

@@ -234,8 +234,8 @@ module OpenAI
                 sig { returns(T.nilable(Integer)) }
                 attr_accessor :input_cache_write_30m_tokens
 
-                # The aggregated number of input tokens written to the cache with a 30-minute
-                # retention period.
+                # The aggregated number of input tokens written to the cache across 30-minute and
+                # 12-hour retention periods.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -433,8 +433,8 @@ module OpenAI
                   # retention period. May be absent or null for older responses.
                   input_cache_write_30m_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache with a 30-minute
-                  # retention period.
+                  # The aggregated number of input tokens written to the cache across 30-minute and
+                  # 12-hour retention periods.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.

data/rbi/openai/models/admin/organization/usage_images_response.rbi

@@ -228,8 +228,8 @@ module OpenAI
                 sig { returns(T.nilable(Integer)) }
                 attr_accessor :input_cache_write_30m_tokens
 
-                # The aggregated number of input tokens written to the cache with a 30-minute
-                # retention period.
+                # The aggregated number of input tokens written to the cache across 30-minute and
+                # 12-hour retention periods.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -427,8 +427,8 @@ module OpenAI
                   # retention period. May be absent or null for older responses.
                   input_cache_write_30m_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache with a 30-minute
-                  # retention period.
+                  # The aggregated number of input tokens written to the cache across 30-minute and
+                  # 12-hour retention periods.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.

data/rbi/openai/models/admin/organization/usage_moderations_response.rbi

@@ -232,8 +232,8 @@ module OpenAI
                 sig { returns(T.nilable(Integer)) }
                 attr_accessor :input_cache_write_30m_tokens
 
-                # The aggregated number of input tokens written to the cache with a 30-minute
-                # retention period.
+                # The aggregated number of input tokens written to the cache across 30-minute and
+                # 12-hour retention periods.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -431,8 +431,8 @@ module OpenAI
                   # retention period. May be absent or null for older responses.
                   input_cache_write_30m_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache with a 30-minute
-                  # retention period.
+                  # The aggregated number of input tokens written to the cache across 30-minute and
+                  # 12-hour retention periods.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.

data/rbi/openai/models/admin/organization/usage_vector_stores_response.rbi

@@ -232,8 +232,8 @@ module OpenAI
                 sig { returns(T.nilable(Integer)) }
                 attr_accessor :input_cache_write_30m_tokens
 
-                # The aggregated number of input tokens written to the cache with a 30-minute
-                # retention period.
+                # The aggregated number of input tokens written to the cache across 30-minute and
+                # 12-hour retention periods.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -431,8 +431,8 @@ module OpenAI
                   # retention period. May be absent or null for older responses.
                   input_cache_write_30m_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache with a 30-minute
-                  # retention period.
+                  # The aggregated number of input tokens written to the cache across 30-minute and
+                  # 12-hour retention periods.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.

data/rbi/openai/models/admin/organization/usage_web_search_calls_response.rbi

@@ -234,8 +234,8 @@ module OpenAI
                 sig { returns(T.nilable(Integer)) }
                 attr_accessor :input_cache_write_30m_tokens
 
-                # The aggregated number of input tokens written to the cache with a 30-minute
-                # retention period.
+                # The aggregated number of input tokens written to the cache across 30-minute and
+                # 12-hour retention periods.
                 sig { returns(T.nilable(Integer)) }
                 attr_reader :input_cache_write_tokens
 
@@ -433,8 +433,8 @@ module OpenAI
                   # retention period. May be absent or null for older responses.
                   input_cache_write_30m_tokens: nil,
 
-                  # The aggregated number of input tokens written to the cache with a 30-minute
-                  # retention period.
+                  # The aggregated number of input tokens written to the cache across 30-minute and
+                  # 12-hour retention periods.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.

data/rbi/openai/models/audio/voice_consent.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Audio
+
+      class VoiceConsent < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Audio::VoiceConsent,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The consent recording identifier.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Unix timestamp (in seconds) for when the consent recording was created.
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        # The BCP 47 language tag for the consent phrase (for example, `en-US`).
+        sig { returns(String) }
+        attr_accessor :language
+
+        # The label provided when the consent recording was uploaded.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # The object type, which is always `audio.voice_consent`.
+        sig { returns(Symbol) }
+        attr_accessor :object
+
+        # A consent recording used to authorize creation of a custom voice.
+        sig do
+          params(
+
+            id: String,
+
+            created_at: Integer,
+
+            language: String,
+
+            name: String,
+
+            object: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The consent recording identifier.
+          id:,
+
+          # The Unix timestamp (in seconds) for when the consent recording was created.
+          created_at:,
+
+          # The BCP 47 language tag for the consent phrase (for example, `en-US`).
+          language:,
+
+          # The label provided when the consent recording was uploaded.
+          name:,
+
+          # The object type, which is always `audio.voice_consent`.
+
+          object: :"audio.voice_consent"
+        )
+        end
+
+        sig do
+          override.returns(
+            {id: String, created_at: Integer, language: String, name: String, object: Symbol}
+          )
+        end
+        def to_hash
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/audio/voice_consent_create_params.rbi

@@ -0,0 +1,92 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Audio
+
+      class VoiceConsentCreateParams < OpenAI::Internal::Type::BaseModel
+
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Audio::VoiceConsentCreateParams,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The BCP 47 language tag for the consent phrase (for example, `en-US`).
+        sig { returns(String) }
+        attr_accessor :language
+
+        # The label to use for this consent recording.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # The consent 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 :recording
+
+        sig do
+          params(
+
+            language: String,
+
+            name: String,
+
+            recording: OpenAI::Internal::FileInput,
+
+            request_options: OpenAI::RequestOptions::OrHash
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The BCP 47 language tag for the consent phrase (for example, `en-US`).
+          language:,
+
+          # The label to use for this consent recording.
+          name:,
+
+          # The consent 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.
+          recording:,
+
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              language: String,
+              name: String,
+              recording: OpenAI::Internal::FileInput,
+              request_options: OpenAI::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/audio/voice_consent_delete_params.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Audio
+
+      class VoiceConsentDeleteParams < OpenAI::Internal::Type::BaseModel
+
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Audio::VoiceConsentDeleteParams,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        sig { returns(String) }
+        attr_accessor :consent_id
+
+        sig do
+          params(
+
+            consent_id: String,
+
+            request_options: OpenAI::RequestOptions::OrHash
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          consent_id:,
+
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {consent_id: String, request_options: OpenAI::RequestOptions}
+          )
+        end
+        def to_hash
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/audio/voice_consent_deleted.rbi

@@ -0,0 +1,62 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Audio
+
+      class VoiceConsentDeleted < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Audio::VoiceConsentDeleted,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The consent recording identifier.
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(T::Boolean) }
+        attr_accessor :deleted
+
+        sig { returns(Symbol) }
+        attr_accessor :object
+
+        sig do
+          params(
+
+            id: String,
+
+            deleted: T::Boolean,
+
+            object: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The consent recording identifier.
+          id:,
+
+          deleted:,
+
+          object: :"audio.voice_consent"
+        )
+        end
+
+        sig do
+          override.returns(
+            {id: String, deleted: T::Boolean, object: Symbol}
+          )
+        end
+        def to_hash
+        end
+
+      end
+
+    end
+
+  end
+end