Получение сведений о состоянии перевода

Метод получения состояния перевода возвращает статус запроса на перевод документа. Показатель состояния включает в себя общий статус запроса и статус документов, которые переводятся как часть данного запроса.

URL-адрес запроса

Отправьте запрос GET на следующий адрес.

GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.0/batches/{id}

Узнайте, как найти имя личного домена.

Важно!

  • Конечную точку личного домена необходимо указывать во всех запросах API к службе перевода документов.
  • Вы не можете использовать конечную точку, найденную в портал Azure ключах ресурсов и конечной точке глобального преобразователя, — для выполнения HTTP-запросов к преобразованию документов.

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

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

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

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

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

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

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

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

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

Получить ответ о статусе перевода

Успешный ответ на получение информации о статусе перевода

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

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

Сообщение об ошибке

Имя Тип Описание
code строка Перечисления с высокоуровневыми кодами ошибок. Возможные значения:
  • InternalServerError
  • InvalidArgument
  • InvalidRequest
  • RequestRateTooHigh
  • ResourceNotFound
  • ServiceUnavailable
  • Не авторизовано
message строка Получает сообщение об ошибке высокого уровня.
target строка Получает источник ошибки. К примеру, для недопустимого документа это будет «документы» или «идентификатор документа».
innerError InnerTranslationError Новый формат внутренней ошибки, соответствующий рекомендациям Cognitive Services API. Он содержит обязательные свойства ErrorCode и message, а также необязательные свойства target, details (пара "ключ-значение"), inner error (это свойство может быть вложенным).
innerError.code строка Получение строки с кодом ошибки.
innerError.message строка Получение высокоуровневого сообщения об ошибке.
innerError.target строка Получает источник ошибки. Например, в случае недействительного документа это будет "документы" или "идентификатор документа".

Примеры

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

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

{
  "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 для ответа с ошибкой. Схема для других кодов ошибок такая же.

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

{
  "error": {
    "code": "Unauthorized",
    "message": "User is not authorized",
    "target": "Document",
    "innerError": {
      "code": "Unauthorized",
      "message": "Operation is not authorized"
    }
  }
}

Дальнейшие действия

Чтобы узнать больше об использовании службы перевода документов и клиентской библиотеки, обратитесь к нашему краткому руководству.