Cloud Translation V3 API - Class Google::Cloud::Translate::V3::BatchTranslateDocumentRequest (v1.1.0)

Reference documentation and code samples for the Cloud Translation V3 API class Google::Cloud::Translate::V3::BatchTranslateDocumentRequest.

The BatchTranslateDocument request.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#customized_attribution

def customized_attribution() -> ::String

Returns

(::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

#customized_attribution=

def customized_attribution=(value) -> ::String

Parameter

value (::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

Returns

(::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_rotation_correction

def enable_rotation_correction() -> ::Boolean

Returns

(::Boolean) — Optional. If true, enable auto rotation correction in DVS.

#enable_rotation_correction=

def enable_rotation_correction=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. If true, enable auto rotation correction in DVS.

Returns

(::Boolean) — Optional. If true, enable auto rotation correction in DVS.

#enable_shadow_removal_native_pdf

def enable_shadow_removal_native_pdf() -> ::Boolean

Returns

(::Boolean) — 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_shadow_removal_native_pdf=

def enable_shadow_removal_native_pdf=(value) -> ::Boolean

Parameter

value (::Boolean) — 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

(::Boolean) — 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

#format_conversions

def format_conversions() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. The file format conversion map that is applied to all input files. The map key is the original mime_type. The map 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.

#format_conversions=

def format_conversions=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — Optional. The file format conversion map that is applied to all input files. The map key is the original mime_type. The map 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

(::Google::Protobuf::Map{::String => ::String}) — Optional. The file format conversion map that is applied to all input files. The map key is the original mime_type. The map 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.

#glossaries

def glossaries() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Translate::V3::TranslateTextGlossaryConfig}

Returns

(::Google::Protobuf::Map{::String => ::Google::Cloud::Translate::V3::TranslateTextGlossaryConfig}) — Optional. Glossaries to be applied. It's keyed by target language code.

#glossaries=

def glossaries=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Translate::V3::TranslateTextGlossaryConfig}

Parameter

value (::Google::Protobuf::Map{::String => ::Google::Cloud::Translate::V3::TranslateTextGlossaryConfig}) — Optional. Glossaries to be applied. It's keyed by target language code.

Returns

(::Google::Protobuf::Map{::String => ::Google::Cloud::Translate::V3::TranslateTextGlossaryConfig}) — Optional. Glossaries to be applied. It's keyed by target language code.

#input_configs

def input_configs() -> ::Array<::Google::Cloud::Translate::V3::BatchDocumentInputConfig>

Returns

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

#input_configs=

def input_configs=(value) -> ::Array<::Google::Cloud::Translate::V3::BatchDocumentInputConfig>

Parameter

value (::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.

Returns

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

#models

def models() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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.

#models=

def models=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — 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

(::Google::Protobuf::Map{::String => ::String}) — 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.

#output_config

def output_config() -> ::Google::Cloud::Translate::V3::BatchDocumentOutputConfig

Returns

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

#output_config=

def output_config=(value) -> ::Google::Cloud::Translate::V3::BatchDocumentOutputConfig

Parameter

value (::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

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

#parent

def parent() -> ::String

Returns

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

#parent=

def parent=(value) -> ::String

Parameter

value (::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.

Returns

(::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

def source_language_code() -> ::String

Returns

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

#source_language_code=

def source_language_code=(value) -> ::String

Parameter

value (::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.

Returns

(::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

def target_language_codes() -> ::Array<::String>

Returns

(::Array<::String>) — Required. The ISO-639 language code to use for translation of the input document. Specify up to 10 language codes here.

#target_language_codes=

def target_language_codes=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — Required. The ISO-639 language code to use for translation of the input document. Specify up to 10 language codes here.

Returns

(::Array<::String>) — Required. The ISO-639 language code to use for translation of the input document. Specify up to 10 language codes here.