maitrang04 commited on
Commit
8c7cdcc
·
verified ·
1 Parent(s): 5b6e7d2

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +65 -56
README.md CHANGED
@@ -10,113 +10,122 @@ pinned: false
10
  # PINE-AI MVP – Hugging Face Space (Docker)
11
 
12
  ## 1. Giới thiệu
 
 
13
 
14
- PINE-AI hệ thống AI hỗ trợ logic sales, xử lý dữ liệu khách hàng & gói cước,
15
- demo thông qua giao diện web.
 
16
 
17
- Repository này được cấu hình để chạy **trực tiếp trên Hugging Face Spaces (Docker)**.
18
- Ban giám khảo **không cần cài Python, không cần Docker**, chỉ cần mở link Space.
19
 
20
  ---
21
 
22
  ## 2. Công nghệ sử dụng
23
-
24
- - **Backend**: Python, FastAPI
25
- - **Frontend**: Web UI (serve trực tiếp từ backend)
26
- - **AI / LLM**: Google GenAI + VNPT AI (qua API key)
27
- - **Deployment**: Hugging Face Spaces – Docker runtime
28
 
29
  ---
30
 
31
  ## 3. Cấu trúc thư mục
32
  ├── Dockerfile
33
  ├── backend/
34
- ── ai/
35
- │ ├── data/
36
- │ ├── requirements.txt
37
- ── main.py
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
38
  ├── frontend/
39
- ── README.md
 
 
 
 
40
 
41
  ---
42
 
43
  ## 4. Environment Variables & Secrets
 
44
 
45
- Toàn bộ API key **KHÔNG commit vào repo**, mà được cấu hình trong:
46
-
47
- **Settings → Variables and secrets**
48
 
49
  ### 4.1 Variables (không nhạy cảm)
50
-
51
  | Name | Value |
52
- |----|----|
53
  | GEMINI_MODEL_ID | gemini-3-flash-preview |
54
  | VNPT_BASE_URL | https://api.idg.vnpt.vn |
55
  | SMARTBOT_URL | https://assistant-stream.vnpt.vn/v1/conversation |
56
 
57
  ### 4.2 Secrets (API keys)
58
-
59
  | Name | Mô tả |
60
- |----|----|
61
  | GOOGLE_API_KEY | Google GenAI API key |
62
  | VNPT_AI_API_KEY | VNPT AI API key |
63
  | SMARTBOT_KEY | SMARTBOT_KEY |
64
 
65
- Secrets **không hiển thị trong code logs**.
66
 
67
  ---
68
 
69
  ## 5. Cách Space hoạt động
 
70
 
71
- Khi Space được build:
 
 
 
 
72
 
73
- 1. Hugging Face đọc `Dockerfile`
74
- 2. Build Docker image
75
- 3. Inject Variables & Secrets
76
- 4. Chạy FastAPI backend
77
- 5. Public web app qua URL Space
78
 
79
- Không cần thao tác thủ công.
 
 
 
 
 
80
 
81
  ---
82
 
83
  ## 6. Truy cập demo
84
-
85
- Sau khi Space trạng thái **Running**, mở trực tiếp link Space.
86
-
87
- Web UI sẽ hiển thị ngay, hệ thống đã:
88
- - Load dữ liệu mẫu
89
- - Sẵn sàng demo logic AI & sales flow
90
 
91
  ---
92
 
93
  ## 7. Troubleshooting
94
-
95
- ### Space báo Configuration error
96
-
97
- Kiểm tra:
98
- - README **YAML header** không
99
- - `sdk: docker`
100
- - `app_file: Dockerfile`
101
- - Dockerfile nằm ở **ROOT**
102
-
103
- ### Không có log
104
-
105
- - Đợi 1–2 phút sau khi Restart Space
106
- - Tránh restart liên tục
107
 
108
  ---
109
 
110
  ## 8. Ghi chú cho Ban giám khảo
111
-
112
- Đây **MVP demo**, tập trung vào:
113
- - Kiến trúc AI Agent
114
- - Flow xử dữ liệu & vấn sales
115
- - Khả năng mở rộng & tích hợp thực tế
116
 
117
  ---
118
 
119
  ## 9. Liên hệ
120
-
121
- Mọi câu hỏi liên quan đến hệ thống **PINE-AI**
122
- vui lòng liên hệ trực tiếp nhóm phát triển.
 
10
  # PINE-AI MVP – Hugging Face Space (Docker)
11
 
12
  ## 1. Giới thiệu
13
+ PINE-AI là hệ thống AI hỗ trợ **logic sales**, **xử lý dữ liệu khách hàng & gói cước**, demo thông qua giao diện web.
14
+ Phiên bản hiện tại có **3 tab chính**:
15
 
16
+ 1. **Desktop Call** giao diện voicebot trên desktop.
17
+ 2. **Mobile Call** giao diện voicebot trên điện thoại (logic backend giống desktop, chỉ khác UI).
18
+ 3. **Dashboard** – giao diện quản lý, theo dõi hiệu quả AI Agent, xem CSAT metrics & feedback khách hàng.
19
 
20
+ Repository này được cấu hình để chạy trực tiếp trên **Hugging Face Spaces (Docker)**. Ban giám khảo không cần cài Python hay Docker, chỉ cần mở link Space.
 
21
 
22
  ---
23
 
24
  ## 2. Công nghệ sử dụng
25
+ - **Backend:** Python, FastAPI
26
+ - **Frontend:** HTML/JS serve trực tiếp từ backend
27
+ - **AI / LLM:** Google GenAI + VNPT AI (qua API key)
28
+ - **Deployment:** Hugging Face Spaces Docker runtime
 
29
 
30
  ---
31
 
32
  ## 3. Cấu trúc thư mục
33
  ├── Dockerfile
34
  ├── backend/
35
+ ── ai/
36
+ ├── core/
37
+ │ │ ├── init.py
38
+ │ │ ├── analyze.py
39
+ │ │ │ └── logic_flow.py
40
+ │ │ ├── data/
41
+ │ │ │ ├── data_engine.py
42
+ │ │ │ ├── final_voice.scripts.json
43
+ │ │ │ ├── product_collection.json
44
+ │ │ │ └── test_customer.csv
45
+ │ │ ├── strategy/
46
+ │ │ │ ├── init.py
47
+ │ │ │ ├── strategy_competitor.py
48
+ │ │ │ ├── strategy_low_data.py
49
+ │ │ │ └── strategy_network.py
50
+ │ │ ├── main.py
51
+ │ │ ├── services.py
52
+ │ │ └── database.py
53
+ │ └── requirements.txt
54
  ├── frontend/
55
+ │ ├── call_desktop.html
56
+ │ ├── call_mobile.html
57
+ │ └── dashboard.html
58
+ ├── README.md
59
+ └── .gitignore
60
 
61
  ---
62
 
63
  ## 4. Environment Variables & Secrets
64
+ Toàn bộ **API key không commit vào repo**, được cấu hình trong:
65
 
66
+ **Settings Variables and secrets**
 
 
67
 
68
  ### 4.1 Variables (không nhạy cảm)
 
69
  | Name | Value |
70
+ |------|-------|
71
  | GEMINI_MODEL_ID | gemini-3-flash-preview |
72
  | VNPT_BASE_URL | https://api.idg.vnpt.vn |
73
  | SMARTBOT_URL | https://assistant-stream.vnpt.vn/v1/conversation |
74
 
75
  ### 4.2 Secrets (API keys)
 
76
  | Name | Mô tả |
77
+ |------|-------|
78
  | GOOGLE_API_KEY | Google GenAI API key |
79
  | VNPT_AI_API_KEY | VNPT AI API key |
80
  | SMARTBOT_KEY | SMARTBOT_KEY |
81
 
82
+ > Secrets không hiển thị trong code hoặc logs.
83
 
84
  ---
85
 
86
  ## 5. Cách Space hoạt động
87
+ Khi Space được build:
88
 
89
+ 1. Hugging Face đọc `Dockerfile`
90
+ 2. Build Docker image
91
+ 3. Inject Variables & Secrets
92
+ 4. Chạy **FastAPI backend**
93
+ 5. Public web app qua URL Space
94
 
95
+ Không cần thao tác thủ công.
 
 
 
 
96
 
97
+ ### 5.1 Truy cập các tab
98
+ - `/desktop` → Desktop Call UI
99
+ - `/mobile` → Mobile Call UI
100
+ - `/dashboard` → Dashboard quản lý
101
+
102
+ Cả desktop & mobile **dùng chung backend**, chỉ khác giao diện frontend.
103
 
104
  ---
105
 
106
  ## 6. Truy cập demo
107
+ - Sau khi Space ở trạng thái Running, mở trực tiếp link Space.
108
+ - Hệ thống sẽ load dữ liệu mẫu sẵn sàng demo logic AI & sales flow.
109
+ - Dashboard đọc dữ liệu từ `database.py` và (tuỳ deploy) từ `feedback_data.csv` để hiển thị CSAT metrics.
 
 
 
110
 
111
  ---
112
 
113
  ## 7. Troubleshooting
114
+ Nếu Space báo **Configuration error**:
115
+ - Kiểm tra YAML header có đúng chưa (`sdk: docker`, `app_file: Dockerfile`)
116
+ - Dockerfile có nằm ở ROOT không
117
+ - Đợi 1–2 phút sau khi Restart Space
118
+ - Tránh restart liên tục
 
 
 
 
 
 
 
 
119
 
120
  ---
121
 
122
  ## 8. Ghi chú cho Ban giám khảo
123
+ MVP demo tập trung vào:
124
+ - Kiến trúc AI Agent
125
+ - Flow xử dữ liệu & tư vấn sales
126
+ - Khả năng mở rộng & tích hợp thực tế
 
127
 
128
  ---
129
 
130
  ## 9. Liên hệ
131
+ Mọi câu hỏi liên quan tới hệ thống **PINE-AI**, vui lòng liên hệ trực tiếp nhóm phát triển.