Compartir vía

Obtener el estado de todos los trabajos de traducción

  • Artículo

Característica de referencia
: Azure AI Translator → versión de Document Translation
API: 2024-05-01
MÉTODO HTTP: GET

  • Use el get translations status método para solicitar una lista y el estado de todos los trabajos de traducción enviados por el usuario (asociado al recurso).

  • $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 indica el número total de registros que se van a devolver en todas las páginas.
    • $skip indica el número de registros que se omitirán de la lista de lotes según el 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.
    • El servidor respeta los valores especificados por el cliente. Sin embargo, los clientes deben estar preparados para controlar las respuestas que contienen un tamaño de página diferente o que contienen un token de continuación.
    • Cuando se incluyen y $top $skip , el servidor se aplicará $skip primero y, a continuación $top , en la colección.

Nota:

Si el servidor no puede cumplir $top y/o $skip, debe devolver un error al cliente informando de ello en lugar de limitarse a ignorar las opciones de consulta. Esto reduce el riesgo de que el cliente realice suposiciones sobre los datos devueltos.

  • $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) devuelve operaciones correctas y canceladas.
    • Los createdDateTimeUtcStart parámetros de consulta y createdDateTimeUtcEnd se pueden usar combinados o 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).

URL de la solicitud

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

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.

Parámetros de solicitud

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

Parámetro de consulta En Obligatorio Type Descripción
$maxpagesize Query Falso integer int32 $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. Los clientes PUEDEN solicitar la paginación dirigida por el servidor con un tamaño de página específico especificando una preferencia $maxpagesize. El servidor DEBE respetar esta preferencia si el tamaño de página especificado es menor que el tamaño de página predeterminado del servidor.
$orderBy query Falso array La consulta de ordenación de la colección (ej: CreatedDateTimeUtc asc, CreatedDateTimeUtc desc)
$skip query Falso integer int32 $skip indica el número de registros que se omitirán de la lista de registros mantenida por el servidor según el método de ordenación especificado. De manera predeterminada, se ordena por hora de inicio descendente. Los clientes PUEDEN utilizar los parámetros de consulta $top y $skip para especificar el número de resultados a devolver y un desplazamiento dentro de la colección. Cuando el cliente proporciona ambos $top y $skip, el servidor DEBE aplicar primero $skip y, a continuación, $top en la colección. Nota: Si el servidor no puede respetar $top y/o $skip, el servidor DEBE devolver un error al cliente que informe al respecto en lugar de simplemente omitir las opciones de consulta.
$top query Falso integer int32 $top iIndica el número total de registros que el usuario quiere que se devuelvan en todas las páginas. Los clientes PUEDEN utilizar los parámetros de consulta $top y $skip para especificar el número de resultados a devolver y un desplazamiento dentro de la colección. Cuando el cliente proporciona ambos $top y $skip, el servidor DEBE aplicar primero $skip y, a continuación, $top en la colección. Nota: Si el servidor no puede respetar $top y/o $skip, el servidor DEBE devolver un error al cliente que informe al respecto en lugar de simplemente omitir las opciones de consulta.
createdDateTimeUtcEnd query Falso string date-time Fecha y hora de finalización para obtener los elementos anteriores.
createdDateTimeUtcStart query Falso string date-time Fecha y hora de inicio después de la cual se obtienen los elementos.
ids query Falso array Los ID que se usarán en el filtrado.
statuses query Falso array Estados que se usarán en el filtrado.

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 todas las operaciones. HeadersRetry-After: integerETag: string
400 Solicitud incorrecta. Solicitud no válida. Compruebe los parámetros de entrada.
401 No autorizado. Compruebe sus credenciales.
500 Error interno del servidor.
Otros códigos de estado • Demasiadas solicitudes
• Servidor temporal no disponible

Respuesta de obtención del estado de las traducciones

Respuesta correcta de obtención del estado de las traducciones

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

Nombre Escribir Descripción
@nextLink string Dirección URL de la página siguiente Valor NULL si no hay más páginas disponibles
value TranslationStatus[] TranslationStatus[] Matriz
value.id string Identificador de la operación.
value.createdDateTimeUtc string Fecha y hora de creación de la operación.
value.lastActionDateTimeUtc string Fecha y hora en la que se actualizó el estado de la operación.
value.status String Lista de posibles estados del trabajo o documento:
• Cancelado
•Cancelar
•Fracasado
• NoStarted
•Corriente
•Tuvo éxito
• ValidationFailed
value.summary StatusSummary[] Resumen que contiene los detalles enumerados.
value.summary.total integer Recuento total de documentos.
value.summary.failed integer Recuento de documentos con errores.
value.summary.success integer Recuento de documentos traducidos correctamente.
value.summary.inProgress integer Recuento de documentos en curso.
value.summary.notYetStarted integer Recuento de documentos que aún no se han empezado a procesar.
value.summary.cancelled integer Recuento de documentos cancelados.
value.summary.totalCharacterCharged integer Recuento total de caracteres cargados.

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 si hubiera un documento inválido.
innerError InnerTranslationError Nuevo formato de error interno, que cumple las directrices de la API de los servicios de Azure AI. Contiene las propiedades requeridas ErrorCode, mensaje y las propiedades opcionales de destino, detalles (par clave-valor), error interno (puede estar anidado).
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 si hubiera un documento inválido.

Ejemplos

Sugerencia

Puede usar este método para recuperar el parámetro de trabajo id de la cadena de consulta get-translation-status .

Ejemplo de respuesta correcta

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

{
    "value": [
        {
            "id": "36724748-f7a0-4db7-b7fd-f041ddc75033",
            "createdDateTimeUtc": "2021-06-18T03:35:30.153374Z",
            "lastActionDateTimeUtc": "2021-06-18T03:36:44.6155316Z",
            "status": "Succeeded",
            "summary": {
                "total": 3,
                "failed": 2,
                "success": 1,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 0
            }
        },
        {
            "id": "1c7399a7-6913-4f20-bb43-e2fe2ba1a67d",
            "createdDateTimeUtc": "2021-05-24T17:57:43.8356624Z",
            "lastActionDateTimeUtc": "2021-05-24T17:57:47.128391Z",
            "status": "Failed",
            "summary": {
                "total": 1,
                "failed": 1,
                "success": 0,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 0
            }
        },
        {
            "id": "daa2a646-4237-4f5f-9a48-d515c2d9af3c",
            "createdDateTimeUtc": "2021-04-14T19:49:26.988272Z",
            "lastActionDateTimeUtc": "2021-04-14T19:49:43.9818634Z",
            "status": "Succeeded",
            "summary": {
                "total": 2,
                "failed": 0,
                "success": 2,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 21899
            }
        }
    ],
    ""@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operations/727BF148-F327-47A0-9481-ABAE6362F11E/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 Traducción de documentos y la biblioteca cliente.

Introducción a la traducción de documentos