Функциональное описание системы

Настоящее функциональное описание определяет назначение, функциональную структуру, роли пользователей, основные процессы, входные и выходные данные, интерфейсы, механизмы разграничения доступа, функциональные зависимости и ограничения программного обеспечения «Визограф».

Описание сформировано по фактически заявленным возможностям готового экземпляра программного обеспечения. Параметры установки, развёртывания, аппаратные требования, количественные показатели производительности, гарантированные сроки обработки и хранения, уровни доступности и параметры внешней сетевой защиты в данном документе не устанавливаются.

1.1. Назначение системы

«Визограф» предназначен для автоматизированного приёма и обработки электронных документов и их отсканированных представлений. Система определяет тип документа, получает текстовое содержимое, извлекает структурированные атрибуты и предоставляет результат пользователю через браузерный интерфейс либо внешней информационной системе через интеграционный программный интерфейс.

1.2. Основные цели использования

• сокращение ручной обработки документов за счёт автоматической классификации и распознавания;

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

• извлечение структурированных значений по заранее настроенной схеме типа документа;

• обеспечение визуальной проверки результата по страницам документа и подтверждающим исходным фрагментам;

• предоставление асинхронного механизма обработки с наблюдением за состоянием задач;

• обеспечение проектной изоляции данных, настроек, пользователей и интеграционных ключей;

• интеграция с внешними информационными системами через версионированный API.

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

3.1. Логическая схема взаимодействия

1. Пользователь браузерного интерфейса или внешний интеграционный клиент инициирует обработку.

2. Сервер приложения выполняет аутентификацию, проверяет права, проект и доступную конфигурацию.

3. Входной файл проверяется, сохраняется и передаётся в подсистему обработки задач.

4. В зависимости от выбранного сценария подключаются служба подготовки документов, OCR и/или LLM.

5. Результаты и промежуточное состояние сохраняются в подсистеме хранения.

6. Пользователь или интеграционный клиент получает состояние и итоговый результат в пределах своей проектной области.

4.1. Проверка и изменение прав

Права, членство пользователя в проектах и доступ к конфигурациям проверяются сервером при каждом обращении к защищённому ресурсу. Изменения статуса пользователя, членства или разрешений учитываются при последующих операциях. Система также предотвращает блокировку либо лишение прав последнего активного глобального администратора.

Основная единица обработки — задача распознавания одного входного файла. Задача выполняется асинхронно и имеет собственные состояние, результат и возможность отмены.

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

Для сценария «Только извлечение через LLM» требуется заранее выбранный точный тип документа. Сценарии с OCR доступны только при включённой функции распознавания текста и настроенной службе OCR.

7.1. Поддерживаемые входные документы

Базовый каталог входных форматов: PDF; JPG/JPEG; PNG; TIF/TIFF; WebP; TXT.

При включённой службе подготовки документов дополнительно могут поддерживаться: DOC, DOCX, DOCM, ODT, RTF; PPT, PPTX, PPTM, PPS, PPSX, PPSM, POT, ODP; XLS, XLSX, XLSM, XLSB, ODS; HTML, HTM; Outlook MSG.

Фактически доступный каталог зависит от конфигурации экземпляра. Браузерный интерфейс отображает его при создании задачи; API предоставляет его операцией GET /api/v1/recognition/formats. Расширение и MIME-тип рассматриваются как сведения о предполагаемом формате, при этом система дополнительно проверяет допустимость файла.

7.2. Результат обработки

• имя исходного файла;

• определённый ключ и отображаемое название типа документа;

• распознанный текст;

• структурированный набор атрибутов;

• изображения страниц;

• распознанные текстовые фрагменты и их координаты;

• подтверждающие данные для извлечённых значений;

• предупреждения о частично обработанных элементах;

• безопасное описание ошибки и, при наличии, идентификатор обращения за поддержкой.

Состав результата зависит от выбранного сценария и фактического результата; перечисленные элементы не обязательно формируются одновременно.

8.1. Работа в проектном контексте

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

8.2. Создание задачи

• выбор одного или нескольких входных файлов;

• создание отдельной задачи для каждого файла;

• выбор поддерживаемого сценария обработки;

• для требующих этого сценариев — выбор точного типа документа;

• наблюдение за текущим состоянием каждой задачи;

• запрос отмены активной задачи.

8.3. Состояния и отмена

После приёма задача проходит подготовку, ожидание в очереди и обработку. Итоговыми состояниями являются успешное завершение, ошибка или отмена. Запрос отмены не означает мгновенную остановку: задача проходит процедуру отмены и затем получает окончательное состояние.

8.4. Просмотр результата

• определённый тип документа;

• распознанный текст;

• извлечённые атрибуты;

• структурированное представление результата;

• страницы исходного документа;

• предупреждения и безопасное описание ошибки.

8.5. Страницы и подтверждающие фрагменты

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

8.6. История и повторная обработка

Панель задач позволяет просматривать доступные активные и завершённые задачи, открывать документы и возвращаться к результатам. Область видимости определяется проектом и ролью. Для завершённого документа пользователь с соответствующими правами может повторно запустить обработку.

8.7. Работа с неподдерживаемыми документами

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

9.1. Проекты и участники

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

9.2. Пользователи

Глобальный администратор создаёт пользователей, блокирует и разблокирует учётные записи, сбрасывает пароль и управляет глобальными административными правами. Блокировка и сброс пароля прекращают действие существующих пользовательских сеансов.

9.3. Конфигурации и типы документов

• просмотр доступных конфигураций;

• создание и изменение конфигураций;

• добавление и настройка типов документов и извлекаемых полей;

• дублирование конфигурации как независимой копии;

• архивирование и восстановление;

• экспорт переносимого описания в JSON;

• импорт проверенного переносимого описания из JSON.

9.4. Профили OCR и LLM

Глобальный администратор раздельно управляет профилями распознавания текста и языковых моделей. Для профилей предусмотрены создание, изменение, проверка подключения, активация, архивирование и восстановление. Активный профиль нельзя архивировать до выбора другого активного профиля. Секретные значения подключённых служб защищаются и не возвращаются в обычном представлении настроек.

9.5. Интеграционные ключи

Администратор проекта создаёт и отзывает интеграционные ключи. Для ключа может быть задан срок действия. Полное секретное значение показывается однократно при создании; далее отображается только его начальная часть.

9.6. Лицензирование

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

API предназначен для создания и получения задач распознавания внешними информационными системами. Маршруты размещены в пространстве /api/v1. Машиночитаемое описание OpenAPI доступно по /api/v1/openapi/v1.json, HTML-представление документации — по /api/v1/docs.

10.1. Аутентификация и проектная область

Интеграционный клиент передаёт проектный ключ в заголовке Authorization: Bearer <API key>. Проект определяется по ключу и отдельно в запросах распознавания не указывается. Отозванный, истёкший ключ либо ключ архивного проекта доступ не предоставляют. Доступ к отдельной задаче ограничен проектом ключа.

10.2. Создание задачи через API

POST /api/v1/recognition/tasks использует multipart/form-data и принимает ровно один обязательный файл в поле file и необязательный точный ключ типа документа в поле documentTypeKey. Состав обработки определяется настройками проекта, а не только наличием documentTypeKey.

Для безопасного повтора поддерживается заголовок Idempotency-Key. Повтор запроса с тем же ключом и теми же данными возвращает ранее созданную задачу; использование того же ключа с другим файлом или типом приводит к конфликту. После надёжного принятия файла система возвращает 202 Accepted, текущее состояние задачи и адрес ресурса в заголовке Location.

10.3. Состояния API-задач

Значение active используется только как фильтр списка активных задач и не является самостоятельным состоянием. Клиент опрашивает задачу до получения окончательного состояния.

10.4. Ошибки API

HTTP-ошибки возвращаются в формате application/problem+json и содержат стабильный машинный код и идентификатор запроса. Предусмотрены группы ошибок аутентификации, файла и формата, недоступности проекта или конфигурации, неизвестного типа документа, конфликта идемпотентности, отсутствующей задачи, недопустимой отмены, временной недоступности обработки и лицензионных ограничений.

10.5. Функциональные ограничения API

• API не предоставляет синхронное распознавание в рамках одного HTTP-запроса;

• API не предоставляет автоматическое уведомление о завершении на заданный адрес;

• API не предоставляет серверная групповая обработка нескольких файлов одной задачей;

• API не предоставляет удаление завершённых задач;

• API не предоставляет общедоступные административные операции;

• API не предоставляет выбор внутренних способов обработки, не предусмотренных опубликованным API.

• локальная аутентификация пользователей браузерного интерфейса;

• серверные пользовательские сеансы;

• защита изменяющих запросов браузерного интерфейса от межсайтовой подделки;

• ролевое разграничение глобального и проектного администрирования;

• проверка членства в проекте и доступа к конфигурации;

• ограничение видимости задач в соответствии с проектом, ролью и способом создания;

• прекращение действия сеансов при блокировке пользователя или сбросе пароля;

• проверка интеграционного ключа по схеме Bearer и привязка ключа к проекту;

• хранение секретных значений интеграционных ключей в виде проверочного значения после однократной выдачи;

• защищённое хранение секретов поставщиков;

• безопасные пользовательские и интеграционные сообщения об ошибках.

Метаданные логически разграничиваются по проектам. Файловые данные сохраняются с разделением по проектам и сеансам распознавания. Требования к внешней сетевой защите, конкретным криптографическим алгоритмам и шифрованию пользовательских документов на носителе определяются средой развёртывания и не входят в заявленный функциональный объём системы.

Настоящий документ описывает функции, заявленные для готового экземпляра программного обеспечения «Визограф». В описание не включены планы развития, функции других систем, средства разработки и выпуска лицензий, служебная диагностика, а также количественные эксплуатационные показатели, не установленные исходной документацией.