Obter status do documento

  • Artigo

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

O método Obter status do documento retorna o status de um documento específico. O método retorna o status da tradução de um documento específico com base na ID da solicitação e na ID do documento.

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}/documents/{documentId}

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
documentId True A ID do documento.
id Verdadeiro A ID do lote.

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 aceita pelo serviço. Os detalhes da operação são retornados. HeadersRetry-After: integerETag: string
401 Não autorizado. Verifique suas credenciais.
404 Não encontrado. 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 de obter status do documento

Resposta de obter status do documento bem-sucedida

Nome Tipo Descrição
caminho string Localização do documento ou da pasta.
sourcePath string Localização do documento de origem.
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
até string Código de idioma de duas letras do idioma de destino. Veja a lista de idiomas.
progress número Progresso da tradução, se disponível
id string ID do documento.
characterCharged Número inteiro 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.
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.

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

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