Cloud Translation V3 Client - Class TranslateDocumentRequest (1.18.0)

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

A document translation request.

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

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}. 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.
↳ source_language_code string

Optional. 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. 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.
↳ target_language_code string

Required. The ISO-639 language code to use for translation of the input document, set to one of the language codes listed in Language Support.
↳ document_input_config Google\Cloud\Translate\V3\DocumentInputConfig

Required. Input configurations.
↳ document_output_config Google\Cloud\Translate\V3\DocumentOutputConfig

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. 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.
↳ glossary_config Google\Cloud\Translate\V3\TranslateTextGlossaryConfig

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|Google\Protobuf\Internal\MapField

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.
↳ 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
↳ is_translate_native_pdf_only bool

Optional. is_translate_native_pdf_only field for external customers. If true, the page limit of online native pdf translation is 300 and only native pdf pages will be translated.
↳ 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}. 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.

Returns
Type Description
string

setParent

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

Parameter
Name Description
var string
Returns
Type Description
$this

getSourceLanguageCode

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

Returns
Type Description
string

setSourceLanguageCode

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

Parameter
Name Description
var string
Returns
Type Description
$this

getTargetLanguageCode

Required. The ISO-639 language code to use for translation of the input document, set to one of the language codes listed in Language Support.

Returns
Type Description
string

setTargetLanguageCode

Required. The ISO-639 language code to use for translation of the input document, set to one of the language codes listed in Language Support.

Parameter
Name Description
var string
Returns
Type Description
$this

getDocumentInputConfig

Required. Input configurations.

Returns
Type Description
Google\Cloud\Translate\V3\DocumentInputConfig|null

hasDocumentInputConfig

clearDocumentInputConfig

setDocumentInputConfig

Required. Input configurations.

Parameter
Name Description
var Google\Cloud\Translate\V3\DocumentInputConfig
Returns
Type Description
$this

getDocumentOutputConfig

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.

Returns
Type Description
Google\Cloud\Translate\V3\DocumentOutputConfig|null

hasDocumentOutputConfig

clearDocumentOutputConfig

setDocumentOutputConfig

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.

Parameter
Name Description
var Google\Cloud\Translate\V3\DocumentOutputConfig
Returns
Type Description
$this

getModel

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.
Returns
Type Description
string

setModel

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.
Parameter
Name Description
var string
Returns
Type Description
$this

getGlossaryConfig

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.

Returns
Type Description
Google\Cloud\Translate\V3\TranslateTextGlossaryConfig|null

hasGlossaryConfig

clearGlossaryConfig

setGlossaryConfig

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.

Parameter
Name Description
var Google\Cloud\Translate\V3\TranslateTextGlossaryConfig
Returns
Type Description
$this

getLabels

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.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

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.

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

getIsTranslateNativePdfOnly

Optional. is_translate_native_pdf_only field for external customers.

If true, the page limit of online native pdf translation is 300 and only native pdf pages will be translated.

Returns
Type Description
bool

setIsTranslateNativePdfOnly

Optional. is_translate_native_pdf_only field for external customers.

If true, the page limit of online native pdf translation is 300 and only native pdf pages will be translated.

Parameter
Name Description
var bool
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