Skip to content

Commit a9ce92b

Browse files
committed
docs: add iflytek config doc
1 parent a5bb916 commit a9ce92b

5 files changed

Lines changed: 74 additions & 0 deletions

File tree

.vscode/settings.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,11 @@
5454
"deepseek",
5555
"esno",
5656
"execa",
57+
"Flytek",
5758
"fullpath",
5859
"ianvs",
5960
"iconify",
61+
"iflytek",
6062
"knip",
6163
"langchain",
6264
"Nicepkg",

website/.vitepress/config/en.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,7 @@ function sidebar(): DefaultTheme.Sidebar {
154154
{ text: 'Azure', link: '/azure' },
155155
{ text: 'DeepSeek', link: '/deepseek' },
156156
{ text: 'Google', link: '/google' },
157+
{ text: 'IFlytek', link: '/iflytek' },
157158
{ text: 'LocalAI', link: '/local-ai' },
158159
{ text: 'Ollama', link: '/ollama' },
159160
{ text: 'OpenAI', link: '/openai' },

website/.vitepress/config/zh.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,7 @@ function sidebar(): DefaultTheme.Sidebar {
187187
{ text: 'Azure', link: '/azure' },
188188
{ text: 'DeepSeek', link: '/deepseek' },
189189
{ text: '谷歌', link: '/google' },
190+
{ text: '讯飞', link: '/iflytek' },
190191
{ text: 'LocalAI', link: '/local-ai' },
191192
{ text: 'Ollama', link: '/ollama' },
192193
{ text: 'OpenAI', link: '/openai' },
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# IFlytek
2+
3+
## Spark
4+
5+
This guide introduces how to configure and use the `IFlytek Spark` model in `Aide`.
6+
7+
You can find more detailed information in the [official IFlytek Spark reference documentation](https://www.xfyun.cn/doc/spark/HTTP%E8%B0%83%E7%94%A8%E6%96%87%E6%A1%A3.html#_1-%E6%8E%A5%E5%8F%A3%E8%AF%B4%E6%98%8E).
8+
9+
### API Base URL Configuration
10+
11+
You need to set [`aide.openaiBaseUrl`](../configuration/openai-base-url.md) to `https://spark-api-open.xf-yun.com/v1`.
12+
13+
### API Key Configuration
14+
15+
You need to set [`aide.openaiKey`](../configuration/openai-key.md) to your `IFlytek Spark` API `key:secret`.
16+
17+
### Model Configuration
18+
19+
You need to set [`aide.openaiModel`](../configuration/openai-model.md) to the `IFlytek Spark` model. We recommend using the `4.0Ultra` model. For more models, please refer to the official reference documentation linked above.
20+
21+
### Example Configuration File
22+
23+
Here is a complete configuration example:
24+
25+
```json
26+
{
27+
"aide.openaiBaseUrl": "https://spark-api-open.xf-yun.com/v1",
28+
29+
// Assuming your iFlytek key is k123, and secret is s123
30+
"aide.openaiKey": "k123:s123",
31+
"aide.openaiModel": "4.0Ultra"
32+
}
33+
```
34+
35+
Make sure to replace `"aide.openaiKey"` with your actual API `key:secret`.
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# 讯飞
2+
3+
## 星火
4+
5+
本指南介绍如何在 `Aide` 中配置和使用 `讯飞星火` 模型。
6+
7+
您可以在 [讯飞星火官方参考文档](https://www.xfyun.cn/doc/spark/HTTP%E8%B0%83%E7%94%A8%E6%96%87%E6%A1%A3.html#_1-%E6%8E%A5%E5%8F%A3%E8%AF%B4%E6%98%8E) 获取更多详细信息。
8+
9+
### API Base URL 配置
10+
11+
您需要配置 [`aide.openaiBaseUrl`](../configuration/openai-base-url.md)`https://spark-api-open.xf-yun.com/v1`
12+
13+
### API Key 配置
14+
15+
您需要配置 [`aide.openaiKey`](../configuration/openai-key.md) 为您的 `讯飞星火` API `key:secret`
16+
17+
### 模型配置
18+
19+
你需要配置 [`aide.openaiModel`](../configuration/openai-model.md)`讯飞星火` 模型,我们推荐使用 `4.0Ultra` 模型。更多模型请参考上面的官方参考文档。
20+
21+
### 示例配置文件
22+
23+
以下是一个完整的配置示例:
24+
25+
```json
26+
{
27+
"aide.openaiBaseUrl": "https://spark-api-open.xf-yun.com/v1",
28+
29+
// 假设你的讯飞 key 是 k123, secret 是 s123
30+
"aide.openaiKey": "k123:s123",
31+
"aide.openaiModel": "4.0Ultra"
32+
}
33+
```
34+
35+
确保将 `"aide.openaiKey"` 替换为您实际的 API `key:secret`

0 commit comments

Comments
 (0)