Получение сведений о состоянии документа
Справочная служба: версия API перевода документов ВИ Azure: версия 1.1
Этот метод Get возвращает состояние определенного документа. Метод возвращает состояние перевода для документа на основе ИД запроса и ИД документа.
Запросить URL-адрес
Отправьте запрос GET на следующий адрес.
GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/{id}/documents/{documentId}
Узнайте, как найти свое личное доменное имя.
Внимание
- Конечную точку личного домена необходимо указывать во всех запросах API к службе перевода документов.
- Вы не можете использовать конечную точку, найденную на странице ключей и конечной точки ресурса портала Azure, или глобальную конечную точку переводчика—
api.cognitive.microsofttranslator.com—для выполнения HTTP-запросов к переводу документов.
Параметры запроса
В таблице ниже приведены параметры, которые передаются в строке запроса.
| Параметр запроса | Обязательное поле | Описание |
|---|---|---|
| documentId | Истина | Идентификатор документа. |
id |
Истина | Идентификатор пакета. |
Заголовки запросов
Заголовки запроса.
| Заголовки | 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"
}
}
}
Следующие шаги
Воспользуйтесь информацией, приведенной в данном кратком руководстве, чтобы узнать больше об использовании перевода документов и клиентской библиотеки.