nhantrungsp commited on
Commit
9edbbf7
·
verified ·
1 Parent(s): 9434032

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +92 -80
README.md CHANGED
@@ -1,81 +1,93 @@
1
- # 🎙️ VieNeu-TTS API Server
2
-
3
- **Vietnamese Text-to-Speech API với 10 giọng nói tự nhiên**
4
-
5
- ## 🚀 Quick Start
6
-
7
- ### 1. Khởi động Server
8
- ```bash
9
- start_server.bat
10
- ```
11
-
12
- ### 2. Test API
13
- ```bash
14
- curl -X POST "http://127.0.0.1:8000/fast-tts" \
15
- -H "Content-Type: application/json" \
16
- -d '{
17
- "text": "Xin chào, tôi là VieNeu-TTS",
18
- "voice_choice": "Tuyên (nam miền Bắc)",
19
- "return_base64": true
20
- }'
21
- ```
22
-
23
- ### 3. Sử dụng trong Python
24
- ```python
25
- import requests
26
- import base64
27
-
28
- # Gửi request
29
- response = requests.post("http://127.0.0.1:8000/fast-tts", json={
30
- "text": "Xin chào từ VieNeu-TTS",
31
- "voice_choice": "Ngọc (nữ miền Bắc)",
32
- "return_base64": True
33
- })
34
-
35
- # Lưu audio
36
- if response.status_code == 200:
37
- result = response.json()
38
- audio_bytes = base64.b64decode(result["audio_base64"])
39
- with open("output.wav", "wb") as f:
40
- f.write(audio_bytes)
41
- ```
42
-
43
- ## 📡 API Endpoints
44
-
45
- | Endpoint | Method | Description |
46
- |----------|--------|-------------|
47
- | `/fast-tts` | POST | **TTS nhanh** (recommended) |
48
- | `/tts` | POST | TTS standard |
49
- | `/bulk-tts` | POST | Xử lý batch (max 50) |
50
- | `/voices` | GET | Danh sách giọng nói |
51
- | `/health` | GET | Health check |
52
- | `/docs` | GET | **API Documentation** |
53
-
54
- ## 🎭 Giọng nói có sẵn
55
-
56
- - **Nam miền Bắc**: Tuyên, Bình
57
- - **Nam miền Nam**: Vĩnh, Nguyên, Sơn
58
- - **Nữ miền Bắc**: Ngọc, Ly
59
- - **Nữ miền Nam**: Đoan, Dung
60
- - **Đặc biệt**: Nhỏ Ngọt Ngào
61
-
62
- ## 🔧 Cấu hình
63
-
64
- - **Server**: http://127.0.0.1:8000
65
- - **GUI**: Tích hợp sẵn khi chạy server
66
- - **Performance**: thể điều chỉnh từ giao diện
67
- - **Cache**: Tự động cache giọng nói
68
-
69
- ## 📚 Tài liệu đầy đủ
70
-
71
- Xem [API_DOCUMENTATION.md](API_DOCUMENTATION.md) để biết chi tiết.
72
-
73
- ## 💡 Tips
74
-
75
- 1. **Dùng `/fast-tts`** thay vì `/tts`
76
- 2. **Set `return_base64=true`** để tránh file I/O
77
- 3. **Cache kết quả** theo text + voice + speed
78
- 4. **Dùng cùng giọng** cho requests liên tiếp
79
-
80
-
 
 
 
 
 
 
 
 
 
 
 
 
81
  **🚀 Bắt đầu ngay với `start_server.bat`!**
 
1
+ ---
2
+ title: VieNeu TTS
3
+ emoji: 🎙️
4
+ colorFrom: indigo
5
+ colorTo: blue
6
+ sdk: gradio
7
+ sdk_version: 4.19.2
8
+ app_file: gradio_app.py
9
+ pinned: false
10
+ license: mit
11
+ ---
12
+
13
+ # 🎙️ VieNeu-TTS API Server
14
+
15
+ **Vietnamese Text-to-Speech API với 10 giọng nói tự nhiên**
16
+
17
+ ## 🚀 Quick Start
18
+
19
+ ### 1. Khởi động Server
20
+ ```bash
21
+ start_server.bat
22
+ ```
23
+
24
+ ### 2. Test API
25
+ ```bash
26
+ curl -X POST "http://127.0.0.1:8000/fast-tts" \
27
+ -H "Content-Type: application/json" \
28
+ -d '{
29
+ "text": "Xin chào, tôi là VieNeu-TTS",
30
+ "voice_choice": "Tuyên (nam miền Bắc)",
31
+ "return_base64": true
32
+ }'
33
+ ```
34
+
35
+ ### 3. Sử dụng trong Python
36
+ ```python
37
+ import requests
38
+ import base64
39
+
40
+ # Gửi request
41
+ response = requests.post("http://127.0.0.1:8000/fast-tts", json={
42
+ "text": "Xin chào từ VieNeu-TTS",
43
+ "voice_choice": "Ngọc (nữ miền Bắc)",
44
+ "return_base64": True
45
+ })
46
+
47
+ # Lưu audio
48
+ if response.status_code == 200:
49
+ result = response.json()
50
+ audio_bytes = base64.b64decode(result["audio_base64"])
51
+ with open("output.wav", "wb") as f:
52
+ f.write(audio_bytes)
53
+ ```
54
+
55
+ ## 📡 API Endpoints
56
+
57
+ | Endpoint | Method | Description |
58
+ |----------|--------|-------------|
59
+ | `/fast-tts` | POST | **TTS nhanh** (recommended) |
60
+ | `/tts` | POST | TTS standard |
61
+ | `/bulk-tts` | POST | Xử lý batch (max 50) |
62
+ | `/voices` | GET | Danh sách giọng nói |
63
+ | `/health` | GET | Health check |
64
+ | `/docs` | GET | **API Documentation** |
65
+
66
+ ## 🎭 Giọng nói sẵn
67
+
68
+ - **Nam miền Bắc**: Tuyên, Bình
69
+ - **Nam miền Nam**: Vĩnh, Nguyên, Sơn
70
+ - **Nữ miền Bắc**: Ngọc, Ly
71
+ - **Nữ miền Nam**: Đoan, Dung
72
+ - **Đặc biệt**: Nhỏ Ngọt Ngào
73
+
74
+ ## 🔧 Cấu hình
75
+
76
+ - **Server**: http://127.0.0.1:8000
77
+ - **GUI**: Tích hợp sẵn khi chạy server
78
+ - **Performance**: thể điều chỉnh từ giao diện
79
+ - **Cache**: Tự động cache giọng nói
80
+
81
+ ## 📚 Tài liệu đầy đủ
82
+
83
+ Xem [API_DOCUMENTATION.md](API_DOCUMENTATION.md) để biết chi tiết.
84
+
85
+ ## 💡 Tips
86
+
87
+ 1. **Dùng `/fast-tts`** thay vì `/tts`
88
+ 2. **Set `return_base64=true`** để tránh file I/O
89
+ 3. **Cache kết quả** theo text + voice + speed
90
+ 4. **Dùng cùng giọng** cho requests liên tiếp
91
+
92
+
93
  **🚀 Bắt đầu ngay với `start_server.bat`!**