Compartir a través de

Obtener el estado de un documento específico

Característica de referencia
: Azure Translator → versión de la API de traducción
de documentos: 2024-05-01
método HTTP: GET

Este método devuelve el estado de un documento específico en un trabajo, tal como se indica en la solicitud por los id parámetros de consulta y documentId .

URL de la solicitud

Importante

Todas las solicitudes de API a la característica traducción de documentos requieren un punto de conexión de dominio personalizado que se encuentra en la página de información general de recursos de Azure Portal.

  curl -i -X GET "{document-translation-endpoint}/translator/document/batches/{id}/documents/{documentId}?api-version={date}"

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 Cierto El identificador del documento.
id Cierto Id. del lote.

Buscar los id valores y documentId

  • Puede encontrar el valor de id del trabajo en el valor de la dirección URL start-batch-translation del encabezado de respuesta del método POST Operation-Location. El último parámetro de la dirección URL es el valor de id del trabajo de la operación:
Encabezado de respuesta Dirección URL del resultado
Operation-Location {document-translation-endpoint}/translator/document/batches/{id}?api-version={date}/ 9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec/

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 No encontrado. 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
camino cuerda / cadena Ubicación del documento o carpeta.
sourcePath cuerda / cadena Ubicación del documento de origen.
createdDateTimeUtc cuerda / cadena Fecha y hora de creación de la operación.
lastActionDateTimeUtc cuerda / cadena Fecha y hora en la que se actualizó el estado de la operación.
estado Cadena Lista de posibles estados para el trabajo o documento:
• Cancelado
•Cancelar
•Fracasado
• NoStarted
•Corriente
•Tuvo éxito
• ValidationFailed
Para cuerda / cadena Código de idioma de dos letras del idioma de destino. Consulte la lista de idiomas.
progreso número Progreso de la traducción, si está disponible.
id cuerda / cadena Identificador del documento.
characterCharged entero Caracteres cargados por la API.

Respuesta de error

Nombre Escribir Descripción
código cuerda / cadena Enumeraciones que contiene códigos de error de alto nivel. Valores aceptados:
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• ServiceUnavailable
•Desautorizado
Mensaje cuerda / cadena Obtiene un mensaje de error de alto nivel.
innerError InnerTranslationError Nuevo formato de error interno que se ajusta a las directrices de la API de Foundry Tools. 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 cuerda / cadena Obtiene la cadena de error de código.
innerError.message cuerda / cadena Obtiene un mensaje de error de alto nivel.
innerError.target cuerda / cadena 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 la traducción de documentos y la biblioteca cliente.

Introducción a la traducción de documentos

  • Last updated on