Прием HTTPS API запросов

Раздел Прием HTTPS API запросов содержит параметры для обработки входящих API-запросов, включая настройки сервисов онлайн-транскрибации (субтитров) и перевода, а также параметры для маршрутизации запросов к сервисам ADP. Конфигурация позволяет управлять тайм-аутами, длительностью аудиофрагментов и параметрами обработки медиаконтента в реальном времени.

Конфигурация включает:

настройки активации и управления сервисами субтитров и переводов
параметры тайм-аутов ожидания ответов от онлайн-сервисов
настройки обработки аудиофрагментов и предотвращения некорректной работы нейросети
параметры логирования и управления системными ресурсами
параметры активации и настройки ADP API Gateway для взаимодействия с сервисами ADP

Параметры для настройки приема HTTPS API запросов

Параметр Значение по умолчанию Назначение

Параметр	Значение по умолчанию	Назначение
Уровень отладочных сообщений	INFO	минимальный уровень отладочных сообщений (возможные значения: CRITICAL, ERROR, WARNING, INFO, DEBUG)
Максимальный размер одного файла сообщений (байты)	10 000 000	максимальный размер одного лог-файла, в байтах
Максимальное количество файлов сообщений	10	максимальное количество хранимых лог-файлов одного контейнера
Субтитры доступны	off	использование сервиса субтитров
Таймаут ожидания ответа от сервиса субтитров	5	длительность ожидания ответа от сервиса субтитров (секунды)
Максимальная длительность речи спикера преобразуемой в субтитры	15	максимальная длительность аудиофрагмента (секунды), отправляемого для преобразования в субтитры
Максимальная пауза между фразами спикера для их слияния	1,5	максимальная длительность паузы (секунды) между аудиофрагментами одного спикера для объединения в один аудиофрагмент
Максимальная длительность звука проверяемого на галлюцинации	1	максимальная длительность аудиофрагмента, контент которого будет удвоен и дважды отправлен в нейросеть для избежания галлюцинаций
Требование наличия двойного текстового контента в удвоенном звуке	on	поиск двойного вхождения текста, полученного от одинарного звука в тексте, полученном от удвоенного звукового контента. Предназначен для исключения показа галлюцинаций. Если задвоенный текст не будет найден, то API вернет клиенту пустой контент
Удалять короткие фрагменты если речь не обнаружена	off	удаление коротких аудиофрагментов и сбрасывание накопленной речи спикера, если нейросеть вернула пустой контент
Сервис переводов доступен	off	поддержка пересылки запросов от API-обработчика к сервису перевода, иначе API будет возвращать клиенту статус код 404. Значение по умолчанию зависит от режима развертывания IVA Terra (см. раздел Файлы для установки IVA Terra): off — для режима Offline on — для режима No-ADP, Full и STS
Таймаут ожидания ответа от сервиса переводов	5	тайм-аут ожидания от сервиса обработки запроса на перевод
Минимальный таймаут бездействия при ожидании ответа от онлайн-сервисов	0,2	длительность ожидания ответа от онлайн-обработчика (секунды)
Путь к файлу шаблонов исключаемых фраз	/var/www/alldata/ cleaning_patterns.txt	путь к файлу в контейнере, содержащему регулярные выражения для текста, исключаемого из стенограммы
Срок хранения звука (дней)	60	количество дней хранения файлов аудиоконтента
Срок хранения стенограмм (дней)	365	количество дней хранения файлов стенограмм
ADP API шлюз доступен	off	активация возможности приема запросов на endpoints `/adp_services` и `/adp_services_stream`
Адрес для запросов ADP API Gateway	http://terra.iva.ru:9002/api/v1/task	адрес ADP-сервиса, куда будут пересылаться запросы, входящие на endpoint `/adp_services`
Адрес ответов ADP API Gateway	http://terra.iva.ru:9002/api/v1/result/	адрес ADP-сервиса, откуда будут извлекаться ответы при обработке запросов с типом response и идентификатором задачи на endpoint `/adp_services`
Имя агента ADP API Gateway	test	идентификатор клиента, включаемый в запрос к ADP-сервису
Токен доступа к ADP API Gateway	ivcs	секретный ключ, включаемый в запрос к ADP-сервису для аутентификации
Таймаут запроса в ADP API Gateway	30	количество секунд ожидания ответа от ADP-сервиса при обработке запросов, входящих на endpoint `/adp_services`
Отладочный режим ADP API Gateway	off	активация сохранения в отладочных журналах содержимого запросов и ответов
Список доступных сервисов ADP API Gateway	["assistant", "summary", "planner"]	список имен ADP-сервисов, доступ к которым будет успешно предоставлен (разделитель — запятая)
Адрес потокового ответа ADP API Gateway	http://terra.iva.ru:9002/api/v2/task_stream	адрес endpoint в ADP-сервисе, обрабатывающего запросы, входящие на endpoint `/adp_services_stream`, с последующим потоковым ответом
Таймаут на получение ответа ADP API Gateway	60	максимальное количество секунд, в течение которого шлюз будет поддерживать вычитывание ответа от ADP-сервиса в потоковом режиме

Уровень отладочных сообщений

INFO

минимальный уровень отладочных сообщений (возможные значения: CRITICAL, ERROR, WARNING, INFO, DEBUG)

Максимальный размер одного файла сообщений (байты)

10 000 000

максимальный размер одного лог-файла, в байтах

Максимальное количество файлов сообщений

максимальное количество хранимых лог-файлов одного контейнера

Субтитры доступны

off

использование сервиса субтитров

Таймаут ожидания ответа от сервиса субтитров

длительность ожидания ответа от сервиса субтитров (секунды)

Максимальная длительность речи спикера преобразуемой в субтитры

максимальная длительность аудиофрагмента (секунды), отправляемого для преобразования в субтитры

Максимальная пауза между фразами спикера для их слияния

1,5

максимальная длительность паузы (секунды) между аудиофрагментами одного спикера для объединения в один аудиофрагмент

Максимальная длительность звука проверяемого на галлюцинации

максимальная длительность аудиофрагмента, контент которого будет удвоен и дважды отправлен в нейросеть для избежания галлюцинаций

Требование наличия двойного текстового контента в удвоенном звуке

поиск двойного вхождения текста, полученного от одинарного звука в тексте, полученном от удвоенного звукового контента. Предназначен для исключения показа галлюцинаций. Если задвоенный текст не будет найден, то API вернет клиенту пустой контент

Удалять короткие фрагменты если речь не обнаружена

off

удаление коротких аудиофрагментов и сбрасывание накопленной речи спикера, если нейросеть вернула пустой контент

Сервис переводов доступен

off

поддержка пересылки запросов от API-обработчика к сервису перевода, иначе API будет возвращать клиенту статус код 404.

Значение по умолчанию зависит от режима развертывания IVA Terra (см. раздел Файлы для установки IVA Terra):

off — для режима Offline
on — для режима No-ADP, Full и STS

Таймаут ожидания ответа от сервиса переводов

тайм-аут ожидания от сервиса обработки запроса на перевод

Минимальный таймаут бездействия при ожидании ответа от онлайн-сервисов

0,2

длительность ожидания ответа от онлайн-обработчика (секунды)

Путь к файлу шаблонов исключаемых фраз

/var/www/alldata/
cleaning_patterns.txt

путь к файлу в контейнере, содержащему регулярные выражения для текста, исключаемого из стенограммы

Срок хранения звука (дней)

количество дней хранения файлов аудиоконтента

Срок хранения стенограмм (дней)

365

количество дней хранения файлов стенограмм

ADP API шлюз доступен

off

активация возможности приема запросов на endpoints /adp_services и /adp_services_stream

Адрес для запросов ADP API Gateway

http://terra.iva.ru:9002/api/v1/task

адрес ADP-сервиса, куда будут пересылаться запросы, входящие на endpoint /adp_services

Адрес ответов ADP API Gateway

http://terra.iva.ru:9002/api/v1/result/

адрес ADP-сервиса, откуда будут извлекаться ответы при обработке запросов с типом response и идентификатором задачи на endpoint /adp_services

Имя агента ADP API Gateway

test

идентификатор клиента, включаемый в запрос к ADP-сервису

Токен доступа к ADP API Gateway

ivcs

секретный ключ, включаемый в запрос к ADP-сервису для аутентификации

Таймаут запроса в ADP API Gateway

количество секунд ожидания ответа от ADP-сервиса при обработке запросов, входящих на endpoint /adp_services

Отладочный режим ADP API Gateway

off

активация сохранения в отладочных журналах содержимого запросов и ответов

Список доступных сервисов ADP API Gateway

["assistant", "summary", "planner"]

список имен ADP-сервисов, доступ к которым будет успешно предоставлен (разделитель — запятая)

Адрес потокового ответа ADP API Gateway

http://terra.iva.ru:9002/api/v2/task_stream

адрес endpoint в ADP-сервисе, обрабатывающего запросы, входящие на endpoint /adp_services_stream, с последующим потоковым ответом

Таймаут на получение ответа ADP API Gateway

максимальное количество секунд, в течение которого шлюз будет поддерживать вычитывание ответа от ADP-сервиса в потоковом режиме

Перед началом использования функций транскрибация в онлайн-режиме и онлайн-перевод необходимо убедиться, что:

переключатель Субтитры доступны активирован для доступности модуля обработки субтитров
переключатель Сервис переводов доступен активирован для доступности модуля обработки запросов на перевод текста

Набор доступных опций определяется версией IVA Terra, а их статус активации настраивается в соответствии с режимом развертывания IVA Terra

Для корректной работы ADP API Gateway необходимо:

активировать переключатель ADP API Шлюз доступен
заполнить обязательные параметры: Адрес для запросов ADP API Gateway, Имя агента ADP API Gateway и Токен доступа к ADP API Gateway
при необходимости настроить Список доступных сервисов ADP API Gateway для ограничения доступа

Набор доступных опций определяется режимом развертывания IVA Terra. Параметры шлюза являются независимыми от настроек модуля Клиент ADP-сервиса.