AdaptationClient

AdaptationClient

Service that implements Google Cloud Speech Adaptation API.

Constructor

new AdaptationClient(optionsopt)

Construct an instance of AdaptationClient.

Parameters:
Name Type Attributes Description
options object <optional>

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 <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.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

Members

apiEndpoint

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

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.

createCustomClass(request, optionsopt) → {Promise}

Create a custom class.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent resource where this custom class will be created. Format: {api_version}/projects/{project}/locations/{location}/customClasses
customClassId string

Required. The ID to use for the custom class, which will become the final component of the custom class' resource name.

This value should be 4-63 characters, and valid characters are /a-z-/.
customClass google.cloud.speech.v1p1beta1.CustomClass

Required. The custom class to create.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing CustomClass. Please see the documentation for more details and examples.
Example
const [response] = await client.createCustomClass(request);

createPhraseSet(request, optionsopt) → {Promise}

Create a set of phrase hints. Each item in the set can be a single word or a multi-word phrase. The items in the PhraseSet are favored by the recognition model when you send a call that includes the PhraseSet.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent resource where this phrase set will be created. Format: {api_version}/projects/{project}/locations/{location}/phraseSets
phraseSetId string

Required. The ID to use for the phrase set, which will become the final component of the phrase set's resource name.

This value should be 4-63 characters, and valid characters are /a-z-/.
phraseSet google.cloud.speech.v1p1beta1.PhraseSet

Required. The phrase set to create.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing PhraseSet. Please see the documentation for more details and examples.
Example
const [response] = await client.createPhraseSet(request);

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.

deleteCustomClass(request, optionsopt) → {Promise}

Delete a custom class.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the custom class to delete. Format: {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class}
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.
Example
const [response] = await client.deleteCustomClass(request);

deletePhraseSet(request, optionsopt) → {Promise}

Delete a phrase set.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the phrase set to delete. Format: {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set}
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.
Example
const [response] = await client.deletePhraseSet(request);

getCustomClass(request, optionsopt) → {Promise}

Get a custom class.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the custom class to retrieve. Format: {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class}
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing CustomClass. Please see the documentation for more details and examples.
Example
const [response] = await client.getCustomClass(request);

getPhraseSet(request, optionsopt) → {Promise}

Get a phrase set.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the phrase set to retrieve. Format: {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set}
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing PhraseSet. Please see the documentation for more details and examples.
Example
const [response] = await client.getPhraseSet(request);

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.

listCustomClasses(request, optionsopt) → {Promise}

List custom classes.

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: {api_version}/projects/{project}/locations/{location}/customClasses
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 <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of CustomClass. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. 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.

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: {api_version}/projects/{project}/locations/{location}/customClasses
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 <optional>

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
const iterable = client.listCustomClassesAsync(request);
for await (const response of iterable) {
  // process response
}

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: {api_version}/projects/{project}/locations/{location}/customClasses
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 <optional>

Call options. See CallOptions for more details.
Returns:
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.

listPhraseSet(request, optionsopt) → {Promise}

List phrase sets.

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 <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of PhraseSet. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. 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.

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 <optional>

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
const iterable = client.listPhraseSetAsync(request);
for await (const response of iterable) {
  // process response
}

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

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 <optional>

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.

updateCustomClass(request, optionsopt) → {Promise}

Update a custom class.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
customClass google.cloud.speech.v1p1beta1.CustomClass

Required. The custom class to update.

The custom class's name field is used to identify the custom class to be updated. Format: {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class}
updateMask google.protobuf.FieldMask

The list of fields to be updated.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing CustomClass. Please see the documentation for more details and examples.
Example
const [response] = await client.updateCustomClass(request);

updatePhraseSet(request, optionsopt) → {Promise}

Update a phrase set.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
phraseSet google.cloud.speech.v1p1beta1.PhraseSet

Required. The phrase set to update.

The phrase set's name field is used to identify the set to be updated. Format: {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set}
updateMask google.protobuf.FieldMask

The list of fields to be updated.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing PhraseSet. Please see the documentation for more details and examples.
Example
const [response] = await client.updatePhraseSet(request);