Partilhar via

Obter o status de um documento específico

  • Artigo

Recurso de referência
: Azure AI Translator → Document Translation
API Versão: 2024-05-01
Método HTTP: GET

Esse método retorna o status de um documento específico em um trabalho, id conforme indicado na solicitação pelos parâmetros e documentId consulta.

URL do Pedido

Importante

Todas as solicitações de API para o recurso Tradução de Documentos 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}/documents/{documentId}?api-version={date}"

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

Localizando os id valores e documentId

  • Você pode encontrar o trabalho id no valor URL do cabeçalho Operation-Location de resposta do método POSTstart-batch-translation. O último parâmetro da URL é o trabalho idda operação:
Cabeçalho da resposta URL do resultado
Operation-Location {document-translation-endpoint}/translator/document/batches/{id}?api-version={date}/ 9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec/

  • Você também pode usar uma solicitação de status de traduções GET para recuperar parâmetros de trabalho id para a cadeia de caracteres de consulta.

  • Você pode encontrar o documentId parâmetro na resposta do método get-documents-status.

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. Pedido bem sucedido aceite pelo serviço. Os detalhes da operação são retornados. HeadersRetry-After: inteiroETag: string
401 Não autorizado. Verifique as suas credenciais.
404 Não encontrado. O recurso não foi encontrado.
500 Erro interno do servidor.
Outros códigos de status • Demasiados pedidos
• Servidor temporariamente indisponível

Obter resposta de status do documento

Resposta de status do documento bem-sucedida

Nome Tipo Description
path string Localização do documento ou pasta.
sourcePath string Localização do documento de origem.
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
para string Código de idioma de duas letras de To Language. Consulte a lista de línguas.
Progresso Número Progresso da tradução, se disponível
id string ID do documento.
personagemCharged integer 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.
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 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 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