openai 0.107.0 → 0.109.0

data/lib/openai/models/admin/organization/usage_code_interpreter_sessions_response.rb

@@ -245,8 +245,8 @@ module OpenAI
                 optional :input_cache_write_30m_tokens, Integer, nil?: true
 
                 # @!attribute 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.
                 #
                 #   @return [Integer, nil]
                 optional :input_cache_write_tokens, Integer
@@ -384,8 +384,8 @@ module OpenAI
                 #     retention period. May be absent or null for older responses.
                 #
                 #   @param 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.
                 #
                 #   @param input_cached_audio_tokens [Integer]
                 #     The aggregated number of cached audio input tokens used.

data/lib/openai/models/admin/organization/usage_completions_response.rb

@@ -241,8 +241,8 @@ module OpenAI
                 optional :input_cache_write_30m_tokens, Integer, nil?: true
 
                 # @!attribute 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.
                 #
                 #   @return [Integer, nil]
                 optional :input_cache_write_tokens, Integer
@@ -380,8 +380,8 @@ module OpenAI
                 #     retention period. May be absent or null for older responses.
                 #
                 #   @param 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.
                 #
                 #   @param input_cached_audio_tokens [Integer]
                 #     The aggregated number of cached audio input tokens used.

data/lib/openai/models/admin/organization/usage_costs_response.rb

@@ -239,8 +239,8 @@ module OpenAI
                 optional :input_cache_write_30m_tokens, Integer, nil?: true
 
                 # @!attribute 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.
                 #
                 #   @return [Integer, nil]
                 optional :input_cache_write_tokens, Integer
@@ -378,8 +378,8 @@ module OpenAI
                 #     retention period. May be absent or null for older responses.
                 #
                 #   @param 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.
                 #
                 #   @param input_cached_audio_tokens [Integer]
                 #     The aggregated number of cached audio input tokens used.

data/lib/openai/models/admin/organization/usage_decisions_response.rb

@@ -145,8 +145,8 @@ module OpenAI
               optional :input_cache_write_30m_tokens, Integer, nil?: true
 
               # @!attribute 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.
               #
               #   @return [Integer, nil]
               optional :input_cache_write_tokens, Integer, nil?: true
@@ -284,8 +284,8 @@ module OpenAI
               #     retention period.
               #
               #   @param input_cache_write_tokens [Integer, 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.
               #
               #   @param input_cached_audio_tokens [Integer, nil]
               #     The aggregated number of cached audio input tokens used.

data/lib/openai/models/admin/organization/usage_embeddings_response.rb

@@ -241,8 +241,8 @@ module OpenAI
                 optional :input_cache_write_30m_tokens, Integer, nil?: true
 
                 # @!attribute 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.
                 #
                 #   @return [Integer, nil]
                 optional :input_cache_write_tokens, Integer
@@ -380,8 +380,8 @@ module OpenAI
                 #     retention period. May be absent or null for older responses.
                 #
                 #   @param 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.
                 #
                 #   @param input_cached_audio_tokens [Integer]
                 #     The aggregated number of cached audio input tokens used.

data/lib/openai/models/admin/organization/usage_file_search_calls_response.rb

@@ -243,8 +243,8 @@ module OpenAI
                 optional :input_cache_write_30m_tokens, Integer, nil?: true
 
                 # @!attribute 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.
                 #
                 #   @return [Integer, nil]
                 optional :input_cache_write_tokens, Integer
@@ -382,8 +382,8 @@ module OpenAI
                 #     retention period. May be absent or null for older responses.
                 #
                 #   @param 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.
                 #
                 #   @param input_cached_audio_tokens [Integer]
                 #     The aggregated number of cached audio input tokens used.

data/lib/openai/models/admin/organization/usage_images_response.rb

@@ -239,8 +239,8 @@ module OpenAI
                 optional :input_cache_write_30m_tokens, Integer, nil?: true
 
                 # @!attribute 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.
                 #
                 #   @return [Integer, nil]
                 optional :input_cache_write_tokens, Integer
@@ -378,8 +378,8 @@ module OpenAI
                 #     retention period. May be absent or null for older responses.
                 #
                 #   @param 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.
                 #
                 #   @param input_cached_audio_tokens [Integer]
                 #     The aggregated number of cached audio input tokens used.

data/lib/openai/models/admin/organization/usage_moderations_response.rb

@@ -241,8 +241,8 @@ module OpenAI
                 optional :input_cache_write_30m_tokens, Integer, nil?: true
 
                 # @!attribute 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.
                 #
                 #   @return [Integer, nil]
                 optional :input_cache_write_tokens, Integer
@@ -380,8 +380,8 @@ module OpenAI
                 #     retention period. May be absent or null for older responses.
                 #
                 #   @param 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.
                 #
                 #   @param input_cached_audio_tokens [Integer]
                 #     The aggregated number of cached audio input tokens used.

data/lib/openai/models/admin/organization/usage_vector_stores_response.rb

@@ -243,8 +243,8 @@ module OpenAI
                 optional :input_cache_write_30m_tokens, Integer, nil?: true
 
                 # @!attribute 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.
                 #
                 #   @return [Integer, nil]
                 optional :input_cache_write_tokens, Integer
@@ -382,8 +382,8 @@ module OpenAI
                 #     retention period. May be absent or null for older responses.
                 #
                 #   @param 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.
                 #
                 #   @param input_cached_audio_tokens [Integer]
                 #     The aggregated number of cached audio input tokens used.

data/lib/openai/models/admin/organization/usage_web_search_calls_response.rb

@@ -243,8 +243,8 @@ module OpenAI
                 optional :input_cache_write_30m_tokens, Integer, nil?: true
 
                 # @!attribute 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.
                 #
                 #   @return [Integer, nil]
                 optional :input_cache_write_tokens, Integer
@@ -382,8 +382,8 @@ module OpenAI
                 #     retention period. May be absent or null for older responses.
                 #
                 #   @param 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.
                 #
                 #   @param input_cached_audio_tokens [Integer]
                 #     The aggregated number of cached audio input tokens used.

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Audio
+      # @see OpenAI::Resources::Audio::VoiceConsents#create
+      class VoiceConsent < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The consent recording identifier.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The Unix timestamp (in seconds) for when the consent recording was created.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute language
+        #   The BCP 47 language tag for the consent phrase (for example, `en-US`).
+        #
+        #   @return [String]
+        required :language, String
+
+        # @!attribute name
+        #   The label provided when the consent recording was uploaded.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute object
+        #   The object type, which is always `audio.voice_consent`.
+        #
+        #   @return [Symbol, :"audio.voice_consent"]
+        required :object, const: :"audio.voice_consent"
+
+        # @!method initialize(id:, created_at:, language:, name:, object: :"audio.voice_consent")
+        #   A consent recording used to authorize creation of a custom voice.
+        #
+        #   @param id [String]
+        #     The consent recording identifier.
+        #
+        #   @param created_at [Integer]
+        #     The Unix timestamp (in seconds) for when the consent recording was created.
+        #
+        #   @param language [String]
+        #     The BCP 47 language tag for the consent phrase (for example, `en-US`).
+        #
+        #   @param name [String]
+        #     The label provided when the consent recording was uploaded.
+        #
+        #   @param object [Symbol, :"audio.voice_consent"]
+        #     The object type, which is always `audio.voice_consent`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Audio
+      # @see OpenAI::Resources::Audio::VoiceConsents#create
+      class VoiceConsentCreateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!attribute language
+        #   The BCP 47 language tag for the consent phrase (for example, `en-US`).
+        #
+        #   @return [String]
+        required :language, String
+
+        # @!attribute name
+        #   The label to use for this consent recording.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute recording
+        #   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.
+        #
+        #   @return [Pathname, StringIO, IO, String, OpenAI::FilePart]
+        required :recording, OpenAI::Internal::Type::FileInput
+
+        # @!method initialize(language:, name:, recording:, request_options: {})
+        #   @param language [String]
+        #     The BCP 47 language tag for the consent phrase (for example, `en-US`).
+        #
+        #   @param name [String]
+        #     The label to use for this consent recording.
+        #
+        #   @param recording [Pathname, StringIO, IO, String, OpenAI::FilePart]
+        #     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.
+        #
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Audio
+      # @see OpenAI::Resources::Audio::VoiceConsents#delete
+      class VoiceConsentDeleteParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!attribute consent_id
+        #
+        #   @return [String]
+        required :consent_id, String
+
+        # @!method initialize(consent_id:, request_options: {})
+        #   @param consent_id [String]
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Audio
+      # @see OpenAI::Resources::Audio::VoiceConsents#delete
+      class VoiceConsentDeleted < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The consent recording identifier.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute deleted
+        #
+        #   @return [Boolean]
+        required :deleted, OpenAI::Internal::Type::Boolean
+
+        # @!attribute object
+        #
+        #   @return [Symbol, :"audio.voice_consent"]
+        required :object, const: :"audio.voice_consent"
+
+        # @!method initialize(id:, deleted:, object: :"audio.voice_consent")
+        #   @param id [String]
+        #     The consent recording identifier.
+        #
+        #   @param deleted [Boolean]
+        #
+        #   @param object [Symbol, :"audio.voice_consent"]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Audio
+      # @see OpenAI::Resources::Audio::VoiceConsents#list
+      class VoiceConsentListParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!attribute after
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :after, String
+
+        # @!attribute limit
+        #   A limit on the number of objects to be returned. Limit can range between 1 and
+        #   100, and the default is 20.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!method initialize(after: nil, limit: nil, request_options: {})
+        #   @param after [String]
+        #     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.
+        #
+        #   @param limit [Integer]
+        #     A limit on the number of objects to be returned. Limit can range between 1 and
+        #     100, and the default is 20.
+        #
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Audio
+      # @see OpenAI::Resources::Audio::VoiceConsents#retrieve
+      class VoiceConsentRetrieveParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!attribute consent_id
+        #
+        #   @return [String]
+        required :consent_id, String
+
+        # @!method initialize(consent_id:, request_options: {})
+        #   @param consent_id [String]
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Audio
+      # @see OpenAI::Resources::Audio::VoiceConsents#update
+      class VoiceConsentUpdateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!attribute consent_id
+        #
+        #   @return [String]
+        required :consent_id, String
+
+        # @!attribute name
+        #   The updated label for this consent recording.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(consent_id:, name:, request_options: {})
+        #   @param consent_id [String]
+        #
+        #   @param name [String]
+        #     The updated label for this consent recording.
+        #
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end