Obter o status de um documento 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

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

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}/documents/{documentId}?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
documentId Verdadeiro A ID do documento.
id Verdadeiro A ID do lote.

Localizando os id valores e documentId

  • Você pode encontrar o trabalho id no valor da URL Operation-Location do cabeçalho de resposta start-batch-translation do método POST. O último parâmetro da URL é o trabalho da operação id :
Cabeçalho de 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 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 • Muitos pedidos
• Servidor temporariamente 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 status possíveis para trabalho ou documento:
• Cancelado
•Cancelar
•Falhou
• Não iniciado
•Executando
•Conseguiu
• Falha na validação
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:
• 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.
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.

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