SpeechClient

SpeechClient

Service that implements Google Cloud Speech API.

Constructor

new SpeechClient(optionsopt)

Construct an instance of SpeechClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. See the subsequent parameters for more details.

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.

Members

(static) apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

(static) port

The port for this API service.

(static) scopes

The scopes needed to make gRPC calls for every method defined in this service.

(static) servicePath

The DNS address for this API service.

Methods

_streamingRecognize(optionsopt) → {Stream}

Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).

Parameters:
Name Type Attributes Description
options object <optional>

Call options. See CallOptions for more details.

(async) checkLongRunningRecognizeProgress(name) → {Promise}

Check the status of the long running operation returned by the longRunningRecognize() method.

Parameters:
Name Type Description
name String

The operation name that will be passed.

close()

Terminate the GRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

longRunningRecognize(request, optionsopt) → {Promise}

Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface. Returns either an Operation.error or an Operation.response which contains a LongRunningRecognizeResponse message. For more information on asynchronous speech recognition, see the how-to.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
config google.cloud.speech.v1.RecognitionConfig

Required. Provides information to the recognizer that specifies how to process the request.
audio google.cloud.speech.v1.RecognitionAudio

Required. The audio data to be recognized.
options object <optional>

Call options. See CallOptions for more details.

recognize(request, optionsopt) → {Promise}

Performs synchronous speech recognition: receive results after all audio has been sent and processed.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
config google.cloud.speech.v1.RecognitionConfig

Required. Provides information to the recognizer that specifies how to process the request.
audio google.cloud.speech.v1.RecognitionAudio

Required. The audio data to be recognized.
options object <optional>

Call options. See CallOptions for more details.