SmartRead: 기술 PDF 문서에 자동으로 주석을 달고 관련 인용을 제공합니다.

일반 소개

SmartRead는 기술 문서용으로 설계된 AI 기반 오픈 소스 도구입니다. PDF 파일을 자동으로 분석하고 중요한 용어, 제목 또는 핵심 아이디어와 같은 주요 콘텐츠에 주석을 달아 사용자가 복잡한 문서를 빠르게 이해할 수 있도록 도와줍니다. 동시에 문서 주제와 관련된 기사 및 동영상 링크도 제공하여 보다 포괄적인 학습을 할 수 있습니다. 이 프로젝트는 개발자 Dev-Khant가 GitHub에 공개했으며, 코드는 완전히 공개되어 무료로 사용할 수 있습니다. smartRead는 기술자, 학생 또는 연구원에게 적합하며 특히 기술 PDF를 효율적으로 읽어야 하는 사람들에게 유용합니다.

기능 목록

• 기술 PDF에 자동으로 주석을 추가하여 용어, 제목 또는 강조 표시된 구절과 같은 주요 콘텐츠를 강조 표시합니다.
• 문서 내용을 기반으로 관련 기사 및 동영상을 추천하여 이해의 깊이를 더할 수 있습니다.
• 다양한 기술 PDF 파일 처리를 지원하여 복잡한 문서를 더 쉽게 읽을 수 있습니다.
• 모든 강조 표시와 주석이 보존된 주석이 있는 PDF 파일을 다운로드할 수 있습니다.
• 오픈 소스 디자인을 통해 사용자는 코드를 보거나 기능을 수정하거나 개선 제안을 제출할 수 있습니다.

도움말 사용

SmartRead는 사용자가 사용하려면 설치 및 구성해야 하는 GitHub에서 호스팅되는 오픈 소스 프로젝트입니다. 다음은 다운로드부터 시작 및 실행까지 도움이 되는 자세한 단계입니다.

설치 프로세스

SmartRead는 프론트 엔드와 백엔드의 두 부분으로 실행되며 개발 환경을 준비해야 합니다. 구체적인 설치 단계는 다음과 같습니다:

환경 준비하기

1. 기본 도구 설치
   • Git 다운로드(git-scm.com)를 사용하여 코드를 복제합니다.
   • Node.js 설치(버전 18 이상.nodejs.org)를 프런트엔드에 사용합니다.
   • Python 설치(버전 3.12.python.org) 백엔드 로컬 개발용입니다.
   • 도커 설치(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

• 로컬 개발(도커 없음)

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 사용 방법 미스트랄 AI 노래로 응답 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. GitHub에서 풀 리퀘스트를 만듭니다.

• 기능 설명
  SmartRead는 MIT 라이선스를 사용하며 사용자가 개발에 참여하여 AI 모델이나 인터페이스를 개선하도록 장려합니다.

주의

• MongoDB, Mistral AI, Groq 및 Cloudinary의 키가 올바르게 구성되었는지 확인하지 않으면 기능이 제한됩니다.
• 현재 버전은 영어 기술 문서에 더 적합하며 중국어 지원은 최적화해야 할 수 있습니다.
• Docker가 더 안정적이므로 먼저 사용하는 것이 좋습니다.

사용하기 쉽고 직관적인 결과와 함께 심층적인 읽기가 필요한 사람들에게 완벽한 스마트 읽기 처리 기술 PDF를 완전히 사용할 수 있습니다.

애플리케이션 시나리오

1. 학술 연구
   학생들이 논문을 작성할 때 SmartRead는 핵심 사항을 강조 표시하고 관련 리소스를 제안하여 검색 시간을 절약해 줍니다.
2. 기술 개발
   프로그래머는 API 설명서를 읽는 동안 주요 매개변수를 강조 표시하고 튜토리얼 동영상에 액세스하는 데 사용합니다.
3. 팀워크
   프로젝트 팀은 커뮤니케이션 효율성을 높이기 위해 기술 매뉴얼을 구성하고, 이를 통일된 라벨로 지정한 후 공유합니다.

QA

1. SmartRead는 중국어 PDF를 지원하나요?
   현재 영어 기술 문서에 더 적합한 중국어 지원은 최적화 중입니다.
2. 네트워크가 필요한가요?
   예, 관련 리소스에 액세스하고 AI 모델을 실행하려면 네트워크 연결이 필요합니다.
3. 오프라인에서도 사용할 수 있나요?
   라벨링 기능은 오프라인에서 작동하지만 리소스 추천은 온라인 상태여야 합니다.