Obter o status de todos os documentos

Funcionalidade de Referência
: Azure Translator → API de tradução
de documentos Versão: 2024-05-01
Método HTTP: GET

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

• $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 que o usuário deseja que sejam retornados 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 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.
  • Se o número de documentos na resposta exceder nosso limite de paginação, a paginação do lado do servidor será usada.
  • As 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 nenhuma outra página está disponível.

• $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) apenas retorna documentos bem-sucedidos e cancelados.
• Os createdDateTimeUtcStart parâmetros de consulta e createdDateTimeUtcEnd 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 ambos $top e $skip estão incluídos, o servidor deve primeiro aplicar $skip e, em seguida, $top na coleção.

URL do Pedido

Envie um pedido GET para:

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

Localizando o id valor

• Você pode encontrar o trabalho id no valor URL do cabeçalho start-batch-translation de resposta do método POSTOperation-Location. A cadeia alfanumérica que segue o /document/ parâmetro é o trabalho idda operação:

• 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 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 documentos

Resposta de status de documentos 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": [
    {
      "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 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.