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

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

  • get translation status Используйте метод для запроса состояния определенного задания перевода. Ответ включает общее состояние задания и состояние документов, которые переводятся в рамках этого задания.

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

Внимание

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

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

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

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

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

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

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

Заголовок ответа URL-адрес ответа
Операция-Местоположение {document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01
  • Вы также можете использовать запрос на получение списка заданий переводаи их idсостояний.

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

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

Заголовки Описание Условие
Ocp-Apim-Subscription-Key Ключ API переводчика на портале Azure. Обязательный
Ocp-Apim-Subscription-Region Регион, в котором был создан ресурс. Требуется при использовании регионального (географического) ресурса, например западной части США.
&маркер.
Тип содержимого Тип содержимого для полезных данных. Допустимые значения: application/json или charset=UTF-8. Обязательный

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

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

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

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

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

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

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

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

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

Примеры

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

Следующий объект 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"
    }
  }
}

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

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

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

  • Last updated on