SmartRead: автоматическое аннотирование технических PDF-документов и предоставление соответствующих ссылок

Общее введение

SmartRead - это инструмент с открытым исходным кодом, основанный на искусственном интеллекте и предназначенный для работы с техническими документами. Он автоматически анализирует PDF-файлы и аннотирует ключевое содержимое, например важные термины, заголовки или основные идеи, чтобы помочь пользователям быстро понять сложные документы. В то же время он может предоставлять ссылки на статьи и видео, связанные с темой документа, чтобы обучение было более полным. Этот проект был опубликован разработчиком Dev-Khant на GitHub, код полностью общедоступен и бесплатен для использования. smartRead подходит для технических специалистов, студентов и исследователей, особенно полезен для людей, которым необходимо эффективно читать технические PDF-файлы.

Список функций

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

Использование помощи

SmartRead - это проект с открытым исходным кодом, размещенный на GitHub, который необходимо установить и настроить для использования. Ниже приведены подробные шаги, которые помогут вам пройти путь от загрузки до начала работы.

Процесс установки

SmartRead состоит из двух частей, front-end и back-end, и должен быть подготовлен к работе в среде разработки. Ниже перечислены конкретные шаги по установке:

Подготовка среды

1. Установка основных инструментов
   • Скачать Git (git-scm.com) для клонирования кода.
   • Установите Node.js (версия 18+.nodejs.org) для передней части.
   • Установите Python (версия 3.12.python.org) для локальной разработки бэкэнда.
   • Установите Docker (docker.com) для внутренних контейнерных запусков.
2. Код загрузки
   • Откройте терминал и запустите его:

     git clone https://github.com/Dev-Khant/smartread.git
     cd smartread
     

3. Настройка переменных среды
   • Скопируйте файл примера:

     cp backend/.env.example backend/.env
     cp web/.env.example web/.env.local
     

   • компилятор backend/.envЗаполните следующие поля (ключ вы должны получить самостоятельно):

     PORT=8000
     HOST=0.0.0.0
     ENVIRONMENT=development
     MONGODB_URL=mongodb://你的MongoDB地址
     MISTRAL_API_KEY=你的Mistral密钥
     GROQ_API_KEY=你的Groq密钥
     CLOUDINARY_CLOUD_NAME=你的Cloudinary名称
     CLOUDINARY_API_KEY=你的Cloudinary密钥
     CLOUDINARY_API_SECRET=你的Cloudinary秘钥
     

   • компилятор web/.env.local::

     NEXT_PUBLIC_BACKEND_API_URL=http://localhost:8000
     

Установите и запустите внешний модуль

1. Перейдите в каталог внешнего интерфейса:

cd web

2. Установите зависимость:

npm install

3. Начните с передней части:

npm run dev

4. Откройте браузер и посетите http://localhost:3000Вы видите внешний интерфейс.

Установите и запустите бэкэнд

• Использование Docker (рекомендуется)

1. Перейдите в каталог внутреннего интерфейса:

cd backend

2. Постройте зеркальное отражение:

docker build -t smartread-backend .

3. Запустите контейнер:

docker run -p 8000:8000 --env-file .env smartread-backend

• Локальная разработка (без Docker)

1. Перейдите в каталог внутреннего интерфейса:

cd backend

2. Создайте виртуальную среду и активируйте ее:

python -m venv .venv
source .venv/bin/activate  # Windows 用 .venv\Scripts\activate

3. Установите зависимость:

pip install -r requirements.txt

4. Начните с задней части:

uvicorn main:app --reload --host 0.0.0.0 --port 8000

Как использовать основные функции

После установки основная функциональность SmartRead сводится к обработке PDF-файлов и рекомендации ресурсов.

Функция 1: Технология автоматического аннотирования PDF

• процедура

1. Подготовьте технический PDF-файл (например, документ или руководство).
2. Загрузка файлов во внешний интерфейс (http://localhost:3000), или в backend/input Папка.
3. Нажмите "Загрузить и наклеить этикетку" на передней панели или запустите ее на задней панели:

python main.py --file input/你的文件名.pdf

4. После завершения обработки аннотированный PDF появится в backend/output Папка.

• Функциональное описание
  Использование SmartRead Мистраль ИИ ответить пением Groq Модель анализирует документ, определяет ключевое содержание и добавляет выделение или аннотацию. Результаты аннотирования отображаются в PDF-файле для быстрого и удобного чтения.

Функция 2: Доступ к соответствующим ресурсам

• процедура

1. После загрузки PDF-файла во внешнем интерфейсе установите флажок "Получить связанные ресурсы".
2. или запустить на задней стороне:

python main.py --file input/你的文件名.pdf --resources

3. После завершения обработки интерфейс или терминал отображает ссылки на статьи и видео.

• Функциональное описание
  Система осуществляет поиск в Интернете на основе содержимого PDF-файлов и рекомендует соответствующие технические статьи или видео, а ссылки хранятся в MongoDB и управляются Cloudinary.

Функция 3: Загрузить аннотированный PDF

• процедура

1. Нажмите на кнопку "Загрузить" во внешнем интерфейсе или перейдите в раздел backend/output Папка.
2. найти 你的文件名_annotated.pdfСохраните его напрямую.

• Функциональное описание
  Аннотированный PDF сохраняет оригинальный текст с новыми выделениями и аннотациями для удобного обмена или архивирования.

Функциональное управление

вклад с открытым исходным кодом

• процедура

1. Измените код и зафиксируйте его на GitHub:

git add .
git commit -m "你的修改说明"
git push origin main

2. Создайте Pull Request на GitHub.

• Функциональное описание
  SmartRead использует лицензию MIT и поощряет участие пользователей в разработке для улучшения моделей или интерфейсов ИИ.

предостережение

• Убедитесь, что ключи для MongoDB, Mistral AI, Groq и Cloudinary настроены правильно, иначе функциональность будет ограничена.
• Текущая версия больше подходит для англоязычной технической документации, поддержка китайского языка может потребовать оптимизации.
• Docker более стабилен и рекомендуется к использованию в первую очередь.

С помощью этих шагов вы сможете использовать SmartRead Processing Technology PDF в полном объеме. Простая в использовании, с интуитивно понятными результатами, она идеально подходит для тех, кто нуждается в углубленном чтении.

сценарий применения

1. научные исследования
   Пока студенты работают над своими работами, SmartRead экономит время на поиск, выделяя ключевые моменты и предлагая соответствующие ресурсы.
2. развитие технологий
   Программисты используют его для выделения ключевых параметров при чтении документации по API, а также для доступа к обучающим видео.
3. Работа в команде
   Команда проекта организует технические руководства, которые единообразно маркируются и затем распространяются для повышения эффективности коммуникации.

QA

1. Поддерживает ли SmartRead китайские PDF-файлы?
   В настоящее время он больше подходит для технической документации на английском языке, поддержка китайского языка находится в стадии оптимизации.
2. Нужна ли мне сеть?
   Да, для доступа к соответствующим ресурсам и запуска моделей ИИ требуется подключение к сети.
3. Можно ли использовать его в автономном режиме?
   Функция маркировки работает в автономном режиме, но рекомендации по ресурсам должны быть в режиме онлайн.