Cloud Translation V3 API - Class Google::Cloud::Translate::V3::TranslateDocumentRequest (v0.6.0)

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

A document translation 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

#document_input_config

def document_input_config() -> ::Google::Cloud::Translate::V3::DocumentInputConfig

Returns

(::Google::Cloud::Translate::V3::DocumentInputConfig) — Required. Input configurations.

#document_input_config=

def document_input_config=(value) -> ::Google::Cloud::Translate::V3::DocumentInputConfig

Parameter

value (::Google::Cloud::Translate::V3::DocumentInputConfig) — Required. Input configurations.

Returns

(::Google::Cloud::Translate::V3::DocumentInputConfig) — Required. Input configurations.

#document_output_config

def document_output_config() -> ::Google::Cloud::Translate::V3::DocumentOutputConfig

Returns

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

#document_output_config=

def document_output_config=(value) -> ::Google::Cloud::Translate::V3::DocumentOutputConfig

Parameter

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

Returns

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

#enable_shadow_removal_native_pdf

def enable_shadow_removal_native_pdf() -> ::Boolean

Returns

(::Boolean) — Optional. If true, use the text removal 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 is false

#enable_shadow_removal_native_pdf=

def enable_shadow_removal_native_pdf=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. If true, use the text removal 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 is false

Returns

(::Boolean) — Optional. If true, use the text removal 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 is false

#glossary_config

def glossary_config() -> ::Google::Cloud::Translate::V3::TranslateTextGlossaryConfig

Returns

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

#glossary_config=

def glossary_config=(value) -> ::Google::Cloud::Translate::V3::TranslateTextGlossaryConfig

Parameter

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

Returns

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

#is_translate_native_pdf_only

def is_translate_native_pdf_only() -> ::Boolean

Returns

(::Boolean) — Optional. If true, the page limit of online native pdf translation is 300 and only native pdf pages will be translated.

#is_translate_native_pdf_only=

def is_translate_native_pdf_only=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. If true, the page limit of online native pdf translation is 300 and only native pdf pages will be translated.

Returns

(::Boolean) — Optional. If true, the page limit of online native pdf translation is 300 and only native pdf pages will be translated.

#labels

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

Returns

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

#labels=

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

Parameter

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

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

#model

def model() -> ::String

Returns

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

#model=

def model=(value) -> ::String

Parameter

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

Returns

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

#parent

def parent() -> ::String

Returns

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

#parent=

def parent=(value) -> ::String

Parameter

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

Returns

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

def source_language_code() -> ::String

Returns

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

#source_language_code=

def source_language_code=(value) -> ::String

Parameter

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

Returns

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

def target_language_code() -> ::String

Returns

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

#target_language_code=

def target_language_code=(value) -> ::String

Parameter

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

Returns

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