Kotaemon: 배포가 간편한 오픈 소스 멀티모달 문서 퀴즈 도구

13.3K 00

일반 소개

Kotaemon은 최종 사용자와 개발자에게 검색 증강 생성(RAG) 기반의 Q&A 기능을 제공하기 위해 설계된 오픈 소스 문서 Q&A 도구입니다. Cinnamon에서 개발한 이 프로젝트는 기본 LLM뿐만 아니라 다양한 LLM API 제공업체(예: OpenAI, AzureOpenAI, Cohere 등)를 지원합니다. Kotaemon은 문서 퀴즈 및 구축을 위한 깔끔하고 사용자 정의 가능한 사용자 인터페이스를 제공합니다. RAG 파이프.

기능 목록

여러 사용자 로그인 지원, 비공개/공개 컬렉션의 파일 정리
네이티브 LLM 및 인기 API 제공업체 지원
최적의 검색 품질을 보장하기 위해 혼합 RAG 배관이 함께 제공됩니다.
차트와 표가 포함된 문서에 대한 다중 모드 Q&A 지원
환경 설정이 필요 없는 간편한 스크립트 설치 제공

기능적 특징

나만의 문서 퀴즈(RAG) 웹 사용자 인터페이스 호스팅하기. 여러 사용자 로그인을 지원하고, 비공개/공개 컬렉션별로 파일을 정리하고, 다른 사람들과 공동 작업하고, 즐겨 찾는 채팅을 공유할 수 있습니다.
LLM 및 임베딩 모델 정리하기. 네이티브 LLM 및 인기 있는 API 제공업체(OpenAI, Azure, Ollama, Groq)를 지원합니다.
혼합 RAG 파이프. 최적의 검색 품질을 보장하기 위해 하이브리드(전체 텍스트 및 벡터) 검색기 + 재정렬과 결합된 합리적인 기본 RAG 파이프라인을 제공합니다.
멀티모달 Q&A 지원. 그래프와 표를 지원하는 여러 문서에 대한 Q&A. 멀티모달 문서 구문 분석 지원(사용자 인터페이스에서 사용 가능한 옵션).
문서 미리 보기를 통한 고급 인용. 시스템은 기본적으로 LLM 정답이 올바른지 확인하기 위해 자세한 참조를 제공합니다. 이 작업은PDF 뷰어인용(관련성 점수 포함)을 보고 강조 표시합니다. 검색 파이프라인에서 관련성이 낮은 문서가 반환되면 경고합니다.
복잡한 추론 방법 지원. 질문 분해를 사용하여 복잡한/멀티홉 질문에 답하세요. ReAct, ReWOO 및 기타 에이전트를 사용하여 에이전트 기반 추론을 지원합니다.
구성 가능한 설정 사용자 인터페이스. 사용자 인터페이스에서 검색 및 생성 프로세스의 중요한 측면(프롬프트 포함)을 대부분 조정할 수 있습니다.
확장성. Gradio를 기반으로 구축되어 원하는 UI 요소를 자유롭게 사용자 지정/추가할 수 있습니다. 또한 다양한 문서 색인 및 검색 전략을 지원하는 것을 목표로 합니다.GraphRAG인덱스 파이프라인이 예시로 제공됩니다.

도움말 사용

일반 사용자를 위한 설치 프로세스

다운로드:통해 (틈새)새 릴리스다운로드kotaemon-app.zip문서화.

설치:

다운로드한 파일의 압축을 풉니다.
로 이동scripts폴더를 열고 운영 체제에 맞는 설치 프로그램을 실행합니다:
- Windows. run_windows.bat. 파일을 더블클릭하기만 하면 됩니다.
- macOS. run_macos.sh
  1. 파일을 마우스 오른쪽 버튼으로 클릭하고 '다른 애플리케이션으로 열기'를 선택합니다.
  2. '모든 애플리케이션'을 활성화하고 '터미널'을 선택합니다.
  3. 참고: 터미널을 사용하여 항상 파일을 열려면 '이 애플리케이션으로 항상 열기' 확인란을 선택합니다.
  4. 이제부터는 파일을 더블클릭하면 정상적으로 작동합니다.
- Linux. run_linux.sh. 를 사용하여bash run_linux.sh스크립트를 실행합니다.
설치가 완료되면 설치 관리자가 ktem의 사용자 인터페이스가 시작되었는지 묻는 메시지가 표시되며, 계속하려면 대답해 주세요.
실행에 성공하면 브라우저에서 애플리케이션이 자동으로 열립니다.

개발자 설치 프로세스

Docker 배포(권장)

docker run \
-e GRADIO_SERVER_NAME=0.0.0.0 \
-e GRADIO_SERVER_PORT=7860 \
-p 7860:7860 -it --rm \
taprosoft/kotaemon:v1.0

http://localhost:7860/ 으로 이동하여 웹 인터페이스에 액세스합니다.

소스 코드 배포

새 Python 환경에 필요한 패키지를 복제하여 설치합니다.

# optional (setup env)
conda create -n kotaemon python=3.10
conda activate kotaemon

# clone this repo
git clone https://github.com/Cinnamon/kotaemon
cd kotaemon

pip install -e "libs/kotaemon[all]"
pip install -e "libs/ktem"

에서 환경 변수(API 키, 엔드포인트)를 보고 편집합니다. .env 가운데.

(선택 사항) 브라우저에서 PDF_JS 뷰어를 활성화하려면 다음을 다운로드하세요. PDF_JS_DIST 로 추출하여 libs/ktem/ktem/assets/prebuilt

웹 서버 시작

python app.py

기본 사용자 아이디/비밀번호는 admin / admin입니다. 다른 사용자는 UI에서 직접 설정할 수 있습니다.

사용 가이드라인

로그인 및 문서 관리::
- 사용자는 다중 사용자 로그인 시스템을 통해 플랫폼에 액세스하여 문서 컬렉션을 정리하고 관리할 수 있습니다.
- 파일을 비공개 또는 공개 컬렉션으로 분류하여 손쉽게 협업하고 공유할 수 있도록 지원합니다.
Q&A 기능::
- 사용자는 인터페이스에서 문서를 업로드하고 Q&A 작업을 수행할 수 있습니다.
- 멀티 모달 Q&A 지원 및 차트와 표가 포함된 문서 콘텐츠로 작업할 수 있습니다.
RAG 파이프 커스터마이징::
- 개발자는 제공된 UI를 사용하여 RAG 파이프라인을 커스터마이징하고 확인할 수 있습니다.
- 네이티브 LLM과 인기 있는 API 제공업체를 지원하므로 사용자는 필요에 따라 적합한 모델을 선택할 수 있습니다.
하이브리드 검색::
- 이 시스템은 최적의 검색 품질을 보장하기 위해 전체 텍스트 검색과 벡터 검색을 결합한 하이브리드 검색 파이프라인을 제공합니다.
- 검색 결과의 관련성을 높이기 위해 재정렬 기능을 지원합니다.
멀티모달 지원::
- 이 플랫폼은 멀티모달 Q&A를 지원하며 차트와 표가 포함된 문서를 처리할 수 있어 보다 포괄적인 Q&A 환경을 제공합니다.

고급 기능

모델 관리::
- 사용자는 자체 LLM과 임베디드 모델을 구성하고 관리할 수 있습니다.
- 네이티브 모델과 인기 있는 API 제공업체를 지원하므로 사용자는 필요에 따라 적합한 모델을 선택할 수 있습니다.
협업 및 공유::
- 사용자는 즐겨찾는 채팅을 다른 사람들과 공유하여 손쉽게 협업하고 소통할 수 있습니다.
- 다중 사용자 로그인 지원을 통해 사용자는 플랫폼에서 협업하고 공유할 수 있습니다.
피드백 및 기여::
- 이 프로젝트는 현재 활발히 개발 중이며 사용자 피드백, 문제 보고 및 홍보 제출을 환영합니다.