whyhow-ai/rule-based-retrieval

Rule-based Retrieval 패키지는 고급 필터링 기능을 통해 검색 증강 생성 (RAG, Retrieval Augmented Generation) 애플리케이션을 생성하고 관리할 수 있게 해주는 Python 패키지입니다. 이 패키지는 텍스트 생성을 위한 OpenAI 및 효율적인 벡터 데이터베이스 관리를 위한 Pinecone과 원활하게 통합됩니다.

• Python 3.10 이상
• OpenAI API 키
• Pinecone, Milvus 또는 Qdrant 자격 증명

pip를 사용하여 PyPI에서 패키지를 직접 설치할 수 있습니다:

pip install rule-based-retrieval

또는, 저장소(repo)를 클론하여 패키지를 설치할 수 있습니다:

git clone git@github.com:whyhow-ai/rule-based-retrieval.git
cd rule-based-retrieval
pip install .

개발자용 설치를 원하시면, 편집 가능한 설치 (editable install)를 사용하고 개발 의존성(development dependencies)을 포함하세요:

pip install -e .[dev]

ZSH의 경우:

pip install -e ".[dev]"

직접 클론하지 않고 패키지를 바로 설치하려면 다음을 실행하세요:

pip install git+ssh://git@github.com/whyhow-ai/rule-based-retrieval

문서(Documentation)는 여기서 확인할 수 있습니다.

로컬에서 문서를 실행하려면 다음을 실행하세요:

pip install -e .[docs]
mkdocs serve

ZSH의 경우:

pip install -e ".[docs]"
mkdocs serve

브라우저에서 http://127.0.0.1:8000/ 로 이동하여 문서를 확인하세요.

Rule-based Retrieval 패키지 사용법을 보여주는 샘플 스크립트는 examples/ 디렉토리를 확인하세요.

whyhow_rbr은 두 개의 데이터베이스를 통해 Rule-based Retrieval을 구현하는 다양한 방법을 제공하며, 각 구현에 대한 문서(튜토리얼 및 예제)는 아래와 같습니다:

Rule-based Retrieval 패키지를 개선하기 위한 기여를 환영합니다! 아이디어, 버그 보고 또는 기능 요청이 있다면 GitHub 저장소에 이슈(issue)를 열어주세요.

코드를 기여하고 싶다면 다음 단계를 따르세요:

• 저장소 포크 (Fork)
• 기능 구현 또는 버그 수정을 위한 새 브랜치 생성
• 변경 사항을 적용하고 설명이 포함된 메시지와 함께 커밋 (commit)
• 변경 사항을 포크한 저장소에 푸시 (push)
• 메인 저장소에 풀 리퀘스트 (pull request) 오픈

이 프로젝트는 MIT 라이선스 (MIT License) 하에 라이선스가 부여됩니다.