Obter status para um trabalho de tradução específico

  • Artigo

Recurso de referência
: Azure AI Translator → Versão da API de Tradução de Documentos
: 2024-05-01
Método HTTP: GET

  • Use o get translation status método para solicitar o status de um trabalho de tradução específico. A resposta inclui o status geral do trabalho e o status dos documentos que estão sendo traduzidos como parte desse trabalho.

URL de solicitação

Importante

Todas as solicitações de API para o recurso de Tradução de Documento exigem um ponto de extremidade de domínio personalizado localizado na página de visão geral do recurso no portal do Azure.

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

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.

Localizando o valor id

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

Cabeçalho de resposta URL da Resposta
Operation-Location {document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01
  • Você também pode usar uma solicitação get-translations-status para recuperar uma lista de trabalhos de tradução e seus ids.

Cabeçalhos da solicitação

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

Cabeçalhos Descrição Condição
Ocp-Apim-Subscription-Key Sua chave de API do serviço Tradutor do portal do Azure. Obrigatório
Ocp-Apim-Subscription-Region A região em que o recurso foi criado. Necessário ao usar um recurso regional (geográfico) como o Oeste dos EUA.
&bullet.
Content-Type O tipo de conteúdo da carga. Os valores aceitos são application/json ou charset=UTF-8. Obrigató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 • Muitos pedidos
• Servidor temporariamente 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 status possíveis para trabalho ou documento:
• Cancelado
•Cancelar
•Falhou
• Não iniciado
•Executando
•Conseguiu
• Falha na validação
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:
• Erro de servidor interno
• 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. Esta mensagem de erro contém as propriedades necessárias ErrorCode, mensagem e propriedades opcionais target, details(par de valores-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