openai 0.106.0 → 0.108.0

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

data/lib/openai/models/beta/beta_response_input_item.rb

@@ -3082,15 +3082,24 @@ module OpenAI
           #   @return [Symbol, :compaction_trigger]
           required :type, const: :compaction_trigger
 
+          # @!attribute id
+          #   The unique ID of this compaction trigger.
+          #
+          #   @return [String, nil]
+          optional :id, String, nil?: true
+
           # @!attribute agent
           #   The agent that produced this item.
           #
           #   @return [OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger::Agent, nil]
           optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::CompactionTrigger::Agent }, nil?: true
 
-          # @!method initialize(agent: nil, type: :compaction_trigger)
+          # @!method initialize(id: nil, agent: nil, type: :compaction_trigger)
           #   Compacts the current context. Must be the final input item.
           #
+          #   @param id [String, nil]
+          #     The unique ID of this compaction trigger.
+          #
           #   @param agent [OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger::Agent, nil]
           #     The agent that produced this item.
           #

data/lib/openai/models/responses/response_input_item.rb

@@ -2177,9 +2177,18 @@ module OpenAI
           #   @return [Symbol, :compaction_trigger]
           required :type, const: :compaction_trigger
 
-          # @!method initialize(type: :compaction_trigger)
+          # @!attribute id
+          #   The unique ID of this compaction trigger.
+          #
+          #   @return [String, nil]
+          optional :id, String, nil?: true
+
+          # @!method initialize(id: nil, type: :compaction_trigger)
           #   Compacts the current context. Must be the final input item.
           #
+          #   @param id [String, nil]
+          #     The unique ID of this compaction trigger.
+          #
           #   @param type [Symbol, :compaction_trigger]
           #     The type of the item. Always `compaction_trigger`.
         end

data/lib/openai/resources/audio/voice_consents.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Audio
+      # Turn audio into text or text into audio.
+      class VoiceConsents
+        # Upload a voice consent recording.
+        #
+        # `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.
+        #
+        # @overload create(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}, nil]
+        #
+        # @return [OpenAI::Models::Audio::VoiceConsent]
+        #
+        # @see OpenAI::Models::Audio::VoiceConsentCreateParams
+        def create(params)
+          parsed, options = OpenAI::Audio::VoiceConsentCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "audio/voice_consents",
+            headers: {"content-type" => "multipart/form-data"},
+            body: parsed,
+            model: OpenAI::Audio::VoiceConsent,
+            security: {bearer_auth: true},
+            options: options
+          )
+        end
+
+        # Retrieves a voice consent recording.
+        #
+        # @overload retrieve(consent_id, request_options: {})
+        #
+        # @param consent_id [String]
+        #   The ID of the consent recording to retrieve.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [OpenAI::Models::Audio::VoiceConsent]
+        #
+        # @see OpenAI::Models::Audio::VoiceConsentRetrieveParams
+        def retrieve(consent_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["audio/voice_consents/%1$s", consent_id],
+            model: OpenAI::Audio::VoiceConsent,
+            security: {bearer_auth: true},
+            options: params[:request_options]
+          )
+        end
+
+        # Updates a voice consent recording (metadata only).
+        #
+        # @overload update(consent_id, name:, request_options: {})
+        #
+        # @param consent_id [String]
+        #   The ID of the consent recording to update.
+        #
+        # @param name [String]
+        #   The updated label for this consent recording.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [OpenAI::Models::Audio::VoiceConsent]
+        #
+        # @see OpenAI::Models::Audio::VoiceConsentUpdateParams
+        def update(consent_id, params)
+          parsed, options = OpenAI::Audio::VoiceConsentUpdateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["audio/voice_consents/%1$s", consent_id],
+            body: parsed,
+            model: OpenAI::Audio::VoiceConsent,
+            security: {bearer_auth: true},
+            options: options
+          )
+        end
+
+        # Returns a list of voice consent recordings.
+        #
+        # @overload list(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}, nil]
+        #
+        # @return [OpenAI::Internal::CursorPage<OpenAI::Models::Audio::VoiceConsent>]
+        #
+        # @see OpenAI::Models::Audio::VoiceConsentListParams
+        def list(params = {})
+          parsed, options = OpenAI::Audio::VoiceConsentListParams.dump_request(params)
+          query = OpenAI::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "audio/voice_consents",
+            query: query,
+            page: OpenAI::Internal::CursorPage,
+            model: OpenAI::Audio::VoiceConsent,
+            security: {bearer_auth: true},
+            options: options
+          )
+        end
+
+        # Deletes a voice consent recording.
+        #
+        # @overload delete(consent_id, request_options: {})
+        #
+        # @param consent_id [String]
+        #   The ID of the consent recording to delete.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [OpenAI::Models::Audio::VoiceConsentDeleted]
+        #
+        # @see OpenAI::Models::Audio::VoiceConsentDeleteParams
+        def delete(consent_id, params = {})
+          @client.request(
+            method: :delete,
+            path: ["audio/voice_consents/%1$s", consent_id],
+            model: OpenAI::Audio::VoiceConsentDeleted,
+            security: {bearer_auth: true},
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [OpenAI::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/openai/resources/audio.rb

@@ -19,6 +19,10 @@ module OpenAI
       # @return [OpenAI::Resources::Audio::Voices]
       attr_reader :voices
 
+      # Turn audio into text or text into audio.
+      # @return [OpenAI::Resources::Audio::VoiceConsents]
+      attr_reader :voice_consents
+
       # @api private
       #
       # @param client [OpenAI::Client]
@@ -28,6 +32,7 @@ module OpenAI
         @translations = OpenAI::Resources::Audio::Translations.new(client: client)
         @speech = OpenAI::Resources::Audio::Speech.new(client: client)
         @voices = OpenAI::Resources::Audio::Voices.new(client: client)
+        @voice_consents = OpenAI::Resources::Audio::VoiceConsents.new(client: client)
       end
     end
   end

data/lib/openai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenAI
-  VERSION = "0.106.0"
+  VERSION = "0.108.0"
 end

data/lib/openai.rb

@@ -462,6 +462,13 @@ require_relative "openai/models/audio/translation_create_params"
 require_relative "openai/models/audio/translation_create_response"
 require_relative "openai/models/audio/translation_verbose"
 require_relative "openai/models/audio/voice"
+require_relative "openai/models/audio/voice_consent"
+require_relative "openai/models/audio/voice_consent_create_params"
+require_relative "openai/models/audio/voice_consent_deleted"
+require_relative "openai/models/audio/voice_consent_delete_params"
+require_relative "openai/models/audio/voice_consent_list_params"
+require_relative "openai/models/audio/voice_consent_retrieve_params"
+require_relative "openai/models/audio/voice_consent_update_params"
 require_relative "openai/models/audio/voice_create_params"
 require_relative "openai/models/audio_model"
 require_relative "openai/models/audio_response_format"
@@ -1558,6 +1565,7 @@ require_relative "openai/resources/audio"
 require_relative "openai/resources/audio/speech"
 require_relative "openai/resources/audio/transcriptions"
 require_relative "openai/resources/audio/translations"
+require_relative "openai/resources/audio/voice_consents"
 require_relative "openai/resources/audio/voices"
 require_relative "openai/resources/batches"
 require_relative "openai/resources/beta"
@@ -1647,6 +1655,7 @@ require_relative "openai/resources/vector_stores/files"
 require_relative "openai/resources/videos"
 require_relative "openai/resources/webhooks"
 require_relative "openai/resources/webhooks/event_types"
+require_relative "openai/helpers/models/embedding"
 require_relative "openai/helpers/models/responses/response"
 require_relative "openai/helpers/files"
 require_relative "openai/helpers/vector_stores/file_batches"

data/rbi/openai/client.rbi

@@ -127,14 +127,7 @@ module OpenAI
 
     # @api private
     sig do
-      override
-        .params(
-          security: {
-            bearer_auth?: T::Boolean,
-            admin_api_key_auth?: T::Boolean
-          }
-        )
-        .returns(T::Hash[String, String])
+      override.params(security: T::Hash[Symbol, T::Boolean]).returns(T::Hash[String, String])
     end
     private def auth_headers(security:)
     end

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/helpers/realtime/translation.rbi

@@ -36,11 +36,6 @@ module OpenAI
   module Models
     module Realtime
       class UnknownTranslationServerEvent < OpenAI::Realtime::UnknownServerEvent
-        sig { returns(String) }
-        def inspect
-        end
-
-        alias to_s inspect
       end
 
       class TranslationConnection

data/rbi/openai/helpers/realtime/unknown_server_event.rbi

@@ -20,6 +20,12 @@ module OpenAI
         sig { returns(T::Hash[Symbol, T.untyped]) }
         def to_h
         end
+
+        sig { returns(String) }
+        def inspect
+        end
+
+        alias to_s inspect
       end
     end
   end

data/rbi/openai/helpers/websocket.rbi

@@ -33,7 +33,42 @@ module OpenAI
           request_options: T.untyped,
           transport: T.untyped,
           transport_options: T::Hash[T.untyped, T.untyped],
-          block: T.proc.params(connection: TypedConnection).returns(T.untyped)
+          block: T.proc.params(connection: TypedConnection[T.untyped, T.untyped]).returns(T.untyped)
+        )
+          .returns(T.untyped)
+      end
+      def connect(
+        *path_arguments,
+        query: {},
+        websocket_base_url: nil,
+        request_options: nil,
+        transport: nil,
+        transport_options: {},
+        &block
+      )
+      end
+    end
+
+    # @api private
+    module TypedResource
+      extend T::Generic
+      include Resource
+
+      WebSocketClientEvent = type_member
+      WebSocketServerEvent = type_member
+
+      sig do
+        params(
+          path_arguments: T.untyped,
+          query: T::Hash[T.untyped, T.untyped],
+          websocket_base_url: T.nilable(String),
+          request_options: T.untyped,
+          transport: T.untyped,
+          transport_options: T::Hash[T.untyped, T.untyped],
+          block: T
+            .proc
+            .params(connection: TypedConnection[WebSocketClientEvent, WebSocketServerEvent])
+            .returns(T.untyped)
         )
           .returns(T.untyped)
       end
@@ -51,23 +86,26 @@ module OpenAI
 
     # @api private
     class TypedConnection
+      extend T::Generic
       include Enumerable
-      Elem = type_member { {fixed: T.untyped} }
+
+      ClientEvent = type_member(:in)
+      Elem = type_member(:out)
 
       sig { returns(URI::Generic) }
       attr_reader :url
 
-      sig { returns(T.untyped) }
+      sig { returns(T.nilable(Elem)) }
       def receive
       end
 
-      sig { params(event: T.untyped).void }
+      sig { params(event: T.any(ClientEvent, T::Hash[T.any(String, Symbol), T.untyped])).void }
       def send_event(event)
       end
 
       sig do
-        params(block: T.nilable(T.proc.params(event: T.untyped).void)).returns(
-          T.any(TypedConnection, T::Enumerator[T.untyped])
+        params(block: T.nilable(T.proc.params(event: Elem).void)).returns(
+          T.any(TypedConnection[ClientEvent, Elem], T::Enumerator[Elem])
         )
       end
       def each(&block)

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

@@ -53,9 +53,7 @@ module OpenAI
               ]
             ),
             model: T.nilable(OpenAI::Internal::Type::Converter::Input),
-            security: T.nilable(
-              {bearer_auth?: T::Boolean, admin_api_key_auth?: T::Boolean}
-            ),
+            security: T.nilable(T::Hash[Symbol, T::Boolean]),
             options: T.nilable(OpenAI::RequestOptions::OrHash)
           }
         end
@@ -387,9 +385,7 @@ module OpenAI
               ]
             ),
             model: T.nilable(OpenAI::Internal::Type::Converter::Input),
-            security: T.nilable(
-              {bearer_auth?: T::Boolean, admin_api_key_auth?: T::Boolean}
-            ),
+            security: T.nilable(T::Hash[Symbol, T::Boolean]),
             options: T.nilable(OpenAI::RequestOptions::OrHash)
           )
             .returns(T.anything)

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

@@ -228,7 +228,12 @@ module OpenAI
                 attr_writer :input_cache_write_12h_tokens
 
                 # The aggregated number of input tokens written to the cache with a 30-minute
-                # retention period.
+                # retention period. May be absent or null for older responses.
+                sig { returns(T.nilable(Integer)) }
+                attr_accessor :input_cache_write_30m_tokens
+
+                # 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
 
@@ -350,6 +355,8 @@ module OpenAI
 
                     input_cache_write_12h_tokens: Integer,
 
+                    input_cache_write_30m_tokens: T.nilable(Integer),
+
                     input_cache_write_tokens: Integer,
 
                     input_cached_audio_tokens: Integer,
@@ -421,7 +428,11 @@ module OpenAI
                   input_cache_write_12h_tokens: nil,
 
                   # The aggregated number of input tokens written to the cache with a 30-minute
-                  # retention period.
+                  # 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 across 30-minute and
+                  # 12-hour retention periods.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.
@@ -491,6 +502,7 @@ module OpenAI
                       batch: T.nilable(T::Boolean),
                       input_audio_tokens: Integer,
                       input_cache_write_12h_tokens: Integer,
+                      input_cache_write_30m_tokens: T.nilable(Integer),
                       input_cache_write_tokens: Integer,
                       input_cached_audio_tokens: Integer,
                       input_cached_image_tokens: Integer,

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

@@ -230,7 +230,12 @@ module OpenAI
                 attr_writer :input_cache_write_12h_tokens
 
                 # The aggregated number of input tokens written to the cache with a 30-minute
-                # retention period.
+                # retention period. May be absent or null for older responses.
+                sig { returns(T.nilable(Integer)) }
+                attr_accessor :input_cache_write_30m_tokens
+
+                # 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
 
@@ -352,6 +357,8 @@ module OpenAI
 
                     input_cache_write_12h_tokens: Integer,
 
+                    input_cache_write_30m_tokens: T.nilable(Integer),
+
                     input_cache_write_tokens: Integer,
 
                     input_cached_audio_tokens: Integer,
@@ -423,7 +430,11 @@ module OpenAI
                   input_cache_write_12h_tokens: nil,
 
                   # The aggregated number of input tokens written to the cache with a 30-minute
-                  # retention period.
+                  # 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 across 30-minute and
+                  # 12-hour retention periods.
                   input_cache_write_tokens: nil,
 
                   # The aggregated number of cached audio input tokens used.
@@ -493,6 +504,7 @@ module OpenAI
                       batch: T.nilable(T::Boolean),
                       input_audio_tokens: Integer,
                       input_cache_write_12h_tokens: Integer,
+                      input_cache_write_30m_tokens: T.nilable(Integer),
                       input_cache_write_tokens: Integer,
                       input_cached_audio_tokens: Integer,
                       input_cached_image_tokens: Integer,