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

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

  • Мақала

Справочная функция: API перевода
документов в Azure Переводчик →: метод HTTP 2024-05-01
: GET

Внимание

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

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

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

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

Примечание.

Если сервер не может соблюдать $top и/или $skip, сервер должен вернуть ошибку клиенту, информируя об этом, а не просто игнорировать параметры запроса. Это снижает риск того, что клиент сделает предположения о возвращаемых данных.

  • $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операции:
Заголовок ответа URL-адрес ответа
Operation-Location {document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01

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

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

Параметр запроса In Обязательное поле Type Описание
id path Истина строка Идентификатор операции.
$maxpagesize query False целое число (int32) $maxpagesize — это максимальное количество элементов, возвращаемых на странице. Если дополнительные элементы запрашиваются через $top (или $top не указаны, и есть больше элементов, которые будут возвращены), @nextLink будет содержать ссылку на следующую страницу. Клиенты могут запрашивать страницы на основе сервера с определенным размером страницы, указав $maxpagesize предпочтения. Сервер ДОЛЖЕН учитывать этот параметр, если размер страницы меньше, чем размер по умолчанию на сервере.
$orderBy query False array Запрос сортировки коллекции (например, CreatedDateTimeUtc asc). CreatedDateTimeUtc desc
$skip query False целое число (int32) $skip указывает количество записей, пропускаемых в сохраняемом на сервере списке на основе указанного метода сортировки. По умолчанию сортировка выполняется по убыванию времени начала. Клиенты МОГУТ использовать параметры $top и запроса, чтобы указать количество возвращаемых результатов и $skip смещение в коллекцию. Когда клиент возвращает оба $top и $skip, сервер должен сначала применить $skip , а затем $top в коллекции. Если сервер не может соблюдать $top и /или $skip, сервер должен вернуть ошибку клиенту, информируя об этом, а не просто игнорировать параметры запроса.
$top query False целое число (int32) $top указывает общее количество записей, которые пользователь хочет вернуть на всех страницах. Клиенты могут использовать $top и $skip запрашивать параметры, чтобы указать количество возвращаемых результатов и смещение в коллекцию. Когда клиент возвращает оба $top и $skip, сервер должен сначала применить $skip , а затем $top в коллекции. Если сервер не может соблюдать $top и /или $skip, сервер должен вернуть ошибку клиенту, информируя об этом, а не просто игнорировать параметры запроса.
createdDateTimeUtcEnd query False строка (дата-время) Конечное значение даты и времени для получения элементов.
createdDateTimeUtcStart query False строка (дата-время) Начальное значение даты и времени для получения элементов.
ids query False array Идентификаторы, используемые при фильтрации.
Статусы query False array Состояния, используемые при фильтрации.

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

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

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

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

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

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

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

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

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

Имя. Тип Описание
@nextLink строка URL следующей страницы. Нулевое значение, если доступных страниц больше нет.
значение DocumentStatus [] Список сведений о состоянии отдельных документов.
value.path строка Расположение документа или папки.
value.sourcePath строка Расположение исходного документа.
value.createdDateTimeUtc строка Дата создания операции, время.
value.lastActionDateTimeUtc строка Время даты, в котором обновляется состояние операции.
value.status статус Список возможных статусов работы или документа.
• Отменено
•Отмена
•Сбой при
• NotStarted
•Запущена
•Удалось
• ValidationFailed
value.to строка К языку.
value.progress number Ход выполнения перевода (если доступно).
value.id строка Идентификатор документа.
value.characterCharged 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 если был недопустимый документ.

Примеры

Совет

Используйте этот метод, чтобы получить documentId параметр для строки запроса get-document-status .

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

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

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

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

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