Partilhar via

Obter o status de um documento específico

Funcionalidade de Referência
: Azure Translator → API de tradução
de documentos 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

Todos os pedidos de API para a funcionalidade de tradução de documentos requerem um endpoint de domínio personalizado localizado na sua página de visão geral de recursos no portal 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 Descrição
documentId Verdade O ID do documento.
id Verdade O ID do lote.

Localizando os id valores e documentId

  • Você pode encontrar o trabalho id no valor URL do cabeçalho start-batch-translation de resposta do método POSTOperation-Location. 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 Descrição
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 Descrição
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 Descrição
caminho cadeia (de caracteres) Localização do documento ou pasta.
sourcePath cadeia (de caracteres) Localização do documento de origem.
createdDateTimeUtc cadeia (de caracteres) Operação criada data hora.
lastActionDateTimeUtc cadeia (de caracteres) Data em que o status da operação foi atualizado.
estado Cordão Lista de possíveis status para trabalho ou documento:
• Cancelado
• Cancelamento
• Falhou
• NotStarted
• Corrida
• Bem sucedido
• ValidaçãoFalhou
para cadeia (de caracteres) 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 cadeia (de caracteres) ID do documento.
personagemCharged número inteiro Caracteres cobrados pela API.

Resposta de erro

Nome Tipo Descrição
código cadeia (de caracteres) Enums contendo códigos de erro de alto nível. Valores aceites:
• Erro-deServidor Interno
• ArgumentoInválido
• InválidoPedido
• SolicitaçãoTaxa Demasiado Alta
• ResourceNotFound
• ServiçoIndisponível
• Não autorizado
mensagem cadeia (de caracteres) Obtém mensagem de erro de alto nível.
erro interno InnerTranslationError Novo formato Inner Error que cumpre as Diretrizes da API do Foundry Tools. 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 cadeia (de caracteres) Obtém a cadeia de erro de código.
mensagemDeErroInterno cadeia (de caracteres) Obtém mensagem de erro de alto nível.
innerError.target cadeia (de caracteres) 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

  • Last updated on