Cloud Translation V3 API - Class Google::Cloud::Translate::V3::TranslateTextRequest (v0.12.0)

Version 0.12.0

• 1.2.0 (latest)
• 1.1.1
• 1.0.0
• 0.12.0
• 0.11.2
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.3
• 0.6.0
• 0.5.2
• 0.4.2

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

The request message for synchronous translation.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#contents

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

Returns

• (::Array<::String>) — Required. The content of the input in string format. We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.

#contents=

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

Parameter

• value (::Array<::String>) — Required. The content of the input in string format. We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.

Returns

• (::Array<::String>) — Required. The content of the input in string format. We recommend the total content be less than 30,000 codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.

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

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

#mime_type

def mime_type() -> ::String

Returns

• (::String) — Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".

#mime_type=

def mime_type=(value) -> ::String

Parameter

• value (::String) — Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".

Returns

• (::String) — Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html".

#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,

  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

#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,

  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

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,

  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

#parent

def parent() -> ::String

Returns

• (::String) — 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.

#parent=

def parent=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.

#source_language_code

def source_language_code() -> ::String

Returns

• (::String) — Optional. The ISO-639 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.

#source_language_code=

def source_language_code=(value) -> ::String

Parameter

• value (::String) — Optional. The ISO-639 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.

Returns

• (::String) — Optional. The ISO-639 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.

#target_language_code

def target_language_code() -> ::String

Returns

• (::String) — Required. The ISO-639 language code to use for translation of the input text, 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 text, 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 text, set to one of the language codes listed in Language Support.