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

  • Статья

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

Этот метод возвращает состояние определенного документа в задании, как указано в запросе параметрами запроса id и documentId запроса.

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

Внимание

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

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

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

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

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

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

  • Задание можно найти в значении id URL-адреса url-адреса заголовка Operation-Location ответа метода POSTstart-batch-translation. Последний параметр URL-адреса — это задание операции id.
Заголовок ответа URL-адрес результата
Operation-Location {document-translation-endpoint}/translator/document/batches/{id}?api-version={date}/ 9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec/

  • Вы также можете использовать запрос состояния перевода GET для получения параметров задания id для строки запроса.

  • Параметр можно найти в ответе documentId метода get-documents-status.

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

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

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

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

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

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

Ответ на получение состояния документа

Ответ на успешное получение состояния документа

Имя. Тип Описание
path строка Расположение документа или папки.
sourcePath строка Расположение исходного документа.
createdDateTimeUtc строка Дата создания операции, время.
lastActionDateTimeUtc строка Время даты, в течение которого была обновлена состояние операции.
статус Строка Список возможных состояний для задания или документа:
• Отменено
•Отмена
•Неудавшийся
• NotStarted
•Бег
•Удалось
• ValidationFailed
до строка Двухбуквенный код целевого языка. См. список языков.
Ход выполнения number Ход выполнения перевода (если доступно).
id строка Идентификатор документа.
characterCharged integer Символы заряжены API.

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

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

Примеры

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

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

{
  "path": "https://myblob.blob.core.windows.net/destinationContainer/fr/mydoc.txt",
  "sourcePath": "https://myblob.blob.core.windows.net/sourceContainer/fr/mydoc.txt",
  "createdDateTimeUtc": "2020-03-26T00:00:00Z",
  "lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
  "status": "Running",
  "to": "fr",
  "progress": 0.1,
  "id": "273622bd-835c-4946-9798-fd8f19f6bbf2",
  "characterCharged": 0
}

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

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

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

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

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

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

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