Отмена перевода
Справочная служба: версия API перевода документов ВИ Azure: версия 1.1
Отмена текущей операции обработки или очереди. Операция не отменяется при завершении, сбое или отмене. Возвращается неправильный запрос. Завершенные переводы не отменяются и взимается плата. Если это возможно, все ожидающие переводы отменяются.
Запросить URL-адрес
Отправьте запрос DELETE
на следующий адрес.
https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/{id}
Узнайте, как найти свое личное доменное имя.
Внимание
- Конечную точку личного домена необходимо указывать во всех запросах API к службе перевода документов.
- Вы не можете использовать конечную точку, найденную на странице ключей и конечной точки ресурса портала Azure, или глобальную конечную точку переводчика—
api.cognitive.microsofttranslator.com
—для выполнения HTTP-запросов к переводу документов.
Параметры запроса
В таблице ниже приведены параметры, которые передаются в строке запроса.
Параметр запроса | Обязательное поле | Описание |
---|---|---|
id |
Истина | Идентификатор операции. |
Заголовки запросов
Заголовки запроса.
Заголовки | 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"
}
}
}
Следующие шаги
Воспользуйтесь информацией, приведенной в данном кратком руководстве, чтобы узнать больше об использовании перевода документов и клиентской библиотеки.