google-cloud-speech 1.7.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac1e083fa42d8a35f1f9983ccc261882b424e6f2fc3c8af219b7b2a8813560bd
-  data.tar.gz: 4ff281270dbb5ad04764685da51dace70d1747e7ecacd080c2a737982d176864
+  metadata.gz: 01aa397e81479c1f954041d7deafb255dc01d92f79c613aa131e87c0b2823e76
+  data.tar.gz: 3a202a63664922895bed5ff8b02c99d1eeba919dd0b62767e4b9151848dd4696
 SHA512:
-  metadata.gz: ab4b7c01a5303472a72047256a7d451666891de2b4b7f45118eb286ab61e7396d9498b71fd92c3ca8e0da6216d37e256569729b811922704602be72fae265029
-  data.tar.gz: f549b343ed1e2e338da38d4fd29c24fcdb3fa5210d6d85f07cd212756bbecd4851fcc03e254fb18c23f348599bdb6f7e7dbd394516e61737ca8190866afce92e
+  metadata.gz: 52abb02e78f420ae4b4e067870d1e2c503613bb19d802b108f751d33ae24db2142ccc65aebc407c90503b9b664120ea55691817cd6ec884a2e0ebfabe42781c2
+  data.tar.gz: 8acdc78b4e8fde8e4c46e38f63fecb858a734db9cd4e2776fb473b132e00b97498f5ce59cd464104969ed000a489647e3aab0e0a3074fb0784ce3809774941f6

data/.yardopts

@@ -8,5 +8,4 @@
 -
 README.md
 AUTHENTICATION.md
-MIGRATING.md
 LICENSE.md

data/README.md

@@ -17,7 +17,7 @@ constructing client objects. Reference documentation for the client objects
 themselves can be found in the client library documentation for the versioned
 client gems:
 [google-cloud-speech-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest),
-[google-cloud-speech-v1p1beta1](https://cloud.google.com/ruby/docs/reference/google-cloud-speech-v1p1beta1/latest).
+[google-cloud-speech-v2](https://cloud.google.com/ruby/docs/reference/google-cloud-speech-v2/latest).
 
 See also the [Product Documentation](https://cloud.google.com/speech-to-text)
 for more usage information.
@@ -35,17 +35,40 @@ In order to use this library, you first need to go through the following steps:
 1. [Enable the API.](https://console.cloud.google.com/apis/library/speech.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
-## Migrating from 0.x versions
-
-The 1.0 release of the google-cloud-speech client is a significant upgrade
-based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
-and includes substantial interface changes. Existing code written for earlier
-versions of this library will likely require updates to use this version.
-See the {file:MIGRATING.md MIGRATING.md} document for more information.
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+Debug logging also requires that the versioned clients for this service be
+sufficiently recent, released after about Dec 10, 2024. If logging is not
+working, try updating the versioned clients in your bundle or installed gems:
+[google-cloud-speech-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest),
+[google-cloud-speech-v2](https://cloud.google.com/ruby/docs/reference/google-cloud-speech-v2/latest).
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.7+.
+This library is supported on Ruby 3.0+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or

data/lib/google/cloud/speech/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Speech
-      VERSION = "1.7.1".freeze
+      VERSION = "2.0.0".freeze
     end
   end
 end

data/lib/google/cloud/speech.rb

@@ -49,8 +49,8 @@ module Google
       # Create a new client object for Speech.
       #
       # By default, this returns an instance of
-      # [Google::Cloud::Speech::V1::Speech::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Cloud-Speech-V1-Speech-Client)
-      # for a gRPC client for version V1 of the API.
+      # [Google::Cloud::Speech::V2::Speech::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-speech-v2/latest/Google-Cloud-Speech-V2-Speech-Client)
+      # for a gRPC client for version V2 of the API.
       # However, you can specify a different API version by passing it in the
       # `version` parameter. If the Speech service is
       # supported by that API version, and the corresponding gem is available, the
@@ -58,16 +58,21 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the Speech service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Speech.speech_available?}.
+      #
       # ## About Speech
       #
-      # Service that implements Google Cloud Speech API.
+      # Enables speech transcription and resource management.
       #
       # @param version [::String, ::Symbol] The API version to connect to. Optional.
-      #   Defaults to `:v1`.
+      #   Defaults to `:v2`.
       # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
       # @return [::Object] A client object for the specified version.
       #
-      def self.speech version: :v1, transport: :grpc, &block
+      def self.speech version: :v2, transport: :grpc, &block
         require "google/cloud/speech/#{version.to_s.downcase}"
 
         package_name = Google::Cloud::Speech
@@ -80,37 +85,34 @@ module Google
       end
 
       ##
-      # Create a new client object for Adaptation.
-      #
-      # By default, this returns an instance of
-      # [Google::Cloud::Speech::V1::Adaptation::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-speech-v1/latest/Google-Cloud-Speech-V1-Adaptation-Client)
-      # for a gRPC client for version V1 of the API.
-      # However, you can specify a different API version by passing it in the
-      # `version` parameter. If the Adaptation service is
-      # supported by that API version, and the corresponding gem is available, the
-      # appropriate versioned client will be returned.
-      # You can also specify a different transport by passing `:rest` or `:grpc` in
-      # the `transport` parameter.
-      #
-      # ## About Adaptation
-      #
-      # Service that implements Google Cloud Speech Adaptation API.
+      # Determines whether the Speech service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Speech.speech}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Speech service,
+      # or if the versioned client gem needs an update to support the Speech service.
       #
       # @param version [::String, ::Symbol] The API version to connect to. Optional.
-      #   Defaults to `:v1`.
+      #   Defaults to `:v2`.
       # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
-      # @return [::Object] A client object for the specified version.
+      # @return [boolean] Whether the service is available.
       #
-      def self.adaptation version: :v1, transport: :grpc, &block
+      def self.speech_available? version: :v2, transport: :grpc
         require "google/cloud/speech/#{version.to_s.downcase}"
-
         package_name = Google::Cloud::Speech
                        .constants
                        .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                        .first
-        service_module = Google::Cloud::Speech.const_get(package_name).const_get(:Adaptation)
-        service_module = service_module.const_get(:Rest) if transport == :rest
-        service_module.const_get(:Client).new(&block)
+        return false unless package_name
+        service_module = Google::Cloud::Speech.const_get package_name
+        return false unless service_module.const_defined? :Speech
+        service_module = service_module.const_get :Speech
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
       end
 
       ##

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-speech
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-08 00:00:00.000000000 Z
+date: 2025-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -28,42 +27,30 @@ dependencies:
   name: google-cloud-speech-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.16'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.16'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: google-cloud-speech-v1p1beta1
+  name: google-cloud-speech-v2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.20'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.20'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.0'
 description: Google Speech-to-Text enables developers to convert audio to text by
   applying powerful neural network models in an easy-to-use API. The API recognizes
   more than 120 languages and variants to support your global user base. You can enable
@@ -78,7 +65,6 @@ files:
 - ".yardopts"
 - AUTHENTICATION.md
 - LICENSE.md
-- MIGRATING.md
 - README.md
 - lib/google-cloud-speech.rb
 - lib/google/cloud/speech.rb
@@ -87,7 +73,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -95,15 +80,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.3
 specification_version: 4
 summary: API Client library for the Cloud Speech-to-Text API
 test_files: []

data/MIGRATING.md

@@ -1,367 +0,0 @@
-## Migrating to google-cloud-speech 1.0
-
-The 1.0 release of the google-cloud-speech client is a significant upgrade
-based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
-and includes substantial interface changes. Existing code written for earlier
-versions of this library will likely require updates to use this version.
-This document describes the changes that have been made, and what you need to
-do to update your usage.
-
-To summarize:
-
- *  The library has been broken out into multiple libraries. The new gems
-    `google-cloud-speech-v1` and `google-cloud-speech-v1p1beta1` contain the
-    actual client classes for versions V1 and V1p1beta1 of the Speech service,
-    and the gem `google-cloud-speech` now simply provides a convenience wrapper.
-    See [Library Structure](#library-structure) for more info.
- *  The library uses a new configuration mechanism giving you closer control
-    over endpoint address, network timeouts, and retry. See
-    [Client Configuration](#client-configuration) for more info. Furthermore,
-    when creating a client object, you can customize its configuration in a
-    block rather than passing arguments to the constructor. See
-    [Creating Clients](#creating-clients) for more info.
- *  Previously, positional arguments were used to indicate required arguments.
-    Now, all method arguments are keyword arguments, with documentation that
-    specifies whether they are required or optional. Additionally, you can pass
-    a proto request object instead of separate arguments. See
-    [Passing Arguments](#passing-arguments) for more info.
- *  Previously, the client included a method supporting bidirectional streaming
-    recognition requests, both incremental audio and incremental results. The
-    current client retains this method, but simplifies the interface to match
-    streaming methods in other Ruby clients. See
-    [Streaming Interface](#streaming-interface) for more info.
- *  Previously, clients reported RPC errors by raising instances of
-    `Google::Gax::GaxError` and its subclasses. Now, RPC exceptions are of type
-    `Google::Cloud::Error` and its subclasses. See
-    [Handling Errors](#handling-errors) for more info.
- *  Some classes have moved into different namespaces. See
-    [Class Namespaces](#class-namespaces) for more info.
-
-### Library Structure
-
-Older 0.x releases of the `google-cloud-speech` gem were all-in-one gems
-that included potentially multiple clients for multiple versions of the Speech
-service. The `Google::Cloud::Speech.new` factory method would
-return you an instance of a `Google::Cloud::Speech::V1::SpeechClient`
-object for the V1 version of the service, or a
-`Google::Cloud::Speech::V1p1beta1::SpeechClient` object for the V1p1beta1
-version of the service. All these classes were defined in the same gem.
-
-With the 1.0 release, the `google-cloud-speech` gem still provides factory
-methods for obtaining clients. (The method signatures will have changed. See
-[Creating Clients](#creating-clients) for details.) However, the actual client
-classes have been moved into separate gems, one per service version. The
-`Google::Cloud::Speech::V1::Speech::Client` class, along with its
-helpers and data types, is now part of the `google-cloud-speech-v1` gem.
-Similarly, the `Google::Cloud::Speech::V1p1beta1::Speech::Client`
-class is part of the `google-cloud-speech-v1p1beta1` gem.
-
-For normal usage, you can continue to install the `google-cloud-speech` gem
-(which will bring in the versioned client gems as dependencies) and continue to
-use factory methods to create clients. However, you may alternatively choose to
-install only one of the versioned gems. For example, if you know you will only
-use `V1` of the service, you can install `google-cloud-speech-v1` by
-itself, and construct instances of the
-`Google::Cloud::Speech::V1::Speech::Client` client class directly.
-
-### Client Configuration
-
-In older releases, if you wanted to customize performance parameters or
-low-level behavior of the client (such as credentials, timeouts, or
-instrumentation), you would pass a variety of keyword arguments to the client
-constructor. It was also extremely difficult to customize the default settings.
-
-With the 1.0 release, a configuration interface provides control over these
-parameters, including defaults for all instances of a client, and settings for
-each specific client instance. For example, to set default credentials and
-timeout for all Speech V1 clients:
-
-```
-Google::Cloud::Speech::V1::Speech::Client.configure do |config|
-  config.credentials = "/path/to/credentials.json"
-  config.timeout = 10.0
-end
-```
-
-Individual RPCs can also be configured independently. For example, to set the
-timeout for the `recognize` call:
-
-```
-Google::Cloud::Speech::V1::Speech::Client.configure do |config|
-  config.rpcs.recognize.timeout = 20.0
-end
-```
-
-Defaults for certain configurations can be set for all Speech versions and
-services globally:
-
-```
-Google::Cloud::Speech.configure do |config|
-  config.credentials = "/path/to/credentials.json"
-  config.timeout = 10.0
-end
-```
-
-Finally, you can override the configuration for each client instance. See the
-next section on [Creating Clients](#creating-clients) for details.
-
-### Creating Clients
-
-In older releases, to create a client object, you would use the
-`Google::Cloud::Speech.new` class method. Keyword arguments were available to
-select a service version and to configure parameters such as credentials and
-timeouts.
-
-With the 1.0 release, use the `Google::Cloud::Speech.speech` class
-method to create a client object. You may select a service version using the
-`:version` keyword argument. However, other configuration parameters should be
-set in a configuration block when you create the client.
-
-Old:
-```
-client = Google::Cloud::Speech.new credentials: "/path/to/credentials.json"
-```
-
-New:
-```
-client = Google::Cloud::Speech.speech do |config|
-  config.credentials = "/path/to/credentials.json"
-end
-```
-
-The configuration block is optional. If you do not provide it, or you do not
-set some configuration parameters, then the default configuration is used. See
-[Client Configuration](#client-configuration).
-
-### Passing Arguments
-
-In older releases, required arguments would be passed as positional method
-arguments, while most optional arguments would be passed as keyword arguments.
-
-With the 1.0 release, all RPC arguments are passed as keyword arguments,
-regardless of whether they are required or optional. For example:
-
-Old:
-```
-client = Google::Cloud::Speech.new
-
-config = {
-  language_code: "en-US",
-  sample_rate_hertz: 44_100,
-  encoding: :FLAC
-}
-audio = {
-  uri: "gs://cloud-samples-data/speech/brooklyn_bridge.flac"
-}
-
-# Config and audio are positional arguments
-response = client.recognize config, audio
-```
-
-New:
-```
-client = Google::Cloud::Speech.speech
-
-config = {
-  language_code: "en-US",
-  sample_rate_hertz: 44_100,
-  encoding: :FLAC
-}
-audio = {
-  uri: "gs://cloud-samples-data/speech/brooklyn_bridge.flac"
-}
-
-# Config and audio are keyword arguments
-response = client.recognize config: config, audio: audio
-```
-
-In the 1.0 release, it is also possible to pass a request object, either
-as a hash or as a protocol buffer.
-
-New:
-```
-client = Google::Cloud::Speech.speech
-
-request_object = Google::Cloud::Speech::V1::RecognizeRequest.new(
-  config: {
-    language_code: "en-US",
-    sample_rate_hertz: 44_100,
-    encoding: :FLAC
-  },
-  audio: {
-    uri: "gs://cloud-samples-data/speech/brooklyn_bridge.flac"
-  }
-)
-
-# Pass a request object as a positional argument:
-response = client.recognize request_object
-```
-
-Finally, in older releases, to provide call options, you would pass a
-`Google::Gax::CallOptions` object with the `:options` keyword argument. In the
-1.0 release, pass call options using a _second set_ of keyword arguments.
-
-Old:
-```
-client = Google::Cloud::Speech.new
-
-config = {
-  language_code: "en-US",
-  sample_rate_hertz: 44_100,
-  encoding: :FLAC
-}
-audio = {
-  uri: "gs://cloud-samples-data/speech/brooklyn_bridge.flac"
-}
-
-options = Google::Gax::CallOptions.new timeout: 10.0
-
-response = client.recognize config, audio, options: options
-```
-
-New:
-```
-client = Google::Cloud::Speech.speech
-
-config = {
-  language_code: "en-US",
-  sample_rate_hertz: 44_100,
-  encoding: :FLAC
-}
-audio = {
-  uri: "gs://cloud-samples-data/speech/brooklyn_bridge.flac"
-}
-
-# Use a hash to wrap the normal call arguments (or pass a request object), and
-# then add further keyword arguments for the call options.
-response = client.batch_annotate_images(
-  { config: config, audio: audio },
-  timeout: 10.0)
-```
-
-### Streaming Interface
-
-The client library includes one special streaming method `streaming_recognize`.
-In the older client, this method employed a streaming interface in which you
-would register callbacks for different incremental result events. In version
-1.0, we have standardized the streaming interfaces across the various Ruby
-client libraries. The `streaming_recognize` call returns a lazy enumerable that
-you can query for incremental results.
-
-Old:
-```
-client = Google::Cloud::Speech.new
-
-config = {
-  language_code: "en-US",
-  sample_rate_hertz: 44_100,
-  encoding: :FLAC
-}
-stream = client.streaming_recognize config: config
-
-stream.on_interim { |result| puts "received interim" }
-stream.on_complete { |result| puts "received complete" }
-
-stream.send File.read("my_input.flac", mode: "rb")
-stream.stop
-
-stream.wait_until_complete!
-results = stream.results
-```
-
-New:
-```
-client = Google::Cloud::Speech.speech
-
-input_stream = Gapic::StreamInput.new
-output_stream = client.streaming_recognize input_stream
-
-config = {
-  language_code: "en-US",
-  sample_rate_hertz: 44_100,
-  encoding: :FLAC
-}
-streaming_config = { config: config }
-
-input_stream.push({ streaming_config: streaming_config })
-input_stream.push({ audio_content: File.read("my_input.flac", mode: "rb") })
-input_stream.close
-
-output_stream.each do |response|
-  puts "received: #{response}"
-end
-```
-
-### Handling Errors
-
-The client reports standard
-[gRPC error codes](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md)
-by raising exceptions. In older releases, these exceptions were located in the
-`Google::Gax` namespace and were subclasses of the `Google::Gax::GaxError` base
-exception class, defined in the `google-gax` gem. However, these classes were
-different from the standard exceptions (subclasses of `Google::Cloud::Error`)
-thrown by other client libraries such as `google-cloud-storage`.
-
-The 1.0 client library now uses the `Google::Cloud::Error` exception hierarchy,
-for consistency across all the Google Cloud client libraries. In general, these
-exceptions have the same name as their counterparts from older releases, but
-are located in the `Google::Cloud` namespace rather than the `Google::Gax`
-namespace.
-
-Old:
-```
-client = Google::Cloud::Speech.new
-
-config = {
-  language_code: "en-US",
-  sample_rate_hertz: 44_100,
-  encoding: :FLAC
-}
-audio = {
-  uri: "gs://cloud-samples-data/speech/brooklyn_bridge.flac"
-}
-
-begin
-  response = client.recognize config, audio
-rescue Google::Gax::Error => e
-  # Handle exceptions that subclass Google::Gax::Error
-end
-```
-
-New:
-```
-client = Google::Cloud::Speech.speech
-
-config = {
-  language_code: "en-US",
-  sample_rate_hertz: 44_100,
-  encoding: :FLAC
-}
-audio = {
-  uri: "gs://cloud-samples-data/speech/brooklyn_bridge.flac"
-}
-
-begin
-  response = client.recognize config: config, audio: audio
-rescue Google::Cloud::Error => e
-  # Handle exceptions that subclass Google::Cloud::Error
-end
-```
-
-### Class Namespaces
-
-In older releases, the client object was of classes with names like:
-`Google::Cloud::Speech::V1::SpeechClient`.
-In the 1.0 release, the client object is of a different class:
-`Google::Cloud::Speech::V1::Speech::Client`.
-Note that most users will use the factory methods such as
-`Google::Cloud::Speech.speech` to create instances of the client object,
-so you may not need to reference the actual class directly.
-See [Creating Clients](#creating-clients).
-
-In older releases, the credentials object was of class
-`Google::Cloud::Speech::V1::Credentials`.
-In the 1.0 release, each service has its own credentials class, e.g.
-`Google::Cloud::Speech::V1::Speech::Credentials`.
-Again, most users will not need to reference this class directly.
-See [Client Configuration](#client-configuration).