Получение сведений о состоянии переводов
Справочная служба: версия API перевода документов ВИ Azure: версия 1.1
Метод получения сведений о состоянии перевода возвращает список отправленных пакетных запросов и состояние каждого запроса. Этот список содержит только пакетные запросы, отправленные пользователем (на основе ресурса).
Если количество запросов превышает ограничение на размер страницы, используется разбиение на страницы на стороне сервера. Ответы, разбитые на страницы, указывают на частичный результат и включают в ответ маркер продолжения. Отсутствие маркера продолжения означает, что дополнительные страницы недоступны.
$top, $skipи $maxpagesize параметры запроса можно использовать для указания количества возвращаемых результатов и смещения для коллекции.
$top указывает общее количество записей, которые пользователь хочет вернуть на всех страницах. $skip указывает количество записей, которые следует пропустить из списка пакетов на основе указанного метода сортировки. По умолчанию сортировка выполняется по убыванию времени начала. $maxpagesize — это максимальное количество элементов, возвращаемых на странице. Если дополнительные элементы запрашиваются через $top (или $top не указаны, и есть больше элементов, которые будут возвращены), @nextLink будет содержать ссылку на следующую страницу.
Параметр запроса $orderBy можно использовать для сортировки возвращаемого списка (например, "$orderBy=createdDateTimeUtc asc" или "$orderBy=createdDateTimeUtc desc"). По умолчанию сортировка выполняется по убыванию значения createdDateTimeUtc. Некоторые параметры запроса можно использовать для фильтрации возвращаемого списка (например, "status=Succeeded,Canceled"), возвращаемых успешно и отмененных операций. Параметры createdDateTimeUtcStart и createdDateTimeUtcEnd можно использовать вместе или по отдельности, чтобы задать диапазон значений даты и времени для фильтрации возвращаемого списка. Поддерживаемые параметры запроса фильтрации: status, ID, createdDateTimeUtcStart, createdDateTimeUtcEnd.
Сервер соблюдает значения, указанные клиентом. Однако клиенты должны быть готовы обрабатывать ответы, содержащие другой размер страницы или токен продолжения.
$top Если оба и $skip включены, сервер должен сначала примениться$skip, а затем $top в коллекции.
Примечание.
Если сервер не может соблюдать $top и/или $skip, сервер должен вернуть ошибку клиенту, информируя об этом, а не просто игнорировать параметры запроса. Это снижает риск того, что клиент сделает предположения о возвращаемых данных.
Запросить URL-адрес
Отправьте запрос GET на следующий адрес.
GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/batches
Узнайте, как найти свое личное доменное имя.
Внимание
- Конечную точку личного домена необходимо указывать во всех запросах API к службе перевода документов.
- Вы не можете использовать конечную точку, найденную на странице ключей и конечной точки ресурса портала Azure, или глобальную конечную точку переводчика—
api.cognitive.microsofttranslator.com—для выполнения HTTP-запросов к переводу документов.
Параметры запроса
В таблице ниже приведены параметры, которые передаются в строке запроса.
| Параметр запроса | In | Обязательное поле | Type | Описание |
|---|---|---|---|---|
$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 | Обязательный заголовок запроса |
Коды состояния ответа
Ниже приведены возможные коды состояния HTTP, которые возвращает запрос.
| Код состояния | Description |
|---|---|
| 200 | ОК. Успешный запрос и возвращение состояния всех операций. HeadersRetry-After: integerETag: строка |
| 400 | Недопустимый запрос. Недопустимый запрос. Проверить входные параметры. |
| 401 | Не авторизовано. Проверьте свои учетные данные. |
| 500 | Внутренняя ошибка сервера. |
| Другие коды состояния | • Слишком много запросов • Временный сервер недоступен |
Ответ на получение информации о статусе перевода
Успешный ответ на получение информации о статусе перевода
В успешном ответе возвращается следующая информация.
| Имя. | Тип | Описание |
|---|---|---|
| @nextLink | строка | URL следующей страницы. Нулевое значение, если доступных страниц больше нет. |
| значение | TranslationStatus[] | Массив TranslationStatus[] |
| value.id | строка | Идентификатор операции. |
| value.createdDateTimeUtc | строка | Дата создания операции, время. |
| value.lastActionDateTimeUtc | строка | Время даты, в течение которого была обновлена состояние операции. |
| value.status | Строка | Список возможных статусов работы или документа: • Отменено •Отмена •Сбой при • NotStarted •Запущена •Удалось • ValidationFailed |
| value.summary | StatusSummary[] | Сводка, содержащая перечисленные сведения. |
| value.summary.total | integer | Подсчет общего количества документов. |
| value.summary.failed | integer | Счетчик документов не прошел. |
| value.summary.success | integer | Количество успешно переведенных документов. |
| value.summary.inProgress | integer | Количество документов в работе. |
| value.summary.notYetStarted | integer | Количество документов, обработка которых еще не началась. |
| value.summary.cancelled | integer | Число отмененных документов. |
| value.summary.totalCharacterCharged | integer | Общее число оплачиваемых знаков. |
Отклик в случае ошибки
| Имя. | Тип | Описание |
|---|---|---|
| кодом | строка | Перечисления, содержащие коды ошибок высокого уровня. Возможные значения: • 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 является примером успешного ответа.
{
"value": [
{
"id": "36724748-f7a0-4db7-b7fd-f041ddc75033",
"createdDateTimeUtc": "2021-06-18T03:35:30.153374Z",
"lastActionDateTimeUtc": "2021-06-18T03:36:44.6155316Z",
"status": "Succeeded",
"summary": {
"total": 3,
"failed": 2,
"success": 1,
"inProgress": 0,
"notYetStarted": 0,
"cancelled": 0,
"totalCharacterCharged": 0
}
},
{
"id": "1c7399a7-6913-4f20-bb43-e2fe2ba1a67d",
"createdDateTimeUtc": "2021-05-24T17:57:43.8356624Z",
"lastActionDateTimeUtc": "2021-05-24T17:57:47.128391Z",
"status": "Failed",
"summary": {
"total": 1,
"failed": 1,
"success": 0,
"inProgress": 0,
"notYetStarted": 0,
"cancelled": 0,
"totalCharacterCharged": 0
}
},
{
"id": "daa2a646-4237-4f5f-9a48-d515c2d9af3c",
"createdDateTimeUtc": "2021-04-14T19:49:26.988272Z",
"lastActionDateTimeUtc": "2021-04-14T19:49:43.9818634Z",
"status": "Succeeded",
"summary": {
"total": 2,
"failed": 0,
"success": 2,
"inProgress": 0,
"notYetStarted": 0,
"cancelled": 0,
"totalCharacterCharged": 21899
}
}
],
""@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operations/727BF148-F327-47A0-9481-ABAE6362F11E/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"
}
}
}
Следующие шаги
Воспользуйтесь информацией, приведенной в данном кратком руководстве, чтобы узнать больше об использовании перевода документов и клиентской библиотеки.