Package google.cloud.translation.v3

Importante: Para acceder a la URL que se indica entre paréntesis, debes conectarte a Internet. Se proporciona la URL para acceder fuera de tu entorno aislado.

TranslationService

Proporciona operaciones de traducción en lenguaje natural.

TranslateDocument

rpc TranslateDocument(TranslateDocumentRequest) returns (TranslateDocumentResponse)

Traduce documentos en modo síncrono.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-translation
  • https://www.googleapis.com/auth/cloud-platform

TranslateDocumentRequest

Es una solicitud de traducción de documentos.

Campos
parent

string

Obligatorio. Ubicación para realizar una llamada regional.

Formato: projects/{project-number-or-id}/locations/{location-id}.

Para las llamadas globales, usa projects/{project-number-or-id}/locations/global o projects/{project-number-or-id}.

Se requiere una ubicación no global para las solicitudes que usan modelos de AutoML o glosarios personalizados.

Los modelos y los glosarios deben estar en la misma región (tener el mismo ID de ubicación); de lo contrario, se devolverá un error INVALID_ARGUMENT (400).
source_language_code

string

Opcional. Es el código de idioma ISO-639 del documento de entrada, si se conoce, por ejemplo, "en-US" o "sr-Latn". Los códigos de idioma admitidos se indican en Idiomas admitidos. Si no se especifica el idioma de origen, la API intenta identificarlo automáticamente y lo devuelve en la respuesta. Se debe especificar el idioma de origen si la solicitud contiene un glosario o un modelo personalizado.
target_language_code

string

Obligatorio. Es el código de idioma ISO-639 que se usará para traducir el documento de entrada. Se debe establecer en uno de los códigos de idioma que se indican en Idiomas admitidos.
document_input_config

DocumentInputConfig

Obligatorio. Configuraciones de entrada
glossary_config

TranslateTextGlossaryConfig

Opcional. Es el glosario que se aplicará. El glosario debe estar en la misma región (tener el mismo ID de ubicación) que el modelo; de lo contrario, se devolverá un error INVALID_ARGUMENT (400).

La autorización requiere el siguiente permiso IAM en el recurso especificado glossaryConfig:

  • cloudtranslate.glossaries.docPredict

TranslateDocumentResponse

Es un mensaje de respuesta de documento traducido.

Campos
document_translation

DocumentTranslation

Documento traducido.
glossary_document_translation

DocumentTranslation

Es el resultado de la traducción del documento si se proporciona un glosario en la solicitud. Puede ser igual a [TranslateDocumentResponse.document_translation] si no se aplican términos del glosario.
glossary_config

TranslateTextGlossaryConfig

Es el glossary_config que se usó para esta traducción.
CreateGlossary

rpc CreateGlossary(CreateGlossaryRequest) returns (Operation)

Crea un glosario y devuelve la operación de larga duración. Muestra NOT_FOUND si el proyecto no existe.
DeleteGlossary

rpc DeleteGlossary(DeleteGlossaryRequest) returns (Operation)

Borra un glosario si no se creó. Muestra NOT_FOUND si el glosario no existe.
DetectLanguage

rpc DetectLanguage(DetectLanguageRequest) returns (DetectLanguageResponse)

Detecta el idioma del texto en una solicitud.
GetGlossary

rpc GetGlossary(GetGlossaryRequest) returns (Glossary)

Obtiene un glosario. Muestra NOT_FOUND si el glosario no existe.
GetSupportedLanguages

rpc GetSupportedLanguages(GetSupportedLanguagesRequest) returns (SupportedLanguages)

Devuelve una lista de los idiomas admitidos para la traducción.
ListGlossaries

rpc ListGlossaries(ListGlossariesRequest) returns (ListGlossariesResponse)

Enumera los glosarios de un proyecto. Muestra NOT_FOUND si el proyecto no existe.
TranslateText

rpc TranslateText(TranslateTextRequest) returns (TranslateTextResponse)

Traduce el texto de entrada y devuelve el texto traducido.

CreateGlossaryMetadata

Se almacena en el campo google.longrunning.Operation.metadata que devuelve CreateGlossary.

Campos
name

string

Es el nombre del glosario que se está creando.
state

State

Es el estado actual de la operación de creación del glosario.
submit_time

Timestamp

Es la fecha y hora en que se envió la operación al servidor.

Estado

Enumera los estados posibles en los que se puede encontrar la solicitud de creación.

Enums
STATE_UNSPECIFIED No válido.
RUNNING Se está procesando la solicitud.
SUCCEEDED El glosario se creó correctamente.
FAILED No se pudo crear el glosario.

CreateGlossaryRequest

Es el mensaje de solicitud para CreateGlossary.

Campos
parent

string

Obligatorio. Es el nombre del proyecto.
glossary

Glossary

Obligatorio. Es el glosario que se creará.

DeleteGlossaryMetadata

Se almacena en el campo google.longrunning.Operation.metadata que devuelve DeleteGlossary.

Campos
name

string

Es el nombre del glosario que se borrará.
state

State

Es el estado actual de la operación de eliminación del glosario.
submit_time

Timestamp

Es la fecha y hora en que se envió la operación al servidor.

Estado

Enumera los estados posibles en los que se puede encontrar la solicitud de creación.

Enums
STATE_UNSPECIFIED No válido.
RUNNING Se está procesando la solicitud.
SUCCEEDED Se borró correctamente el glosario.
FAILED No se pudo borrar el glosario.

DeleteGlossaryRequest

Es el mensaje de solicitud para DeleteGlossary.

Campos
name

string

Obligatorio. Es el nombre del glosario que se borrará.

DeleteGlossaryResponse

Se almacena en el campo google.longrunning.Operation.response que devuelve DeleteGlossary.

Campos
name

string

Es el nombre del glosario borrado.
submit_time

Timestamp

Es la fecha y hora en que se envió la operación al servidor.
end_time

Timestamp

Es la fecha y hora en que finaliza el borrado del glosario y google.longrunning.Operation.done se establece como verdadero.

DetectLanguageRequest

Es el mensaje de solicitud para la detección de idioma.

Campos
parent

string

Obligatorio. Es el proyecto para realizar una llamada. Debe hacer referencia al proyecto de un llamador.

Formato: projects/{project-id}.
mime_type

string

Opcional. Es el formato del texto fuente, por ejemplo, "text/html" o "text/plain". Si se deja en blanco, el tipo de MIME predeterminado es "text/html".
content

string

Es el contenido de la entrada almacenado como una cadena.

DetectLanguageResponse

Es el mensaje de respuesta para la detección de idioma.

Campos
languages[]

DetectedLanguage

Es el idioma más probable que detectó la API de Translation. Para cada solicitud, la API de Translation siempre devolverá solo un resultado.

DetectedLanguage

Es el mensaje de respuesta para la detección de idioma.

Campos
language_code

string

Es el código de idioma BCP-47 del contenido fuente de la solicitud, que se detecta automáticamente.
confidence

float

Es la confianza del resultado de detección para este idioma.

S3Source

Ubicación de almacenamiento del contenido de entrada.

Campos
input_uri

string

Obligatorio. Es el URI de los datos de origen. Por ejemplo, s3://my_bucket/my_object.

GetGlossaryRequest

Es el mensaje de solicitud para GetGlossary.

Campos
name

string

Obligatorio. Nombre del glosario que se recuperará.

GetSupportedLanguagesRequest

Es el mensaje de solicitud para descubrir los idiomas admitidos.

Campos
parent

string

Obligatorio. Es el proyecto para realizar una llamada. Debe hacer referencia al proyecto de un llamador.

Formato: projects/{project-id}.
display_language_code

string

Opcional. Idioma que se usará para devolver nombres localizados y legibles de los idiomas admitidos. Si falta, no se devuelven los nombres visibles en una respuesta.

Glosario

Representa un glosario creado a partir de los datos proporcionados por el usuario.

Campos
name

string

Obligatorio. Es el nombre del recurso del glosario. Los nombres del glosario tienen el formato projects/{project-id}/glossaries/{glossary-id}.
input_config

GlossaryInputConfig

Obligatorio. Proporciona ejemplos para crear el glosario. El glosario total no debe exceder los 10 millones de puntos de código Unicode.
entry_count

int32

Solo salida. Es la cantidad de entradas definidas en el glosario.
submit_time

Timestamp

Solo salida. Cuándo se llamó a CreateGlossary.
end_time

Timestamp

Solo salida. Cuándo finalizó la creación del glosario.
display_name

string

Opcional. Es el nombre visible del glosario.
Campo de unión languages. Son los idiomas admitidos por el glosario. languages puede ser solo uno de los siguientes:
language_pair

LanguageCodePair

Se usa con glosarios unidireccionales.
language_codes_set

LanguageCodesSet

Se usa con glosarios de conjuntos de términos equivalentes.

LanguageCodePair

Se usa con glosarios unidireccionales.

Campos
source_language_code

string

Obligatorio. Es el código de idioma BCP-47 del texto de entrada, por ejemplo, "en-US". Se espera que coincida exactamente con GlossaryTerm.language_code.
target_language_code

string

Obligatorio. Es el código de idioma BCP-47 para el resultado de la traducción, por ejemplo, "zh-CN". Se espera que coincida exactamente con GlossaryTerm.language_code.

LanguageCodesSet

Se usa con glosarios de conjuntos de términos equivalentes.

Campos
language_codes[]

string

Son los códigos de idioma BCP-47 para los términos definidos en el glosario. Todas las entradas son únicas. La lista contiene al menos dos entradas. Se espera que coincida exactamente con GlossaryTerm.language_code.

GlossaryInputConfig

Es la configuración de entrada para los glosarios.

Campos
s3_source

S3Source

Obligatorio. Ubicación de almacenamiento de los datos del glosario. El formato de archivo se determina según la extensión del nombre de archivo. La API devuelve google.rpc.Code.INVALID_ARGUMENT para los formatos de archivo y los URI no admitidos. No se permiten comodines. Debe ser un solo archivo en uno de los siguientes formatos:

Para los glosarios unidireccionales, haz lo siguiente:

  • TSV/CSV (.tsv/.csv): Archivo de 2 columnas, separadas por tabulaciones o comas. La primera columna es el texto fuente. La segunda columna es el texto de destino. El archivo no debe contener encabezados. Es decir, la primera fila contiene datos, no nombres de columnas.

  • TMX (.tmx): Archivo TMX con datos paralelos que definen pares de términos fuente y objetivo.

Para los glosarios de conjuntos de términos equivalentes, haz lo siguiente:

  • CSV (.csv): Archivo CSV de varias columnas que define términos del glosario equivalentes en varios idiomas. Consulta la documentación para obtener más información sobre los glosarios.

ListGlossariesRequest

Es el mensaje de solicitud de ListGlossaries.

Campos
parent

string

Obligatorio. Es el nombre del proyecto del que se enumerarán todos los glosarios.
page_size

int32

Opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos glosarios de los solicitados. Si no se especifica, el servidor elige un valor predeterminado adecuado.
page_token

string

Opcional. Es un token que identifica una página de resultados que debe devolver el servidor. Por lo general, este es el valor de [ListGlossariesResponse.next_page_token] que se devolvió en la llamada anterior al método ListGlossaries. Se muestra la primera página si page_token está vacío o falta.
filter

string

Opcional. Es un filtro que especifica las restricciones de una operación de lista. Especifica la restricción con el formato “clave=valor”, en el que la clave debe ser “src” o “tgt”, y el valor debe ser un código de idioma válido. Si hay varias restricciones, concaténalas con "AND" (solo en mayúsculas), por ejemplo: "src=en-US AND tgt=zh-CN". Ten en cuenta que aquí se usa la coincidencia exacta, lo que significa que usar "en-US" y "en" puede generar resultados diferentes, según el código de idioma que usaste cuando creaste el glosario. En el caso de los glosarios unidireccionales, "src" y "tgt" agregan restricciones al código de idioma de origen y de destino por separado. Para los glosarios de conjuntos de términos equivalentes, "src" o "tgt" agregan restricciones al conjunto de términos. Por ejemplo, "src=en-US AND tgt=zh-CN" solo seleccionará los glosarios unidireccionales que coincidan exactamente con el código de idioma fuente como "en-US" y el código de idioma de destino "zh-CN", pero se seleccionarán todos los glosarios de conjunto de términos equivalentes que contengan "en-US" y "zh-CN" en su conjunto de idiomas. Si falta, no se realiza ningún filtrado.

ListGlossariesResponse

Es el mensaje de respuesta para ListGlossaries.

Campos
glossaries[]

Glossary

Es la lista de glosarios de un proyecto.
next_page_token

string

Es un token para recuperar una página de resultados. Pasa este valor en el campo [ListGlossariesRequest.page_token] en la llamada posterior al método ListGlossaries para recuperar la siguiente página de resultados.

SupportedLanguage

Una sola respuesta de idioma admitido corresponde a la información relacionada con un idioma admitido.

Campos
language_code

string

Es el código de idioma admitido, que generalmente consta de su identificador ISO 639-1, por ejemplo, “en” o “ja”. En algunos casos, se devuelven códigos BCP-47 que incluyen identificadores de idioma y región (por ejemplo, "zh-TW" y "zh-CN").
display_name

string

Nombre legible por humanos del idioma localizado en el idioma de visualización especificado en la solicitud.
support_source

bool

Se puede usar como idioma de origen.
support_target

bool

Se puede usar como idioma de destino.

SupportedLanguages

Es el mensaje de respuesta para descubrir los idiomas admitidos.

Campos
languages[]

SupportedLanguage

Es una lista de respuestas de idiomas compatibles. Esta lista contiene una entrada para cada idioma que admite la API de Translation.

TranslateTextGlossaryConfig

Configura qué glosario se debe usar para un idioma de destino específico y define opciones para aplicar ese glosario.

Campos
glossary

string

Obligatorio. Es el glossary que se aplicará a esta traducción.

El formato depende del glosario:

  • El usuario proporcionó un glosario personalizado: projects/{project-id}/glossaries/{glossary-id}
ignore_case

bool

Opcional. Indica que la coincidencia no distingue mayúsculas de minúsculas. El valor predeterminado es falso si falta.

TranslateTextRequest

Es el mensaje de solicitud para la traducción síncrona.

Campos
contents[]

string

Obligatorio. Es el contenido de la entrada en formato de cadena. Recomendamos que el contenido total sea inferior a 30,000 puntos de código. La longitud máxima de este campo es de 1,024. Usa BatchTranslateText para textos más grandes.
mime_type

string

Opcional. Es el formato del texto fuente, por ejemplo, "text/html" o "text/plain". Si se deja en blanco, el tipo de MIME predeterminado es "text/html".
source_language_code

string

Es el código de idioma BCP-47 del texto de entrada, si se conoce, por ejemplo, en-US o sr-Latn. Los códigos de idioma admitidos se indican en Idiomas admitidos.
target_language_code

string

Obligatorio. Es el código de idioma BCP-47 que se usará para traducir el texto de entrada. Se debe establecer en uno de los códigos de idioma que se indican en Idiomas admitidos.
parent

string

Obligatorio. Es el proyecto para realizar una llamada. Debe hacer referencia al proyecto de un llamador.

Formato: projects/{project-id}
glossary_config

TranslateTextGlossaryConfig

Opcional. Es el glosario que se aplicará.

TranslateTextResponse

Campos
translations[]

Translation

Son las respuestas de traducción de texto sin glosario aplicado. Este campo tiene la misma longitud que contents.
glossary_translations[]

Translation

Respuestas de traducción de texto si se proporciona un glosario en la solicitud. Puede ser igual que translations si no se aplican condiciones. Este campo tiene la misma longitud que contents.

Traducción

Es una sola respuesta de traducción.

Campos
translated_text

string

Es el texto traducido al idioma de destino. Si se produce un error durante la traducción, es posible que este campo se excluya de la respuesta.
detected_language_code

string

Si se pasó el idioma de origen, no se produce la detección automática del idioma y este campo está vacío.
glossary_config

TranslateTextGlossaryConfig

Es el glossary_config que se usó para esta traducción.