Skip to content

stepan41k/NeuroFile

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NeuroFile: Интеллектуальная система анализа документов

NeuroFile — это мультимодульная RAG-система (Retrieval-Augmented Generation), предназначенная для глубокого анализа документов, поиска информации и автоматического обнаружения логических противоречий.

🚀 Быстрый запуск (Docker)

Самый простой способ запустить всю систему целиком (Бэкенд, AI-агент, Фронтенд и БД):

  1. Убедитесь, что у вас установлены Docker и Docker Compose.
  2. Перейдите в директорию сборки:
    cd build
  3. Запустите сборку и контейнеры:
    docker-compose up --build
  4. Сервисы будут доступны по адресам:

🛠 Ручная сборка и разработка

Если вам нужно запустить модули по отдельности для отладки:

1. AI Agent (Python + FastAPI)

Сердце системы, отвечающее за парсинг, эмбеддинги и LLM.

cd ai-agent
pip install -r requirements.txt
# Убедитесь, что модели загружены в папку ai-agent/model/
uvicorn gateway:app --host 0.0.0.0 --port 3001 --reload

2. Server (Node.js + Express)

Оркестратор, управляющий пользователями, файлами и историей чатов.

cd server
npm install
# Настройте .env (PostgreSQL, JWT_SECRET)
npm run dev

3. Client (Vite + TypeScript)

Веб-интерфейс для работы с системой.

cd client
npm install
npm run dev

4. Mobile (Android + Kotlin)

Мобильное приложение для доступа к базе знаний.

  1. Откройте папку mobile/ в Android Studio.
  2. Дождитесь синхронизации Gradle.
  3. Запустите проект на эмуляторе или реальном устройстве.
  4. В настройках укажите IP-адрес вашего запущенного сервера.

🧪 Тестирование и проверка

1. Автоматизированное тестирование

  • AI Agent: Запуск тестов логики поиска и конфликтов:
    cd ai-agent
    pytest
  • Server: Проверка API-эндпоинтов:
    cd server
    npm test

2. Ручное тестирование (Checklist)

Для проверки работоспособности MVP выполните следующие шаги:

  1. Регистрация: Создайте нового пользователя в веб-интерфейсе.
  2. Загрузка: Загрузите PDF или DOCX файл. Убедитесь, что он появился в списке "My Files".
  3. Чат: Задайте вопрос по содержимому файла. Проверьте, что ответ содержит ссылки на источник.
  4. Конфликты: Загрузите два документа с противоречивой информацией (например, разные даты одного события). Включите тумблер Conflicts и проверьте, подсветит ли система противоречие.
  5. OCR: Загрузите скан документа (картинку или PDF без текстового слоя) и проверьте качество извлечения текста.

📂 Структура проекта

  • /ai-agent — логика ИИ, парсинг и векторный поиск.
  • /server — бэкенд на Node.js.
  • /client — фронтенд на React/Vite.
  • /mobile — Android-приложение.
  • /build — конфигурация Docker Compose.
  • /upload — общая папка для хранения загруженных документов.

⚠️ Известные ограничения (Roadmap)

  • OCR: Текущая версия использует Tesseract и может работать нестабильно на "грязных" сканах. В планах переход на более мощные модели.
  • Промпты: Логика детекции конфликтов находится в стадии калибровки (Fine-tuning).

Releases

No releases published

Packages

 
 
 

Contributors