Obter status de tradução

Artigo
02/21/2024

Serviço de Referência
: Azure AI Document
Translation API Versão: v1.1

O método Get translation status 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 do Pedido

Envie um pedido GET para:

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

Saiba como encontrar o seu nome de domínio personalizado.

Importante

Todas as solicitações de API para o serviço de Tradução de Documentos exigem um ponto de extremidade de domínio personalizado.
Você não pode 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 Documentos.

Parâmetros de solicitação

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

Parâmetro de consulta	Necessário	Description
`id`	True	O ID da operação.

Cabeçalhos do pedido

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

Cabeçalhos	Description
Ocp-Apim-Subscription-Key	Cabeçalho de solicitação obrigatório

Códigos de status de resposta

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

Código de Estado	Description
200	OK. Solicitação bem-sucedida e retorna o status da operação de tradução em lote. HeadersRetry-After: inteiroETag: string
401	Não autorizado. Verifique as suas credenciais.
404	O recurso não foi encontrado.
500	Erro interno do servidor.
Outros códigos de status	• Demasiados pedidos • Servidor temporariamente indisponível

Obter resposta ao estado da tradução

Resposta de status de tradução bem-sucedida

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

Nome	Tipo	Description
`id`	string	ID da operação.
createdDateTimeUtc	string	Operação criada data hora.
lastActionDateTimeUtc	string	Data em que o status da operação foi atualizado.
status	String	Lista de possíveis status para trabalho ou documento: • Cancelado • Cancelamento • Falhou • NotStarted • Corrida • Bem sucedido • ValidaçãoFalhou
Resumo	StatusSummary	Resumo contendo os detalhes listados.
sumário.total	integer	Contagem total.
resumo.falhou	integer	Falha na contagem.
sumário.sucesso	integer	Número de bem-sucedidos.
resumo.inProgress	integer	Número de em curso.
summary.notYetStarted	integer	Contagem de ainda não começou.
resumo.cancelado	integer	Número de cancelados.
summary.totalCharacterCharged	integer	Total de caracteres cobrados pela API.

Resposta de erro

Nome	Tipo	Description
code	string	Enums contendo códigos de erro de alto nível. Valores possíveis: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiçoIndisponível • Não autorizado
mensagem	string	Obtém mensagem de erro de alto nível.
destino	string	Obtém a origem do erro. Por exemplo, seria `documents` ou `document id` para um documento inválido.
innerError	InnerTranslationError	Novo formato de Erro Interno que está em conformidade com as Diretrizes da API de serviços de IA do Azure. Esta mensagem de erro contém propriedades necessárias ErrorCode, mensagem e propriedades opcionais de destino, detalhes (par de valores de chave), erro interno (pode ser aninhado).
innerError.code	string	Obtém a cadeia de erro de código.
innerError.message	string	Obtém mensagem de erro de alto nível.
innerError.target	string	Obtém a origem do erro. Por exemplo, seria `documents` ou `document id` para 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 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: 401

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

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.

Introdução à Tradução de Documentos

Share via