Method: projects.locations.translateDocument

Traduce documentos en modo síncrono.

Solicitud HTTP

POST https://{TRANSLATION_GDC_ENDPOINT}/v3/{parent}:translateDocument

Parámetros de ruta

Parámetros
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).

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "sourceLanguageCode": string,
  "targetLanguageCode": string,
  "documentInputConfig": {
    object (DocumentInputConfig)
  },
  "glossaryConfig": {
    object (TranslateTextGlossaryConfig)
  }
}
Campos
sourceLanguageCode

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.

targetLanguageCode

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.

documentInputConfig

object (DocumentInputConfig)

Obligatorio. Configuraciones de entrada

glossaryConfig

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

Cuerpo de la respuesta

Es un mensaje de respuesta de documento traducido.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "documentTranslation": {
    object (DocumentTranslation)
  },
  "glossaryDocumentTranslation": {
    object (DocumentTranslation)
  },
  "glossaryConfig": {
    object (TranslateTextGlossaryConfig)
  }
}
Campos
documentTranslation

object (DocumentTranslation)

Documento traducido.

glossaryDocumentTranslation

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

glossaryConfig

object (TranslateTextGlossaryConfig)

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

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

DocumentInputConfig

Es la configuración de entrada de una solicitud de traducción de documentos.

Representación JSON
{
  "mimeType": string,
  "content": string,
  "S3Source": {
    object (S3Source)
  }
}
Campos
mimeType

string

Especifica el tipo de MIME del documento de entrada.

Si no se especifica, se determinará con la extensión de archivo para los archivos proporcionados por S3Source. Se debe proporcionar el mimeType para un archivo proporcionado a través del contenido de bytes.

Actualmente, se admiten los siguientes tipos de MIME:

  • application/pdf
  • application/msword
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document
  • application/vnd.ms-powerpoint
  • application/vnd.openxmlformats-officedocument.presentationml.presentation
  • application/vnd.ms-excel
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Supported file formats are:

  • PDF
  • DOC
  • DOCX
  • PPT
  • PPTX
  • XLS
  • XLSX

content

string (bytes format)

Contenido del documento representado como un flujo de bytes.

String codificada en base64.

S3Source

object (S3Source)

Ubicación de almacenamiento del contenido de entrada.

DocumentTranslation

Es un mensaje de documento traducido.

Representación JSON
{
  "byteStreamOutputs": [
    string
  ],
  "mimeType": string,
  "detectedLanguageCode": string
}
Campos
byteStreamOutputs[]

string (bytes format)

Es el array de documentos traducidos. Por el momento, se espera que sea de tamaño 1. Es posible que, en el futuro, produzcamos varios documentos traducidos para otros tipos de formatos de archivo.

String codificada en base64.

mimeType

string

Es el tipo de MIME del documento traducido.

detectedLanguageCode

string

Es el idioma detectado del documento de entrada. Si el usuario no proporcionó el idioma de origen del documento de entrada, este campo tendrá el código de idioma detectado automáticamente. Si se pasó el idioma de origen, no se produce la detección automática del idioma y este campo está vacío.