Skip to content

Commit fb3c0ab

Browse files
committed
docs: 添加硅基流动配置指南的中英文文档
1 parent f509558 commit fb3c0ab

2 files changed

Lines changed: 466 additions & 0 deletions

File tree

Lines changed: 233 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,233 @@
1+
---
2+
draft: false
3+
title: SiliconFlow Configuration Guide
4+
description: Configure AI chat and remote embedding models with SiliconFlow.
5+
---
6+
7+
[SiliconFlow](https://siliconflow.cn/) is a leading AI model service platform in China, providing rich open-source model APIs, including chat models and Embedding models.
8+
9+
## Why Choose SiliconFlow?
10+
11+
- **Affordable Pricing**: Pay-as-you-go, with free credits for new users
12+
- **Rich Model Selection**: Supports DeepSeek, Qwen, Llama and other mainstream open-source models
13+
- **Fast Access in China**: Servers located in China for fast access
14+
- **Embedding Models**: Provides various Embedding models for semantic search
15+
16+
## Register Account
17+
18+
1. Visit [SiliconFlow Official Website](https://cloud.siliconflow.cn/)
19+
2. Click "Register" to create an account
20+
3. Complete identity verification (required for some models)
21+
22+
![SiliconFlow Register Page](./images/siliconflow-register.png)
23+
*Register SiliconFlow Account*
24+
25+
![Identity Verification Page](./images/siliconflow-verify.png)
26+
*Complete Identity Verification*
27+
28+
## Get API Key
29+
30+
1. After logging in, go to [API Key Management](https://cloud.siliconflow.cn/account/ak)
31+
2. Click "Create API Key"
32+
3. Copy the generated API Key (starts with `sk-`)
33+
34+
![API Key Management Page](./images/siliconflow-api-keys.png)
35+
*API Key Management Page*
36+
37+
![Create New Key](./images/siliconflow-create-key.png)
38+
*Click Create API Key*
39+
40+
![Copy API Key](./images/siliconflow-copy-key.png)
41+
*Copy Generated API Key*
42+
43+
:::warning
44+
Please keep your API Key safe and do not share it with others.
45+
:::
46+
47+
## Configure AI Chat
48+
49+
### Steps
50+
51+
1. Go to **Settings → AI**
52+
2. Click "Add Endpoint"
53+
3. Select **SiliconFlow** as provider
54+
4. Enter your API Key
55+
5. Click "Fetch Models" to get available models
56+
6. Select the model you want to use
57+
58+
![ReadAny AI Settings Page](./images/readany-ai-settings.png)
59+
*ReadAny AI Settings Page*
60+
61+
![Add SiliconFlow Endpoint](./images/readany-add-siliconflow.png)
62+
*Add SiliconFlow Endpoint*
63+
64+
![Enter API Key](./images/readany-enter-apikey.png)
65+
*Enter API Key and Fetch Models*
66+
67+
![Select Model](./images/readany-select-model.png)
68+
*Select Model to Use*
69+
70+
### Recommended Models
71+
72+
| Model | Description |
73+
|---|---|
74+
| **DeepSeek-V3** | Strong overall capability, suitable for daily chat |
75+
| **DeepSeek-R1** | Strong reasoning ability, suitable for complex analysis |
76+
| **Qwen2.5-72B-Instruct** | Alibaba open-source, strong Chinese capability |
77+
| **Llama-3.3-70B-Instruct** | Meta open-source, strong English capability |
78+
79+
## Configure Embedding Model (Semantic Search)
80+
81+
SiliconFlow provides various Embedding models for book semantic search functionality.
82+
83+
### Steps
84+
85+
1. Go to **Settings → Embedding Model**
86+
2. Select "Remote API"
87+
3. Select **SiliconFlow** as provider
88+
4. Enter your API Key
89+
5. Select an Embedding model
90+
91+
![Embedding Model Settings Page](./images/readany-embedding-settings.png)
92+
*Embedding Model Settings Page*
93+
94+
![Select SiliconFlow Embedding Model](./images/readany-embedding-siliconflow.png)
95+
*Select SiliconFlow as Embedding Model Provider*
96+
97+
### Recommended Embedding Models
98+
99+
| Model | Max Length | Description |
100+
|---|---|---|
101+
| **BAAI/bge-m3** | 8192 | Multilingual support, recommended for Chinese users |
102+
| **BAAI/bge-large-zh-v1.5** | 512 | Chinese-specific, fast |
103+
| **BAAI/bge-large-en-v1.5** | 512 | English-specific |
104+
| **Qwen/Qwen3-Embedding** | 32768 | Alibaba open-source, ultra-long text support |
105+
106+
### Using Embedding Model
107+
108+
After configuration:
109+
110+
1. Open a book
111+
2. Click the "Vectorize" button in the sidebar
112+
3. Select "Use Remote API"
113+
4. Wait for processing to complete
114+
115+
![Book Vectorize Button](./images/readany-vectorize-button.png)
116+
*Click Vectorize Button*
117+
118+
![Select Remote API](./images/readany-vectorize-remote.png)
119+
*Select Use Remote API for Vectorization*
120+
121+
![Vectorization Progress](./images/readany-vectorize-progress.png)
122+
*Vectorization Processing Progress*
123+
124+
Embedding data will be sent to SiliconFlow servers for processing, and the index will be saved locally after completion.
125+
126+
:::info
127+
Mobile only supports remote embedding API, not local embedding models (to reduce app size).
128+
:::
129+
130+
## Pricing
131+
132+
SiliconFlow uses pay-as-you-go pricing:
133+
134+
- **Chat Models**: Charged by input/output token count
135+
- **Embedding Models**: Charged by processed token count
136+
137+
New users get free credits after registration. Check the official website for details.
138+
139+
![SiliconFlow Billing Page](./images/siliconflow-billing.png)
140+
*Billing and Usage Statistics Page*
141+
142+
## Troubleshooting
143+
144+
### API Key Invalid
145+
146+
**Symptoms**: "API Key invalid" or "Authentication failed" error
147+
148+
**Solutions**:
149+
- Confirm the API Key is correctly copied without extra spaces
150+
- Check if identity verification is completed
151+
- Confirm account balance is sufficient
152+
- Try creating a new API Key
153+
154+
### Model List Empty
155+
156+
**Symptoms**: Model list is empty or errors after clicking "Fetch Models"
157+
158+
**Solutions**:
159+
- Check network connection
160+
- Confirm API Key is valid
161+
- Some models need to be enabled in SiliconFlow console first
162+
- Try manually entering the model name
163+
164+
### Vectorization Failed
165+
166+
**Symptoms**: Vectorization process interrupted or errors
167+
168+
**Solutions**:
169+
- Check if embedding model is correctly configured
170+
- Confirm account balance is sufficient
171+
- Large files may take longer to process, please wait patiently
172+
- Check network connection stability
173+
- Try switching to another Embedding model
174+
175+
### Connection Timeout
176+
177+
**Symptoms**: Request timeout or no response
178+
179+
**Solutions**:
180+
- Check network connection
181+
- If overseas, may need to use a proxy
182+
- Check if SiliconFlow service is normal (check official announcements)
183+
- Try changing network environment
184+
185+
### Model Not Responding
186+
187+
**Symptoms**: No reply for a long time after sending message
188+
189+
**Solutions**:
190+
- Check if model is available in current region
191+
- Confirm model name is correct
192+
- Try switching to another model
193+
- Check if account has sufficient balance
194+
195+
### Insufficient Balance
196+
197+
**Symptoms**: "Insufficient balance" or "Quota exhausted" error
198+
199+
**Solutions**:
200+
- Login to SiliconFlow console to check balance
201+
- Top up account
202+
- Check if there are unclaimed free credits
203+
204+
### Rate Limit
205+
206+
**Symptoms**: "Too many requests" or "Rate Limit" error
207+
208+
**Solutions**:
209+
- Reduce request frequency
210+
- Wait for a while and retry
211+
- Upgrade account level for higher limits
212+
213+
## Screenshot Checklist
214+
215+
Please prepare the following screenshots and place them in `website/src/content/docs/support/ai/images/` directory:
216+
217+
| Filename | Description |
218+
|---|---|
219+
| `siliconflow-register.png` | SiliconFlow register page |
220+
| `siliconflow-verify.png` | Identity verification page |
221+
| `siliconflow-api-keys.png` | API key management page |
222+
| `siliconflow-create-key.png` | Create new key popup |
223+
| `siliconflow-copy-key.png` | Copy API key |
224+
| `readany-ai-settings.png` | ReadAny AI settings page |
225+
| `readany-add-siliconflow.png` | Add SiliconFlow endpoint |
226+
| `readany-enter-apikey.png` | Enter API key |
227+
| `readany-select-model.png` | Select model |
228+
| `readany-embedding-settings.png` | Embedding model settings page |
229+
| `readany-embedding-siliconflow.png` | Select SiliconFlow embedding model |
230+
| `readany-vectorize-button.png` | Book vectorize button |
231+
| `readany-vectorize-remote.png` | Select remote API |
232+
| `readany-vectorize-progress.png` | Vectorization progress |
233+
| `siliconflow-billing.png` | Billing statistics page |

0 commit comments

Comments
 (0)