TranslationServiceClient

Constructor

new TranslationServiceClient(optionsopt)

Construct an instance of TranslationServiceClient.

Parameters:

Name Type Attributes Description

options

object

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

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.

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

batchTranslateText(request, optionsopt) → {Promise}

Translates a large volume of text in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location.

This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. Location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}/locations/{location-id}`. The `global` location is not supported for batch translation. Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.
`sourceLanguageCode`	string		Required. Source language code.
`targetLanguageCodes`	Array.<string>		Required. Specify up to 10 language codes here.
`models`	Array.<number>	<optional>	Optional. The models to use for translation. Map's key is target language code. Map's value is model name. Value can be a built-in general model, or an AutoML Translation model. The value format depends on model type: AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, `projects/{project-number-or-id}/locations/{location-id}/models/general/base` If the map is empty or a specific model is not requested for a language pair, then default google model (nmt) is used.
`inputConfigs`	Array.<number>		Required. Input configurations. The total number of files matched should be <= 1000. The total content size should be <= 100M Unicode codepoints. The files must use UTF-8 encoding.
`outputConfig`	google.cloud.translation.v3.OutputConfig		Required. Output configuration. If 2 input configs match to the same file (that is, same input path), we don't generate output for duplicate inputs.
`glossaries`	Array.<number>	<optional>	Optional. Glossaries to be applied for translation. It's keyed by target language code.
`labels`	Array.<number>	<optional>	Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. See https://cloud.google.com/translate/docs/labels for more information.

options

object

Call options. See CallOptions for more details.

(async) checkBatchTranslateTextProgress(name) → {Promise}

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

Parameters:

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

(async) checkCreateGlossaryProgress(name) → {Promise}

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

Parameters:

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

(async) checkDeleteGlossaryProgress(name) → {Promise}

Check the status of the long running operation returned by the deleteGlossary() 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.

createGlossary(request, optionsopt) → {Promise}

Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The project name.
`glossary`	google.cloud.translation.v3.Glossary	Required. The glossary to create.

options

object

Call options. See CallOptions for more details.

deleteGlossary(request, optionsopt) → {Promise}

Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist.

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 glossary to delete.

options

object

Call options. See CallOptions for more details.

detectLanguage(request, optionsopt) → {Promise}

Detects the language of text within a request.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}/locations/{location-id}` or `projects/{project-number-or-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned.
`model`	string	<optional>	Optional. The language detection model to be used. Format: `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}` Only one language detection model is currently supported: `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default`. If not specified, the default model is used.
`content`	string		The content of the input stored as a string.
`mimeType`	string	<optional>	Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".
`labels`	Array.<number>	<optional>	Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. See https://cloud.google.com/translate/docs/labels for more information.

options

object

Call options. See CallOptions for more details.

getGlossary(request, optionsopt) → {Promise}

Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist.

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 glossary to retrieve.

options

object

Call options. See CallOptions for more details.

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.

getSupportedLanguages(request, optionsopt) → {Promise}

Returns a list of supported languages for translation.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Attributes Description

parent

string

Required. Project or location to make a call. Must refer to a caller's project.

Format: projects/{project-number-or-id} or projects/{project-number-or-id}/locations/{location-id}.

For global calls, use projects/{project-number-or-id}/locations/global or projects/{project-number-or-id}.

Non-global location is required for AutoML models.

Only models within the same region (have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned.

displayLanguageCode

string

Optional. The language to use to return localized, human readable names of supported languages. If missing, then display names are not returned in a response.

model

string

Optional. Get supported languages of this model.

The format depends on model type:

AutoML Translation models: projects/{project-number-or-id}/locations/{location-id}/models/{model-id}
General (built-in) models: projects/{project-number-or-id}/locations/{location-id}/models/general/nmt, projects/{project-number-or-id}/locations/{location-id}/models/general/base

Returns languages supported by the specified model. If missing, we get supported languages of Google general base (PBMT) model.

options

object

Call options. See CallOptions for more details.

glossaryPath(project, location, glossary) → {string}

Return a fully-qualified glossary resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`glossary`	string

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.

listGlossaries(request, optionsopt) → {Promise}

Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. The name of the project from which to list all of the glossaries.
`pageSize`	number	<optional>	Optional. Requested page size. The server may return fewer glossaries than requested. If unspecified, the server picks an appropriate default.
`pageToken`	string	<optional>	Optional. A token identifying a page of results the server should return. Typically, this is the value of [ListGlossariesResponse.next_page_token] returned from the previous call to `ListGlossaries` method. The first page is returned if `page_token`is empty or missing.
`filter`	string	<optional>	Optional. Filter specifying constraints of a list operation. Filtering is not supported yet, and the parameter currently has no effect. If missing, no filtering is performed.

options

object

Call options. See CallOptions for more details.

listGlossariesAsync(request, optionsopt) → {Object}

Equivalent to listGlossaries, but 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
`parent`	string		Required. The name of the project from which to list all of the glossaries.
`pageSize`	number	<optional>	Optional. Requested page size. The server may return fewer glossaries than requested. If unspecified, the server picks an appropriate default.
`pageToken`	string	<optional>	Optional. A token identifying a page of results the server should return. Typically, this is the value of [ListGlossariesResponse.next_page_token] returned from the previous call to `ListGlossaries` method. The first page is returned if `page_token`is empty or missing.
`filter`	string	<optional>	Optional. Filter specifying constraints of a list operation. Filtering is not supported yet, and the parameter currently has no effect. If missing, no filtering is performed.

options

object

Call options. See CallOptions for more details.

listGlossariesStream(request, optionsopt) → {Stream}

Equivalent to listGlossaries, but returns a NodeJS Stream object.

This fetches the paged responses for listGlossaries continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. The name of the project from which to list all of the glossaries.
`pageSize`	number	<optional>	Optional. Requested page size. The server may return fewer glossaries than requested. If unspecified, the server picks an appropriate default.
`pageToken`	string	<optional>	Optional. A token identifying a page of results the server should return. Typically, this is the value of [ListGlossariesResponse.next_page_token] returned from the previous call to `ListGlossaries` method. The first page is returned if `page_token`is empty or missing.
`filter`	string	<optional>	Optional. Filter specifying constraints of a list operation. Filtering is not supported yet, and the parameter currently has no effect. If missing, no filtering is performed.

options

object

Call options. See CallOptions for more details.

See:

https://nodejs.org/api/stream.html

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string

matchGlossaryFromGlossaryName(glossaryName) → {string}

Parse the glossary from Glossary resource.

Parameters:

Name	Type	Description
`glossaryName`	string	A fully-qualified path representing Glossary resource.

matchLocationFromGlossaryName(glossaryName) → {string}

Parse the location from Glossary resource.

Parameters:

Name	Type	Description
`glossaryName`	string	A fully-qualified path representing Glossary resource.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:

Name	Type	Description
`locationName`	string	A fully-qualified path representing Location resource.

matchProjectFromGlossaryName(glossaryName) → {string}

Parse the project from Glossary resource.

Parameters:

Name	Type	Description
`glossaryName`	string	A fully-qualified path representing Glossary resource.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:

Name	Type	Description
`locationName`	string	A fully-qualified path representing Location resource.

translateText(request, optionsopt) → {Promise}

Translates input text and returns translated text.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`contents`	Array.<string>		Required. The content of the input in string format. We recommend the total content be less than 30k codepoints. Use BatchTranslateText for larger text.
`mimeType`	string	<optional>	Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".
`sourceLanguageCode`	string	<optional>	Optional. The BCP-47 language code of the input text if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response.
`targetLanguageCode`	string		Required. The BCP-47 language code to use for translation of the input text, set to one of the language codes listed in Language Support.
`parent`	string		Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
`model`	string	<optional>	Optional. The `model` type requested for this translation. The format depends on model type: AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, `projects/{project-number-or-id}/locations/{location-id}/models/general/base` For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If missing, the system decides which google base model to use.
`glossaryConfig`	google.cloud.translation.v3.TranslateTextGlossaryConfig	<optional>	Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.
`labels`	Array.<number>	<optional>	Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. See https://cloud.google.com/translate/docs/labels for more information.

options

object

Call options. See CallOptions for more details.