🇰🇷 한국어

🇺🇸 English | 🇮🇳 हिंदी | 🇯🇵 日本語 | 🇨🇳 简体中文 | 🇪🇸 Español | 🇧🇷 Português (Brasil) | 🇰🇷 한국어 | 🇩🇪 Deutsch | 🇫🇷 Français

Note: 이 문서는 번역본입니다. 영어 README.md가 기준 문서입니다.

RAG Container Template

이 저장소는 로컬 Retrieval-Augmented Generation (RAG) 시스템을 구축하기 위한 풀스택 샌드박스입니다.
백엔드는 인증과 RAG API를 제공하는 FastAPI 서비스이며, 영구 벡터 저장소로 ChromaDB를 사용하고 임베딩과 채팅 모두에 Ollama를 사용합니다. 프론트엔드는 백엔드와 통신하는 Expo / React Native 앱입니다.

---

Features

• Backend
  • FastAPI
• Frontend
  • Expo / React-Native
• DataBase
  • PostgreSQL
• RAG (Retrieval-Augmented Generation)
  • Ollama를 사용한 Embeddings
  • ChromaDB를 사용한 Vector store
  • Chat / Answer generation
• DevOps
  • Docker Compose
  • GitHub Actions workflows

---

Architecture

+-----------------------------+
|        Frontend (Expo)      |
|  - React Native app         |
|  - Calls backend /auth,     |
|    /items, /rag endpoints   |
+--------------+--------------+
               |
               v
+-----------------------------+
|       Backend (FastAPI)     |
|  - Auth & Items routers     |
|  - RAG router (/rag/...)    |
|  - SQLAlchemy + Postgres    |
+--------------+--------------+
               |
       +-------+----------+
       |                  |
       v                  v
+-------------+   +------------------+
|  ChromaDB   |   |   Ollama (LLM)   |
|  Vector DB  |   |  /api/chat       |
|  /chroma_db |   |  /api/embeddings |
+-------------+   +------------------+

---

🚀 Getting Started

1. Prerequisites

• Docker Compose
• Expo Go

2. Build and start all services:

# set environment variables:
export REACT_NATIVE_PACKAGER_HOSTNAME=${YOUR_HOST}

# Build the image
docker compose build

# Run the container
docker compose up

---

3. Test:

# Backend pytest
docker compose \
  -f docker-compose.test.yml run \
  --rm \
  --entrypoint /bin/sh backend_test \
  -lc 'pytest -q'

# Backend Lint
docker compose \
  -f docker-compose.test.yml run \
  --rm \
  --entrypoint /bin/sh backend_test \
  -lc 'ruff check /app /tests'

# Frontend Test
docker compose \
  -f docker-compose.test.yml run \
  --rm frontend_test

Visit the services:

• Backend API: http://localhost:8000/docs

• Frontend UI (WEB): http://localhost:8081
• Frontend UI (mobile): exp://${YOUR_HOST}:8081: Expo에서 제공하는 QR로 접속합니다.

---

RAG API

Ingest documents

POST /rag/ingest

curl -X POST http://localhost:8000/rag/ingest \
  -H "Content-Type: application/json" \
  -d '{
    "documents": [
      {
        "id": "miura_intro_001",
        "text": "Miura Peninsula is located in Kanagawa, south of Yokohama. It is famous for its coastline, fresh seafood, and views of Mount Fuji on clear days.",
        "source": "local-notes"
      }
    ]
  }'

Response:

{
  "total_chunks": 1
}

Ask a question

POST /rag/query

curl -X POST http://localhost:8000/rag/query \
  -H "Content-Type: application/json" \
  -d '{
    "question": "Where is the Miura Peninsula and what is it famous for?",
    "top_k": 5
  }'

Example response:

{
  "answer": "The Miura Peninsula is in Kanagawa, south of Yokohama. It is known for its coastline, fresh seafood, and views of Mount Fuji on clear days.",
  "chunks": [
    {
      "id": "miura_intro_001_0",
      "text": "...",
      "source": "local-notes",
      "chunk_index": 0,
      "distance": 0.01
    }
  ]
}

---

License

• Apache License 2.0