google-cloud-speech-v1 0.4.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d5316a918da7c2ad7f23c0374171f72052da19f4ebc2c9904dca316d9d61419
-  data.tar.gz: 6d7470cf60fc24d5955e73a3a4a340201a262bac6bc90ed6b0c39a2aa69f0608
+  metadata.gz: 4df4067d98b6dde2049d349aaba7e230db5c79344083061a7836304474c8c7e4
+  data.tar.gz: 331c15b79d60c83e8f6f613059765b9c51587e223d7f4cfdf779eb5372661356
 SHA512:
-  metadata.gz: 16d09dda5f5cbe83f106bb56de5165a7864a21a175f0f89aa4dd886121321f015d67d11436b928d9b1454979b9689bf9adf08e422a65454683fd50738c0d18b4
-  data.tar.gz: 97eda913ae53329053ac96837a71384f0e408658bd5c257f6b089be9478d4a43c8904b0c4b09d839b178c926438bb304c24532eecffb7ff1ff1b9dfcad2c8a80
+  metadata.gz: d7b43c7650ab17d38e959b078bdf2d9bb339b06befca56f17f11c1c5a7000d560fa7cde22779781c0e1d598e3e0e4faf236fe3f47221456b25e0d5c0b78217e8
+  data.tar.gz: 7e24249767948c0e9a766993dc71c67b4c71bca11afcb2620cf1068b65b0d8afed18878d31e925dc7f00a16834f75c30513bfbeddbc3e9195964e9a968e80154

data/lib/google/cloud/speech/v1/cloud_speech_pb.rb

@@ -1,16 +1,18 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/speech/v1/cloud_speech.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
+require 'google/cloud/speech/v1/resource_pb'
 require 'google/longrunning/operations_pb'
 require 'google/protobuf/any_pb'
 require 'google/protobuf/duration_pb'
 require 'google/protobuf/timestamp_pb'
+require 'google/protobuf/wrappers_pb'
 require 'google/rpc/status_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/speech/v1/cloud_speech.proto", :syntax => :proto3) do
     add_message "google.cloud.speech.v1.RecognizeRequest" do
@@ -20,6 +22,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.cloud.speech.v1.LongRunningRecognizeRequest" do
       optional :config, :message, 1, "google.cloud.speech.v1.RecognitionConfig"
       optional :audio, :message, 2, "google.cloud.speech.v1.RecognitionAudio"
+      optional :output_config, :message, 4, "google.cloud.speech.v1.TranscriptOutputConfig"
+    end
+    add_message "google.cloud.speech.v1.TranscriptOutputConfig" do
+      oneof :output_type do
+        optional :gcs_uri, :string, 1
+      end
     end
     add_message "google.cloud.speech.v1.StreamingRecognizeRequest" do
       oneof :streaming_request do
@@ -38,11 +46,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :audio_channel_count, :int32, 7
       optional :enable_separate_recognition_per_channel, :bool, 12
       optional :language_code, :string, 3
+      repeated :alternative_language_codes, :string, 18
       optional :max_alternatives, :int32, 4
       optional :profanity_filter, :bool, 5
+      optional :adaptation, :message, 20, "google.cloud.speech.v1.SpeechAdaptation"
       repeated :speech_contexts, :message, 6, "google.cloud.speech.v1.SpeechContext"
       optional :enable_word_time_offsets, :bool, 8
+      optional :enable_word_confidence, :bool, 15
       optional :enable_automatic_punctuation, :bool, 11
+      optional :enable_spoken_punctuation, :message, 22, "google.protobuf.BoolValue"
+      optional :enable_spoken_emojis, :message, 23, "google.protobuf.BoolValue"
       optional :diarization_config, :message, 19, "google.cloud.speech.v1.SpeakerDiarizationConfig"
       optional :metadata, :message, 9, "google.cloud.speech.v1.RecognitionMetadata"
       optional :model, :string, 13
@@ -57,6 +70,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :AMR_WB, 5
       value :OGG_OPUS, 6
       value :SPEEX_WITH_HEADER_BYTE, 7
+      value :WEBM_OPUS, 9
     end
     add_message "google.cloud.speech.v1.SpeakerDiarizationConfig" do
       optional :enable_speaker_diarization, :bool, 1
@@ -107,6 +121,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.cloud.speech.v1.SpeechContext" do
       repeated :phrases, :string, 1
+      optional :boost, :float, 4
     end
     add_message "google.cloud.speech.v1.RecognitionAudio" do
       oneof :audio_source do
@@ -116,19 +131,25 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.cloud.speech.v1.RecognizeResponse" do
       repeated :results, :message, 2, "google.cloud.speech.v1.SpeechRecognitionResult"
+      optional :total_billed_time, :message, 3, "google.protobuf.Duration"
     end
     add_message "google.cloud.speech.v1.LongRunningRecognizeResponse" do
       repeated :results, :message, 2, "google.cloud.speech.v1.SpeechRecognitionResult"
+      optional :total_billed_time, :message, 3, "google.protobuf.Duration"
+      optional :output_config, :message, 6, "google.cloud.speech.v1.TranscriptOutputConfig"
+      optional :output_error, :message, 7, "google.rpc.Status"
     end
     add_message "google.cloud.speech.v1.LongRunningRecognizeMetadata" do
       optional :progress_percent, :int32, 1
       optional :start_time, :message, 2, "google.protobuf.Timestamp"
       optional :last_update_time, :message, 3, "google.protobuf.Timestamp"
+      optional :uri, :string, 4
     end
     add_message "google.cloud.speech.v1.StreamingRecognizeResponse" do
       optional :error, :message, 1, "google.rpc.Status"
       repeated :results, :message, 2, "google.cloud.speech.v1.StreamingRecognitionResult"
       optional :speech_event_type, :enum, 4, "google.cloud.speech.v1.StreamingRecognizeResponse.SpeechEventType"
+      optional :total_billed_time, :message, 5, "google.protobuf.Duration"
     end
     add_enum "google.cloud.speech.v1.StreamingRecognizeResponse.SpeechEventType" do
       value :SPEECH_EVENT_UNSPECIFIED, 0
@@ -145,6 +166,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.cloud.speech.v1.SpeechRecognitionResult" do
       repeated :alternatives, :message, 1, "google.cloud.speech.v1.SpeechRecognitionAlternative"
       optional :channel_tag, :int32, 2
+      optional :result_end_time, :message, 4, "google.protobuf.Duration"
+      optional :language_code, :string, 5
     end
     add_message "google.cloud.speech.v1.SpeechRecognitionAlternative" do
       optional :transcript, :string, 1
@@ -155,6 +178,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :start_time, :message, 1, "google.protobuf.Duration"
       optional :end_time, :message, 2, "google.protobuf.Duration"
       optional :word, :string, 3
+      optional :confidence, :float, 4
       optional :speaker_tag, :int32, 5
     end
   end
@@ -166,6 +190,7 @@ module Google
       module V1
         RecognizeRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.speech.v1.RecognizeRequest").msgclass
         LongRunningRecognizeRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.speech.v1.LongRunningRecognizeRequest").msgclass
+        TranscriptOutputConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.speech.v1.TranscriptOutputConfig").msgclass
         StreamingRecognizeRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.speech.v1.StreamingRecognizeRequest").msgclass
         StreamingRecognitionConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.speech.v1.StreamingRecognitionConfig").msgclass
         RecognitionConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.speech.v1.RecognitionConfig").msgclass

data/lib/google/cloud/speech/v1/cloud_speech_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/cloud/speech/v1/cloud_speech.proto for package 'google.cloud.speech.v1'
 # Original file comments:
-# Copyright 2019 Google LLC.
+# Copyright 2021 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-#
 
 require 'grpc'
 require 'google/cloud/speech/v1/cloud_speech_pb'
@@ -28,7 +27,7 @@ module Google
           # Service that implements Google Cloud Speech API.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

data/lib/google/cloud/speech/v1/resource_pb.rb

@@ -0,0 +1,48 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/speech/v1/resource.proto
+
+require 'google/api/resource_pb'
+require 'google/protobuf/timestamp_pb'
+require 'google/api/annotations_pb'
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/speech/v1/resource.proto", :syntax => :proto3) do
+    add_message "google.cloud.speech.v1.CustomClass" do
+      optional :name, :string, 1
+      optional :custom_class_id, :string, 2
+      repeated :items, :message, 3, "google.cloud.speech.v1.CustomClass.ClassItem"
+    end
+    add_message "google.cloud.speech.v1.CustomClass.ClassItem" do
+      optional :value, :string, 1
+    end
+    add_message "google.cloud.speech.v1.PhraseSet" do
+      optional :name, :string, 1
+      repeated :phrases, :message, 2, "google.cloud.speech.v1.PhraseSet.Phrase"
+      optional :boost, :float, 4
+    end
+    add_message "google.cloud.speech.v1.PhraseSet.Phrase" do
+      optional :value, :string, 1
+      optional :boost, :float, 2
+    end
+    add_message "google.cloud.speech.v1.SpeechAdaptation" do
+      repeated :phrase_sets, :message, 1, "google.cloud.speech.v1.PhraseSet"
+      repeated :phrase_set_references, :string, 2
+      repeated :custom_classes, :message, 3, "google.cloud.speech.v1.CustomClass"
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Speech
+      module V1
+        CustomClass = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.speech.v1.CustomClass").msgclass
+        CustomClass::ClassItem = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.speech.v1.CustomClass.ClassItem").msgclass
+        PhraseSet = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.speech.v1.PhraseSet").msgclass
+        PhraseSet::Phrase = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.speech.v1.PhraseSet.Phrase").msgclass
+        SpeechAdaptation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.speech.v1.SpeechAdaptation").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/speech/v1/speech/client.rb

@@ -30,6 +30,8 @@ module Google
           # Service that implements Google Cloud Speech API.
           #
           class Client
+            include Paths
+
             # @private
             attr_reader :speech_stub
 
@@ -39,13 +41,12 @@ module Google
             # See {::Google::Cloud::Speech::V1::Speech::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
-            #
-            # To modify the configuration for all Speech clients:
+            # @example
             #
-            #     ::Google::Cloud::Speech::V1::Speech::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all Speech clients
+            #   ::Google::Cloud::Speech::V1::Speech::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -104,19 +105,15 @@ module Google
             ##
             # Create a new Speech client object.
             #
-            # ## Examples
-            #
-            # To create a new Speech client with the default
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Speech::V1::Speech::Client.new
+            # @example
             #
-            # To create a new Speech client with a custom
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Speech::V1::Speech::Client.new
             #
-            #     client = ::Google::Cloud::Speech::V1::Speech::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Speech::V1::Speech::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Speech client.
             # @yieldparam config [Client::Configuration]
@@ -136,10 +133,9 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # 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.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              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
@@ -205,6 +201,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/speech/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Speech::V1::Speech::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Speech::V1::RecognizeRequest.new
+            #
+            #   # Call the recognize method.
+            #   result = client.recognize request
+            #
+            #   # The returned object is of type Google::Cloud::Speech::V1::RecognizeResponse.
+            #   p result
+            #
             def recognize request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -225,7 +236,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.recognize.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.recognize.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @speech_stub.call_rpc :recognize, request, options: options do |response, operation|
@@ -254,7 +267,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload long_running_recognize(config: nil, audio: nil)
+            # @overload long_running_recognize(config: nil, audio: nil, output_config: nil)
             #   Pass arguments to `long_running_recognize` 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).
@@ -264,6 +277,8 @@ module Google
             #     process the request.
             #   @param audio [::Google::Cloud::Speech::V1::RecognitionAudio, ::Hash]
             #     Required. The audio data to be recognized.
+            #   @param output_config [::Google::Cloud::Speech::V1::TranscriptOutputConfig, ::Hash]
+            #     Optional. Specifies an optional destination for the recognition results.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::Operation]
@@ -273,6 +288,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/speech/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Speech::V1::Speech::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Speech::V1::LongRunningRecognizeRequest.new
+            #
+            #   # Call the long_running_recognize method.
+            #   result = client.long_running_recognize request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def long_running_recognize request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -293,7 +330,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.long_running_recognize.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.long_running_recognize.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @speech_stub.call_rpc :long_running_recognize, request, options: options do |response, operation|
@@ -322,6 +361,30 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/speech/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Speech::V1::Speech::Client.new
+            #
+            #   # Create an input stream
+            #   input = Gapic::StreamInput.new
+            #
+            #   # Call the streaming_recognize method to start streaming.
+            #   output = client.streaming_recognize input
+            #
+            #   # Send requests on the stream. For each request, pass in keyword
+            #   # arguments to set fields. Be sure to close the stream when done.
+            #   input << Google::Cloud::Speech::V1::StreamingRecognizeRequest.new
+            #   input << Google::Cloud::Speech::V1::StreamingRecognizeRequest.new
+            #   input.close
+            #
+            #   # Handle streamed responses. These may be interleaved with inputs.
+            #   # Each response is of type ::Google::Cloud::Speech::V1::StreamingRecognizeResponse.
+            #   output.each do |response|
+            #     p response
+            #   end
+            #
             def streaming_recognize request, options = nil
               unless request.is_a? ::Enumerable
                 raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum
@@ -347,7 +410,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.streaming_recognize.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.streaming_recognize.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @speech_stub.call_rpc :streaming_recognize, request, options: options do |response, operation|
@@ -371,22 +436,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for recognize
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Speech::V1::Speech::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.recognize.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Speech::V1::Speech::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.recognize.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # recognize to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Speech::V1::Speech::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.recognize.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Speech::V1::Speech::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.recognize.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.