Cancelar tradução

  • Artigo

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

  • Esse método cancela um trabalho de tradução que está atualmente em processamento ou em fila (pendente), conforme indicado na solicitação pelo id parâmetro query.
  • Uma operação não será cancelada se já tiver sido concluída, tiver falhado ou ainda estiver cancelando. Nesses casos, uma solicitação incorreta é devolvida.
  • As traduções concluídas não podem ser canceladas e são cobradas.

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  DELETE "{document-translation-endpoint}/translator/document/batches/{id}?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
id True O ID da operação.

Localizando o id valor

Você pode encontrar o trabalho id no valor URL do cabeçalho Operation-Location de resposta do método POSTstart-batch-translation. A cadeia alfanumérica que segue o /document/ parâmetro é o trabalho idda operação:

Cabeçalho da resposta URL de resposta
Local de Operação {document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01

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. Cancelar pedido enviado
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

Cancelar resposta de tradução

Resposta com êxito

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 é atualizado.
status String Lista de possíveis status para trabalho ou documento: • Cancelado
• Cancelamento
• Falhou
• NotStarted
• Corrida
• Bem sucedido
• ValidaçãoFalhou
Resumo StatusSummary Resumo com uma lista de pormenores.
sumário.total integer Contagem do total de documentos.
resumo.falhou integer Falha na contagem de documentos.
sumário.sucesso integer Contagem de documentos traduzidos com sucesso.
resumo.inProgress integer Contagem de documentos em curso.
summary.notYetStarted integer Contagem de documentos ainda não iniciados no processamento.
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 "documentos" 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 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 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 se houvesse um documento inválido.

Exemplos

Exemplo de resposta bem-sucedida

O objeto JSON a seguir é um exemplo de uma resposta bem-sucedida.

Código de status: 200

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

{
  "error": {
    "code": "InternalServerError",
    "message": "Internal Server Error",
    "target": "Operation",
    "innerError": {
      "code": "InternalServerError",
      "message": "Unexpected internal server error has occurred"
    }
  }
}

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