SpeechClient

Service that implements Google Cloud Speech API.

Constructor

new SpeechClient(optionsopt, gaxInstanceopt)

Construct an instance of SpeechClient.

Parameters:

Name Type Attributes Description

options

object

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

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

The port on which to connect to the remote host.

projectId

string

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

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance

gax

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new SpeechClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

port

The port for this API service.

scopes

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

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.

Returns:

Type	Description
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. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Provides information to the recognizer that specifies how to process the
   *  request. The first `StreamingRecognizeRequest` message must contain a
   *  `streaming_config`  message.
   */
  // const streamingConfig = {}
  /**
   *  The audio data to be recognized. Sequential chunks of audio data are sent
   *  in sequential `StreamingRecognizeRequest` messages. The first
   *  `StreamingRecognizeRequest` message must not contain `audio_content` data
   *  and all subsequent `StreamingRecognizeRequest` messages must contain
   *  `audio_content` data. The audio bytes must be encoded as specified in
   *  `RecognitionConfig`. Note: as with all bytes fields, proto buffers use a
   *  pure binary representation (not base64). See
   *  content limits (https://cloud.google.com/speech-to-text/quotas#content).
   */
  // const audioContent = Buffer.from('string')

  // Imports the Speech library
  const {SpeechClient} = require('@google-cloud/speech').v1p1beta1;

  // Instantiates a client
  const speechClient = new SpeechClient();

  async function callStreamingRecognize() {
    // Construct request
    const request = {
    };

    // Run request
    const stream = await speechClient.streamingRecognize();
    stream.on('data', (response) => { console.log(response) });
    stream.on('error', (err) => { throw(err) });
    stream.on('end', () => { /* API call completed */ });
    stream.write(request);
    stream.end();
  }

  callStreamingRecognize();

cancelOperation(request, optionsopt, callbackopt) → {Promise}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource to be cancelled.

options

Object

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

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

Returns:

Type	Description
Promise	The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example

```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```

(async) checkLongRunningRecognizeProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Provides information to the recognizer that specifies how to
   *  process the request.
   */
  // const config = {}
  /**
   *  Required. The audio data to be recognized.
   */
  // const audio = {}
  /**
   *  Optional. Specifies an optional destination for the recognition results.
   */
  // const outputConfig = {}

  // Imports the Speech library
  const {SpeechClient} = require('@google-cloud/speech').v1p1beta1;

  // Instantiates a client
  const speechClient = new SpeechClient();

  async function callLongRunningRecognize() {
    // Construct request
    const request = {
      config,
      audio,
    };

    // Run request
    const [operation] = await speechClient.longRunningRecognize(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callLongRunningRecognize();

close() → {Promise}

Terminate the gRPC channel and close the client.

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

Returns:

Type	Description
Promise	A promise that resolves when the client is closed.

customClassPath(project, location, custom_class) → {string}

Return a fully-qualified customClass resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`custom_class`	string

Returns:

Type	Description
string	Resource name string.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource to be deleted.

options

Object

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

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

Returns:

Type	Description
Promise	The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example

```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```

getOperation(request, optionsopt, callbackopt) → {Promise}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource.

options

Object

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

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

The second parameter to the callback is an object representing google.longrunning.Operation.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing google.longrunning.Operation. The promise has a method named "cancel" which cancels the ongoing API call.

Example

```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:

Type	Description
Promise	A promise that resolves to string containing the 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.

Returns:

Type	Description
Promise	A promise that resolves to an authenticated service stub.

listOperationsAsync(request, optionsopt) → {Object}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`name`	string		The name of the operation collection.
`filter`	string		The standard list filter.
`pageSize`	number	<optional>	The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Object

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

Returns:

Type	Description
Object	An iterable Object that conforms to iteration protocols.

Example

```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```

matchCustomClassFromCustomClassName(customClassName) → {string}

Parse the custom_class from CustomClass resource.

Parameters:

Name	Type	Description
`customClassName`	string	A fully-qualified path representing CustomClass resource.

Returns:

Type	Description
string	A string representing the custom_class.

matchLocationFromCustomClassName(customClassName) → {string}

Parse the location from CustomClass resource.

Parameters:

Name	Type	Description
`customClassName`	string	A fully-qualified path representing CustomClass resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromPhraseSetName(phraseSetName) → {string}

Parse the location from PhraseSet resource.

Parameters:

Name	Type	Description
`phraseSetName`	string	A fully-qualified path representing PhraseSet resource.

Returns:

Type	Description
string	A string representing the location.

matchPhraseSetFromPhraseSetName(phraseSetName) → {string}

Parse the phrase_set from PhraseSet resource.

Parameters:

Name	Type	Description
`phraseSetName`	string	A fully-qualified path representing PhraseSet resource.

Returns:

Type	Description
string	A string representing the phrase_set.

matchProjectFromCustomClassName(customClassName) → {string}

Parse the project from CustomClass resource.

Parameters:

Name	Type	Description
`customClassName`	string	A fully-qualified path representing CustomClass resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromPhraseSetName(phraseSetName) → {string}

Parse the project from PhraseSet resource.

Parameters:

Name	Type	Description
`phraseSetName`	string	A fully-qualified path representing PhraseSet resource.

Returns:

Type	Description
string	A string representing the project.

phraseSetPath(project, location, phrase_set) → {string}

Return a fully-qualified phraseSet resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`phrase_set`	string

Returns:

Type	Description
string	Resource name string.