Получение состояния для всех документов

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

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

• $top, $skipи $maxpagesize параметры запроса можно использовать для указания количества возвращаемых результатов и смещения для коллекции.

  • $top указывает общее количество записей, которые пользователь хочет вернуть на всех страницах.
  • $skip указывает количество записей, которые следует пропустить из списка состояния документа, удерживаемого сервером на основе указанного метода сортировки. По умолчанию записи сортируются по убыванию времени начала.
  • $maxpagesize — это максимальное количество элементов, возвращаемых на странице.
  • Если дополнительные элементы запрашиваются через $top (или $top не указаны, и есть больше элементов, которые будут возвращены), @nextLink будет содержать ссылку на следующую страницу.
  • Если количество документов в ответе превышает наш предел разбиения на страницы, используется разбиение на страницы на стороне сервера.
  • Ответы, разбитые на страницы, указывают на частичный результат и включают в ответ маркер продолжения. Отсутствие маркера продолжения означает, что дополнительные страницы недоступны.

• $orderBy Параметр запроса можно использовать для сортировки возвращаемого списка (например, $orderBy=createdDateTimeUtc asc или $orderBy=createdDateTimeUtc desc).
• Сортировка по умолчанию по убыванию createdDateTimeUtc. Некоторые параметры запроса можно использовать для фильтрации возвращаемого списка (например, status=Succeeded,Cancelledвозвращает только успешные и отмененные документы).
• Параметры createdDateTimeUtcStart запроса createdDateTimeUtcEnd можно использовать в сочетании или отдельно, чтобы указать диапазон даты и времени для фильтрации возвращаемого списка.
• Поддерживаются параметры запроса фильтрации (status, , idcreatedDateTimeUtcStartи createdDateTimeUtcEnd).
• $top Если оба и $skip включены, сервер должен сначала примениться$skip, а затем $top в коллекции.

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

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

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

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

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

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

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

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

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

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

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

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

Получить ответ о статусе документов

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

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

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

Примеры

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

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

{
  "value": [
    {
      "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
    }
  ],
  "@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/documents?$top=5&$skip=15"
}

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

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

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

{
  "error": {
    "code": "InternalServerError",
    "message": "Internal Server Error",
    "target": "Operation",
    "innerError": {
      "code": "InternalServerError",
      "message": "Unexpected internal server error has occurred"
    }
  }
}

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

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