google-cloud-speech 0.23.0 → 0.24.0

data/lib/google/cloud/speech/{v1beta1 → v1}/speech_client.rb

@@ -14,7 +14,7 @@
 #
 # EDITING INSTRUCTIONS
 # This file was generated from the file
-# https://github.com/googleapis/googleapis/blob/master/google/cloud/speech/v1beta1/cloud_speech.proto,
+# https://github.com/googleapis/googleapis/blob/master/google/cloud/speech/v1/cloud_speech.proto,
 # and updates to that file get reflected here through a refresh process.
 # For the short term, the refresh process will only be runnable by Google
 # engineers.
@@ -29,16 +29,16 @@ require "google/gax"
 require "google/gax/operation"
 require "google/longrunning/operations_client"
 
-require "google/cloud/speech/v1beta1/cloud_speech_pb"
+require "google/cloud/speech/v1/cloud_speech_pb"
 
 module Google
   module Cloud
     module Speech
-      module V1beta1
+      module V1
         # Service that implements Google Cloud Speech API.
         #
         # @!attribute [r] speech_stub
-        #   @return [Google::Cloud::Speech::V1beta1::Speech::Stub]
+        #   @return [Google::Cloud::Speech::V1::Speech::Stub]
         class SpeechClient
           attr_reader :speech_stub
 
@@ -64,6 +64,12 @@ module Google
           #   A Channel object through which to make calls.
           # @param chan_creds [Grpc::ChannelCredentials]
           #   A ChannelCredentials for the setting up the RPC client.
+          # @param updater_proc [Proc]
+          #   A function that transforms the metadata for requests, e.g., to give
+          #   OAuth credentials.
+          # @param scopes [Array<String>]
+          #   The OAuth scopes for this service. This parameter is ignored if
+          #   an updater_proc is supplied.
           # @param client_config[Hash]
           #   A Hash for call options for each method. See
           #   Google::Gax#construct_settings for the structure of
@@ -76,6 +82,7 @@ module Google
               port: DEFAULT_SERVICE_PORT,
               channel: nil,
               chan_creds: nil,
+              updater_proc: nil,
               scopes: ALL_SCOPES,
               client_config: {},
               timeout: DEFAULT_TIMEOUT,
@@ -87,13 +94,14 @@ module Google
             # the gRPC module only when it's required.
             # See https://github.com/googleapis/toolkit/issues/446
             require "google/gax/grpc"
-            require "google/cloud/speech/v1beta1/cloud_speech_services_pb"
+            require "google/cloud/speech/v1/cloud_speech_services_pb"
 
             @operations_client = Google::Longrunning::OperationsClient.new(
               service_path: service_path,
               port: port,
               channel: channel,
               chan_creds: chan_creds,
+              updater_proc: updater_proc,
               scopes: scopes,
               client_config: client_config,
               timeout: timeout,
@@ -119,7 +127,7 @@ module Google
             )
             defaults = client_config_file.open do |f|
               Google::Gax.construct_settings(
-                "google.cloud.speech.v1beta1.Speech",
+                "google.cloud.speech.v1.Speech",
                 JSON.parse(f.read),
                 client_config,
                 Google::Gax::Grpc::STATUS_CODE_NAMES,
@@ -133,17 +141,18 @@ module Google
               port,
               chan_creds: chan_creds,
               channel: channel,
+              updater_proc: updater_proc,
               scopes: scopes,
-              &Google::Cloud::Speech::V1beta1::Speech::Stub.method(:new)
+              &Google::Cloud::Speech::V1::Speech::Stub.method(:new)
             )
 
-            @sync_recognize = Google::Gax.create_api_call(
-              @speech_stub.method(:sync_recognize),
-              defaults["sync_recognize"]
+            @recognize = Google::Gax.create_api_call(
+              @speech_stub.method(:recognize),
+              defaults["recognize"]
             )
-            @async_recognize = Google::Gax.create_api_call(
-              @speech_stub.method(:async_recognize),
-              defaults["async_recognize"]
+            @long_running_recognize = Google::Gax.create_api_call(
+              @speech_stub.method(:long_running_recognize),
+              defaults["long_running_recognize"]
             )
             @streaming_recognize = Google::Gax.create_api_call(
               @speech_stub.method(:streaming_recognize),
@@ -153,84 +162,88 @@ module Google
 
           # Service calls
 
-          # Perform synchronous speech-recognition: receive results after all audio
+          # Performs synchronous speech recognition: receive results after all audio
           # has been sent and processed.
           #
-          # @param config [Google::Cloud::Speech::V1beta1::RecognitionConfig]
-          #   [Required] The +config+ message provides information to the recognizer
-          #   that specifies how to process the request.
-          # @param audio [Google::Cloud::Speech::V1beta1::RecognitionAudio]
-          #   [Required] The audio data to be recognized.
+          # @param config [Google::Cloud::Speech::V1::RecognitionConfig]
+          #   *Required* Provides information to the recognizer that specifies how to
+          #   process the request.
+          # @param audio [Google::Cloud::Speech::V1::RecognitionAudio]
+          #   *Required* The audio data to be recognized.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
-          # @return [Google::Cloud::Speech::V1beta1::SyncRecognizeResponse]
+          # @return [Google::Cloud::Speech::V1::RecognizeResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/speech/v1beta1/speech_client"
+          #   require "google/cloud/speech/v1"
           #
-          #   AudioEncoding = Google::Cloud::Speech::V1beta1::RecognitionConfig::AudioEncoding
-          #   RecognitionAudio = Google::Cloud::Speech::V1beta1::RecognitionAudio
-          #   RecognitionConfig = Google::Cloud::Speech::V1beta1::RecognitionConfig
-          #   SpeechClient = Google::Cloud::Speech::V1beta1::SpeechClient
+          #   AudioEncoding = Google::Cloud::Speech::V1::RecognitionConfig::AudioEncoding
+          #   RecognitionAudio = Google::Cloud::Speech::V1::RecognitionAudio
+          #   RecognitionConfig = Google::Cloud::Speech::V1::RecognitionConfig
+          #   SpeechClient = Google::Cloud::Speech::V1::SpeechClient
           #
           #   speech_client = SpeechClient.new
           #   encoding = AudioEncoding::FLAC
-          #   sample_rate = 44100
+          #   sample_rate_hertz = 44100
+          #   language_code = "en-US"
           #   config = RecognitionConfig.new
           #   config.encoding = encoding
-          #   config.sample_rate = sample_rate
+          #   config.sample_rate_hertz = sample_rate_hertz
+          #   config.language_code = language_code
           #   uri = "gs://bucket_name/file_name.flac"
           #   audio = RecognitionAudio.new
           #   audio.uri = uri
-          #   response = speech_client.sync_recognize(config, audio)
+          #   response = speech_client.recognize(config, audio)
 
-          def sync_recognize \
+          def recognize \
               config,
               audio,
               options: nil
-            req = Google::Cloud::Speech::V1beta1::SyncRecognizeRequest.new({
+            req = Google::Cloud::Speech::V1::RecognizeRequest.new({
               config: config,
               audio: audio
             }.delete_if { |_, v| v.nil? })
-            @sync_recognize.call(req, options)
+            @recognize.call(req, options)
           end
 
-          # Perform asynchronous speech-recognition: receive results via the
+          # Performs asynchronous speech recognition: receive results via the
           # google.longrunning.Operations interface. Returns either an
           # +Operation.error+ or an +Operation.response+ which contains
-          # an +AsyncRecognizeResponse+ message.
+          # a +LongRunningRecognizeResponse+ message.
           #
-          # @param config [Google::Cloud::Speech::V1beta1::RecognitionConfig]
-          #   [Required] The +config+ message provides information to the recognizer
-          #   that specifies how to process the request.
-          # @param audio [Google::Cloud::Speech::V1beta1::RecognitionAudio]
-          #   [Required] The audio data to be recognized.
+          # @param config [Google::Cloud::Speech::V1::RecognitionConfig]
+          #   *Required* Provides information to the recognizer that specifies how to
+          #   process the request.
+          # @param audio [Google::Cloud::Speech::V1::RecognitionAudio]
+          #   *Required* The audio data to be recognized.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
           # @return [Google::Gax::Operation]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/speech/v1beta1/speech_client"
+          #   require "google/cloud/speech/v1"
           #
-          #   AudioEncoding = Google::Cloud::Speech::V1beta1::RecognitionConfig::AudioEncoding
-          #   RecognitionAudio = Google::Cloud::Speech::V1beta1::RecognitionAudio
-          #   RecognitionConfig = Google::Cloud::Speech::V1beta1::RecognitionConfig
-          #   SpeechClient = Google::Cloud::Speech::V1beta1::SpeechClient
+          #   AudioEncoding = Google::Cloud::Speech::V1::RecognitionConfig::AudioEncoding
+          #   RecognitionAudio = Google::Cloud::Speech::V1::RecognitionAudio
+          #   RecognitionConfig = Google::Cloud::Speech::V1::RecognitionConfig
+          #   SpeechClient = Google::Cloud::Speech::V1::SpeechClient
           #
           #   speech_client = SpeechClient.new
           #   encoding = AudioEncoding::FLAC
-          #   sample_rate = 44100
+          #   sample_rate_hertz = 44100
+          #   language_code = "en-US"
           #   config = RecognitionConfig.new
           #   config.encoding = encoding
-          #   config.sample_rate = sample_rate
+          #   config.sample_rate_hertz = sample_rate_hertz
+          #   config.language_code = language_code
           #   uri = "gs://bucket_name/file_name.flac"
           #   audio = RecognitionAudio.new
           #   audio.uri = uri
           #
           #   # Register a callback during the method call.
-          #   operation = speech_client.async_recognize(config, audio) do |op|
+          #   operation = speech_client.long_running_recognize(config, audio) do |op|
           #     raise op.results.message if op.error?
           #     op_results = op.results
           #     # Process the results.
@@ -256,35 +269,35 @@ module Google
           #   # completion.
           #   operation.wait_until_done!
 
-          def async_recognize \
+          def long_running_recognize \
               config,
               audio,
               options: nil
-            req = Google::Cloud::Speech::V1beta1::AsyncRecognizeRequest.new({
+            req = Google::Cloud::Speech::V1::LongRunningRecognizeRequest.new({
               config: config,
               audio: audio
             }.delete_if { |_, v| v.nil? })
             operation = Google::Gax::Operation.new(
-              @async_recognize.call(req, options),
+              @long_running_recognize.call(req, options),
               @operations_client,
-              Google::Cloud::Speech::V1beta1::AsyncRecognizeResponse,
-              Google::Cloud::Speech::V1beta1::AsyncRecognizeMetadata,
+              Google::Cloud::Speech::V1::LongRunningRecognizeResponse,
+              Google::Cloud::Speech::V1::LongRunningRecognizeMetadata,
               call_options: options
             )
             operation.on_done { |operation| yield(operation) } if block_given?
             operation
           end
 
-          # Perform bidirectional streaming speech-recognition: receive results while
+          # Performs bidirectional streaming speech recognition: receive results while
           # sending audio. This method is only available via the gRPC API (not REST).
           #
-          # @param reqs [Enumerable<Google::Cloud::Speech::V1beta1::StreamingRecognizeRequest>]
+          # @param reqs [Enumerable<Google::Cloud::Speech::V1::StreamingRecognizeRequest>]
           #   The input requests.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
-          # @return [Enumerable<Google::Cloud::Speech::V1beta1::StreamingRecognizeResponse>]
-          #   An enumerable of Google::Cloud::Speech::V1beta1::StreamingRecognizeResponse instances.
+          # @return [Enumerable<Google::Cloud::Speech::V1::StreamingRecognizeResponse>]
+          #   An enumerable of Google::Cloud::Speech::V1::StreamingRecognizeResponse instances.
           #
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           #
@@ -294,10 +307,10 @@ module Google
           #     This method interface might change in the future.
           #
           # @example
-          #   require "google/cloud/speech/v1beta1/speech_client"
+          #   require "google/cloud/speech/v1"
           #
-          #   SpeechClient = Google::Cloud::Speech::V1beta1::SpeechClient
-          #   StreamingRecognizeRequest = Google::Cloud::Speech::V1beta1::StreamingRecognizeRequest
+          #   SpeechClient = Google::Cloud::Speech::V1::SpeechClient
+          #   StreamingRecognizeRequest = Google::Cloud::Speech::V1::StreamingRecognizeRequest
           #
           #   speech_client = SpeechClient.new
           #   request = StreamingRecognizeRequest.new

data/lib/google/cloud/speech/{v1beta1 → v1}/speech_client_config.json

@@ -1,6 +1,6 @@
 {
   "interfaces": {
-    "google.cloud.speech.v1beta1.Speech": {
+    "google.cloud.speech.v1.Speech": {
       "retry_codes": {
         "idempotent": [
           "DEADLINE_EXCEEDED",
@@ -15,26 +15,26 @@
           "initial_retry_delay_millis": 100,
           "retry_delay_multiplier": 1.3,
           "max_retry_delay_millis": 60000,
-          "initial_rpc_timeout_millis": 60000,
+          "initial_rpc_timeout_millis": 190000,
           "rpc_timeout_multiplier": 1.0,
-          "max_rpc_timeout_millis": 60000,
+          "max_rpc_timeout_millis": 190000,
           "total_timeout_millis": 600000
         }
       },
       "methods": {
-        "SyncRecognize": {
-          "timeout_millis": 60000,
+        "Recognize": {
+          "timeout_millis": 190000,
           "retry_codes_name": "idempotent",
           "retry_params_name": "default"
         },
-        "AsyncRecognize": {
+        "LongRunningRecognize": {
           "timeout_millis": 60000,
-          "retry_codes_name": "idempotent",
+          "retry_codes_name": "non_idempotent",
           "retry_params_name": "default"
         },
         "StreamingRecognize": {
           "timeout_millis": 190000,
-          "retry_codes_name": "non_idempotent",
+          "retry_codes_name": "idempotent",
           "retry_params_name": "default"
         }
       }

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Speech
-      VERSION = "0.23.0"
+      VERSION = "0.24.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-speech
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-01 00:00:00.000000000 Z
+date: 2017-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.2
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -180,19 +180,19 @@ files:
 - lib/google/cloud/speech.rb
 - lib/google/cloud/speech/audio.rb
 - lib/google/cloud/speech/credentials.rb
-- lib/google/cloud/speech/job.rb
+- lib/google/cloud/speech/operation.rb
 - lib/google/cloud/speech/project.rb
 - lib/google/cloud/speech/result.rb
 - lib/google/cloud/speech/service.rb
 - lib/google/cloud/speech/stream.rb
-- lib/google/cloud/speech/v1beta1.rb
-- lib/google/cloud/speech/v1beta1/cloud_speech_pb.rb
-- lib/google/cloud/speech/v1beta1/cloud_speech_services_pb.rb
-- lib/google/cloud/speech/v1beta1/doc/google/cloud/speech/v1beta1/cloud_speech.rb
-- lib/google/cloud/speech/v1beta1/doc/google/protobuf/any.rb
-- lib/google/cloud/speech/v1beta1/doc/google/rpc/status.rb
-- lib/google/cloud/speech/v1beta1/speech_client.rb
-- lib/google/cloud/speech/v1beta1/speech_client_config.json
+- lib/google/cloud/speech/v1.rb
+- lib/google/cloud/speech/v1/cloud_speech_pb.rb
+- lib/google/cloud/speech/v1/cloud_speech_services_pb.rb
+- lib/google/cloud/speech/v1/doc/google/cloud/speech/v1/cloud_speech.rb
+- lib/google/cloud/speech/v1/doc/google/protobuf/any.rb
+- lib/google/cloud/speech/v1/doc/google/rpc/status.rb
+- lib/google/cloud/speech/v1/speech_client.rb
+- lib/google/cloud/speech/v1/speech_client_config.json
 - lib/google/cloud/speech/version.rb
 homepage: http://googlecloudplatform.github.io/google-cloud-ruby/
 licenses:

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

@@ -1,159 +0,0 @@
-# Copyright 2016 Google Inc. All rights reserved.
-#
-# 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
-#
-#     http://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.
-
-
-require "google/cloud/speech/v1beta1"
-
-module Google
-  module Cloud
-    module Speech
-      ##
-      # # Job
-      #
-      # A resource represents the long-running, asynchronous processing of a
-      # speech-recognition operation. The job can be refreshed to retrieve
-      # recognition results once the audio data has been processed.
-      #
-      # See {Project#recognize_job} and {Audio#recognize_job}.
-      #
-      # @see https://cloud.google.com/speech/docs/basics#async-responses
-      #   Asynchronous Speech API Responses
-      # @see https://cloud.google.com/speech/reference/rpc/google.longrunning#google.longrunning.Operations
-      #   Long-running Operation
-      #
-      # @example
-      #   require "google/cloud/speech"
-      #
-      #   speech = Google::Cloud::Speech.new
-      #
-      #   job = speech.recognize_job "path/to/audio.raw",
-      #                              encoding: :raw, sample_rate: 16000
-      #
-      #   job.done? #=> false
-      #   job.reload! # API call
-      #   job.done? #=> true
-      #   results = job.results
-      #
-      class Job
-        ##
-        # @private The Google::Gax::Operation gRPC object.
-        attr_accessor :grpc
-
-        ##
-        # @private Creates a new Job instance.
-        def initialize
-          @grpc = nil
-        end
-
-        ##
-        # A speech recognition result corresponding to a portion of the audio.
-        #
-        # @return [Array<Result>] The transcribed text of audio recognized. If
-        #   the job is not done this will return `nil`.
-        #
-        # @example
-        #   require "google/cloud/speech"
-        #
-        #   speech = Google::Cloud::Speech.new
-        #
-        #   job = speech.recognize_job "path/to/audio.raw",
-        #                              encoding: :raw, sample_rate: 16000
-        #
-        #   job.done? #=> true
-        #   results = job.results
-        #
-        def results
-          return nil unless @grpc.response?
-          @grpc.response.results.map do |result_grpc|
-            Result.from_grpc result_grpc
-          end
-          # TODO: Ensure we are raising the proper error
-          # TODO: Ensure GRPC behavior here, is an error already raised?
-          # raise @grpc.error
-        end
-
-        ##
-        # Checks if the speech-recognition processing of the audio data is
-        # complete.
-        #
-        # @return [boolean] `true` when complete, `false` otherwise.
-        #
-        # @example
-        #   require "google/cloud/speech"
-        #
-        #   speech = Google::Cloud::Speech.new
-        #
-        #   job = speech.recognize_job "path/to/audio.raw",
-        #                              encoding: :raw, sample_rate: 16000
-        #
-        #   job.done? #=> false
-        #
-        def done?
-          @grpc.done?
-        end
-
-        ##
-        # Reloads the job with current data from the long-running, asynchronous
-        # processing of a speech-recognition operation.
-        #
-        # @example
-        #   require "google/cloud/speech"
-        #
-        #   speech = Google::Cloud::Speech.new
-        #
-        #   job = speech.recognize_job "path/to/audio.raw",
-        #                              encoding: :raw, sample_rate: 16000
-        #
-        #   job.done? #=> false
-        #   job.reload! # API call
-        #   job.done? #=> true
-        #
-        def reload!
-          @grpc.reload!
-          self
-        end
-        alias_method :refresh!, :reload!
-
-        ##
-        # Reloads the job until the operation is complete. The delay between
-        # reloads will incrementally increase.
-        #
-        # @example
-        #   require "google/cloud/speech"
-        #
-        #   speech = Google::Cloud::Speech.new
-        #
-        #   job = speech.recognize_job "path/to/audio.raw",
-        #                              encoding: :raw, sample_rate: 16000
-        #
-        #   job.done? #=> false
-        #   job.wait_until_done!
-        #   job.done? #=> true
-        #
-        def wait_until_done!
-          @grpc.wait_until_done!
-        end
-
-        ##
-        # @private New Result::Job from a Google::Longrunning::Operation
-        # object.
-        def self.from_grpc grpc
-          new.tap do |job|
-            job.instance_variable_set :@grpc, grpc
-          end
-        end
-      end
-    end
-  end
-end