AdaptationClient

Service that implements Google Cloud Speech Adaptation API.

Constructor

new AdaptationClient(optionsopt, gaxInstanceopt)

Construct an instance of AdaptationClient.

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 AdaptationClient({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

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.

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.

listCustomClassesAsync(request, optionsopt) → {Object}

Equivalent to listCustomClasses, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. The parent, which owns this collection of custom classes. Format:

projects/{project}/locations/{location}/customClasses

Speech-to-Text supports three locations: global, us (US North America), and eu (Europe). If you are calling the speech.googleapis.com endpoint, use the global location. To specify a region, use a regional endpoint with matching us or eu location value.

pageSize

number

The maximum number of custom classes to return. The service may return fewer than this value. If unspecified, at most 50 custom classes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken

string

A page token, received from a previous ListCustomClass call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCustomClass must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing CustomClass. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. 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. The parent, which owns this collection of custom classes. Format:
   *  `projects/{project}/locations/{location}/customClasses`
   *  Speech-to-Text supports three locations: `global`, `us` (US North America),
   *  and `eu` (Europe). If you are calling the `speech.googleapis.com`
   *  endpoint, use the `global` location. To specify a region, use a
   *  regional endpoint (https://cloud.google.com/speech-to-text/docs/endpoints)
   *  with matching `us` or `eu` location value.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of custom classes to return. The service may return
   *  fewer than this value. If unspecified, at most 50 custom classes will be
   *  returned. The maximum value is 1000; values above 1000 will be coerced to
   *  1000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListCustomClass` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListCustomClass` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'

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

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

  async function callListCustomClasses() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = speechClient.listCustomClassesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListCustomClasses();

listCustomClassesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. The parent, which owns this collection of custom classes. Format:

projects/{project}/locations/{location}/customClasses

pageSize

number

pageToken

string

A page token, received from a previous ListCustomClass call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCustomClass must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Type	Description
Stream	An object stream which emits an object representing CustomClass on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using `listCustomClassesAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

Stream

An object stream which emits an object representing CustomClass on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCustomClassesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listPhraseSetAsync(request, optionsopt) → {Object}

Equivalent to listPhraseSet, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. The parent, which owns this collection of phrase set. Format:

projects/{project}/locations/{location}

pageSize

number

The maximum number of phrase sets to return. The service may return fewer than this value. If unspecified, at most 50 phrase sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken

string

A page token, received from a previous ListPhraseSet call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListPhraseSet must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing PhraseSet. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. 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. The parent, which owns this collection of phrase set. Format:
   *  `projects/{project}/locations/{location}`
   *  Speech-to-Text supports three locations: `global`, `us` (US North America),
   *  and `eu` (Europe). If you are calling the `speech.googleapis.com`
   *  endpoint, use the `global` location. To specify a region, use a
   *  regional endpoint (https://cloud.google.com/speech-to-text/docs/endpoints)
   *  with matching `us` or `eu` location value.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of phrase sets to return. The service may return
   *  fewer than this value. If unspecified, at most 50 phrase sets will be
   *  returned. The maximum value is 1000; values above 1000 will be coerced to
   *  1000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListPhraseSet` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListPhraseSet` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'

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

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

  async function callListPhraseSet() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = speechClient.listPhraseSetAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListPhraseSet();

listPhraseSetStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. The parent, which owns this collection of phrase set. Format:

projects/{project}/locations/{location}

pageSize

number

pageToken

string

A page token, received from a previous ListPhraseSet call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListPhraseSet must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing PhraseSet on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using `listPhraseSetAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string

Returns:

Type	Description
string	Resource name string.

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.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:

Name	Type	Description
`locationName`	string	A fully-qualified path representing Location 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.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:

Name	Type	Description
`locationName`	string	A fully-qualified path representing Location 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.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:

Name	Type	Description
`projectName`	string	A fully-qualified path representing Project 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.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:

Name	Type	Description
`project`	string

Returns:

Type	Description
string	Resource name string.