openai 0.107.0 → 0.109.0

data/sig/openai/models/audio/voice_consent_create_params.rbs

@@ -0,0 +1,61 @@
+module OpenAI
+  module Models
+    module Audio
+      type voice_consent_create_params =
+        {
+          language: String,
+          name: String,
+          recording: OpenAI::Internal::file_input,
+          ?request_options: OpenAI::request_opts
+        }
+
+      class VoiceConsentCreateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # The BCP 47 language tag for the consent phrase (for example, `en-US`).
+        attr_accessor language: String
+
+        # The label to use for this consent recording.
+        attr_accessor name: String
+
+        # 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.
+        attr_accessor recording: OpenAI::Internal::file_input
+
+        # @param language
+        #   The BCP 47 language tag for the consent phrase (for example, `en-US`).
+        # @param name
+        #   The label to use for this consent recording.
+        # @param 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.
+        def initialize: (
+          language: String,
+          name: String,
+          recording: OpenAI::Internal::file_input,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          language: String,
+          name: String,
+          recording: OpenAI::Internal::file_input,
+          ?request_options: OpenAI::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/audio/voice_consent_delete_params.rbs

@@ -0,0 +1,25 @@
+module OpenAI
+  module Models
+    module Audio
+      type voice_consent_delete_params =
+        { consent_id: String, ?request_options: OpenAI::request_opts }
+
+      class VoiceConsentDeleteParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        attr_accessor consent_id: String
+
+        def initialize: (
+          consent_id: String,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          consent_id: String,
+          ?request_options: OpenAI::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/audio/voice_consent_deleted.rbs

@@ -0,0 +1,31 @@
+module OpenAI
+  module Models
+    module Audio
+      type voice_consent_deleted =
+        { id: String, deleted: bool, ?object: :"audio.voice_consent" }
+
+      class VoiceConsentDeleted < OpenAI::Internal::Type::BaseModel
+        # The consent recording identifier.
+        attr_accessor id: String
+
+        attr_accessor deleted: bool
+
+        attr_accessor object: :"audio.voice_consent"
+
+        # @param id
+        #   The consent recording identifier.
+        def initialize: (
+          id: String,
+          deleted: bool,
+          ?object: :"audio.voice_consent"
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          deleted: bool,
+          ?object: :"audio.voice_consent"
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/audio/voice_consent_list_params.rbs

@@ -0,0 +1,57 @@
+module OpenAI
+  module Models
+    module Audio
+      type voice_consent_list_params =
+        {
+          ?after: String,
+          ?limit: Integer,
+          ?request_options: OpenAI::request_opts
+        }
+
+      class VoiceConsentListParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # 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.
+        attr_reader 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.
+        def after=: (String) -> String
+
+        # A limit on the number of objects to be returned. Limit can range between 1 and
+        # 100, and the default is 20.
+        attr_reader limit: Integer?
+
+        # A limit on the number of objects to be returned. Limit can range between 1 and
+        # 100, and the default is 20.
+        def limit=: (Integer) -> Integer
+
+        # @param 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.
+        # @param limit
+        #   A limit on the number of objects to be returned. Limit can range between 1 and
+        #   100, and the default is 20.
+        def initialize: (
+          ?after: String,
+          ?limit: Integer,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          ?after: String,
+          ?limit: Integer,
+          ?request_options: OpenAI::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/audio/voice_consent_retrieve_params.rbs

@@ -0,0 +1,25 @@
+module OpenAI
+  module Models
+    module Audio
+      type voice_consent_retrieve_params =
+        { consent_id: String, ?request_options: OpenAI::request_opts }
+
+      class VoiceConsentRetrieveParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        attr_accessor consent_id: String
+
+        def initialize: (
+          consent_id: String,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          consent_id: String,
+          ?request_options: OpenAI::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/audio/voice_consent_update_params.rbs

@@ -0,0 +1,36 @@
+module OpenAI
+  module Models
+    module Audio
+      type voice_consent_update_params =
+        {
+          consent_id: String,
+          name: String,
+          ?request_options: OpenAI::request_opts
+        }
+
+      class VoiceConsentUpdateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        attr_accessor consent_id: String
+
+        # The updated label for this consent recording.
+        attr_accessor name: String
+
+        # @param name
+        #   The updated label for this consent recording.
+        def initialize: (
+          consent_id: String,
+          name: String,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          consent_id: String,
+          name: String,
+          ?request_options: OpenAI::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/openai/providers.rbs

@@ -6,6 +6,14 @@ module OpenAI
       ?token_provider: (^-> String)?
     ) -> OpenAI::Provider
 
+    def self.vertex: (
+      ?project: String?,
+      ?location: String?,
+      ?base_url: String?,
+      ?token_provider: (^-> String)?,
+      ?credentials: untyped
+    ) -> OpenAI::Provider
+
     def self.bedrock: (
       ?endpoint: (:mantle | :runtime | "mantle" | "runtime")?,
       ?region: String?,

data/sig/openai/resources/audio/voice_consents.rbs

@@ -0,0 +1,38 @@
+module OpenAI
+  module Resources
+    class Audio
+      class VoiceConsents
+        def create: (
+          language: String,
+          name: String,
+          recording: OpenAI::Internal::file_input,
+          ?request_options: OpenAI::request_opts
+        ) -> OpenAI::Audio::VoiceConsent
+
+        def retrieve: (
+          String consent_id,
+          ?request_options: OpenAI::request_opts
+        ) -> OpenAI::Audio::VoiceConsent
+
+        def update: (
+          String consent_id,
+          name: String,
+          ?request_options: OpenAI::request_opts
+        ) -> OpenAI::Audio::VoiceConsent
+
+        def list: (
+          ?after: String,
+          ?limit: Integer,
+          ?request_options: OpenAI::request_opts
+        ) -> OpenAI::Internal::CursorPage[OpenAI::Audio::VoiceConsent]
+
+        def delete: (
+          String consent_id,
+          ?request_options: OpenAI::request_opts
+        ) -> OpenAI::Audio::VoiceConsentDeleted
+
+        def initialize: (client: OpenAI::Client) -> void
+      end
+    end
+  end
+end

data/sig/openai/resources/audio.rbs

@@ -9,6 +9,8 @@ module OpenAI
 
       attr_reader voices: OpenAI::Resources::Audio::Voices
 
+      attr_reader voice_consents: OpenAI::Resources::Audio::VoiceConsents
+
       def initialize: (client: OpenAI::Client) -> void
     end
   end

data/vertex.md

@@ -0,0 +1,29 @@
+# Google Vertex AI
+
+Configure the standard `OpenAI::Client` to use the Responses API through Vertex AI. For Google Application Default Credentials (ADC), add the optional `googleauth` gem to your application's Gemfile and run `bundle install`:
+
+```ruby
+gem "googleauth", "~> 1"
+```
+
+Configure ADC in your environment, then create a client:
+
+```ruby
+require "openai"
+
+client = OpenAI::Client.new(
+  provider: OpenAI::Providers.vertex(
+    project: "your-project-id",
+    location: "your-vertex-location"
+  )
+)
+
+response = client.responses.create(model: "your-enabled-model", input: "Say hello!")
+puts(response.output_text)
+```
+
+Use a model enabled for your project and location. Vertex AI determines which Responses features are available.
+
+To manage credentials in your application, pass either `credentials:` with a Google credentials object or `token_provider:` with a callback that returns a current access token. The callback runs once per request attempt, including retries; cache and refresh tokens as needed. The `googleauth` gem is not required when using `token_provider:`.
+
+To use a test server or trusted gateway, set `base_url:` to the full API root before `/responses`. The configured origin receives your bearer token. HTTP test roots are supported; use HTTPS in production.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openai
 version: !ruby/object:Gem::Version
-  version: 0.107.0
+  version: 0.109.0
 platform: ruby
 authors:
 - OpenAI
@@ -49,6 +49,7 @@ extra_rdoc_files:
 - local-audio.md
 - realtime.md
 - responses-websocket.md
+- vertex.md
 files:
 - ".ignore"
 - CHANGELOG.md
@@ -59,6 +60,7 @@ files:
 - bedrock.md
 - docs/architecture/security-model.md
 - examples/audio/record_and_play.rb
+- examples/chat/tool_runner.rb
 - examples/mtls_custom_http_client.rb
 - examples/realtime/README.md
 - examples/realtime/browser/README.md
@@ -103,6 +105,7 @@ files:
 - lib/openai/helpers/beta/agents/tool_dispatcher.rb
 - lib/openai/helpers/beta/agents/tool_error.rb
 - lib/openai/helpers/beta/agents/typed_output.rb
+- lib/openai/helpers/chat/tool_runner.rb
 - lib/openai/helpers/client_options.rb
 - lib/openai/helpers/client_runtime.rb
 - lib/openai/helpers/data_residency.rb
@@ -442,6 +445,13 @@ files:
 - lib/openai/models/audio/translation_create_response.rb
 - lib/openai/models/audio/translation_verbose.rb
 - lib/openai/models/audio/voice.rb
+- lib/openai/models/audio/voice_consent.rb
+- lib/openai/models/audio/voice_consent_create_params.rb
+- lib/openai/models/audio/voice_consent_delete_params.rb
+- lib/openai/models/audio/voice_consent_deleted.rb
+- lib/openai/models/audio/voice_consent_list_params.rb
+- lib/openai/models/audio/voice_consent_retrieve_params.rb
+- lib/openai/models/audio/voice_consent_update_params.rb
 - lib/openai/models/audio/voice_create_params.rb
 - lib/openai/models/audio_model.rb
 - lib/openai/models/audio_response_format.rb
@@ -1639,6 +1649,7 @@ files:
 - lib/openai/provider.rb
 - lib/openai/providers/azure.rb
 - lib/openai/providers/bedrock.rb
+- lib/openai/providers/vertex.rb
 - lib/openai/request_options.rb
 - lib/openai/resources/admin.rb
 - lib/openai/resources/admin/organization.rb
@@ -1677,6 +1688,7 @@ files:
 - lib/openai/resources/audio/speech.rb
 - lib/openai/resources/audio/transcriptions.rb
 - lib/openai/resources/audio/translations.rb
+- lib/openai/resources/audio/voice_consents.rb
 - lib/openai/resources/audio/voices.rb
 - lib/openai/resources/batches.rb
 - lib/openai/resources/beta.rb
@@ -1786,6 +1798,7 @@ files:
 - rbi/openai/helpers/beta/agents/function_tool.rbi
 - rbi/openai/helpers/beta/agents/model_adapter.rbi
 - rbi/openai/helpers/beta/agents/tool_error.rbi
+- rbi/openai/helpers/chat/tool_runner.rbi
 - rbi/openai/helpers/client_options.rbi
 - rbi/openai/helpers/client_runtime.rbi
 - rbi/openai/helpers/data_residency.rbi
@@ -2098,6 +2111,13 @@ files:
 - rbi/openai/models/audio/translation_create_response.rbi
 - rbi/openai/models/audio/translation_verbose.rbi
 - rbi/openai/models/audio/voice.rbi
+- rbi/openai/models/audio/voice_consent.rbi
+- rbi/openai/models/audio/voice_consent_create_params.rbi
+- rbi/openai/models/audio/voice_consent_delete_params.rbi
+- rbi/openai/models/audio/voice_consent_deleted.rbi
+- rbi/openai/models/audio/voice_consent_list_params.rbi
+- rbi/openai/models/audio/voice_consent_retrieve_params.rbi
+- rbi/openai/models/audio/voice_consent_update_params.rbi
 - rbi/openai/models/audio/voice_create_params.rbi
 - rbi/openai/models/audio_model.rbi
 - rbi/openai/models/audio_response_format.rbi
@@ -3331,6 +3351,7 @@ files:
 - rbi/openai/resources/audio/speech.rbi
 - rbi/openai/resources/audio/transcriptions.rbi
 - rbi/openai/resources/audio/translations.rbi
+- rbi/openai/resources/audio/voice_consents.rbi
 - rbi/openai/resources/audio/voices.rbi
 - rbi/openai/resources/batches.rbi
 - rbi/openai/resources/beta.rbi
@@ -3440,6 +3461,7 @@ files:
 - sig/openai/helpers/beta/agents/function_tool.rbs
 - sig/openai/helpers/beta/agents/model_adapter.rbs
 - sig/openai/helpers/beta/agents/tool_error.rbs
+- sig/openai/helpers/chat/tool_runner.rbs
 - sig/openai/helpers/client_options.rbs
 - sig/openai/helpers/client_runtime.rbs
 - sig/openai/helpers/data_residency.rbs
@@ -3742,6 +3764,13 @@ files:
 - sig/openai/models/audio/translation_create_response.rbs
 - sig/openai/models/audio/translation_verbose.rbs
 - sig/openai/models/audio/voice.rbs
+- sig/openai/models/audio/voice_consent.rbs
+- sig/openai/models/audio/voice_consent_create_params.rbs
+- sig/openai/models/audio/voice_consent_delete_params.rbs
+- sig/openai/models/audio/voice_consent_deleted.rbs
+- sig/openai/models/audio/voice_consent_list_params.rbs
+- sig/openai/models/audio/voice_consent_retrieve_params.rbs
+- sig/openai/models/audio/voice_consent_update_params.rbs
 - sig/openai/models/audio/voice_create_params.rbs
 - sig/openai/models/audio_model.rbs
 - sig/openai/models/audio_response_format.rbs
@@ -4975,6 +5004,7 @@ files:
 - sig/openai/resources/audio/speech.rbs
 - sig/openai/resources/audio/transcriptions.rbs
 - sig/openai/resources/audio/translations.rbs
+- sig/openai/resources/audio/voice_consents.rbs
 - sig/openai/resources/audio/voices.rbs
 - sig/openai/resources/batches.rbs
 - sig/openai/resources/beta.rbs
@@ -5065,6 +5095,7 @@ files:
 - sig/openai/response_carrier.rbs
 - sig/openai/streaming.rbs
 - sig/openai/version.rbs
+- vertex.md
 homepage: https://gemdocs.org/gems/openai
 licenses:
 - Apache-2.0