chatpdflike

chatpdflike

대형 언어 모델 API를 사용한 엔드 투 엔드 문서 질문 응용 프로그램.

참고 :이 프로젝트는 ChatPDF와 제휴하거나 승인되지 않습니다. 이것은 유사한 기능을 복제하려는 독립적 인 프로젝트입니다.

개요

ChatPDF-Like는 사용자가 PDF 문서를 업로드하고 자연어 쿼리를 사용하여 상호 작용할 수있는 웹 응용 프로그램입니다. 이 응용 프로그램은 OpenAI의 GPT-3.5 터보와 같은 대형 언어 모델 (LLM)을 활용하여 PDF의 내용을 이해하고 사용자 질문에 대한 간결하고 정확한 답변을 제공합니다.

특징

• PDF 문서 업로드 : 로컬 PDF 파일을 업로드하거나 PDF 문서에 URL을 제공합니다.
• 자연어 상호 작용 : 자연어로 PDF의 내용에 대해 질문하십시오.
• 관련 답변 : 문서의 내용에 따라 간결한 답변을받습니다.
• 소스 참조 : 답을 생성하는 데 사용 된 소스 (PDF의 섹션)를 봅니다.
• 다수의 LLM 제공 업체 : OpenAI 및 Ollama 모델을 지원합니다.
• 웹 인터페이스 : 플라스크 및 자바 스크립트로 구축 된 간단하고 직관적 인 웹 인터페이스.

작동 방식

응용 프로그램은 다음과 같은 주요 단계를 따릅니다.

1. 텍스트 추출 및 처리 :

   • PDF는 PyPDF2 사용하여 구문 분석됩니다.
   • 텍스트는 각 페이지에서 추출되며 큰 텍스트는 관리 가능한 청크로 나뉩니다.

2. 임베딩 생성 :

   • 각각의 텍스트 청크에 대해, 선택된 임베딩 모델 (예 : OpenAi의 text-embedding-ada-002 )을 사용하여 임베딩 벡터가 생성됩니다.
   • 이러한 임베딩은 텍스트 청크의 의미 론적 의미를 나타내며 유사성 계산을 위해 저장됩니다.

3. 사용자 쿼리 처리 :

   • 사용자가 질문을하면 동일한 임베딩 모델을 사용하여 쿼리의 임베딩 벡터가 생성됩니다.

4. 유사성 검색 :

   • 응용 프로그램은 쿼리 임베딩과 텍스트 청크 임베딩 사이의 코사인 유사성을 계산합니다.
   • 가장 관련성이 높은 텍스트 청크는 가장 높은 유사성 점수에 따라 선택됩니다.

5. 신속한 건축 :

   • 언어 모델에 대한 프롬프트가 생성되어 사용자의 질문과 가장 관련성이 높은 텍스트 청크를 통합합니다.

6. 답변 세대 :

   • 프롬프트는 언어 모델 (예 : OpenAi의 GPT-3.5 터보)으로 전송됩니다.
   • 이 모델은 제공된 컨텍스트를 기반으로 사용자의 질문에 대한 답을 생성합니다.

7. 응답 디스플레이 :

   • 답은 웹 인터페이스의 사용자에게 표시됩니다.
   • 소스 텍스트 청크에 대한 참조도 투명성을 위해 제공됩니다.

시작하기

전제 조건

• 파이썬 : 버전 3.6 이상이 필요합니다.
• API 키 :
  • OpenAI API 키 : 임베딩 및 답변 세대에 OpenAI의 모델을 사용해야합니다.
  • Ollama API 키 : 선택 사항. Ollama 모델을 사용하려면 필요합니다.

설치

1. 저장소를 복제하십시오

   git clone https://github.com/Ulov888/chatpdflike.git
   cd chatpdflike

2. 종속성을 설치하십시오

   pip 사용하여 필요한 패키지를 설치합니다.

   pip install -r requirements.txt

API 키

OpenAi의 API를 사용하려면 :

1. OpenAI에서 API 키에 가입하십시오.

2. OPENAI_API_KEY 환경 변수 설정 :

    export OPENAI_API_KEY= " your_openai_api_key "

Ollama의 API를 사용하려면 (원하는 경우) :

1. Ollama에서 API 키를 얻으십시오.

2. OLLAMA_API_KEY 환경 변수 설정 :

    export OLLAMA_API_KEY= " your_ollama_api_key " 

용법

1. 응용 프로그램을 시작하십시오

   플라스크 응용 프로그램 실행 :

   python run.py

   기본적으로 서버는 http://0.0.0.0:8080 에서 실행됩니다.

2. 웹 인터페이스에 액세스하십시오

   웹 브라우저를 열고 http://localhost:8080 으로 이동하십시오.

3. PDF 문서를 업로드하십시오

   당신은 둘 중 하나를 할 수 있습니다 :

   • "PDF 업로드"를 클릭하여 컴퓨터에서 PDF 파일을 선택하고 업로드하십시오.
   • PDF 문서에 URL을 입력하고 "제출"을 클릭하십시오.

4. PDF와 상호 작용하십시오

   • PDF가 처리되면 화면 오른쪽의 채팅 인터페이스를 사용하여 콘텐츠에 대한 질문을 할 수 있습니다.
   • 입력 상자에 질문을 입력하고 "보내기"를 누릅니다.

5. 답을 봅니다

   • 응용 프로그램의 응답은 귀하의 질문 아래에 나타납니다.
   • 소스 참조 (예 : 페이지 번호 및 발췌)가 컨텍스트를 위해 제공됩니다.

사용자 정의

신속한 전략

언어 모델의 동작은 generate_embedding.py , 특히 Chatbot 클래스의 create_prompt 메소드에서 프롬프트 전략을 수정하여 사용자 정의 할 수 있습니다.

전략에는 다음이 포함됩니다.

• 논문 : 과학 논문 요약.
• 핸드북 : 금융 핸드북 요약 (중국어로 된 답변).
• 계약 : 계약 이해를위한 (중국어의 답변).
• 기본값 : 일반 목적 전략 (중국어로 된 답변).

전략을 선택하려면 create_prompt 호출 할 때 strategy 매개 변수를 수정할 수 있습니다.

언어와 출력

응용 프로그램은 현재 일부 전략에 대해 중국어로 답변을 제공하도록 구성되어 있습니다. 프롬프트를 수정하여 언어를 변경하거나 모델의 동작을 조정할 수 있습니다.

제한

• OpenAI API 비용 : OpenAI의 API 사용은 사용에 따라 비용이 발생합니다. 예상치 못한 요금을 피하려면 API 사용을 모니터링하십시오.
• PDF 파싱 : 응용 프로그램은 PyPDF2 사용하여 모든 PDF를 완벽하게 처리하지 못할 수 있습니다. 비정상적인 형식을 갖는 복잡한 PDF는 제대로 구문 분석되지 않을 수 있습니다.
• 임베딩 한도 : 임베딩의 최대 토큰 한계는 텍스트 청크의 크기 또는 프롬프트의 최대 길이를 제한 할 수 있습니다.
• 모델 응답 : 답변의 품질과 정확성은 언어 모델의 성능과 검색된 텍스트 청크의 관련성에 따라 다릅니다.

기여

기부금을 환영합니다! 제안이나 개선 사항이 있으면 문제를 제출하거나 요청을 제출하십시오.

특허

이 프로젝트는 Apache 라이센스에 따라 라이센스가 부여됩니다.