Cloud Translation V3 Client - Class BatchTranslateDocumentRequest (1.16.0)

Reference documentation and code samples for the Cloud Translation V3 Client class BatchTranslateDocumentRequest.

The BatchTranslateDocument request.

Generated from protobuf message google.cloud.translation.v3.BatchTranslateDocumentRequest

Namespace

Google \ Cloud \ Translate \ V3

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` 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.
`↳ source_language_code`	`string` Required. The ISO-639 language code of the input document if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support.
`↳ target_language_codes`	`array` Required. The ISO-639 language code to use for translation of the input document. Specify up to 10 language codes here.
`↳ input_configs`	`array<Google\Cloud\Translate\V3\BatchDocumentInputConfig>` 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.
`↳ output_config`	`Google\Cloud\Translate\V3\BatchDocumentOutputConfig` 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\|Google\Protobuf\Internal\MapField` 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.
`↳ glossaries`	`array\|Google\Protobuf\Internal\MapField` Optional. Glossaries to be applied. It's keyed by target language code.
`↳ format_conversions`	`array\|Google\Protobuf\Internal\MapField` 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.
`↳ customized_attribution`	`string` Optional. This flag is to support user customized attribution. If not provided, the default is `Machine Translated by Google`. Customized attribution should follow rules in https://cloud.google.com/translate/attribution#attribution_and_logos
`↳ enable_shadow_removal_native_pdf`	`bool` Optional. If true, use the text removal server to remove the shadow text on background image for native pdf translation. Shadow removal feature can only be enabled when is_translate_native_pdf_only: false && pdf_native_only: false
`↳ enable_rotation_correction`	`bool` Optional. If true, enable auto rotation correction in DVS.

getParent

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.

Returns
Type	Description
`string`

setParent

Required. Location to make a regional call.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceLanguageCode

Required. The ISO-639 language code of the input document if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support.

Returns
Type	Description
`string`

setSourceLanguageCode

Required. The ISO-639 language code of the input document if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTargetLanguageCodes

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

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setTargetLanguageCodes

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

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getInputConfigs

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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setInputConfigs

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.

Parameter
Name	Description
`var`	`array<Google\Cloud\Translate\V3\BatchDocumentInputConfig>`

Returns
Type	Description
`$this`

getOutputConfig

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.

Returns
Type	Description
`Google\Cloud\Translate\V3\BatchDocumentOutputConfig\|null`

hasOutputConfig

clearOutputConfig

setOutputConfig

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.

Parameter
Name	Description
`var`	`Google\Cloud\Translate\V3\BatchDocumentOutputConfig`

Returns
Type	Description
`$this`

getModels

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.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setModels

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.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getGlossaries

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

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setGlossaries

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

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getFormatConversions

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.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setFormatConversions

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.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getCustomizedAttribution

Optional. This flag is to support user customized attribution.

If not provided, the default is Machine Translated by Google. Customized attribution should follow rules in https://cloud.google.com/translate/attribution#attribution_and_logos

Returns
Type	Description
`string`

setCustomizedAttribution

Optional. This flag is to support user customized attribution.

If not provided, the default is Machine Translated by Google. Customized attribution should follow rules in https://cloud.google.com/translate/attribution#attribution_and_logos

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getEnableShadowRemovalNativePdf

Optional. If true, use the text removal server to remove the shadow text on background image for native pdf translation.

Shadow removal feature can only be enabled when is_translate_native_pdf_only: false && pdf_native_only: false

Returns
Type	Description
`bool`

setEnableShadowRemovalNativePdf

Optional. If true, use the text removal server to remove the shadow text on background image for native pdf translation.

Shadow removal feature can only be enabled when is_translate_native_pdf_only: false && pdf_native_only: false

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getEnableRotationCorrection

Optional. If true, enable auto rotation correction in DVS.

Returns
Type	Description
`bool`

setEnableRotationCorrection

Optional. If true, enable auto rotation correction in DVS.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`parent`	`string` 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. Please see Google\Cloud\Translate\V3\TranslationServiceClient::locationName() for help formatting this field.
`sourceLanguageCode`	`string` Required. The ISO-639 language code of the input document if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support.
`targetLanguageCodes`	`string[]` Required. The ISO-639 language code to use for translation of the input document. Specify up to 10 language codes here.
`inputConfigs`	`array<Google\Cloud\Translate\V3\BatchDocumentInputConfig>` 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.
`outputConfig`	`Google\Cloud\Translate\V3\BatchDocumentOutputConfig` 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.

Returns
Type	Description
`Google\Cloud\Translate\V3\BatchTranslateDocumentRequest`