Obter status da tradução

  • Artigo

Referência
Serviço: Tradução de documentos da IA do Azure
Versão da API: v1.1

O método Obter status da tradução retorna o status de uma solicitação de tradução de documento. O status inclui o status geral da solicitação e o status dos documentos que estão sendo traduzidos como parte dessa solicitação.

URL da solicitação

Envie uma solicitação GET para:

GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/{id}

Saiba como localizar seu nome de domínio personalizado.

Importante

  • Todas as solicitações de API ao serviço de Tradução de Documento exigem um ponto de extremidade de domínio personalizado.
  • Não é possível usar o ponto de extremidade encontrado na página Chaves e ponto de extremidade de recursos do portal do Azure nem o ponto de extremidade do tradutor global (api.cognitive.microsofttranslator.com) para fazer solicitações HTTP para a Tradução de Documento.

Parâmetros da solicitação

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

Parâmetro de consulta Obrigatório Descrição
id Verdadeiro A ID da operação.

Cabeçalhos da solicitação

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

Cabeçalhos Descrição
Ocp-Apim-Subscription-Key Cabeçalho de solicitação necessário

Códigos de status de resposta

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

Código de status Descrição
200 OK. Solicitação bem-sucedida e retorna o status da operação de tradução em lote. HeadersRetry-After: integerETag: string
401 Não autorizado. Verifique suas credenciais.
404 O recurso não foi encontrado.
500 Erro Interno do Servidor.
Outros códigos de status • Excesso de pedidos
• Servidor temporário indisponível

Resposta do método Obter status da tradução

Resposta bem-sucedida do método Obter status da tradução

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

Nome Tipo Descrição
id string Identificador da operação.
createdDateTimeUtc string Data e hora de criação da operação.
lastActionDateTimeUtc string Data e hora em que o status da operação foi atualizado.
status String Lista de possíveis status para trabalho ou documento:
• Cancelado
•Cancelar
•Falhou
• NãoIniciado
•Executando
•Conseguiu
• ValidaçãoFalhou
summary StatusSummary Resumo que contém os detalhes listados abaixo.
summary.total Número inteiro Contagem total.
summary.failed Número inteiro Contagem com falha.
summary.success Número inteiro Número de itens com êxito.
summary.inProgress Número inteiro Número de itens em andamento.
summary.notYetStarted Número inteiro Contagem de itens não iniciados.
summary.cancelled Número inteiro Número de itens cancelados.
summary.totalCharacterCharged Número inteiro Total de caracteres cobrados pela API.

Resposta de erro

Nome Tipo Descrição
code string Enumerações contendo códigos de erro de alto nível. Valores possíveis:
• InternalServerError
• Argumento Inválido
• Solicitação Inválida
• RequestRateTooHigh
• ResourceNotFound
• ServiçoIndisponível
•Desautorizado
message string Obtém uma mensagem de erro de alto nível.
destino string Obtém a fonte do erro. Por exemplo, seria documents ou document id para um documento inválido.
innerError InnerTranslationError Novo formato de erro interno, em conformidade com as Diretrizes da API dos serviços de IA do Azure. Essa mensagem de erro contém as propriedades necessárias ErrorCode, mensagem e destino de propriedades opcionais, detalhes (par de valores de chave), erro interno (pode ser aninhado).
innerError.code string Obtém a cadeia de caracteres de erro do código.
innerError.message string Obtém uma mensagem de erro de alto nível.
innerError.target string Obtém a fonte do erro. Por exemplo, seria documents ou document id para um documento inválido.

Exemplos

Exemplo de resposta bem-sucedida

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

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

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: 401

{
  "error": {
    "code": "Unauthorized",
    "message": "User is not authorized",
    "target": "Document",
    "innerError": {
      "code": "Unauthorized",
      "message": "Operation is not authorized"
    }
  }
}

Próximas etapas

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

Introdução à Tradução de Documento