Obtener el estado de todos los documentos

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

• Use el get documents status método para solicitar el estado de todos los documentos de un trabajo de traducción.

• $top, $skip, y $maxpagesize se pueden utilizar parámetros de consulta para especificar el número de resultados a devolver y un desplazamiento para la colección.

  • $top iIndica el número total de registros que el usuario quiere que se devuelvan en todas las páginas.
  • $skip indica el número de registros que hay que omitir de la lista de estado de documentos que tiene el servidor en función del método de ordenación especificado. De forma predeterminada, los registros se ordenan por hora de inicio descendente.
  • $maxpagesize es el máximo de elementos devueltos en una página.
  • Si se solicitan más elementos a través de $top (o $top no se especifica y hay más elementos a devolver), @nextLink contendrá el enlace a la página siguiente.
  • Si el número de documentos de la respuesta supera el límite de paginación, se usa la paginación del lado de servidor.
  • Las respuestas paginadas indican un resultado parcial e incluyen un token de continuación en la respuesta. La ausencia de un token de continuación significa que no hay otras páginas disponibles.

• $orderBy el parámetro query se puede usar para ordenar la lista devuelta (por ejemplo, $orderBy=createdDateTimeUtc asc o $orderBy=createdDateTimeUtc desc).
• La ordenación predeterminada es descendente por createdDateTimeUtc. Algunos parámetros de consulta se pueden usar para filtrar la lista devuelta (por ejemplo: status=Succeeded,Cancelled) solo devuelve documentos correctos y cancelados.
• Los createdDateTimeUtcStart parámetros de consulta y createdDateTimeUtcEnd se pueden combinar o usar por separado para especificar un intervalo de fecha y hora para filtrar la lista devuelta.
• Los parámetros de consulta de filtrado admitidos son (status, id, createdDateTimeUtcStarty createdDateTimeUtcEnd).
• Cuando se incluyen ambas $top y $skip, el servidor debe aplicar primero $skip y luego $top en la colección.

URL de la solicitud

Envíe una solicitud GET a:

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

Búsqueda del valor de id

• 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. La cadena alfanumérica que sigue al parámetro /document/ es el trabajo de la operación id:

• También puede usar una solicitud get-translations-status para recuperar una lista de trabajos de traducción y sus id.

Parámetros de solicitud

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

Encabezados de solicitud

Los encabezados de solicitud son:

Códigos de estado de respuesta

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

Respuesta de obtención del estado de los documentos

Respuesta correcta del estado de obtención de los documentos

En una respuesta correcta se devuelve la información siguiente.

Respuesta de error

Ejemplos

Ejemplo de respuesta correcta

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

{
  "value": [
    {
      "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
    }
  ],
  "@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/documents?$top=5&$skip=15"
}

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: 500

{
  "error": {
    "code": "InternalServerError",
    "message": "Internal Server Error",
    "target": "Operation",
    "innerError": {
      "code": "InternalServerError",
      "message": "Unexpected internal server error has occurred"
    }
  }
}

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.