Obtención del estado del documento

  • Artículo

Servicio de referencia
: Traducción de documentos de Azure AI
Versión de API: v1.1

El método de obtención del estado de un documento devuelve el estado de un documento específico. El método devuelve el estado de la traducción de un documento específico en función del identificador de la solicitud y del identificador del documento.

URL de la solicitud

Envíe una solicitud GET a:

GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/{id}/documents/{documentId}

Aprenda a encontrar su nombre de dominio personalizado.

Importante

  • Todas las solicitudes de API al servicio de traducción de documentos requieren un punto de conexión de dominio personalizado.
  • No usará el punto de conexión que se encuentra en la página Claves y punto de conexión del recurso en Azure Portal, ni el punto de conexión global del traductor (api.cognitive.microsofttranslator.com) para realizar solicitudes HTTP de traducción de documentos.

Parámetros de solicitud

Los parámetros de solicitud que se pasaron en la cadena de consulta son:

Parámetro de consulta Obligatorio Descripción
documentId Verdadero El identificador del documento.
id True Id. del lote.

Encabezados de solicitud

Los encabezados de solicitud son:

encabezados Descripción
Ocp-Apim-Subscription-Key Encabezado de solicitud obligatorio

Códigos de estado de respuesta

A continuación se indican los códigos de estado HTTP posibles que devuelve una solicitud.

Código de estado Descripción
200 Aceptar. Solicitud correcta aceptada por el servicio. Se devuelven los detalles de la operación. HeadersRetry-After: integerETag: cadena
401 No autorizado. Compruebe sus credenciales.
404 Not Found. No se encuentra el recurso.
500 Error interno del servidor.
Otros códigos de estado • Demasiadas solicitudes
• Servidor temporal no disponible

Respuesta de obtención del estado del documento

Respuesta correcta de obtención del estado del documento

Nombre Escribir Descripción
path string Ubicación del documento o carpeta.
sourcePath string Ubicación del documento de origen.
createdDateTimeUtc string Fecha y hora de creación de la operación.
lastActionDateTimeUtc string Fecha y hora en la que se actualizó el estado de la operación.
status Cadena Lista de posibles estados para el trabajo o documento:
• Cancelado
•Cancelar
•Fallado
• NoStarted
•Corriendo
•Tuvo éxito
• ValidationFailed
to string Código de idioma de dos letras del idioma de destino. Consulte la lista de idiomas.
progreso number Progreso de la traducción, si está disponible.
id string Identificador del documento.
characterCharged integer Caracteres cargados por la API.

Respuesta de error

Nombre Escribir Descripción
código string Enumeraciones que contiene códigos de error de alto nivel. Valores posibles:
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• ServiceUnavailable
•Desautorizado
message string Obtiene un mensaje de error de alto nivel.
innerError InnerTranslationError Nuevo formato de error interno, que cumple las directrices de la API de los servicios de Azure AI. Este mensaje de error contiene las propiedades necesarias ErrorCode, message y el destino de propiedades opcionales, details(key value pair), inner error(it can be nested).
innerError.code string Obtiene la cadena de error de código.
innerError.message string Obtiene un mensaje de error de alto nivel.
innerError.target string Obtiene el origen del error. Por ejemplo, sería documents o document id para un documento inválido.

Ejemplos

Ejemplo de respuesta correcta

El siguiente objeto JSON es un ejemplo de una respuesta correcta.

{
  "path": "https://myblob.blob.core.windows.net/destinationContainer/fr/mydoc.txt",
  "sourcePath": "https://myblob.blob.core.windows.net/sourceContainer/fr/mydoc.txt",
  "createdDateTimeUtc": "2020-03-26T00:00:00Z",
  "lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
  "status": "Running",
  "to": "fr",
  "progress": 0.1,
  "id": "273622bd-835c-4946-9798-fd8f19f6bbf2",
  "characterCharged": 0
}

Ejemplo de respuesta con error

El siguiente objeto JSON es un ejemplo de una respuesta con error. El esquema de otros códigos de error es el mismo.

Código de estado: 401

{
  "error": {
    "code": "Unauthorized",
    "message": "User is not authorized",
    "target": "Document",
    "innerError": {
      "code": "Unauthorized",
      "message": "Operation is not authorized"
    }
  }
}

Pasos siguientes

Siga nuestro inicio rápido para obtener más información sobre el uso de Traducción de documentos y la biblioteca cliente.

Introducción a la traducción de documentos