Cancelar tradução

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

• Esse método cancela um trabalho de conversão que está sendo processado id ou enfileirado (pendente), conforme indicado na solicitação pelo parâmetro de consulta.
• Uma operação não será cancelada se já tiver sido concluída, falhada ou ainda estiver sendo cancelada. Nesses casos, uma solicitação ruim é devolvida.
• As traduções concluídas não podem ser canceladas e são cobradas.

URL de solicitação

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 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
id	Verdadeiro	A ID da operação.

Localizando o valor id

Você pode encontrar o trabalho id no valor URL de 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 de resposta	URL de resposta
Operation-Location	{document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01

• Você também pode usar uma solicitação get-translations-status para recuperar uma lista de trabalhos de tradução e seus ids.

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. Cancelar solicitação enviada
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

Cancelar resposta de tradução

Resposta bem-sucedida

As informações a seguir são retornadas em uma resposta bem-sucedida.

Nome	Tipo	Descrição
id	string	Identificador da operação.
createdDateTimeUtc	string	Data e hora de criação da operação.
lastActionDateTimeUtc	string	Data e hora em que o status da operação é atualizado.
status	String	Lista de possíveis status para trabalho ou documento: • Cancelado •Cancelar •Falhou • NãoIniciado •Executando •Conseguiu • ValidaçãoFalhou
summary	StatusSummary	Resumo que contém uma lista de detalhes.
summary.total	Número inteiro	Número total de documentos.
summary.failed	Número inteiro	Número de documentos com falha.
summary.success	Número inteiro	Número de documentos traduzidos com sucesso.
summary.inProgress	Número inteiro	Número de documentos em andamento.
summary.notYetStarted	Número inteiro	Número de documentos cujo processamento ainda não começou.
summary.cancelled	Número inteiro	Número de itens cancelados.
summary.totalCharacterCharged	Número inteiro	Total de 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.
destino	string	Obtém a fonte do erro. Por exemplo, seria "documents" ou document id para um documento inválido.
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 obrigatórias ErrorCode e message, bem como as propriedades opcionais target, details (par chave-valor) e innerError (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 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 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: 500

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

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