google-cloud-text_to_speech-v1beta1 0.9.1 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5857351981087b607bd1285257fb1df83c3a40c5d81e816b85ae47b71d57735
-  data.tar.gz: 2c68fdc71315eb776588fd8a343a8b319860a3c8a32b06ca35eb59da7f873345
+  metadata.gz: 056e5a3b65183ab4d17972d530040540ba217fe83969a05100e4f90647e99000
+  data.tar.gz: dceca2fa3d6b9fd87cb2cb02624ec0c1b1fe1866424515b56a96d2912dfd2d6b
 SHA512:
-  metadata.gz: 1096fdacf05e327218341dee6a4d6d1a9f8526e779a8272feb8efbbbef59f8ef87608216ac1d1885ee2b99ba07975f56d7cb6911156421917867fc3caaa90bb0
-  data.tar.gz: 8c769305d9d2b48adc595a1ac153ce41bd2ab0b21e4a346cafa6a81513740941c971f140532a487e58a674f774da5db393de6a18a1c8754514e20dc1a1a4d933
+  metadata.gz: 36681ccc312e4c9a30536bca170df0f4dfc5e12fd1f30ebb6078327700180d257b7ac1b74aeba0eaab17cb759d8efdb8fc4760e332b225a6e4af777b0d7932fa
+  data.tar.gz: 97f0b174d92b7e718d1399513f13590d34d82ee9e409d5eda0fd9cb39d260d2a2f461669551d836c1fdb8ac0886267d905faf4629ef4912295488f2d59ea7a53

data/README.md

@@ -1,6 +1,6 @@
 # Ruby Client for the Cloud Text-to-Speech V1beta1 API
 
-API Client library for the Cloud Text-to-Speech V1beta1 API
+Synthesizes natural-sounding speech by applying powerful neural network models.
 
 Text-to-Speech converts text or Speech Synthesis Markup Language (SSML) input into audio data of natural human speech.
 
@@ -47,7 +47,7 @@ for general usage information.
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
 The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
 that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
 and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
 

data/lib/google/cloud/text_to_speech/v1beta1/rest.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/text_to_speech/v1beta1/text_to_speech/rest"
+require "google/cloud/text_to_speech/v1beta1/text_to_speech_long_audio_synthesize/rest"
+require "google/cloud/text_to_speech/v1beta1/version"
+
+module Google
+  module Cloud
+    module TextToSpeech
+      ##
+      # To load just the REST part of this package, including all its services, and instantiate a REST client:
+      #
+      # @example
+      #
+      #     require "google/cloud/text_to_speech/v1beta1/rest"
+      #     client = ::Google::Cloud::TextToSpeech::V1beta1::TextToSpeech::Rest::Client.new
+      #
+      module V1beta1
+      end
+    end
+  end
+end

data/lib/google/cloud/text_to_speech/v1beta1/text_to_speech/client.rb

@@ -355,9 +355,9 @@ module Google
             #    *  (`String`) The path to a service account key file in JSON format
             #    *  (`Hash`) A service account key as a Hash
             #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-            #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+            #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-            #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials

data/lib/google/cloud/text_to_speech/v1beta1/text_to_speech/rest/client.rb

@@ -0,0 +1,432 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/errors"
+require "google/cloud/texttospeech/v1beta1/cloud_tts_pb"
+require "google/cloud/text_to_speech/v1beta1/text_to_speech/rest/service_stub"
+
+module Google
+  module Cloud
+    module TextToSpeech
+      module V1beta1
+        module TextToSpeech
+          module Rest
+            ##
+            # REST client for the TextToSpeech service.
+            #
+            # Service that implements Google Cloud Text-to-Speech API.
+            #
+            class Client
+              include Paths
+
+              # @private
+              attr_reader :text_to_speech_stub
+
+              ##
+              # Configure the TextToSpeech Client class.
+              #
+              # See {::Google::Cloud::TextToSpeech::V1beta1::TextToSpeech::Rest::Client::Configuration}
+              # for a description of the configuration fields.
+              #
+              # @example
+              #
+              #   # Modify the configuration for all TextToSpeech clients
+              #   ::Google::Cloud::TextToSpeech::V1beta1::TextToSpeech::Rest::Client.configure do |config|
+              #     config.timeout = 10.0
+              #   end
+              #
+              # @yield [config] Configure the Client client.
+              # @yieldparam config [Client::Configuration]
+              #
+              # @return [Client::Configuration]
+              #
+              def self.configure
+                @configure ||= begin
+                  namespace = ["Google", "Cloud", "TextToSpeech", "V1beta1"]
+                  parent_config = while namespace.any?
+                                    parent_name = namespace.join "::"
+                                    parent_const = const_get parent_name
+                                    break parent_const.configure if parent_const.respond_to? :configure
+                                    namespace.pop
+                                  end
+                  default_config = Client::Configuration.new parent_config
+
+                  default_config.timeout = 300.0
+                  default_config.retry_policy = {
+                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                  }
+
+                  default_config
+                end
+                yield @configure if block_given?
+                @configure
+              end
+
+              ##
+              # Configure the TextToSpeech Client instance.
+              #
+              # The configuration is set to the derived mode, meaning that values can be changed,
+              # but structural changes (adding new fields, etc.) are not allowed. Structural changes
+              # should be made on {Client.configure}.
+              #
+              # See {::Google::Cloud::TextToSpeech::V1beta1::TextToSpeech::Rest::Client::Configuration}
+              # for a description of the configuration fields.
+              #
+              # @yield [config] Configure the Client client.
+              # @yieldparam config [Client::Configuration]
+              #
+              # @return [Client::Configuration]
+              #
+              def configure
+                yield @config if block_given?
+                @config
+              end
+
+              ##
+              # Create a new TextToSpeech REST client object.
+              #
+              # @example
+              #
+              #   # Create a client using the default configuration
+              #   client = ::Google::Cloud::TextToSpeech::V1beta1::TextToSpeech::Rest::Client.new
+              #
+              #   # Create a client using a custom configuration
+              #   client = ::Google::Cloud::TextToSpeech::V1beta1::TextToSpeech::Rest::Client.new do |config|
+              #     config.timeout = 10.0
+              #   end
+              #
+              # @yield [config] Configure the TextToSpeech client.
+              # @yieldparam config [Client::Configuration]
+              #
+              def initialize
+                # Create the configuration object
+                @config = Configuration.new Client.configure
+
+                # Yield the configuration if needed
+                yield @config if block_given?
+
+                # Create credentials
+                credentials = @config.credentials
+                # Use self-signed JWT if the endpoint is unchanged from default,
+                # but only if the default endpoint does not have a region prefix.
+                enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
+                                         !@config.endpoint.split(".").first.include?("-")
+                credentials ||= Credentials.default scope: @config.scope,
+                                                    enable_self_signed_jwt: enable_self_signed_jwt
+                if credentials.is_a?(::String) || credentials.is_a?(::Hash)
+                  credentials = Credentials.new credentials, scope: @config.scope
+                end
+
+                @quota_project_id = @config.quota_project
+                @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
+
+                @text_to_speech_stub = ::Google::Cloud::TextToSpeech::V1beta1::TextToSpeech::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
+              end
+
+              # Service calls
+
+              ##
+              # Returns a list of Voice supported for synthesis.
+              #
+              # @overload list_voices(request, options = nil)
+              #   Pass arguments to `list_voices` via a request object, either of type
+              #   {::Google::Cloud::TextToSpeech::V1beta1::ListVoicesRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::TextToSpeech::V1beta1::ListVoicesRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @overload list_voices(language_code: nil)
+              #   Pass arguments to `list_voices` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param language_code [::String]
+              #     Optional. Recommended.
+              #     [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
+              #     If not specified, the API will return all supported voices.
+              #     If specified, the ListVoices call will only return voices that can be used
+              #     to synthesize this language_code. For example, if you specify `"en-NZ"`,
+              #     all `"en-NZ"` voices will be returned. If you specify `"no"`, both
+              #     `"no-\*"` (Norwegian) and `"nb-\*"` (Norwegian Bokmal) voices will be
+              #     returned.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::TextToSpeech::V1beta1::ListVoicesResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::TextToSpeech::V1beta1::ListVoicesResponse]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              def list_voices request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TextToSpeech::V1beta1::ListVoicesRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                call_metadata = @config.rpcs.list_voices.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::TextToSpeech::V1beta1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.list_voices.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.list_voices.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @text_to_speech_stub.list_voices request, options do |result, operation|
+                  yield result, operation if block_given?
+                  return result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Synthesizes speech synchronously: receive results after all text input
+              # has been processed.
+              #
+              # @overload synthesize_speech(request, options = nil)
+              #   Pass arguments to `synthesize_speech` via a request object, either of type
+              #   {::Google::Cloud::TextToSpeech::V1beta1::SynthesizeSpeechRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::TextToSpeech::V1beta1::SynthesizeSpeechRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @overload synthesize_speech(input: nil, voice: nil, audio_config: nil, enable_time_pointing: nil)
+              #   Pass arguments to `synthesize_speech` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param input [::Google::Cloud::TextToSpeech::V1beta1::SynthesisInput, ::Hash]
+              #     Required. The Synthesizer requires either plain text or SSML as input.
+              #   @param voice [::Google::Cloud::TextToSpeech::V1beta1::VoiceSelectionParams, ::Hash]
+              #     Required. The desired voice of the synthesized audio.
+              #   @param audio_config [::Google::Cloud::TextToSpeech::V1beta1::AudioConfig, ::Hash]
+              #     Required. The configuration of the synthesized audio.
+              #   @param enable_time_pointing [::Array<::Google::Cloud::TextToSpeech::V1beta1::SynthesizeSpeechRequest::TimepointType>]
+              #     Whether and what timepoints are returned in the response.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::TextToSpeech::V1beta1::SynthesizeSpeechResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::TextToSpeech::V1beta1::SynthesizeSpeechResponse]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              def synthesize_speech request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TextToSpeech::V1beta1::SynthesizeSpeechRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                call_metadata = @config.rpcs.synthesize_speech.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::TextToSpeech::V1beta1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.synthesize_speech.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.synthesize_speech.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @text_to_speech_stub.synthesize_speech request, options do |result, operation|
+                  yield result, operation if block_given?
+                  return result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Configuration class for the TextToSpeech REST API.
+              #
+              # This class represents the configuration for TextToSpeech REST,
+              # providing control over timeouts, retry behavior, logging, transport
+              # parameters, and other low-level controls. Certain parameters can also be
+              # applied individually to specific RPCs. See
+              # {::Google::Cloud::TextToSpeech::V1beta1::TextToSpeech::Rest::Client::Configuration::Rpcs}
+              # for a list of RPCs that can be configured independently.
+              #
+              # Configuration can be applied globally to all clients, or to a single client
+              # on construction.
+              #
+              # @example
+              #
+              #   # Modify the global config, setting the timeout for
+              #   # list_voices to 20 seconds,
+              #   # and all remaining timeouts to 10 seconds.
+              #   ::Google::Cloud::TextToSpeech::V1beta1::TextToSpeech::Rest::Client.configure do |config|
+              #     config.timeout = 10.0
+              #     config.rpcs.list_voices.timeout = 20.0
+              #   end
+              #
+              #   # Apply the above configuration only to a new client.
+              #   client = ::Google::Cloud::TextToSpeech::V1beta1::TextToSpeech::Rest::Client.new do |config|
+              #     config.timeout = 10.0
+              #     config.rpcs.list_voices.timeout = 20.0
+              #   end
+              #
+              # @!attribute [rw] endpoint
+              #   The hostname or hostname:port of the service endpoint.
+              #   Defaults to `"texttospeech.googleapis.com"`.
+              #   @return [::String]
+              # @!attribute [rw] credentials
+              #   Credentials to send with calls. You may provide any of the following types:
+              #    *  (`String`) The path to a service account key file in JSON format
+              #    *  (`Hash`) A service account key as a Hash
+              #    *  (`Google::Auth::Credentials`) A googleauth credentials object
+              #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
+              #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
+              #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
+              #    *  (`nil`) indicating no credentials
+              #   @return [::Object]
+              # @!attribute [rw] scope
+              #   The OAuth scopes
+              #   @return [::Array<::String>]
+              # @!attribute [rw] lib_name
+              #   The library name as recorded in instrumentation and logging
+              #   @return [::String]
+              # @!attribute [rw] lib_version
+              #   The library version as recorded in instrumentation and logging
+              #   @return [::String]
+              # @!attribute [rw] timeout
+              #   The call timeout in seconds.
+              #   @return [::Numeric]
+              # @!attribute [rw] metadata
+              #   Additional headers to be sent with the call.
+              #   @return [::Hash{::Symbol=>::String}]
+              # @!attribute [rw] retry_policy
+              #   The retry policy. The value is a hash with the following keys:
+              #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+              #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+              #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+              #       trigger a retry.
+              #   @return [::Hash]
+              # @!attribute [rw] quota_project
+              #   A separate project against which to charge quota.
+              #   @return [::String]
+              #
+              class Configuration
+                extend ::Gapic::Config
+
+                config_attr :endpoint,      "texttospeech.googleapis.com", ::String
+                config_attr :credentials,   nil do |value|
+                  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
+                  allowed.any? { |klass| klass === value }
+                end
+                config_attr :scope,         nil, ::String, ::Array, nil
+                config_attr :lib_name,      nil, ::String, nil
+                config_attr :lib_version,   nil, ::String, nil
+                config_attr :timeout,       nil, ::Numeric, nil
+                config_attr :metadata,      nil, ::Hash, nil
+                config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
+                config_attr :quota_project, nil, ::String, nil
+
+                # @private
+                def initialize parent_config = nil
+                  @parent_config = parent_config unless parent_config.nil?
+
+                  yield self if block_given?
+                end
+
+                ##
+                # Configurations for individual RPCs
+                # @return [Rpcs]
+                #
+                def rpcs
+                  @rpcs ||= begin
+                    parent_rpcs = nil
+                    parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
+                    Rpcs.new parent_rpcs
+                  end
+                end
+
+                ##
+                # Configuration RPC class for the TextToSpeech API.
+                #
+                # Includes fields providing the configuration for each RPC in this service.
+                # Each configuration object is of type `Gapic::Config::Method` and includes
+                # the following configuration fields:
+                #
+                #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
+                #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
+                #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
+                #     include the following keys:
+                #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+                #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+                #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+                #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+                #         trigger a retry.
+                #
+                class Rpcs
+                  ##
+                  # RPC-specific configuration for `list_voices`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :list_voices
+                  ##
+                  # RPC-specific configuration for `synthesize_speech`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :synthesize_speech
+
+                  # @private
+                  def initialize parent_rpcs = nil
+                    list_voices_config = parent_rpcs.list_voices if parent_rpcs.respond_to? :list_voices
+                    @list_voices = ::Gapic::Config::Method.new list_voices_config
+                    synthesize_speech_config = parent_rpcs.synthesize_speech if parent_rpcs.respond_to? :synthesize_speech
+                    @synthesize_speech = ::Gapic::Config::Method.new synthesize_speech_config
+
+                    yield self if block_given?
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end