Obtención del estado de un trabajo de traducción específico
Característica de referencia
: Azure AI Translator → versión de Document Translation
API: 2024-05-01
MÉTODO HTTP: GET
- Use el
get translation status
método para solicitar el estado de un trabajo de traducción específico. La respuesta incluye el estado general del trabajo y el estado de los documentos que se traducen como parte de ese trabajo.
URL de la solicitud
Importante
Todas las solicitudes de API a la característica de traducción de documentos requieren un punto de conexión de dominio personalizado que se encuentra en la página de información general del recurso en Azure Portal.
curl -i -X GET "{document-translation-endpoint}/translator/document/batches/{id}?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 |
---|---|---|
id |
True | El identificador de la operación. |
Búsqueda del valor de id
Puede encontrar el valor de id
del trabajo en el valor de la dirección URL Operation-Location
del encabezado de respuesta del método POST start-batch-translation
. La cadena alfanumérica que sigue al parámetro /document/
es el trabajo de la operación id
:
Encabezado de respuesta | Dirección URL de respuesta |
---|---|
Operation-Location | {document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec ?api-version=2024-05-01 |
- También puede usar una solicitud get-translations-status para recuperar una lista de trabajos de traducción y sus
id
.
Encabezados de solicitud
Los encabezados de solicitud son:
encabezados | Descripción | Condición |
---|---|---|
Ocp-Apim-Subscription-Key | La clave de API del servicio Translator desde Azure Portal. | Obligatorio |
Ocp-Apim-Subscription-Region | La región donde se creó el recurso. | Se requiere cuando se usa un recurso regional (geográfico) como Oeste de EE. UU. &viñeta. |
Content-Type | En este encabezado se especifica el tipo de contenido de la carga. Los valores que se aceptan son application/json o charset=UTF-8. | 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 y devuelve el estado de la operación de traducción por lotes. HeadersRetry-After: integerETag: string |
401 | No autorizado. Compruebe sus credenciales. |
404 | 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 de la traducción
Respuesta correcta de obtención del estado de la traducción
En una respuesta correcta se devuelve la información siguiente.
Nombre | Escribir | Description |
---|---|---|
id |
string | Identificador de la operación. |
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 •Fracasado • NoStarted •Corriente •Tuvo éxito • ValidationFailed |
summary | StatusSummary | Resumen que contiene los detalles enumerados. |
summary.total | integer | Número total. |
summary.failed | integer | Recuento de elementos con errores. |
summary.success | integer | Número de elementos correctos. |
summary.inProgress | integer | Número de elementos en curso. |
summary.notYetStarted | integer | Recuento de operaciones no iniciadas aún. |
summary.cancelled | integer | Número de cancelaciones. |
summary.totalCharacterCharged | integer | Caracteres totales 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. |
Destino | string | Obtiene el origen del error. Por ejemplo, sería documents o document id para un documento inválido. |
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.
{
"id": "727bf148-f327-47a0-9481-abae6362f11e",
"createdDateTimeUtc": "2020-03-26T00:00:00Z",
"lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
"status": "Succeeded",
"summary": {
"total": 10,
"failed": 1,
"success": 9,
"inProgress": 0,
"notYetStarted": 0,
"cancelled": 0,
"totalCharacterCharged": 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.