Skip to content

Commit 067611f

Browse files
committed
修改 api 注意事项
1 parent 4fb659d commit 067611f

File tree

4 files changed

+12
-0
lines changed

4 files changed

+12
-0
lines changed
122 KB
Loading

docs/user_manual/X-Pack/system_API.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@
1919

2020
![swagger](../../img/system/swagger_api.png)
2121

22+
!!! Abstract ""
23+
注意:当使用的接口涉及应用对话时,Authorize 需填写应用的 API Key(application-0d5722xxxxxxxxx),否则会出现如下报错:
24+
![swagger](../../img/system/swagger_apinotice.png)
25+
2226

2327

2428
## 3 开启身份验证的 API 调用

docs/user_manual/app/workflow_app.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,6 +273,7 @@
273273
- 知识库:待检索的知识库。
274274
- 检索参数:包括检索模式、相似度阈值、引用分段数量以及最大引用字符数。
275275
- 检索问题:一般是开始节点的用户问题。
276+
- 结果显示在知识来源中:默认关闭,开启后可以在回答结果中显示知识来源。
276277

277278
参数输出:
278279

docs/user_manual/chat_to_API.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@
99
MaxKB 应用兼容 OpenAI API 格式,在 OpenAI API 原有调用方式的基础上替换为 MaxKB 应用提供的 Base URL 以及 API Key 即可。
1010
![api示例](../../img/system/api_example.png)
1111

12+
!!! Abstract ""
13+
**注意:**
14+
15+
- openai url 的格式为: Base URL/chat/completions
16+
17+
- openai Authorization 的格式为:Bearer API Key
18+
1219
!!! Abstract ""
1320
```
1421
# 将 url 和 Authorization 替换为 MaxKB 应用实际真实的 Base URL 和 API Key。

0 commit comments

Comments
 (0)