Construct an instance of TranslationServiceClient.
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.
Translates a large volume of documents 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.
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. The BCP-47 language code of the input document if known, for
example, "en-US" or "sr-Latn". Supported language codes are listed in
Language Support (https://cloud.google.com/translate/docs/languages).
targetLanguageCodes
Array.<string>
Required. The BCP-47 language code to use for translation of the input
document. Specify up to 10 language codes here.
inputConfigs
Array.<number>
Required. Input configurations.
The total number of files matched should be <= 100.
The total content size to translate should be <= 100M Unicode codepoints.
The files must use UTF-8 encoding.
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.
models
Array.<number>
<optional>
Optional. The models to use for translation. Map's key is target language
code. Map's value is the model name. Value can be a built-in general model,
or an AutoML Translation model.
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.
glossaries
Array.<number>
<optional>
Optional. Glossaries to be applied. It's keyed by target language code.
The promise which resolves to an array.
The first element of the array is an object representing
a long running operation. Its promise() method returns a promise
you can await for.
Please see the
documentation
for more details and examples.
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.
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 the model name. Value can be a built-in general model,
or an AutoML Translation model.
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 <= 100.
The total content size should be <= 100M Unicode codepoints.
The files must use UTF-8 encoding.
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.
The promise which resolves to an array.
The first element of the array is an object representing
a long running operation. Its promise() method returns a promise
you can await for.
Please see the
documentation
for more details and examples.
Check the status of the long running operation returned by batchTranslateDocument().
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.
Check the status of the long running operation returned by batchTranslateText().
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.
Check the status of the long running operation returned by createGlossary().
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.
Check the status of the long running operation returned by deleteGlossary().
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.
The promise which resolves to an array.
The first element of the array is an object representing
a long running operation. Its promise() method returns a promise
you can await for.
Please see the
documentation
for more details and examples.
The promise which resolves to an array.
The first element of the array is an object representing
a long running operation. Its promise() method returns a promise
you can await for.
Please see the
documentation
for more details and examples.
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.
The promise which resolves to an array.
The first element of the array is an object representing DetectLanguageResponse.
Please see the
documentation
for more details and examples.
The promise which resolves to an array.
The first element of the array is an object representing Glossary.
Please see the
documentation
for more details and examples.
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>
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.
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.
The promise which resolves to an array.
The first element of the array is an object representing SupportedLanguages.
Please see the
documentation
for more details and examples.
Return a fully-qualified glossary resource name string.
Parameters:
Name
Type
Description
project
string
location
string
glossary
string
Returns:
Type
Description
string
Resource name 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.
Returns:
Type
Description
Promise
A promise that resolves to an authenticated service stub.
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_tokenis empty or missing.
filter
string
<optional>
Optional. Filter specifying constraints of a list operation.
Specify the constraint by the format of "key=value", where key must be
"src" or "tgt", and the value must be a valid language code.
For multiple restrictions, concatenate them by "AND" (uppercase only),
such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used
here, which means using 'en-US' and 'en' can lead to different results,
which depends on the language code you used when you create the glossary.
For the unidirectional glossaries, the "src" and "tgt" add restrictions
on the source and target language code separately.
For the equivalent term set glossaries, the "src" and/or "tgt" add
restrictions on the term set.
For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional
glossaries which exactly match the source language code as "en-US" and the
target language code "zh-CN", but all equivalent term set glossaries which
contain "en-US" and "zh-CN" in their language set will be picked.
If missing, no filtering is performed.
The promise which resolves to an array.
The first element of the array is Array of Glossary.
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 listGlossariesAsync()
method described below for async iteration which you can stop as needed.
Please see the
documentation
for more details and examples.
Equivalent to listGlossaries, 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
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_tokenis empty or missing.
filter
string
<optional>
Optional. Filter specifying constraints of a list operation.
Specify the constraint by the format of "key=value", where key must be
"src" or "tgt", and the value must be a valid language code.
For multiple restrictions, concatenate them by "AND" (uppercase only),
such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used
here, which means using 'en-US' and 'en' can lead to different results,
which depends on the language code you used when you create the glossary.
For the unidirectional glossaries, the "src" and "tgt" add restrictions
on the source and target language code separately.
For the equivalent term set glossaries, the "src" and/or "tgt" add
restrictions on the term set.
For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional
glossaries which exactly match the source language code as "en-US" and the
target language code "zh-CN", but all equivalent term set glossaries which
contain "en-US" and "zh-CN" in their language set will be picked.
If missing, no filtering is performed.
An iterable Object that allows async iteration.
When you iterate the returned iterable, each element will be an object representing
Glossary. 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.listGlossariesAsync(request);
for await (const response of iterable) {
// process response
}
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
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_tokenis empty or missing.
filter
string
<optional>
Optional. Filter specifying constraints of a list operation.
Specify the constraint by the format of "key=value", where key must be
"src" or "tgt", and the value must be a valid language code.
For multiple restrictions, concatenate them by "AND" (uppercase only),
such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used
here, which means using 'en-US' and 'en' can lead to different results,
which depends on the language code you used when you create the glossary.
For the unidirectional glossaries, the "src" and "tgt" add restrictions
on the source and target language code separately.
For the equivalent term set glossaries, the "src" and/or "tgt" add
restrictions on the term set.
For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional
glossaries which exactly match the source language code as "en-US" and the
target language code "zh-CN", but all equivalent term set glossaries which
contain "en-US" and "zh-CN" in their language set will be picked.
If missing, no filtering is performed.
An object stream which emits an object representing Glossary 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 listGlossariesAsync()
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.
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 the same
location-id), otherwise an INVALID_ARGUMENT (400) error is returned.
sourceLanguageCode
string
<optional>
Optional. The BCP-47 language code of the input document 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. Source language must be specified if the
request contains a glossary or a custom model.
targetLanguageCode
string
Required. The BCP-47 language code to use for translation of the input
document, set to one of the language codes listed in Language Support.
Optional. Output configurations.
Defines if the output file should be stored within Cloud Storage as well
as the desired output format. If not provided the translated file will
only be returned through a byte-stream and its output mime type will be
the same as the input file's mime type.
model
string
<optional>
Optional. The model type requested for this translation.
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 not provided, the default Google model (NMT) will be used for
translation.
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/advanced/labels for more
information.
The promise which resolves to an array.
The first element of the array is an object representing TranslateDocumentResponse.
Please see the
documentation
for more details and examples.
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. The max length
of this field is 1024.
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.
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-idglobal.
For example,
projects/{project-number-or-id}/locations/global/models/general/nmt.
If missing, the system decides which google base model to use.
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.
The promise which resolves to an array.
The first element of the array is an object representing TranslateTextResponse.
Please see the
documentation
for more details and examples.