openai 0.107.0 → 0.108.0

data/rbi/openai/models/audio/voice_consent_list_params.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Audio
+
+      class VoiceConsentListParams < OpenAI::Internal::Type::BaseModel
+
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Audio::VoiceConsentListParams,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # A cursor for use in pagination. `after` is an object ID that defines your place
+        # in the list. For instance, if you make a list request and receive 100 objects,
+        # ending with obj_foo, your subsequent call can include after=obj_foo in order to
+        # fetch the next page of the list.
+        sig { returns(T.nilable(String)) }
+        attr_reader :after
+
+        sig { params(after: String).void }
+        attr_writer :after
+
+        # A limit on the number of objects to be returned. Limit can range between 1 and
+        # 100, and the default is 20.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        sig do
+          params(
+
+            after: String,
+
+            limit: Integer,
+
+            request_options: OpenAI::RequestOptions::OrHash
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # A cursor for use in pagination. `after` is an object ID that defines your place
+          # in the list. For instance, if you make a list request and receive 100 objects,
+          # ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          # fetch the next page of the list.
+          after: nil,
+
+          # A limit on the number of objects to be returned. Limit can range between 1 and
+          # 100, and the default is 20.
+          limit: nil,
+
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {after: String, limit: Integer, request_options: OpenAI::RequestOptions}
+          )
+        end
+        def to_hash
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/audio/voice_consent_retrieve_params.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Audio
+
+      class VoiceConsentRetrieveParams < OpenAI::Internal::Type::BaseModel
+
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Audio::VoiceConsentRetrieveParams,
+            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_update_params.rbi

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

data/rbi/openai/models/response_format_json_schema.rbi

@@ -2,24 +2,25 @@
 
 module OpenAI
   module Models
+
     class ResponseFormatJSONSchema < OpenAI::Internal::Type::BaseModel
+
       OrHash = T.type_alias do
-        T.any(OpenAI::ResponseFormatJSONSchema, OpenAI::Internal::AnyHash)
+        T.any(
+          OpenAI::ResponseFormatJSONSchema,
+          OpenAI::Internal::AnyHash
+        )
       end
 
       # Structured Outputs configuration options, including a JSON Schema.
-      sig do
+      sig {
         returns(
-          T.any(
-            OpenAI::ResponseFormatJSONSchema::JSONSchema::OrHash,
-            OpenAI::StructuredOutput::JsonSchemaConverter
-          )
+          T.any(OpenAI::ResponseFormatJSONSchema::JSONSchema::OrHash, OpenAI::StructuredOutput::JsonSchemaConverter)
         )
-      end
-
+      }
       attr_reader :json_schema
 
-      sig do
+      sig {
         params(
           json_schema: T.any(
             OpenAI::ResponseFormatJSONSchema::JSONSchema::OrHash,
@@ -27,8 +28,7 @@ module OpenAI
           )
         )
           .void
-      end
-
+      }
       attr_writer :json_schema
 
       # The type of response format being defined. Always `json_schema`.
@@ -40,10 +40,12 @@ module OpenAI
       # [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
       sig do
         params(
+
           json_schema: T.any(
             OpenAI::ResponseFormatJSONSchema::JSONSchema::OrHash,
             OpenAI::StructuredOutput::JsonSchemaConverter
           ),
+
           type: Symbol
         )
           .returns(T.attached_class)

data/rbi/openai/resources/audio/voice_consents.rbi

@@ -0,0 +1,108 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Audio
+
+      # Turn audio into text or text into audio.
+      class VoiceConsents
+
+        # Upload a voice consent recording.
+        sig {
+          params(
+            language: String,
+            name: String,
+            recording: OpenAI::Internal::FileInput,
+            request_options: OpenAI::RequestOptions::OrHash
+          )
+            .returns(OpenAI::Audio::VoiceConsent)
+        }
+        def create(
+          # 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
+
+        # Retrieves a voice consent recording.
+        sig {
+          params(consent_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+            OpenAI::Audio::VoiceConsent
+          )
+        }
+        def retrieve(
+          # The ID of the consent recording to retrieve.
+          consent_id,
+          request_options: {}
+        )
+        end
+
+        # Updates a voice consent recording (metadata only).
+        sig {
+          params(consent_id: String, name: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+            OpenAI::Audio::VoiceConsent
+          )
+        }
+        def update(
+          # The ID of the consent recording to update.
+          consent_id,
+          # The updated label for this consent recording.
+          name:,
+          request_options: {}
+        )
+        end
+
+        # Returns a list of voice consent recordings.
+        sig {
+          params(after: String, limit: Integer, request_options: OpenAI::RequestOptions::OrHash).returns(
+            OpenAI::Internal::CursorPage[OpenAI::Audio::VoiceConsent]
+          )
+        }
+        def list(
+          # A cursor for use in pagination. `after` is an object ID that defines your place
+          # in the list. For instance, if you make a list request and receive 100 objects,
+          # ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          # fetch the next page of the list.
+          after: nil,
+          # A limit on the number of objects to be returned. Limit can range between 1 and
+          # 100, and the default is 20.
+          limit: nil,
+          request_options: {}
+        )
+        end
+
+        # Deletes a voice consent recording.
+        sig {
+          params(consent_id: String, request_options: OpenAI::RequestOptions::OrHash).returns(
+            OpenAI::Audio::VoiceConsentDeleted
+          )
+        }
+        def delete(
+          # The ID of the consent recording to delete.
+          consent_id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: OpenAI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+
+    end
+
+  end
+end

data/rbi/openai/resources/audio.rbi

@@ -21,6 +21,10 @@ module OpenAI
       sig { returns(OpenAI::Resources::Audio::Voices) }
       attr_reader :voices
 
+      # Turn audio into text or text into audio.
+      sig { returns(OpenAI::Resources::Audio::VoiceConsents) }
+      attr_reader :voice_consents
+
       # @api private
       sig { params(client: OpenAI::Client).returns(T.attached_class) }
       def self.new(client:)

data/sig/openai/helpers/chat/tool_runner.rbs

@@ -0,0 +1,48 @@
+module OpenAI
+  module Helpers
+    module Chat
+      class ToolRunner
+        type handler = ^(Hash[String, untyped]) -> untyped
+
+        class Error < StandardError
+        end
+
+        class MaxRoundsError < Error
+        end
+
+        # @api private
+        def initialize: (
+          completions: OpenAI::Resources::Chat::Completions,
+          params: Hash[Symbol, untyped],
+          tool_handlers: Hash[String, handler],
+          max_rounds: Integer
+        ) -> void
+
+        # @api private
+        def run: -> OpenAI::Chat::ChatCompletion
+      end
+    end
+  end
+
+  module Resources
+    class Chat
+      class Completions
+        # @api private
+        def create_for_tool_runner: (
+          Hash[Symbol, untyped] params
+        ) -> OpenAI::Chat::ChatCompletion
+
+        def run_tools: (
+          model: String | Symbol,
+          messages: Array[untyped],
+          tools: Array[Class
+          | OpenAI::Chat::ChatCompletionFunctionTool
+          | Hash[Symbol, untyped]],
+          tool_handlers: Hash[String, OpenAI::Helpers::Chat::ToolRunner::handler],
+          ?max_rounds: Integer,
+          **untyped
+        ) -> OpenAI::Chat::ChatCompletion
+      end
+    end
+  end
+end

data/sig/openai/models/admin/organization/usage_audio_speeches_response.rbs

@@ -157,12 +157,12 @@ module OpenAI
                 # retention period. May be absent or null for older responses.
                 attr_accessor input_cache_write_30m_tokens: Integer?
 
-                # 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.
                 attr_reader input_cache_write_tokens: Integer?
 
-                # 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.
                 def input_cache_write_tokens=: (Integer) -> Integer
 
                 # The aggregated number of cached audio input tokens used.
@@ -277,8 +277,8 @@ module OpenAI
                 #   The aggregated number of input tokens written to the cache with a 30-minute
                 #   retention period. May be absent or null for older responses.
                 # @param input_cache_write_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.
                 # @param input_cached_audio_tokens
                 #   The aggregated number of cached audio input tokens used.
                 # @param input_cached_image_tokens

data/sig/openai/models/admin/organization/usage_audio_transcriptions_response.rbs

@@ -157,12 +157,12 @@ module OpenAI
                 # retention period. May be absent or null for older responses.
                 attr_accessor input_cache_write_30m_tokens: Integer?
 
-                # 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.
                 attr_reader input_cache_write_tokens: Integer?
 
-                # 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.
                 def input_cache_write_tokens=: (Integer) -> Integer
 
                 # The aggregated number of cached audio input tokens used.
@@ -277,8 +277,8 @@ module OpenAI
                 #   The aggregated number of input tokens written to the cache with a 30-minute
                 #   retention period. May be absent or null for older responses.
                 # @param input_cache_write_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.
                 # @param input_cached_audio_tokens
                 #   The aggregated number of cached audio input tokens used.
                 # @param input_cached_image_tokens

data/sig/openai/models/admin/organization/usage_code_interpreter_sessions_response.rbs

@@ -157,12 +157,12 @@ module OpenAI
                 # retention period. May be absent or null for older responses.
                 attr_accessor input_cache_write_30m_tokens: Integer?
 
-                # 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.
                 attr_reader input_cache_write_tokens: Integer?
 
-                # 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.
                 def input_cache_write_tokens=: (Integer) -> Integer
 
                 # The aggregated number of cached audio input tokens used.
@@ -277,8 +277,8 @@ module OpenAI
                 #   The aggregated number of input tokens written to the cache with a 30-minute
                 #   retention period. May be absent or null for older responses.
                 # @param input_cache_write_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.
                 # @param input_cached_audio_tokens
                 #   The aggregated number of cached audio input tokens used.
                 # @param input_cached_image_tokens

data/sig/openai/models/admin/organization/usage_completions_response.rbs

@@ -157,12 +157,12 @@ module OpenAI
                 # retention period. May be absent or null for older responses.
                 attr_accessor input_cache_write_30m_tokens: Integer?
 
-                # 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.
                 attr_reader input_cache_write_tokens: Integer?
 
-                # 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.
                 def input_cache_write_tokens=: (Integer) -> Integer
 
                 # The aggregated number of cached audio input tokens used.
@@ -277,8 +277,8 @@ module OpenAI
                 #   The aggregated number of input tokens written to the cache with a 30-minute
                 #   retention period. May be absent or null for older responses.
                 # @param input_cache_write_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.
                 # @param input_cached_audio_tokens
                 #   The aggregated number of cached audio input tokens used.
                 # @param input_cached_image_tokens

data/sig/openai/models/admin/organization/usage_costs_response.rbs

@@ -157,12 +157,12 @@ module OpenAI
                 # retention period. May be absent or null for older responses.
                 attr_accessor input_cache_write_30m_tokens: Integer?
 
-                # 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.
                 attr_reader input_cache_write_tokens: Integer?
 
-                # 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.
                 def input_cache_write_tokens=: (Integer) -> Integer
 
                 # The aggregated number of cached audio input tokens used.
@@ -277,8 +277,8 @@ module OpenAI
                 #   The aggregated number of input tokens written to the cache with a 30-minute
                 #   retention period. May be absent or null for older responses.
                 # @param input_cache_write_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.
                 # @param input_cached_audio_tokens
                 #   The aggregated number of cached audio input tokens used.
                 # @param input_cached_image_tokens

data/sig/openai/models/admin/organization/usage_decisions_response.rbs

@@ -134,8 +134,8 @@ module OpenAI
               # retention period.
               attr_accessor input_cache_write_30m_tokens: Integer?
 
-              # 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.
               attr_accessor input_cache_write_tokens: Integer?
 
               # The aggregated number of cached audio input tokens used.
@@ -217,8 +217,8 @@ module OpenAI
               #   The aggregated number of input tokens written to the cache with a 30-minute
               #   retention period.
               # @param input_cache_write_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.
               # @param input_cached_audio_tokens
               #   The aggregated number of cached audio input tokens used.
               # @param input_cached_image_tokens

data/sig/openai/models/admin/organization/usage_embeddings_response.rbs

@@ -157,12 +157,12 @@ module OpenAI
                 # retention period. May be absent or null for older responses.
                 attr_accessor input_cache_write_30m_tokens: Integer?
 
-                # 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.
                 attr_reader input_cache_write_tokens: Integer?
 
-                # 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.
                 def input_cache_write_tokens=: (Integer) -> Integer
 
                 # The aggregated number of cached audio input tokens used.
@@ -277,8 +277,8 @@ module OpenAI
                 #   The aggregated number of input tokens written to the cache with a 30-minute
                 #   retention period. May be absent or null for older responses.
                 # @param input_cache_write_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.
                 # @param input_cached_audio_tokens
                 #   The aggregated number of cached audio input tokens used.
                 # @param input_cached_image_tokens

data/sig/openai/models/admin/organization/usage_file_search_calls_response.rbs

@@ -157,12 +157,12 @@ module OpenAI
                 # retention period. May be absent or null for older responses.
                 attr_accessor input_cache_write_30m_tokens: Integer?
 
-                # 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.
                 attr_reader input_cache_write_tokens: Integer?
 
-                # 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.
                 def input_cache_write_tokens=: (Integer) -> Integer
 
                 # The aggregated number of cached audio input tokens used.
@@ -277,8 +277,8 @@ module OpenAI
                 #   The aggregated number of input tokens written to the cache with a 30-minute
                 #   retention period. May be absent or null for older responses.
                 # @param input_cache_write_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.
                 # @param input_cached_audio_tokens
                 #   The aggregated number of cached audio input tokens used.
                 # @param input_cached_image_tokens

data/sig/openai/models/admin/organization/usage_images_response.rbs

@@ -157,12 +157,12 @@ module OpenAI
                 # retention period. May be absent or null for older responses.
                 attr_accessor input_cache_write_30m_tokens: Integer?
 
-                # 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.
                 attr_reader input_cache_write_tokens: Integer?
 
-                # 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.
                 def input_cache_write_tokens=: (Integer) -> Integer
 
                 # The aggregated number of cached audio input tokens used.
@@ -277,8 +277,8 @@ module OpenAI
                 #   The aggregated number of input tokens written to the cache with a 30-minute
                 #   retention period. May be absent or null for older responses.
                 # @param input_cache_write_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.
                 # @param input_cached_audio_tokens
                 #   The aggregated number of cached audio input tokens used.
                 # @param input_cached_image_tokens