com.google.cloud.speech.spi.v1beta1.SpeechApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-speech Show documentation
Show all versions of google-cloud-speech Show documentation
Java idiomatic client for Google Cloud Speech.
/*
* 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.
*/
package com.google.cloud.speech.spi.v1beta1;
import com.google.api.gax.grpc.StreamingCallable;
import com.google.api.gax.grpc.UnaryCallable;
import com.google.cloud.speech.v1beta1.AsyncRecognizeRequest;
import com.google.cloud.speech.v1beta1.RecognitionAudio;
import com.google.cloud.speech.v1beta1.RecognitionConfig;
import com.google.cloud.speech.v1beta1.StreamingRecognizeRequest;
import com.google.cloud.speech.v1beta1.StreamingRecognizeResponse;
import com.google.cloud.speech.v1beta1.SyncRecognizeRequest;
import com.google.cloud.speech.v1beta1.SyncRecognizeResponse;
import com.google.longrunning.Operation;
import io.grpc.ManagedChannel;
import java.io.Closeable;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.ScheduledExecutorService;
// AUTO-GENERATED DOCUMENTATION AND SERVICE
/**
* 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:
*
*
* - 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.
*
- 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.
*
- A "callable" method. This type of method takes no parameters and returns an immutable API
* callable 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);
*
*
*/
@javax.annotation.Generated("by GAPIC")
public class SpeechApi implements AutoCloseable {
private final SpeechSettings settings;
private final ManagedChannel channel;
private final ScheduledExecutorService executor;
private final List closeables = new ArrayList<>();
private final UnaryCallable syncRecognizeCallable;
private final UnaryCallable asyncRecognizeCallable;
private final StreamingCallable
streamingRecognizeCallable;
/** Constructs an instance of SpeechApi with default settings. */
public static final SpeechApi create() throws IOException {
return create(SpeechSettings.defaultBuilder().build());
}
/**
* 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.
*/
public static final SpeechApi create(SpeechSettings settings) throws IOException {
return new SpeechApi(settings);
}
/**
* 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.
*/
protected SpeechApi(SpeechSettings settings) throws IOException {
this.settings = settings;
this.executor = settings.getExecutorProvider().getOrBuildExecutor();
this.channel = settings.getChannelProvider().getOrBuildChannel(this.executor);
this.syncRecognizeCallable =
UnaryCallable.create(settings.syncRecognizeSettings(), this.channel, this.executor);
this.asyncRecognizeCallable =
UnaryCallable.create(settings.asyncRecognizeSettings(), this.channel, this.executor);
this.streamingRecognizeCallable =
StreamingCallable.create(settings.streamingRecognizeSettings(), this.channel);
if (settings.getChannelProvider().shouldAutoClose()) {
closeables.add(
new Closeable() {
@Override
public void close() throws IOException {
channel.shutdown();
}
});
}
if (settings.getExecutorProvider().shouldAutoClose()) {
closeables.add(
new Closeable() {
@Override
public void close() throws IOException {
executor.shutdown();
}
});
}
}
public final SpeechSettings getSettings() {
return settings;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param config [Required] The `config` message provides information to the recognizer that
* specifies how to process the request.
* @param audio [Required] The audio data to be recognized.
* @throws com.google.api.gax.grpc.ApiException if the remote call fails
*/
public final SyncRecognizeResponse syncRecognize(
RecognitionConfig config, RecognitionAudio audio) {
SyncRecognizeRequest request =
SyncRecognizeRequest.newBuilder().setConfig(config).setAudio(audio).build();
return syncRecognize(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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);
* }
*
*
* @param 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
*/
public final SyncRecognizeResponse syncRecognize(SyncRecognizeRequest request) {
return syncRecognizeCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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();
* }
*
*/
public final UnaryCallable syncRecognizeCallable() {
return syncRecognizeCallable;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Perform 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.
*
* Sample code:
*
*
* try (SpeechApi speechApi = SpeechApi.create()) {
* RecognitionConfig config = RecognitionConfig.newBuilder().build();
* RecognitionAudio audio = RecognitionAudio.newBuilder().build();
* Operation response = speechApi.asyncRecognize(config, audio);
* }
*
*
* @param config [Required] The `config` message provides information to the recognizer that
* specifies how to process the request.
* @param audio [Required] The audio data to be recognized.
* @throws com.google.api.gax.grpc.ApiException if the remote call fails
*/
public final Operation asyncRecognize(RecognitionConfig config, RecognitionAudio audio) {
AsyncRecognizeRequest request =
AsyncRecognizeRequest.newBuilder().setConfig(config).setAudio(audio).build();
return asyncRecognize(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Perform 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.
*
* 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);
* }
*
*
* @param 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
*/
public final Operation asyncRecognize(AsyncRecognizeRequest request) {
return asyncRecognizeCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Perform 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.
*
* 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();
* }
*
*/
public final UnaryCallable asyncRecognizeCallable() {
return asyncRecognizeCallable;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Perform bidirectional streaming speech-recognition: receive results while sending audio. This
* method is only available via the gRPC API (not REST).
*
* Sample code:
*
*
* try (SpeechApi speechApi = SpeechApi.create()) {
* StreamObserver<StreamingRecognizeResponse> responseObserver =
* new StreamObserver<StreamingRecognizeResponse>() {
* @Override
* public void onNext(StreamingRecognizeResponse response) {
* // Do something when receive a response
* }
*
* @Override
* public void onError(Throwable t) {
* // Add error-handling
* }
*
* @Override
* public void onCompleted() {
* // Do something when complete.
* }
* };
* StreamObserver<StreamingRecognizeRequest> requestObserver =
* speechApi.streamingRecognizeCallable().bidiStreamingCall(responseObserver)});
*
* StreamingRecognizeRequest request = StreamingRecognizeRequest.newBuilder().build();
* requestObserver.onNext(request);
* }
*
*/
public final StreamingCallable
streamingRecognizeCallable() {
return streamingRecognizeCallable;
}
/**
* Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately
* cancelled.
*/
@Override
public final void close() throws Exception {
for (AutoCloseable closeable : closeables) {
closeable.close();
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy