Поделиться через

Отмена перевода

  • Статья

Справочная
функция: azure AI Translator → ВЕРСИЯ API перевода
документов: 2024-05-01
HTTP: DELETE

  • Этот метод отменяет задание перевода, которое в настоящее время обрабатывает или в очереди (ожидается), как указано в запросе параметром id запроса.
  • Операция не отменяется, если она уже завершена, не выполнена или по-прежнему отменена. В этих случаях возвращается неправильный запрос.
  • Завершенные переводы не могут быть отменены и взиматься плата.

Запросить URL-адрес

Внимание

Для всех запросов API к функции перевода документов требуется конечная точка личного домена, расположенная на странице обзора ресурсов в портал Azure.

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

Параметры запроса

В таблице ниже приведены параметры, которые передаются в строке запроса.

Параметр запроса Обязательное поле Описание
id Истина Идентификатор операции.

Поиск значения id

Задание можно найти в значении id URL-адреса url-адреса заголовка Operation-Location ответа метода POSTstart-batch-translation. Буквенно-цифровой строкой, следующей за /document/ параметром, является задание idоперации:

Заголовок ответа URL-адрес ответа
Operation-Location {document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01

Заголовки запросов

Заголовки запроса.

Заголовки Description
Ocp-Apim-Subscription-Key Обязательный заголовок запроса

Коды состояния ответа

Ниже приведены возможные коды состояния HTTP, которые возвращает запрос.

Код состояния Description
200 ОК. Отмена отправленного запроса
401 Не авторизовано. Проверьте свои учетные данные.
404 Не найдено. Ресурс не найден.
500 Внутренняя ошибка сервера.
Другие коды состояния • Слишком много запросов
• Временный сервер недоступен

Отменить ответ на перевод

Успешный ответ

В успешном ответе возвращается следующая информация.

Имя. Тип Описание:
id строка Идентификатор операции.
createdDateTimeUtc строка Дата создания операции, время.
lastActionDateTimeUtc строка Время даты, в котором обновляется состояние операции.
статус Строка Список возможных состояний задания или документа: • Отменено
•Отмена
•Неудавшийся
• NotStarted
•Бег
•Удалось
• ValidationFailed
Итоги StatusSummary Сводка, содержащая список сведений.
summary.total integer Подсчет общего количества документов.
summary.failed integer Счетчик документов не прошел.
summary.success integer Количество успешно переведенных документов.
summary.inProgress integer Количество документов в работе.
summary.notYetStarted integer Количество документов, обработка которых еще не началась.
summary.cancelled integer Количество отмененных документов.
summary.totalCharacterCharged integer Общее количество символов, взимаемых API.

Отклик в случае ошибки

Имя. Тип Описание
кодом строка Перечисления, содержащие коды ошибок высокого уровня. Возможные значения:
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• ServiceUnavailable
•Несанкционированный
message строка Получает сообщение об ошибке высокого уровня.
целевой объект строка Получает источник ошибки. Например, это будет "документы" или document id недопустимый документ.
innerError InnerTranslationError Новый формат внутренней ошибки, соответствующий рекомендациям ПО API служб искусственного интеллекта Azure. Это сообщение об ошибке содержит обязательные свойства ErrorCode, message и необязательные свойства, сведения (пара "значение ключа"), внутреннюю ошибку (ее можно вложить).
innerError.code строка Получает строку с ошибкой кода.
innerError.message строка Получает сообщение об ошибке высокого уровня.
innerError.target строка Получает источник ошибки. Например, это будет documents или document id если был недопустимый документ.

Примеры

Пример успешного ответа

Следующий объект JSON является примером успешного ответа.

Код состояния: 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
  }
}

Пример ответа с ошибкой

Следующий объект JSON является примером ответа с ошибкой. Схема для других кодов ошибок такая же.

Код состояния: 500

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

Следующие шаги

Воспользуйтесь информацией, приведенной в данном кратком руководстве, чтобы узнать больше об использовании перевода документов и клиентской библиотеки.

Начало работы с функцией перевода документов