@google-cloud/speech 3.1.1 » Class: SpeechClient

Properties

Methods

getProjectId(callback)
longRunningRecognize(request[, options][, callback])

recognize(request[, options][, callback])
streamingRecognize([options])

streamingRecognize(config[, options])

new SpeechClient([options])

Construct an instance of SpeechClient.

Parameters

Name Type Optional Description

options

Yes

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

Values in options have the following properties:

Name	Optional	Description
credentials	Yes	Credentials object.
credentials.client_email	Yes
credentials.private_key	Yes
email	Yes	Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename	Yes	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	Yes	The port on which to connect to the remote host.
projectId	Yes	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.
promise	Yes	Custom promise module to use instead of native Promises.
servicePath	Yes	The domain name of the API remote host.

Properties

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

getProjectId(callback)

Return the project ID used by this class.

Parameter

Name	Type	Optional	Description
callback	function(Error, string)		the callback to be called with the current project Id.

longRunningRecognize(request[, options][, callback]) → 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.

Example

const speech = require('@google-cloud/speech');

const client = new speech.v1.SpeechClient({
  // optional auth parameters.
});

const encoding = 'FLAC';
const sampleRateHertz = 44100;
const languageCode = 'en-US';
const config = {
  encoding: encoding,
  sampleRateHertz: sampleRateHertz,
  languageCode: languageCode,
};
const uri = 'gs://bucket_name/file_name.flac';
const audio = {
  uri: uri,
};
const request = {
  config: config,
  audio: audio,
};

// Handle the operation using the promise pattern.
client.longRunningRecognize(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Operation#promise starts polling for the completion of the LRO.
    return operation.promise();
  })
  .then(responses => {
    const result = responses[0];
    const metadata = responses[1];
    const finalApiResponse = responses[2];
  })
  .catch(err => {
    console.error(err);
  });

const encoding = 'FLAC';
const sampleRateHertz = 44100;
const languageCode = 'en-US';
const config = {
  encoding: encoding,
  sampleRateHertz: sampleRateHertz,
  languageCode: languageCode,
};
const uri = 'gs://bucket_name/file_name.flac';
const audio = {
  uri: uri,
};
const request = {
  config: config,
  audio: audio,
};

// Handle the operation using the event emitter pattern.
client.longRunningRecognize(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Adding a listener for the "complete" event starts polling for the
    // completion of the operation.
    operation.on('complete', (result, metadata, finalApiResponse) => {
      // doSomethingWith(result);
    });

    // Adding a listener for the "progress" event causes the callback to be
    // called on any change in metadata when the operation is polled.
    operation.on('progress', (metadata, apiResponse) => {
      // doSomethingWith(metadata)
    });

    // Adding a listener for the "error" event handles any errors found during polling.
    operation.on('error', err => {
      // throw(err);
    });
  })
  .catch(err => {
    console.error(err);
  });

const encoding = 'FLAC';
const sampleRateHertz = 44100;
const languageCode = 'en-US';
const config = {
  encoding: encoding,
  sampleRateHertz: sampleRateHertz,
  languageCode: languageCode,
};
const uri = 'gs://bucket_name/file_name.flac';
const audio = {
  uri: uri,
};
const request = {
  config: config,
  audio: audio,
};

// Handle the operation using the await pattern.
const [operation] = await client.longRunningRecognize(request);

const [response] = await operation.promise();

Parameters

Name Type Optional Description

request

Object

The request object that will be sent.

Values in request have the following properties:

Name

Type

Optional

Description

config

Object

Required Provides information to the recognizer that specifies how to process the request.

This object should have the same structure as RecognitionConfig

audio

Object

Required The audio data to be recognized.

This object should have the same structure as RecognitionAudio

options

Object

Yes

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function(nullable Error, nullable Object)

Yes

The function which will be called with the result of the API call.

The second parameter to the callback is a gax.Operation object.

Returns

Promise

The promise which resolves to an array. The first element of the array is a gax.Operation object. The promise has a method named "cancel" which cancels the ongoing API call.

recognize(request[, options][, callback]) → Promise

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

Example

const speech = require('@google-cloud/speech');

const client = new speech.v1.SpeechClient({
  // optional auth parameters.
});

const encoding = 'FLAC';
const sampleRateHertz = 44100;
const languageCode = 'en-US';
const config = {
  encoding: encoding,
  sampleRateHertz: sampleRateHertz,
  languageCode: languageCode,
};
const uri = 'gs://bucket_name/file_name.flac';
const audio = {
  uri: uri,
};
const request = {
  config: config,
  audio: audio,
};
client.recognize(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Parameters

Name Type Optional Description

request

Object

The request object that will be sent.

Values in request have the following properties:

Name

Type

Optional

Description

config

Object

Required Provides information to the recognizer that specifies how to process the request.

This object should have the same structure as RecognitionConfig

audio

Object

Required The audio data to be recognized.

This object should have the same structure as RecognitionAudio

options

Object

Yes

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function(nullable Error, nullable Object)

Yes

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing RecognizeResponse.

Returns

Promise

The promise which resolves to an array. The first element of the array is an object representing RecognizeResponse. The promise has a method named "cancel" which cancels the ongoing API call.

streamingRecognize([options]) → Stream

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

Example

const speech = require('@google-cloud/speech');

const client = new speech.v1.SpeechClient({
  // optional auth parameters.
});

const stream = client.streamingRecognize().on('data', response => {
  // doThingsWith(response)
});
const request = {};
// Write request objects.
stream.write(request);

Parameter

Name	Type	Optional	Description
options	Object	Yes	Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns

Stream

An object stream which is both readable and writable. It accepts objects representing StreamingRecognizeRequest for write() method, and will emit objects representing StreamingRecognizeResponse on 'data' event asynchronously.

streamingRecognize(config[, options]) → stream

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

Example

const speech = require('@google-cloud/speech');
const client = new speech.SpeechClient();

const stream = client.streamingRecognize({
  config: {
    encoding: 'LINEAR16',
    languageCode: 'en-us',
    sampleRateHertz: 44100,
  },
}).on('data', function(response) {
  // doThingsWith(response);
});
const request = {};
// Write request objects.
stream.write(request);

Parameters

Name	Type	Optional	Description
config	object		The configuration for the stream. This is appropriately wrapped and sent as the first argument. It should be an object conforming to the StreamingRecognitionConfig structure.
options	object	Yes	Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns

stream

An object stream which is both readable and writable. It accepts raw audio for the write() method, and will emit objects representing StreamingRecognizeResponse on the 'data' event asynchronously.