RAGFlow는 심층 문서 이해에 기반한 오픈소스 RAG (Retrieval-Augmented Generation) 엔진입니다. 이 엔진은 대규모 언어 모델(LLM)과 결합하여 정확한 질문 응답 기능을 제공하며, 다양한 복잡한 형식의 데이터에서 신뢰할 수 있는 출처를 바탕으로 한 인용을 통해 이를 뒷받침합니다. RAGFlow는 규모에 상관없이 모든 기업에 최적화된 RAG 워크플로우를 제공합니다.
데모를 https://demo.ragflow.io에서 실행해 보세요.
-
2024-11-01 파싱된 청크에 키워드 추출 및 관련 질문 생성을 추가하여 재현율을 향상시킵니다.
-
2024-09-29 다단계 대화를 최적화합니다.
-
2024-09-13 지식베이스 Q&A 검색 모드를 추가합니다.
-
2024-09-09 Agent에 의료상담 템플릿을 추가하였습니다.
-
2024-08-22 RAG를 통해 SQL 문에 텍스트를 지원합니다.
-
2024-08-02: graphrag와 마인드맵에서 영감을 받은 GraphRAG를 지원합니다.
⭐️우리의 저장소를 즐겨찾기에 등록하여 흥미로운 새로운 기능과 업데이트를 최신 상태로 유지하세요! 모든 새로운 릴리스에 대한 즉시 알림을 받으세요! 🌟
- 심층 문서 이해를 기반으로 복잡한 형식의 비정형 데이터에서 지식을 추출합니다.
- 문자 그대로 무한한 토큰에서 "데이터 속의 바늘"을 찾아냅니다.
- 똑똑하고 설명 가능한 방식.
- 다양한 템플릿 옵션을 제공합니다.
- 텍스트 청킹을 시각화하여 사용자가 개입할 수 있도록 합니다.
- 중요한 참고 자료와 추적 가능한 인용을 빠르게 확인하여 신뢰할 수 있는 답변을 지원합니다.
- 워드, 슬라이드, 엑셀, 텍스트 파일, 이미지, 스캔본, 구조화된 데이터, 웹 페이지 등을 지원합니다.
- 개인 및 대규모 비즈니스에 맞춘 효율적인 RAG 오케스트레이션.
- 구성 가능한 LLM 및 임베딩 모델.
- 다중 검색과 결합된 re-ranking.
- 비즈니스와 원활하게 통합할 수 있는 직관적인 API.
- CPU >= 4 cores
- RAM >= 16 GB
- Disk >= 50 GB
- Docker >= 24.0.0 & Docker Compose >= v2.26.1
로컬 머신(Windows, Mac, Linux)에 Docker가 설치되지 않은 경우, Docker 엔진 설치를 참조하세요.
-
vm.max_map_count가 262144 이상인지 확인하세요:vm.max_map_count의 값을 아래 명령어를 통해 확인하세요:$ sysctl vm.max_map_count
만약
vm.max_map_count이 262144 보다 작다면 값을 쟈설정하세요.# 이 경우에 262144로 설정했습니다.: $ sudo sysctl -w vm.max_map_count=262144이 변경 사항은 시스템 재부팅 후에 초기화됩니다. 변경 사항을 영구적으로 적용하려면 /etc/sysctl.conf 파일에 vm.max_map_count 값을 추가하거나 업데이트하세요:
vm.max_map_count=262144
-
레포지토리를 클론하세요:
$ git clone https://github.com/infiniflow/ragflow.git
-
미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요:
아래의 명령은 RAGFlow slim(dev-slim)의 개발 버전 Docker 이미지를 다운로드합니다. RAGFlow slim Docker 이미지에는 임베딩 모델이나 Python 라이브러리가 포함되어 있지 않으므로 크기는 약 1GB입니다.
$ cd ragflow/docker $ docker compose -f docker-compose.yml up -d- 특정 버전의 RAGFlow slim Docker 이미지를 다운로드하려면, docker/.env에서
RAGFlow_IMAGE변수를 원하는 버전으로 업데이트하세요. 예를 들어,RAGFLOW_IMAGE=infiniflow/ragflow:v0.13.0-slim으로 설정합니다. 이 변경을 완료한 후, 위의 명령을 다시 실행하여 다운로드를 시작하세요. - RAGFlow의 임베딩 모델과 Python 라이브러리를 포함한 개발 버전 Docker 이미지를 다운로드하려면, docker/.env에서
RAGFlow_IMAGE변수를RAGFLOW_IMAGE=infiniflow/ragflow:dev로 업데이트하세요. 이 변경을 완료한 후, 위의 명령을 다시 실행하여 다운로드를 시작하세요. - 특정 버전의 RAGFlow Docker 이미지를 임베딩 모델과 Python 라이브러리를 포함하여 다운로드하려면, docker/.env에서
RAGFlow_IMAGE변수를 원하는 버전으로 업데이트하세요. 예를 들어,RAGFLOW_IMAGE=infiniflow/ragflow:v0.13.0로 설정합니다. 이 변경을 완료한 후, 위의 명령을 다시 실행하여 다운로드를 시작하세요.
NOTE: 임베딩 모델과 Python 라이브러리를 포함한 RAGFlow Docker 이미지의 크기는 약 9GB이며, 로드하는 데 상당히 오랜 시간이 걸릴 수 있습니다.
- 특정 버전의 RAGFlow slim Docker 이미지를 다운로드하려면, docker/.env에서
-
서버가 시작된 후 서버 상태를 확인하세요:
$ docker logs -f ragflow-server
다음 출력 결과로 시스템이 성공적으로 시작되었음을 확인합니다:
____ ___ ______ ______ __ / __ \ / | / ____// ____// /____ _ __ / /_/ // /| | / / __ / /_ / // __ \| | /| / / / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ / /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/ * Running on all addresses (0.0.0.0) * Running on http://127.0.0.1:9380 * Running on http://x.x.x.x:9380 INFO:werkzeug:Press CTRL+C to quit만약 확인 단계를 건너뛰고 바로 RAGFlow에 로그인하면, RAGFlow가 완전히 초기화되지 않았기 때문에 브라우저에서
network abnormal오류가 발생할 수 있습니다. -
웹 브라우저에 서버의 IP 주소를 입력하고 RAGFlow에 로그인하세요.
기본 설정을 사용할 경우,
http://IP_OF_YOUR_MACHINE만 입력하면 됩니다 (포트 번호는 제외). 기본 HTTP 서비스 포트80은 기본 구성으로 사용할 때 생략할 수 있습니다. -
service_conf.yaml 파일에서 원하는 LLM 팩토리를
user_default_llm에 선택하고,API_KEY필드를 해당 API 키로 업데이트하세요.자세한 내용은 llm_api_key_setup를 참조하세요.
이제 쇼가 시작됩니다!
시스템 설정과 관련하여 다음 파일들을 관리해야 합니다:
- .env:
SVR_HTTP_PORT,MYSQL_PASSWORD,MINIO_PASSWORD와 같은 시스템의 기본 설정을 포함합니다. - service_conf.yaml: 백엔드 서비스를 구성합니다.
- docker-compose.yml: 시스템은 docker-compose.yml을 사용하여 시작됩니다.
.env 파일의 변경 사항이 service_conf.yaml 파일의 내용과 일치하도록 해야 합니다.
./docker/README 파일에는 환경 설정과 서비스 구성에 대한 자세한 설명이 있으며, ./docker/README 파일에 나열된 모든 환경 설정이 service_conf.yaml 파일의 해당 구성과 일치하도록 해야 합니다.
기본 HTTP 서비스 포트(80)를 업데이트하려면 docker-compose.yml 파일에서 80:80을 <YOUR_SERVING_PORT>:80으로 변경하세요.
모든 시스템 구성 업데이트는 적용되기 위해 시스템 재부팅이 필요합니다.
$ docker compose -f docker/docker-compose.yml up -d
이 Docker 이미지의 크기는 약 1GB이며, 외부 대형 모델과 임베딩 서비스에 의존합니다.
git clone https://github.com/infiniflow/ragflow.git
cd ragflow/
pip3 install huggingface-hub nltk
python3 download_deps.py
docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim .이 Docker의 크기는 약 9GB이며, 이미 임베딩 모델을 포함하고 있으므로 외부 대형 모델 서비스에만 의존하면 됩니다.
git clone https://github.com/infiniflow/ragflow.git
cd ragflow/
pip3 install huggingface-hub nltk
python3 download_deps.py
docker build -f Dockerfile -t infiniflow/ragflow:dev .-
Poetry를 설치하거나 이미 설치된 경우 이 단계를 건너뜁니다:
curl -sSL https://install.python-poetry.org | python3 - -
소스 코드를 클론하고 Python 의존성을 설치합니다:
git clone https://github.com/infiniflow/ragflow.git cd ragflow/ export POETRY_VIRTUALENVS_CREATE=true POETRY_VIRTUALENVS_IN_PROJECT=true ~/.local/bin/poetry install --sync --no-root # install RAGFlow dependent python modules
-
Docker Compose를 사용하여 의존 서비스(MinIO, Elasticsearch, Redis 및 MySQL)를 시작합니다:
docker compose -f docker/docker-compose-base.yml up -d
/etc/hosts에 다음 줄을 추가하여 docker/service_conf.yaml 에 지정된 모든 호스트를127.0.0.1로 해결합니다:127.0.0.1 es01 mysql minio redisdocker/service_conf.yaml 에서 mysql 포트를
5455로, es 포트를1200으로 업데이트합니다( docker/.env 에 지정된 대로). -
HuggingFace에 접근할 수 없는 경우,
HF_ENDPOINT환경 변수를 설정하여 미러 사이트를 사용하세요:export HF_ENDPOINT=https://hf-mirror.com -
백엔드 서비스를 시작합니다:
source .venv/bin/activate export PYTHONPATH=$(pwd) bash docker/launch_backend_service.sh
-
프론트엔드 의존성을 설치합니다:
cd web npm install --force -
.umirc.ts 에서
proxy.target을http://127.0.0.1:9380으로 업데이트합니다: -
프론트엔드 서비스를 시작합니다:
npm run dev
다음 인터페이스는 시스템이 성공적으로 시작되었음을 나타냅니다:
RAGFlow 로드맵 2024을 확인하세요.
RAGFlow는 오픈소스 협업을 통해 발전합니다. 이러한 정신을 바탕으로, 우리는 커뮤니티의 다양한 기여를 환영합니다. 참여하고 싶으시다면, 먼저 가이드라인을 검토해 주세요.