Obter status para todos os trabalhos de tradução

Recurso de referência
: Azure AI Translator → Document Translation
API Versão: 2024-05-01
Método HTTP: GET

• Use o get translations status método para solicitar uma lista e o status de todos os trabalhos de tradução enviados pelo usuário (associado ao recurso).

• $top, $skipe $maxpagesize os parâmetros de consulta podem ser usados para especificar o número de resultados a serem retornados e um deslocamento para a coleção.

  • $top Indica o número total de registros a serem retornados em todas as páginas.
  • $skip Indica o número de registros a serem ignorados da lista de lotes com base no método de classificação especificado. Por padrão, os registros são classificados por hora de início decrescente.
  • $maxpagesize é o máximo de itens retornados em uma página.
  • Se mais itens forem solicitados via $top (ou $top não for especificado e houver mais itens a serem devolvidos), @nextLink conterá o link para a próxima página.
  • O servidor honra os valores especificados pelo cliente. No entanto, os clientes devem estar preparados para lidar com respostas que contenham um tamanho de página diferente ou um token de continuação.
  • Quando ambos $top forem $skip incluídos, o servidor primeiro se aplicará $skip e, em seguida $top , na coleção.

• $orderBy O parâmetro query pode ser usado para classificar a lista retornada (ex: $orderBy=createdDateTimeUtc asc ou $orderBy=createdDateTimeUtc desc).
  • A classificação padrão é decrescente por createdDateTimeUtc. Alguns parâmetros de consulta podem ser usados para filtrar a lista retornada (ex: status=Succeeded,Cancelled) retorna operações bem-sucedidas e canceladas.
  • Os createdDateTimeUtcStart parâmetros de consulta e createdDateTimeUtcEnd podem ser usados combinados ou separadamente para especificar um intervalo de data/hora para filtrar a lista retornada.
  • Os parâmetros de consulta de filtragem suportados são (status, id, createdDateTimeUtcStarte createdDateTimeUtcEnd).

URL do Pedido

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

Parâmetros de solicitação

Os parâmetros de solicitação passados na cadeia de caracteres de consulta são:

Cabeçalhos do pedido

Os cabeçalhos de solicitação são:

Códigos de status de resposta

A seguir estão os possíveis códigos de status HTTP que uma solicitação retorna.

Obter resposta de status de traduções

Resposta de status de traduções bem-sucedida

As informações a seguir são retornadas em uma resposta bem-sucedida.

Resposta de erro

Exemplos

Exemplo de resposta bem-sucedida

O objeto JSON a seguir é um exemplo de uma resposta bem-sucedida.

{
    "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"
}

Exemplo de resposta de erro

O objeto JSON a seguir é um exemplo de uma resposta de erro. O esquema para outros códigos de erro é o mesmo.

Código de status: 500

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

Próximos passos

Siga nosso guia de início rápido para saber mais sobre como usar a Tradução de Documentos e a biblioteca do cliente.