Obter status de todos os documentos

Recurso de Referência
: Tradução do Azure → Versão da API de Tradução
de Documento: método HTTP 2024-05-01
: GET

• Use o get documents status método para solicitar o status de todos os documentos em um trabalho de tradução.

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

  • $top indica o número total de registros que o usuário deseja retornar em todas as páginas.
  • $skip indica o número de registros a serem ignorados da lista de status do documento mantida pelo servidor 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 por meio de $top (ou se $top não for especificado e houver mais itens a serem retornados), @nextLink conterá o link para a próxima página.
  • Se o número de documentos na resposta ultrapassar nosso limite de paginação, a paginação do servidor será usada.
  • Respostas paginadas indicam um resultado parcial e incluem um token de continuação na resposta. A ausência de um token de continuação significa que não há nenhuma página adicional disponível.

• $orderBy query pode ser usado para classificar a lista retornada (ex: $orderBy=createdDateTimeUtc asc ou $orderBy=createdDateTimeUtc desc).
• A classificação padrão é decrescente em createdDateTimeUtc. Alguns parâmetros de consulta podem ser usados para filtrar a lista retornada (ex: status=Succeeded,Cancelled) retorna apenas documentos bem-sucedidos e cancelados.
• Os createdDateTimeUtcStart parâmetros e createdDateTimeUtcEnd consulta podem ser combinados ou usados separadamente para especificar um intervalo de datetime para filtrar a lista retornada.
• Os parâmetros de consulta de filtragem suportados são (status, id, createdDateTimeUtcStarte createdDateTimeUtcEnd).
• Quando $top e $skip estão incluídos, o servidor deve primeiro aplicar $skip e, depois, $top à coleção.

URL da solicitação

Envie uma solicitação GET para:

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

Localizando o valor id

• Você pode encontrar o trabalho id no valor da URL start-batch-translation do cabeçalho de resposta Operation-Location do método POST. A cadeia de caracteres alfanumérica seguindo o parâmetro /document/ é o trabalho da operaçãoid:

• Você também pode usar uma solicitação get-translations-status para recuperar uma lista de trabalhos de tradução e seus ids.

Parâmetros da solicitação

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

Cabeçalhos da solicitação

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

Códigos de status de resposta

Veja a seguir os possíveis códigos de status HTTP retornados por uma solicitação.

Resposta de Obter status do documento

Resposta bem-sucedida de Obter status do documento

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

Exemplo de resposta com erro

O objeto JSON a seguir é um exemplo de uma resposta com erro. O esquema dos 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óximas etapas

Siga nosso início rápido para saber mais sobre como usar a tradução de documento e a biblioteca de clientes.