README.md

---
title: First Chatbot
emoji: 🤖
colorFrom: indigo
colorTo: pink
sdk: streamlit
sdk_version: 1.44.0
app_file: app.py
pinned: false
short_description: A simple chatbot using Streamlit and Hugging Face.
---

# 🤖 나만의 개인 챗봇

Hugging Face 모델과 Streamlit을 사용하여 만든 간단한 대화형 챗봇입니다. 사이드바에서 AI의 성격, 시작 메시지, 아바타 등을 직접 설정하고 AI와 대화를 나눌 수 있습니다.

## ✨ 주요 기능

- **💬 실시간 채팅 인터페이스**: 사용자와 AI가 메시지를 주고받는 깔끔한 UI.
- **🔧 손쉬운 설정**: 사이드바에서 시스템 메시지, 시작 메시지, 최대 응답 길이를 쉽게 변경할 수 있습니다.
- **🎨 커스텀 아바타**: 사용자와 AI의 아바타를 원하는 이모티콘으로 선택할 수 있습니다.
- **🧠 유연한 모델 사용**: Hugging Face에 있는 다양한 언어 모델(`MODEL_ID` 변경)을 활용할 수 있습니다.
- **🔄 대화 초기화**: 버튼 클릭 한 번으로 대화 기록을 초기화하고 새 대화를 시작할 수 있습니다.

## 🛠️ 시작하기

### 1. 환경 설정

이 프로젝트는 `uv`와 같은 가상 환경 도구를 사용하는 것을 권장합니다.

먼저, 필요한 라이브러리를 설치하세요.

```bash
uv pip install -r requirements.txt
```

### 2. Hugging Face 토큰 설정

프로젝트 루트 디렉터리에 `.env` 파일을 생성하고, 여러분의 Hugging Face API 토큰을 추가하세요. 토큰은 [Hugging Face 설정](https://huggingface.co/settings/tokens)에서 발급받을 수 있습니다.

```
HF_TOKEN="ここにHugging Faceのトークンを貼り付けてください"
```

### 3. 애플리케이션 실행

터미널에서 아래 명령어를 실행하여 Streamlit 앱을 시작하세요.

```bash
uv run streamlit run app.py
```

앱이 실행되면 웹 브라우저에서 로컬 주소(예: `http://localhost:8501`)가 열립니다.

## 📂 코드 구조

`app.py` 파일은 가독성과 유지보수성을 높이기 위해 기능별로 모듈화되었습니다.

- **상수 정의**: `MODEL_ID`, `PROMPT_TEMPLATE` 등 주요 설정값을 파일 상단에서 관리합니다.
- **LLM 및 체인 설정 (`get_llm`, `get_chain`)**: Hugging Face 모델을 로드하고, LangChain으로 프롬프트와 모델을 연결하는 체인을 생성합니다.
- **UI 렌더링 (`initialize_session_state`, `setup_sidebar`, `display_chat_history`)**: Streamlit의 세션 상태를 초기화하고, 사이드바와 채팅 기록 UI를 구성합니다.
- **메인 로직 (`generate_response`, `main`)**: 사용자 입력을 받아 AI의 응답을 생성하고, 전체 애플리케이션의 흐름을 제어합니다.

## 📚 참고 자료

- [Creating Your Personal Chatbot Using Hugging Face Spaces and Streamlit](https://medium.com/@james.irving.phd/creating-your-personal-chatbot-using-hugging-face-spaces-and-streamlit-596a54b9e3ed)
- [Hugging Face Spaces Configuration Reference](https.huggingface.co/docs/hub/spaces-config-reference)