com.google.cloud.speech.spi.v1beta1

Class SpeechApi

java.lang.Object

com.google.cloud.speech.spi.v1beta1.SpeechApi

All Implemented Interfaces:

AutoCloseable

@Generated(value="by GAPIC")
public class SpeechApi
extends Object
implements AutoCloseable

Service Description: Service that implements Google Cloud Speech API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 
 try (SpeechApi speechApi = SpeechApi.create()) {
   RecognitionConfig config = RecognitionConfig.newBuilder().build();
   RecognitionAudio audio = RecognitionAudio.newBuilder().build();
   SyncRecognizeResponse response = speechApi.syncRecognize(config, audio);
 }
 
 

Note: close() needs to be called on the speechApi object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable ApiCallable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of SpeechSettings to create(). For example:

 
 SpeechSettings speechSettings = SpeechSettings.defaultBuilder()
     .provideChannelWith(myCredentials)
     .build();
 SpeechApi speechApi = SpeechApi.create(speechSettings);
 
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SpeechApi(SpeechSettings settings) Constructs an instance of SpeechApi, using the given settings.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.longrunning.Operation	asyncRecognize(com.google.cloud.speech.v1beta1.AsyncRecognizeRequest request) Perform asynchronous speech-recognition: receive results via the google.longrunning.Operations interface.
com.google.longrunning.Operation	asyncRecognize(com.google.cloud.speech.v1beta1.RecognitionConfig config, com.google.cloud.speech.v1beta1.RecognitionAudio audio) Perform asynchronous speech-recognition: receive results via the google.longrunning.Operations interface.
com.google.api.gax.grpc.ApiCallable<com.google.cloud.speech.v1beta1.AsyncRecognizeRequest,com.google.longrunning.Operation>	asyncRecognizeCallable() Perform asynchronous speech-recognition: receive results via the google.longrunning.Operations interface.
void	close() Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.
static SpeechApi	create() Constructs an instance of SpeechApi with default settings.
static SpeechApi	create(SpeechSettings settings) Constructs an instance of SpeechApi, using the given settings.
SpeechSettings	getSettings()
com.google.cloud.speech.v1beta1.SyncRecognizeResponse	syncRecognize(com.google.cloud.speech.v1beta1.RecognitionConfig config, com.google.cloud.speech.v1beta1.RecognitionAudio audio) Perform synchronous speech-recognition: receive results after all audio has been sent and processed.
com.google.cloud.speech.v1beta1.SyncRecognizeResponse	syncRecognize(com.google.cloud.speech.v1beta1.SyncRecognizeRequest request) Perform synchronous speech-recognition: receive results after all audio has been sent and processed.
com.google.api.gax.grpc.ApiCallable<com.google.cloud.speech.v1beta1.SyncRecognizeRequest,com.google.cloud.speech.v1beta1.SyncRecognizeResponse>	syncRecognizeCallable() Perform synchronous speech-recognition: receive results after all audio has been sent and processed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpeechApi

protected SpeechApi(SpeechSettings settings)
             throws IOException

Constructs an instance of SpeechApi, using the given settings. This is protected so that it easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

Method Detail

getSettings

public final SpeechSettings getSettings()

create

public static final SpeechApi create()
                              throws IOException

Constructs an instance of SpeechApi with default settings.

Throws:

IOException

create

public static final SpeechApi create(SpeechSettings settings)
                              throws IOException

Constructs an instance of SpeechApi, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

syncRecognize

public final com.google.cloud.speech.v1beta1.SyncRecognizeResponse syncRecognize(com.google.cloud.speech.v1beta1.RecognitionConfig config,
                                                                  com.google.cloud.speech.v1beta1.RecognitionAudio audio)

Perform synchronous speech-recognition: receive results after all audio has been sent and processed. Sample code:

 try (SpeechApi speechApi = SpeechApi.create()) {
   RecognitionConfig config = RecognitionConfig.newBuilder().build();
   RecognitionAudio audio = RecognitionAudio.newBuilder().build();
   SyncRecognizeResponse response = speechApi.syncRecognize(config, audio);
 }
 

Parameters:

config - [Required] The `config` message provides information to the recognizer that specifies how to process the request.

audio - [Required] The audio data to be recognized.

Throws:

com.google.api.gax.grpc.ApiException - if the remote call fails

syncRecognize

public final com.google.cloud.speech.v1beta1.SyncRecognizeResponse syncRecognize(com.google.cloud.speech.v1beta1.SyncRecognizeRequest request)

Perform synchronous speech-recognition: receive results after all audio has been sent and processed. Sample code:

 try (SpeechApi speechApi = SpeechApi.create()) {
   RecognitionConfig config = RecognitionConfig.newBuilder().build();
   RecognitionAudio audio = RecognitionAudio.newBuilder().build();
   SyncRecognizeRequest request = SyncRecognizeRequest.newBuilder()
     .setConfig(config)
     .setAudio(audio)
     .build();
   SyncRecognizeResponse response = speechApi.syncRecognize(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.grpc.ApiException - if the remote call fails

syncRecognizeCallable

public final com.google.api.gax.grpc.ApiCallable<com.google.cloud.speech.v1beta1.SyncRecognizeRequest,com.google.cloud.speech.v1beta1.SyncRecognizeResponse> syncRecognizeCallable()

Perform synchronous speech-recognition: receive results after all audio has been sent and processed. Sample code:

 try (SpeechApi speechApi = SpeechApi.create()) {
   RecognitionConfig config = RecognitionConfig.newBuilder().build();
   RecognitionAudio audio = RecognitionAudio.newBuilder().build();
   SyncRecognizeRequest request = SyncRecognizeRequest.newBuilder()
     .setConfig(config)
     .setAudio(audio)
     .build();
   ListenableFuture<SyncRecognizeResponse> future = speechApi.syncRecognizeCallable().futureCall(request);
   // Do something
   SyncRecognizeResponse response = future.get();
 }
 

asyncRecognize

public final com.google.longrunning.Operation asyncRecognize(com.google.cloud.speech.v1beta1.RecognitionConfig config,
                                              com.google.cloud.speech.v1beta1.RecognitionAudio audio)

Perform asynchronous speech-recognition: receive results via the google.longrunning.Operations interface. `Operation.response` returns `AsyncRecognizeResponse`. Sample code:

 try (SpeechApi speechApi = SpeechApi.create()) {
   RecognitionConfig config = RecognitionConfig.newBuilder().build();
   RecognitionAudio audio = RecognitionAudio.newBuilder().build();
   Operation response = speechApi.asyncRecognize(config, audio);
 }
 

Parameters:

config - [Required] The `config` message provides information to the recognizer that specifies how to process the request.

audio - [Required] The audio data to be recognized.

Throws:

com.google.api.gax.grpc.ApiException - if the remote call fails

asyncRecognize

public final com.google.longrunning.Operation asyncRecognize(com.google.cloud.speech.v1beta1.AsyncRecognizeRequest request)

Perform asynchronous speech-recognition: receive results via the google.longrunning.Operations interface. `Operation.response` returns `AsyncRecognizeResponse`. Sample code:

 try (SpeechApi speechApi = SpeechApi.create()) {
   RecognitionConfig config = RecognitionConfig.newBuilder().build();
   RecognitionAudio audio = RecognitionAudio.newBuilder().build();
   AsyncRecognizeRequest request = AsyncRecognizeRequest.newBuilder()
     .setConfig(config)
     .setAudio(audio)
     .build();
   Operation response = speechApi.asyncRecognize(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.grpc.ApiException - if the remote call fails

asyncRecognizeCallable

public final com.google.api.gax.grpc.ApiCallable<com.google.cloud.speech.v1beta1.AsyncRecognizeRequest,com.google.longrunning.Operation> asyncRecognizeCallable()

Perform asynchronous speech-recognition: receive results via the google.longrunning.Operations interface. `Operation.response` returns `AsyncRecognizeResponse`. Sample code:

 try (SpeechApi speechApi = SpeechApi.create()) {
   RecognitionConfig config = RecognitionConfig.newBuilder().build();
   RecognitionAudio audio = RecognitionAudio.newBuilder().build();
   AsyncRecognizeRequest request = AsyncRecognizeRequest.newBuilder()
     .setConfig(config)
     .setAudio(audio)
     .build();
   ListenableFuture<Operation> future = speechApi.asyncRecognizeCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

close

public final void close()
                 throws Exception

Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.

Specified by:

close in interface AutoCloseable

Throws:

Exception