Package google.cloud.translation.v3

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

TranslationService

Proporciona operaciones de traducción de lenguaje natural.

TranslateDocument

rpc TranslateDocument(TranslateDocumentRequest) returns (TranslateDocumentResponse)

Traduce documentos en modo síncrono.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

TranslateDocumentRequest

Una solicitud de traducción de un documento.

Campos
parent

string

Obligatorio. Ubicación para hacer una llamada regional.

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

Para llamadas internacionales, 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 usen modelos de AutoML o glosarios personalizados.

Los modelos y los glosarios deben estar en la misma región (tener el mismo location-id). De lo contrario, se devolverá un error INVALID_ARGUMENT (400).
source_language_code

string

Opcional. 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 la página de idiomas admitidos. Si no se especifica el idioma de origen, la API intenta identificarlo automáticamente y lo devuelve en la respuesta. El idioma de origen debe especificarse si la solicitud contiene un glosario o un modelo personalizado.
target_language_code

string

Obligatorio. Código de idioma ISO-639 que se va a usar para traducir el documento de entrada. Debe ser uno de los códigos de idioma que se indican en la sección Idiomas admitidos.
document_input_config

DocumentInputConfig

Obligatorio. Configuraciones de entrada.
glossary_config

TranslateTextGlossaryConfig

Opcional. Glosario que se va a aplicar. El glosario debe estar en la misma región (tener el mismo location-id) que el modelo. De lo contrario, se devolverá un error INVALID_ARGUMENT (400).

Para la autorización, se necesita el siguiente permiso de IAM en el recurso especificado glossaryConfig:

  • cloudtranslate.glossaries.docPredict

TranslateDocumentResponse

Un mensaje de respuesta de un documento traducido.

Campos
document_translation

DocumentTranslation

Documento traducido.
glossary_document_translation

DocumentTranslation

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

TranslateTextGlossaryConfig

El glossary_config usado en esta traducción.
CreateGlossary

rpc CreateGlossary(CreateGlossaryRequest) returns (Operation)

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

rpc DeleteGlossary(DeleteGlossaryRequest) returns (Operation)

Elimina una lista de términos si no se ha creado. Devuelve NOT_FOUND si el glosario no existe.
DetectLanguage

rpc DetectLanguage(DetectLanguageRequest) returns (DetectLanguageResponse)

Detecta el idioma del texto de una petición.
GetGlossary

rpc GetGlossary(GetGlossaryRequest) returns (Glossary)

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

rpc GetSupportedLanguages(GetSupportedLanguagesRequest) returns (SupportedLanguages)

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

rpc ListGlossaries(ListGlossariesRequest) returns (ListGlossariesResponse)

Muestra las glosarios de un proyecto. Devuelve NOT_FOUND si el proyecto no existe.
TranslateText

rpc TranslateText(TranslateTextRequest) returns (TranslateTextResponse)

Traduce el texto introducido y devuelve el texto traducido.

CreateGlossaryMetadata

Se almacena en el campo google.longrunning.Operation.metadata devuelto por CreateGlossary.

Campos
name

string

Nombre del glosario que se va a crear.
state

State

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

Timestamp

La hora en la que se envió la operación al servidor.

Estado

Enumera los posibles estados en los que puede estar la petición de creación.

Enumeraciones
STATE_UNSPECIFIED No es válida.
RUNNING La solicitud se está procesando.
SUCCEEDED El glosario se ha creado correctamente.
FAILED No se ha podido crear el glosario.

CreateGlossaryRequest

Mensaje de solicitud de CreateGlossary.

Campos
parent

string

Obligatorio. Nombre del proyecto.
glossary

Glossary

Obligatorio. Glosario que se va a crear.

DeleteGlossaryMetadata

Se almacena en el campo google.longrunning.Operation.metadata devuelto por DeleteGlossary.

Campos
name

string

Nombre de la glosario que se va a eliminar.
state

State

El estado actual de la operación de eliminación de la glosario.
submit_time

Timestamp

La hora en la que se envió la operación al servidor.

Estado

Enumera los posibles estados en los que puede estar la petición de creación.

Enumeraciones
STATE_UNSPECIFIED No es válida.
RUNNING La solicitud se está procesando.
SUCCEEDED El glosario se ha eliminado correctamente.
FAILED No se ha podido eliminar el glosario.

DeleteGlossaryRequest

Mensaje de solicitud de DeleteGlossary.

Campos
name

string

Obligatorio. Nombre de la glosario que se va a eliminar.

DeleteGlossaryResponse

Se almacena en el campo google.longrunning.Operation.response devuelto por DeleteGlossary.

Campos
name

string

Nombre del glosario eliminado.
submit_time

Timestamp

La hora en la que se envió la operación al servidor.
end_time

Timestamp

La hora en la que se ha completado la eliminación de la glosario y google.longrunning.Operation.done se ha definido como true.

DetectLanguageRequest

Mensaje de solicitud para la detección de idiomas.

Campos
parent

string

Obligatorio. Proyecta para hacer una llamada. Debe hacer referencia al proyecto de un llamante.

Formato: projects/{project-id}.
mime_type

string

Opcional. El formato del texto de origen, por ejemplo, "text/html" o "text/plain". Si se deja en blanco, el tipo MIME será "text/html" de forma predeterminada.
content

string

El contenido de la entrada almacenado como una cadena.

DetectLanguageResponse

El mensaje de respuesta para la detección del idioma.

Campos
languages[]

DetectedLanguage

El idioma más probable detectado por la API Translation. La API Translation siempre devolverá un solo resultado por cada solicitud.

Idioma detectado

El mensaje de respuesta para la detección del idioma.

Campos
language_code

string

El código de idioma BCP-47 del contenido fuente en la petición (se detecta automáticamente).
confidence

float

La confianza del resultado de detección para este idioma.

S3Source

Ubicación de almacenamiento del contenido de entrada.

Campos
input_uri

string

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

GetGlossaryRequest

Mensaje de solicitud de GetGlossary.

Campos
name

string

Obligatorio. Nombre de la glosario que se quiere obtener.

GetSupportedLanguagesRequest

Mensaje de solicitud para descubrir los idiomas admitidos.

Campos
parent

string

Obligatorio. Proyecta para hacer una llamada. Debe hacer referencia al proyecto de un llamante.

Formato: projects/{project-id}.
display_language_code

string

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

Glosario

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

Campos
name

string

Obligatorio. Nombre de recurso del glosario. Los nombres de los glosarios tienen el formato projects/{project-id}/glossaries/{glossary-id}.
input_config

GlossaryInputConfig

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

int32

Solo de salida. Número de entradas definidas en el glosario.
submit_time

Timestamp

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

Timestamp

Solo de salida. Cuándo se terminó de crear el glosario.
display_name

string

Opcional. Nombre visible del glosario.
Campo de unión languages. Idiomas admitidos por el glosario. languages solo puede ser una de las siguientes cosas:
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. El código de idioma BCP-47 del texto de entrada (por ejemplo, "en-US"). Debe ser una coincidencia exacta de GlossaryTerm.language_code.
target_language_code

string

Obligatorio. El código de idioma BCP-47 de la traducción, por ejemplo, "zh-CN". Debe ser una coincidencia exacta de GlossaryTerm.language_code.

LanguageCodesSet

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

Campos
language_codes[]

string

Los códigos de idioma BCP-47 de los términos definidos en el glosario. Todas las entradas son únicas. La lista contiene al menos dos entradas. Debe ser una coincidencia exacta de GlossaryTerm.language_code.

GlossaryInputConfig

Configuración de entrada de glosarios.

Campos
s3_source

S3Source

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

Para glosarios unidireccionales:

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

  • TMX (.tmx): archivo TMX con datos paralelos que definen pares de términos de origen y destino.

Para glosarios de conjuntos de términos equivalentes:

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

ListGlossariesRequest

Mensaje de solicitud de ListGlossaries.

Campos
parent

string

Obligatorio. Nombre del proyecto del que se van a enumerar todas las glosarios.
page_size

int32

Opcional. Tamaño de la página solicitado. El servidor puede devolver menos glosarios de los solicitados. Si no se especifica, el servidor elige un valor predeterminado adecuado.
page_token

string

Opcional. Un token con el que se identifica la página de resultados que el servidor debería devolver. Normalmente, se trata del valor de [ListGlossariesResponse.next_page_token] devuelto por la llamada anterior al método ListGlossaries. Se devuelve la primera página si page_token está vacío o falta.
filter

string

Opcional. Filtro que especifica las restricciones de una operación de lista. Especifica la restricción con el formato "clave=valor", donde 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), como "src=en-US AND tgt=zh-CN". Ten en cuenta que aquí se usa la concordancia exacta, lo que significa que usar "en-US" y "en" puede dar lugar a resultados diferentes, que dependen del código de idioma que hayas usado al crear el glosario. En los glosarios unidireccionales, "src" y "tgt" añaden restricciones al código de idioma de origen y de destino por separado. En los glosarios de conjuntos de términos equivalentes, los atributos "src" o "tgt" añaden 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 de origen "en-US" y el código de idioma de destino "zh-CN", pero se seleccionarán todos los glosarios de conjuntos de términos equivalentes que contengan "en-US" y "zh-CN" en su conjunto de idiomas. Si falta, no se aplica ningún filtro.

ListGlossariesResponse

Mensaje de respuesta a ListGlossaries.

Campos
glossaries[]

Glossary

Lista de glosarios de un proyecto.
next_page_token

string

Token para obtener una página de resultados. Pasa este valor al campo [ListGlossariesRequest.page_token] en la siguiente llamada al método ListGlossaries para obtener la siguiente página de resultados.

Idioma admitido

Una única respuesta de idioma admitida corresponde a la información relacionada con un idioma admitido.

Campos
language_code

string

Código de idioma admitido, que suele ser 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 del idioma con un formato legible por humanos, 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

El mensaje de respuesta para descubrir los idiomas compatibles.

Campos
languages[]

SupportedLanguage

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

TranslateTextGlossaryConfig

Configura el glosario que se debe usar para un idioma de destino específico y define las opciones para aplicar ese glosario.

Campos
glossary

string

Obligatorio. El glossary que se va a aplicar a esta traducción.

El formato depende del glosario:

  • Glosario personalizado proporcionado por el usuario: projects/{project-id}/glossaries/{glossary-id}
ignore_case

bool

Opcional. Indica que la coincidencia no distingue entre mayúsculas y minúsculas. El valor predeterminado es false si falta.

TranslateTextRequest

Mensaje de solicitud de traducción síncrona.

Campos
contents[]

string

Obligatorio. 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 1024 caracteres. Usa BatchTranslateText para textos más largos.
mime_type

string

Opcional. El formato del texto de origen, por ejemplo, "text/html" o "text/plain". Si se deja en blanco, el tipo MIME será "text/html" de forma predeterminada.
source_language_code

string

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 la página de idiomas admitidos.
target_language_code

string

Obligatorio. Código de idioma BCP-47 que se va a usar para traducir el texto de entrada. Debe ser uno de los códigos de idioma que se indican en la sección de idiomas admitidos.
parent

string

Obligatorio. Proyecta para hacer una llamada. Debe hacer referencia al proyecto de un llamante.

Formato: projects/{project-id}
glossary_config

TranslateTextGlossaryConfig

Opcional. Glosario que se va a aplicar.

TranslateTextResponse

Campos
translations[]

Translation

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 la misma que translations si no se aplican términos. Este campo tiene la misma longitud que contents.

Traducción

Una sola respuesta de traducción.

Campos
translated_text

string

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 ha proporcionado el idioma de origen, no se detectará automáticamente el idioma y este campo estará vacío.
glossary_config

TranslateTextGlossaryConfig

El glossary_config usado en esta traducción.