API v2 асинхронного распознавания
Для работы с API v2 понадобятся:
- Бакет Yandex Object Storage, в который вы загружаете аудиофайл для распознавания.
- Сервисный аккаунт с ролями
ai.speechkit-stt.user
иstorage.uploader
, которые нужны для работы со SpeechKit и Object Storage. - IAM-токен или API-ключ для аутентификации.
Подробнее о предварительной работе см. в разделе Как асинхронно распознать предзаписанное аудио.
Важно
Асинхронно распознать аудиофайлы можно только от имени сервисного аккаунта. Не используйте для этого другие аккаунты в Yandex Cloud.
Сервис асинхронного распознавания для API v2 располагается по адресу: transcribe.api.cloud.yandex.net/speech/stt/v2/longRunningRecognize
Отправить файл на распознавание
Параметры в теле запроса
Структура тела запроса:
{
"config": {
"specification": {
"languageCode": "string",
"model": "string",
"profanityFilter": boolean,
"literature_text": boolean,
"audioEncoding": "string",
"sampleRateHertz": integer,
"audioChannelCount": integer,
"rawResults": boolean
}
},
"audio": {
"uri": "string"
}
}
Параметр |
Описание |
config |
object |
config. |
object |
config. |
string |
config. |
string |
config. |
boolean
|
config. |
boolean |
config. |
string
|
config. |
integer (int64)
|
config. |
integer (int64) |
config. |
boolean
|
audio. |
string |
Ответ
Если запрос был составлен правильно, сервис возвращает объект Operation, в котором содержится идентификатор операции распознавания (id
):
{
"done": false,
"id": "e03sup6d5h1q********",
"createdAt": "2019-04-21T22:49:29Z",
"createdBy": "ajes08feato8********",
"modifiedAt": "2019-04-21T22:49:29Z"
}
Используйте полученный идентификатор на следующем шаге.
Получить результаты распознавания
Чтобы проверить статус операции и получить результат распознавания, отправьте запрос по адресу: operation.api.cloud.yandex.net
Проверяйте результаты распознавания, используя полученный идентификатор. Количество запросов на проверку результатов ограничено, 1 минута одноканального аудио распознается примерно за 10 секунд.
Важно
Результаты распознавания хранятся на сервере 3 суток. После этого вы не сможете запросить результаты распознавания, используя полученный идентификатор.
Path-параметры
Параметр | Описание |
---|---|
operationId | Идентификатор операции, полученный при отправке запроса на распознавание. |
Ответ
В ответе на запрос возвращается объект Operation. Пример ответа:
{
"done": true,
"response": {
"@type": "type.googleapis.com/yandex.cloud.ai.stt.v2.LongRunningRecognitionResponse",
"chunks": [
{
"alternatives": [
{
"words": [
{
"startTime": "0.879999999s",
"endTime": "1.159999992s",
"word": "при",
"confidence": 1
},
{
"startTime": "1.219999995s",
"endTime": "1.539999988s",
"word": "написании",
"confidence": 1
},
...
],
"text": "при написании хоббита толкин обращался к мотивам скандинавской мифологии древней английской поэмы беовульф",
"confidence": 1
}
],
"channelTag": "1"
},
...
]
},
"id": "e03sup6d5h1q********",
"createdAt": "2019-04-21T22:49:29Z",
"createdBy": "ajes08feato8********",
"modifiedAt": "2019-04-21T22:49:36Z"
}
Параметр |
Описание |
done |
boolean |
response |
object |
response. |
string |
response. |
array |
response. |
array |
response. |
array |
response. |
string |
response. |
string |
response. |
string |
response. |
integer (int64) |
response. |
string |
response. |
integer (int64) |
response. |
string |
id |
string |
createdAt |
google.protobuf.Timestamp |
createdBy |
string |
modifiedAt |
google.protobuf.Timestamp |
Подробнее о формате и кодах ответов см. на странице Формат ответа.