Cancelación de la traducción

Característica de referencia
: Azure AI Translator → versión de Document Translation
API: 2024-05-01
MÉTODO HTTP: DELETE

• Este método cancela un trabajo de traducción que está procesando o en cola (pendiente) como se indica en la solicitud por el parámetro de id consulta.
• No se cancela una operación si ya se ha completado, se ha producido un error o se sigue cancelando. En esos casos, se devuelve una solicitud incorrecta.
• Las traducciones completadas no se pueden cancelar y se cobran.

URL de la solicitud

Importante

Todas las solicitudes de API a la característica de traducción de documentos requieren un punto de conexión de dominio personalizado que se encuentra en la página de información general del recurso en Azure Portal.

  curl -i -X  DELETE "{document-translation-endpoint}/translator/document/batches/{id}?api-version={date}"

Parámetros de solicitud

Los parámetros de solicitud que se pasaron en la cadena de consulta son:

Parámetro de consulta	Obligatorio	Descripción
id	True	Identificador de la operación.

Búsqueda del valor de id

Puede encontrar el valor de id del trabajo en el valor de la dirección URL Operation-Location del encabezado de respuesta del método POST start-batch-translation. La cadena alfanumérica que sigue al parámetro /document/ es el trabajo de la operación id:

Encabezado de respuesta	Dirección URL de respuesta
Operation-Location	{document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01

• También puede usar una solicitud get-translations-status para recuperar una lista de trabajos de traducción y sus id.

Encabezados de solicitud

Los encabezados de solicitud son:

encabezados	Descripción
Ocp-Apim-Subscription-Key	Encabezado de solicitud obligatorio

Códigos de estado de respuesta

A continuación se indican los códigos de estado HTTP posibles que devuelve una solicitud.

Código de estado	Descripción
200	Aceptar. Cancelación de la solicitud enviada
401	No autorizado. Compruebe sus credenciales.
404	Not found. No se encuentra el recurso.
500	Error interno del servidor.
Otros códigos de estado	• Demasiadas solicitudes • Servidor temporal no disponible

Respuesta de cancelación de la traducción

Respuesta correcta

En una respuesta correcta se devuelve la información siguiente.

Nombre	Escribir	Description
id	string	Identificador de la operación.
createdDateTimeUtc	string	Fecha y hora de creación de la operación.
lastActionDateTimeUtc	string	Fecha y hora en la que se actualiza el estado de la operación.
status	Cadena	Lista de posibles estados para el trabajo o documento: • Cancelado •Cancelar •Fracasado • NoStarted •Corriente •Tuvo éxito • ValidationFailed
summary	StatusSummary	Resumen que contiene una lista de detalles.
summary.total	integer	Recuento total de documentos.
summary.failed	integer	Recuento de documentos con errores.
summary.success	integer	Recuento de documentos traducidos correctamente.
summary.inProgress	integer	Recuento de documentos en curso.
summary.notYetStarted	integer	Recuento de documentos que aún no se han empezado a procesar.
summary.cancelled	integer	Número de cancelaciones.
summary.totalCharacterCharged	integer	Caracteres totales cargados por la API.

Respuesta de error

Nombre	Escribir	Descripción
código	string	Enumeraciones que contiene códigos de error de alto nivel. Valores posibles: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •Desautorizado
message	string	Obtiene un mensaje de error de alto nivel.
Destino	string	Obtiene el origen del error. Por ejemplo, sería "documentos" o document id para un documento inválido.
innerError	InnerTranslationError	Nuevo formato de error interno, que cumple las directrices de la API de los servicios de Azure AI. Contiene las propiedades requeridas ErrorCode, mensaje y las propiedades opcionales de destino, detalles (par clave-valor), error interno (puede estar anidado).
innerError.code	string	Obtiene la cadena de error de código.
innerError.message	string	Obtiene un mensaje de error de alto nivel.
innerError.target	string	Obtiene el origen del error. Por ejemplo, sería documents o document id si hubiera un documento inválido.

Ejemplos

Ejemplo de respuesta correcta

El siguiente objeto JSON es un ejemplo de una respuesta correcta.

Código de estado: 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
  }
}

Ejemplo de respuesta con error

El siguiente objeto JSON es un ejemplo de una respuesta con error. El esquema de otros códigos de error es el mismo.

Código de estado: 500

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

Pasos siguientes

Siga nuestro inicio rápido para obtener más información sobre el uso de Traducción de documentos y la biblioteca cliente.

Introducción a la traducción de documentos