Бөлісу құралы:

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

  • Мақала

Справочная функция: API перевода
документов в Azure Переводчик →: метод 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-адреса заголовка 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 Ключ API службы Переводчик из портал Azure. Обязательное поле
Ocp-Apim-Subscription-Region Регион, в котором был создан ресурс. • Требуется при использовании регионального (географического) ресурса, например западной части США.
&маркер.
Content-Type Тип содержимого для полезных данных. Допустимые значения: application/json или charset=UTF-8. • Требуется

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

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

Код состояния Description
200 ОК. Успешный запрос и возвращает статус операции пакетного перевода. HeadersRetry-After: integerETag: строка
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 строка Получает сообщение об ошибке высокого уровня.
целевой объект строка Получает источник ошибки. Например, это будет documents или document id для недопустимого документа.
innerError InnerTranslationError Новый формат внутренней ошибки, соответствующий рекомендациям ПО API служб искусственного интеллекта Azure. Это сообщение об ошибке содержит обязательные свойства ErrorCode, message и необязательные свойства, сведения (пара "значение ключа"), внутреннюю ошибку (ее можно вложить).
innerError.code строка Получает строку с ошибкой кода.
innerError.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"
    }
  }
}

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

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

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