As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Translate v3beta1 API¶

class google.cloud.translate_v3beta1.types.BatchDocumentInputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Input configuration for BatchTranslateDocument request.

gcs_source¶

Google Cloud Storage location for the source input. This can be a single file (for example, gs://translation-test/input.docx) or a wildcard (for example, gs://translation-test/*).

File mime type is determined based on extension. Supported mime type includes:

pdf, application/pdf
docx, application/vnd.openxmlformats-officedocument.wordprocessingml.document
pptx, application/vnd.openxmlformats-officedocument.presentationml.presentation
xlsx, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

The max file size to support for .docx, .pptx and .xlsx is 100MB. The max file size to support for .pdf is 1GB and the max page limit is 1000 pages. The max file size to support for all input documents is 1GB.

This field is a member of oneof source.

Type: google.cloud.translate_v3beta1.types.GcsSource

class google.cloud.translate_v3beta1.types.BatchDocumentOutputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Output configuration for BatchTranslateDocument request.

gcs_destination¶

Google Cloud Storage destination for output content. For every single input document (for example, gs://a/b/c.[extension]), we generate at most 2 * n output files. (n is the # of target_language_codes in the BatchTranslateDocumentRequest).

While the input documents are being processed, we write/update an index file index.csv under gcs_destination.output_uri_prefix (for example, gs://translation_output/index.csv) The index file is generated/updated as new files are being translated. The format is:

input_document,target_language_code,translation_output,error_output, glossary_translation_output,glossary_error_output

input_document is one file we matched using gcs_source.input_uri. target_language_code is provided in the request. translation_output contains the translations. (details provided below) error_output contains the error message during processing of the file. Both translations_file and errors_file could be empty strings if we have no content to output. glossary_translation_output and glossary_error_output are the translated output/error when we apply glossaries. They could also be empty if we have no content to output.

Once a row is present in index.csv, the input/output matching never changes. Callers should also expect all the content in input_file are processed and ready to be consumed (that is, no partial output file is written).

Since index.csv will be keeping updated during the process, please make sure there is no custom retention policy applied on the output bucket that may avoid file updating. (https://cloud.google.com/storage/docs/bucket-lock?hl=en#retention-policy)

The naming format of translation output files follows (for target language code [trg]): translation_output: gs://translation_output/a_b_c_[trg]translation.[extension] ``glossary_translation_output``: gs://translation_test/a_b_c[trg]_glossary_translation.[extension] The output document will maintain the same file format as the input document.

The naming format of error output files follows (for target language code [trg]): error_output: gs://translation_test/a_b_c_[trg]errors.txt ``glossary_error_output``: gs://translation_test/a_b_c[trg]_glossary_translation.txt The error output is a txt file containing error details.

This field is a member of oneof destination.

Type: google.cloud.translate_v3beta1.types.GcsDestination

class google.cloud.translate_v3beta1.types.BatchTranslateDocumentMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

State metadata for the batch translation operation.

state¶

The state of the operation.

Type: google.cloud.translate_v3beta1.types.BatchTranslateDocumentMetadata.State

total_pages¶

Total number of pages to translate in all documents so far. Documents without clear page definition (such as XLSX) are not counted.

Type: int

translated_pages¶

Number of successfully translated pages in all documents so far. Documents without clear page definition (such as XLSX) are not counted.

Type: int

failed_pages¶

Number of pages that failed to process in all documents so far. Documents without clear page definition (such as XLSX) are not counted.

Type: int

total_billable_pages¶

Number of billable pages in documents with clear page definition (such as PDF, DOCX, PPTX) so far.

Type: int

total_characters¶

Total number of characters (Unicode codepoints) in all documents so far.

Type: int

translated_characters¶

Number of successfully translated characters (Unicode codepoints) in all documents so far.

Type: int

failed_characters¶

Number of characters that have failed to process (Unicode codepoints) in all documents so far.

Type: int

total_billable_characters¶

Number of billable characters (Unicode codepoints) in documents without clear page definition (such as XLSX) so far.

Type: int

submit_time¶

Time when the operation was submitted.

Type: google.protobuf.timestamp_pb2.Timestamp

class State(value)[source]¶

Bases: proto.enums.Enum

State of the job.

CANCELLED = 5¶

CANCELLING = 4¶

FAILED = 3¶

RUNNING = 1¶

STATE_UNSPECIFIED = 0¶

SUCCEEDED = 2¶

class google.cloud.translate_v3beta1.types.BatchTranslateDocumentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The BatchTranslateDocument request.

parent¶

Required. Location to make a regional call.

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.

Type: str

source_language_code¶

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).

Type: str

target_language_codes¶

Required. The BCP-47 language code to use for translation of the input document. Specify up to 10 language codes here.

Type: Sequence[str]

input_configs¶

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.

Type: Sequence[google.cloud.translate_v3beta1.types.BatchDocumentInputConfig]

output_config¶

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.

Type: google.cloud.translate_v3beta1.types.BatchDocumentOutputConfig

models¶

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.

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,

If the map is empty or a specific model is not requested for a language pair, then default google model (nmt) is used.

Type: Sequence[google.cloud.translate_v3beta1.types.BatchTranslateDocumentRequest.ModelsEntry]

glossaries¶

Optional. Glossaries to be applied. It’s keyed by target language code.

Type: Sequence[google.cloud.translate_v3beta1.types.BatchTranslateDocumentRequest.GlossariesEntry]

format_conversions¶

Optional. File format conversion map to be applied to all input files. Map’s key is the original mime_type. Map’s value is the target mime_type of translated documents.

Supported file format conversion includes:

application/pdf to application/vnd.openxmlformats-officedocument.wordprocessingml.document

If nothing specified, output files will be in the same format as the original file.

Type: Sequence[google.cloud.translate_v3beta1.types.BatchTranslateDocumentRequest.FormatConversionsEntry]

class FormatConversionsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class GlossariesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class ModelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.translate_v3beta1.types.BatchTranslateDocumentResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Stored in the [google.longrunning.Operation.response][google.longrunning.Operation.response] field returned by BatchTranslateDocument if at least one document is translated successfully.

total_pages¶

Total number of pages to translate in all documents. Documents without clear page definition (such as XLSX) are not counted.

Type: int

translated_pages¶

Number of successfully translated pages in all documents. Documents without clear page definition (such as XLSX) are not counted.

Type: int

failed_pages¶

Number of pages that failed to process in all documents. Documents without clear page definition (such as XLSX) are not counted.

Type: int

total_billable_pages¶

Number of billable pages in documents with clear page definition (such as PDF, DOCX, PPTX)

Type: int

total_characters¶

Total number of characters (Unicode codepoints) in all documents.

Type: int

translated_characters¶

Number of successfully translated characters (Unicode codepoints) in all documents.

Type: int

failed_characters¶

Number of characters that have failed to process (Unicode codepoints) in all documents.

Type: int

total_billable_characters¶

Number of billable characters (Unicode codepoints) in documents without clear page definition, such as XLSX.

Type: int

submit_time¶

Time when the operation was submitted.

Type: google.protobuf.timestamp_pb2.Timestamp

end_time¶

The time when the operation is finished and [google.longrunning.Operation.done][google.longrunning.Operation.done] is set to true.

Type: google.protobuf.timestamp_pb2.Timestamp

class google.cloud.translate_v3beta1.types.BatchTranslateMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

State metadata for the batch translation operation.

state¶

The state of the operation.

Type: google.cloud.translate_v3beta1.types.BatchTranslateMetadata.State

translated_characters¶

Number of successfully translated characters so far (Unicode codepoints).

Type: int

failed_characters¶

Number of characters that have failed to process so far (Unicode codepoints).

Type: int

total_characters¶

Total number of characters (Unicode codepoints). This is the total number of codepoints from input files times the number of target languages and appears here shortly after the call is submitted.

Type: int

submit_time¶

Time when the operation was submitted.

Type: google.protobuf.timestamp_pb2.Timestamp

class State(value)[source]¶

Bases: proto.enums.Enum

State of the job.

CANCELLED = 5¶

CANCELLING = 4¶

FAILED = 3¶

RUNNING = 1¶

STATE_UNSPECIFIED = 0¶

SUCCEEDED = 2¶

class google.cloud.translate_v3beta1.types.BatchTranslateResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Stored in the [google.longrunning.Operation.response][google.longrunning.Operation.response] field returned by BatchTranslateText if at least one sentence is translated successfully.

total_characters¶

Total number of characters (Unicode codepoints).

Type: int

translated_characters¶

Number of successfully translated characters (Unicode codepoints).

Type: int

failed_characters¶

Number of characters that have failed to process (Unicode codepoints).

Type: int

submit_time¶

Time when the operation was submitted.

Type: google.protobuf.timestamp_pb2.Timestamp

end_time¶

The time when the operation is finished and [google.longrunning.Operation.done][google.longrunning.Operation.done] is set to true.

Type: google.protobuf.timestamp_pb2.Timestamp

class google.cloud.translate_v3beta1.types.BatchTranslateTextRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The batch translation request.

parent¶

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.

Type: str

source_language_code¶

Required. Source language code.

Type: str

target_language_codes¶

Required. Specify up to 10 language codes here.

Type: Sequence[str]

models¶

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,

If the map is empty or a specific model is not requested for a language pair, then default google model (nmt) is used.

Type: Sequence[google.cloud.translate_v3beta1.types.BatchTranslateTextRequest.ModelsEntry]

input_configs¶

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.

Type: Sequence[google.cloud.translate_v3beta1.types.InputConfig]

output_config¶

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.

Type: google.cloud.translate_v3beta1.types.OutputConfig

glossaries¶

Optional. Glossaries to be applied for translation. It’s keyed by target language code.

Type: Sequence[google.cloud.translate_v3beta1.types.BatchTranslateTextRequest.GlossariesEntry]

labels¶

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.

Type: Sequence[google.cloud.translate_v3beta1.types.BatchTranslateTextRequest.LabelsEntry]

class GlossariesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class ModelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.translate_v3beta1.types.CreateGlossaryMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Stored in the [google.longrunning.Operation.metadata][google.longrunning.Operation.metadata] field returned by CreateGlossary.

name¶

The name of the glossary that is being created.

Type: str

state¶

The current state of the glossary creation operation.

Type: google.cloud.translate_v3beta1.types.CreateGlossaryMetadata.State

submit_time¶

The time when the operation was submitted to the server.

Type: google.protobuf.timestamp_pb2.Timestamp

class State(value)[source]¶

Bases: proto.enums.Enum

Enumerates the possible states that the creation request can be in.

CANCELLED = 5¶

CANCELLING = 4¶

FAILED = 3¶

RUNNING = 1¶

STATE_UNSPECIFIED = 0¶

SUCCEEDED = 2¶

class google.cloud.translate_v3beta1.types.CreateGlossaryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for CreateGlossary.

parent¶

Required. The project name.

Type: str

glossary¶

Required. The glossary to create.

Type: google.cloud.translate_v3beta1.types.Glossary

class google.cloud.translate_v3beta1.types.DeleteGlossaryMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Stored in the [google.longrunning.Operation.metadata][google.longrunning.Operation.metadata] field returned by DeleteGlossary.

name¶

The name of the glossary that is being deleted.

Type: str

state¶

The current state of the glossary deletion operation.

Type: google.cloud.translate_v3beta1.types.DeleteGlossaryMetadata.State

submit_time¶

The time when the operation was submitted to the server.

Type: google.protobuf.timestamp_pb2.Timestamp

class State(value)[source]¶

Bases: proto.enums.Enum

Enumerates the possible states that the creation request can be in.

CANCELLED = 5¶

CANCELLING = 4¶

FAILED = 3¶

RUNNING = 1¶

STATE_UNSPECIFIED = 0¶

SUCCEEDED = 2¶

class google.cloud.translate_v3beta1.types.DeleteGlossaryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for DeleteGlossary.

name¶

Required. The name of the glossary to delete.

Type: str

class google.cloud.translate_v3beta1.types.DeleteGlossaryResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Stored in the [google.longrunning.Operation.response][google.longrunning.Operation.response] field returned by DeleteGlossary.

name¶

The name of the deleted glossary.

Type: str

submit_time¶

The time when the operation was submitted to the server.

Type: google.protobuf.timestamp_pb2.Timestamp

end_time¶

The time when the glossary deletion is finished and [google.longrunning.Operation.done][google.longrunning.Operation.done] is set to true.

Type: google.protobuf.timestamp_pb2.Timestamp

class google.cloud.translate_v3beta1.types.DetectLanguageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message for language detection.

parent¶

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.

Type: str

model¶

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.

Type: str

content¶

The content of the input stored as a string.

This field is a member of oneof source.

Type: str

mime_type¶

Optional. The format of the source text, for example, “text/html”, “text/plain”. If left blank, the MIME type defaults to “text/html”.

Type: str

labels¶

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.

Type: Sequence[google.cloud.translate_v3beta1.types.DetectLanguageRequest.LabelsEntry]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.translate_v3beta1.types.DetectLanguageResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response message for language detection.

languages¶

A list of detected languages sorted by detection confidence in descending order. The most probable language first.

Type: Sequence[google.cloud.translate_v3beta1.types.DetectedLanguage]

class google.cloud.translate_v3beta1.types.DetectedLanguage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response message for language detection.

language_code¶

The BCP-47 language code of source content in the request, detected automatically.

Type: str

confidence¶

The confidence of the detection result for this language.

Type: float

class google.cloud.translate_v3beta1.types.DocumentInputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A document translation request input config.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

content¶

Document’s content represented as a stream of bytes.

This field is a member of oneof source.

Type: bytes

gcs_source¶

Google Cloud Storage location. This must be a single file. For example: gs://example_bucket/example_file.pdf This field is a member of oneof source.

Type: google.cloud.translate_v3beta1.types.GcsSource

mime_type¶

Specifies the input document’s mime_type.

If not specified it will be determined using the file extension for gcs_source provided files. For a file provided through bytes content the mime_type must be provided. Currently supported mime types are:

application/pdf
application/vnd.openxmlformats-officedocument.wordprocessingml.document
application/vnd.openxmlformats-officedocument.presentationml.presentation
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Type: str

class google.cloud.translate_v3beta1.types.DocumentOutputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A document translation request output config.

gcs_destination¶

Optional. Google Cloud Storage destination for the translation output, e.g., gs://my_bucket/my_directory/.

The destination directory provided does not have to be empty, but the bucket must exist. If a file with the same name as the output file already exists in the destination an error will be returned.

For a DocumentInputConfig.contents provided document, the output file will have the name “output_[trg]_translations.[ext]”, where

[trg] corresponds to the translated file’s language code,
[ext] corresponds to the translated file’s extension according to its mime type.

For a DocumentInputConfig.gcs_uri provided document, the output file will have a name according to its URI. For example: an input file with URI: “gs://a/b/c.[extension]” stored in a gcs_destination bucket with name “my_bucket” will have an output URI: “gs://my_bucket/a_b_c_[trg]_translations.[ext]”, where

[trg] corresponds to the translated file’s language code,
[ext] corresponds to the translated file’s extension according to its mime type.

If the document was directly provided through the request, then the output document will have the format: “gs://my_bucket/translated_document_[trg]_translations.[ext], where

[trg] corresponds to the translated file’s language code,
[ext] corresponds to the translated file’s extension according to its mime type.

If a glossary was provided, then the output URI for the glossary translation will be equal to the default output URI but have glossary_translations instead of translations. For the previous example, its glossary URI would be: “gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext]”.

Thus the max number of output files will be 2 (Translated document, Glossary translated document).

Callers should expect no partial outputs. If there is any error during document translation, no output will be stored in the Cloud Storage bucket.

This field is a member of oneof destination.

Type: google.cloud.translate_v3beta1.types.GcsDestination

mime_type¶

Optional. Specifies the translated document’s mime_type. If not specified, the translated file’s mime type will be the same as the input file’s mime type. Currently only support the output mime type to be the same as input mime type.

application/pdf
application/vnd.openxmlformats-officedocument.wordprocessingml.document
application/vnd.openxmlformats-officedocument.presentationml.presentation
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Type: str

class google.cloud.translate_v3beta1.types.DocumentTranslation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A translated document message.

byte_stream_outputs¶

The array of translated documents. It is expected to be size 1 for now. We may produce multiple translated documents in the future for other type of file formats.

Type: Sequence[bytes]

mime_type¶

The translated document’s mime type.

Type: str

detected_language_code¶

The detected language for the input document. If the user did not provide the source language for the input document, this field will have the language code automatically detected. If the source language was passed, auto-detection of the language does not occur and this field is empty.

Type: str

class google.cloud.translate_v3beta1.types.GcsDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The Google Cloud Storage location for the output content.

output_uri_prefix¶

Required. There must be no files under ‘output_uri_prefix’. ‘output_uri_prefix’ must end with “/” and start with “gs://”, otherwise an INVALID_ARGUMENT (400) error is returned.

Type: str

class google.cloud.translate_v3beta1.types.GcsSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The Google Cloud Storage location for the input content.

input_uri¶

Required. Source data URI. For example, gs://my_bucket/my_object.

Type: str

class google.cloud.translate_v3beta1.types.GetGlossaryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for GetGlossary.

name¶

Required. The name of the glossary to retrieve.

Type: str

class google.cloud.translate_v3beta1.types.GetSupportedLanguagesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message for discovering supported languages.

parent¶

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.

Type: str

display_language_code¶

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.

Type: str

model¶

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,

Returns languages supported by the specified model. If missing, we get supported languages of Google general NMT model.

Type: str

class google.cloud.translate_v3beta1.types.Glossary(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Represents a glossary built from user provided data.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

name¶

Required. The resource name of the glossary. Glossary names have the form projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}.

Type: str

language_pair¶

Used with unidirectional glossaries.

This field is a member of oneof languages.

Type: google.cloud.translate_v3beta1.types.Glossary.LanguageCodePair

language_codes_set¶

Used with equivalent term set glossaries.

This field is a member of oneof languages.

Type: google.cloud.translate_v3beta1.types.Glossary.LanguageCodesSet

input_config¶

Required. Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints.

Type: google.cloud.translate_v3beta1.types.GlossaryInputConfig

entry_count¶

Output only. The number of entries defined in the glossary.

Type: int

submit_time¶

Output only. When CreateGlossary was called.

Type: google.protobuf.timestamp_pb2.Timestamp

end_time¶

Output only. When the glossary creation was finished.

Type: google.protobuf.timestamp_pb2.Timestamp

class LanguageCodePair(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Used with unidirectional glossaries.

source_language_code¶

Required. The BCP-47 language code of the input text, for example, “en-US”. Expected to be an exact match for GlossaryTerm.language_code.

Type: str

target_language_code¶

Required. The BCP-47 language code for translation output, for example, “zh-CN”. Expected to be an exact match for GlossaryTerm.language_code.

Type: str

class LanguageCodesSet(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Used with equivalent term set glossaries.

language_codes¶

The BCP-47 language code(s) for terms defined in the glossary. All entries are unique. The list contains at least two entries. Expected to be an exact match for GlossaryTerm.language_code.

Type: Sequence[str]

class google.cloud.translate_v3beta1.types.GlossaryInputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Input configuration for glossaries.

gcs_source¶

Required. Google Cloud Storage location of glossary data. File format is determined based on the filename extension. API returns [google.rpc.Code.INVALID_ARGUMENT] for unsupported URI-s and file formats. Wildcards are not allowed. This must be a single file in one of the following formats:

For unidirectional glossaries:

TSV/CSV (.tsv/.csv): 2 column file, tab- or comma-separated. The first column is source text. The second column is target text. The file must not contain headers. That is, the first row is data, not column names.
TMX (.tmx): TMX file with parallel data defining source/target term pairs.

For equivalent term sets glossaries:

CSV (.csv): Multi-column CSV file defining equivalent glossary terms in multiple languages. The format is defined for Google Translation Toolkit and documented in Use a glossary.

This field is a member of oneof source.

Type: google.cloud.translate_v3beta1.types.GcsSource

class google.cloud.translate_v3beta1.types.InputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Input configuration for BatchTranslateText request.

mime_type¶

Optional. Can be “text/plain” or “text/html”. For .tsv, “text/html” is used if mime_type is missing. For .html, this field must be “text/html” or empty. For .txt, this field must be “text/plain” or empty.

Type: str

gcs_source¶

Required. Google Cloud Storage location for the source input. This can be a single file (for example, gs://translation-test/input.tsv) or a wildcard (for example, gs://translation-test/*). If a file extension is .tsv, it can contain either one or two columns. The first column (optional) is the id of the text request. If the first column is missing, we use the row number (0-based) from the input file as the ID in the output file. The second column is the actual text to be translated. We recommend each row be <= 10K Unicode codepoints, otherwise an error might be returned. Note that the input tsv must be RFC 4180 compliant.

You could use https://github.com/Clever/csvlint to check potential formatting errors in your tsv file. csvlint –delimiter=’t’ your_input_file.tsv

The other supported file extensions are .txt or .html, which is treated as a single large chunk of text.

This field is a member of oneof source.

Type: google.cloud.translate_v3beta1.types.GcsSource

class google.cloud.translate_v3beta1.types.ListGlossariesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request message for ListGlossaries.

parent¶

Required. The name of the project from which to list all of the glossaries.

Type: str

page_size¶

Optional. Requested page size. The server may return fewer glossaries than requested. If unspecified, the server picks an appropriate default.

Type: int

page_token¶

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.

Type: str

filter¶

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.

Type: str

class google.cloud.translate_v3beta1.types.ListGlossariesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response message for ListGlossaries.

glossaries¶

The list of glossaries for a project.

Type: Sequence[google.cloud.translate_v3beta1.types.Glossary]

next_page_token¶

A token to retrieve a page of results. Pass this value in the [ListGlossariesRequest.page_token] field in the subsequent call to ListGlossaries method to retrieve the next page of results.

Type: str

property raw_page¶

class google.cloud.translate_v3beta1.types.OutputConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Output configuration for BatchTranslateText request.

gcs_destination¶

Google Cloud Storage destination for output content. For every single input file (for example, gs://a/b/c.[extension]), we generate at most 2 * n output files. (n is the # of target_language_codes in the BatchTranslateTextRequest).

Output files (tsv) generated are compliant with RFC 4180 except that record delimiters are ‘n’ instead of ‘rn’. We don’t provide any way to change record delimiters.

While the input files are being processed, we write/update an index file ‘index.csv’ under ‘output_uri_prefix’ (for example, gs://translation-test/index.csv) The index file is generated/updated as new files are being translated. The format is:

input_file,target_language_code,translations_file,errors_file, glossary_translations_file,glossary_errors_file

input_file is one file we matched using gcs_source.input_uri. target_language_code is provided in the request. translations_file contains the translations. (details provided below) errors_file contains the errors during processing of the file. (details below). Both translations_file and errors_file could be empty strings if we have no content to output. glossary_translations_file and glossary_errors_file are always empty strings if the input_file is tsv. They could also be empty if we have no content to output.

Once a row is present in index.csv, the input/output matching never changes. Callers should also expect all the content in input_file are processed and ready to be consumed (that is, no partial output file is written).

Since index.csv will be keeping updated during the process, please make sure there is no custom retention policy applied on the output bucket that may avoid file updating. (https://cloud.google.com/storage/docs/bucket-lock?hl=en#retention-policy)

The format of translations_file (for target language code ‘trg’) is: gs://translation_test/a_b_c_’trg’_translations.[extension]

If the input file extension is tsv, the output has the following columns: Column 1: ID of the request provided in the input, if it’s not provided in the input, then the input row number is used (0-based). Column 2: source sentence. Column 3: translation without applying a glossary. Empty string if there is an error. Column 4 (only present if a glossary is provided in the request): translation after applying the glossary. Empty string if there is an error applying the glossary. Could be same string as column 3 if there is no glossary applied.

If input file extension is a txt or html, the translation is directly written to the output file. If glossary is requested, a separate glossary_translations_file has format of gs://translation_test/a_b_c_’trg’_glossary_translations.[extension]

The format of errors file (for target language code ‘trg’) is: gs://translation_test/a_b_c_’trg’_errors.[extension]

If the input file extension is tsv, errors_file contains the following: Column 1: ID of the request provided in the input, if it’s not provided in the input, then the input row number is used (0-based). Column 2: source sentence. Column 3: Error detail for the translation. Could be empty. Column 4 (only present if a glossary is provided in the request): Error when applying the glossary.

If the input file extension is txt or html, glossary_error_file will be generated that contains error details. glossary_error_file has format of gs://translation_test/a_b_c_’trg’_glossary_errors.[extension] This field is a member of oneof destination.

Type: google.cloud.translate_v3beta1.types.GcsDestination

class google.cloud.translate_v3beta1.types.SupportedLanguage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A single supported language response corresponds to information related to one supported language.

language_code¶

Supported language code, generally consisting of its ISO 639-1 identifier, for example, ‘en’, ‘ja’. In certain cases, BCP-47 codes including language and region identifiers are returned (for example, ‘zh-TW’ and ‘zh-CN’)

Type: str

display_name¶

Human readable name of the language localized in the display language specified in the request.

Type: str

support_source¶

Can be used as source language.

Type: bool

support_target¶

Can be used as target language.

Type: bool

class google.cloud.translate_v3beta1.types.SupportedLanguages(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response message for discovering supported languages.

languages¶

A list of supported language responses. This list contains an entry for each language the Translation API supports.

Type: Sequence[google.cloud.translate_v3beta1.types.SupportedLanguage]

class google.cloud.translate_v3beta1.types.TranslateDocumentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A document translation request.

parent¶

Required. Location to make a regional call.

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

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

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.

Type: str

source_language_code¶

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.

Type: str

target_language_code¶

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.

Type: str

document_input_config¶

Required. Input configurations.

Type: google.cloud.translate_v3beta1.types.DocumentInputConfig

document_output_config¶

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.

Type: google.cloud.translate_v3beta1.types.DocumentOutputConfig

model¶

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,

If not provided, the default Google model (NMT) will be used for translation.

Type: str

glossary_config¶

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.

Type: google.cloud.translate_v3beta1.types.TranslateTextGlossaryConfig

labels¶

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.

Type: Sequence[google.cloud.translate_v3beta1.types.TranslateDocumentRequest.LabelsEntry]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.translate_v3beta1.types.TranslateDocumentResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A translated document response message.

document_translation¶

Translated document.

Type: google.cloud.translate_v3beta1.types.DocumentTranslation

glossary_document_translation¶

The document’s translation output if a glossary is provided in the request. This can be the same as [TranslateDocumentResponse.document_translation] if no glossary terms apply.

Type: google.cloud.translate_v3beta1.types.DocumentTranslation

model¶

Only present when ‘model’ is present in the request. ‘model’ is normalized to have a project number.

For example: If the ‘model’ field in TranslateDocumentRequest is: projects/{project-id}/locations/{location-id}/models/general/nmt then model here would be normalized to projects/{project-number}/locations/{location-id}/models/general/nmt.

Type: str

glossary_config¶

The glossary_config used for this translation.

Type: google.cloud.translate_v3beta1.types.TranslateTextGlossaryConfig

class google.cloud.translate_v3beta1.types.TranslateTextGlossaryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Configures which glossary should be used for a specific target language, and defines options for applying that glossary.

glossary¶

Required. Specifies the glossary used for this translation. Use this format: projects//locations//glossaries/*

Type: str

ignore_case¶

Optional. Indicates match is case- nsensitive. Default value is false if missing.

Type: bool

class google.cloud.translate_v3beta1.types.TranslateTextRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message for synchronous translation.

contents¶

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.

Type: Sequence[str]

mime_type¶

Optional. The format of the source text, for example, “text/html”, “text/plain”. If left blank, the MIME type defaults to “text/html”.

Type: str

source_language_code¶

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.

Type: str

target_language_code¶

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.

Type: str

parent¶

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.

Type: str

model¶

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,

For global (non-regionalized) requests, use location-id global. For example, projects/{project-number-or-id}/locations/global/models/general/nmt.

If not provided, the default Google model (NMT) will be used

Type: str

glossary_config¶

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.

Type: google.cloud.translate_v3beta1.types.TranslateTextGlossaryConfig

labels¶

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.

Type: Sequence[google.cloud.translate_v3beta1.types.TranslateTextRequest.LabelsEntry]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶: Bases: proto.message.Message

class google.cloud.translate_v3beta1.types.TranslateTextResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

translations¶

Text translation responses with no glossary applied. This field has the same length as [contents][google.cloud.translation.v3beta1.TranslateTextRequest.contents].

Type: Sequence[google.cloud.translate_v3beta1.types.Translation]

glossary_translations¶

Text translation responses if a glossary is provided in the request. This can be the same as [translations][google.cloud.translation.v3beta1.TranslateTextResponse.translations] if no terms apply. This field has the same length as [contents][google.cloud.translation.v3beta1.TranslateTextRequest.contents].

Type: Sequence[google.cloud.translate_v3beta1.types.Translation]

class google.cloud.translate_v3beta1.types.Translation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A single translation response.

translated_text¶

Text translated into the target language. If an error occurs during translation, this field might be excluded from the response.

Type: str

model¶

Only present when model is present in the request. model here is normalized to have project number.

For example: If the model requested in TranslationTextRequest is projects/{project-id}/locations/{location-id}/models/general/nmt then model here would be normalized to projects/{project-number}/locations/{location-id}/models/general/nmt.

Type: str

detected_language_code¶

The BCP-47 language code of source text in the initial request, detected automatically, if no source language was passed within the initial request. If the source language was passed, auto-detection of the language does not occur and this field is empty.

Type: str

glossary_config¶

The glossary_config used for this translation.

Type: google.cloud.translate_v3beta1.types.TranslateTextGlossaryConfig

Types for Google Cloud Translate v3beta1 API¶

google-cloud-translate

Navigation

Related Topics