Skip to content
This repository was archived by the owner on Mar 11, 2026. It is now read-only.

Commit 442e000

Browse files
author
astrbot-docs-agent[bot]
committed
docs: update for AstrBotDevs/AstrBot#5442
1 parent dd95160 commit 442e000

File tree

2 files changed

+36
-7
lines changed

2 files changed

+36
-7
lines changed

en/use/knowledge-base.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# AstrBot Knowledge Base
32

43
> [!TIP]
@@ -14,8 +13,23 @@ Currently, AstrBot supports embedding vector services compatible with OpenAI API
1413

1514
Click on the provider card above to enter the configuration page and fill in the configuration.
1615

16+
> [!NOTE]
17+
> **OpenAI Embedding API Base URL**
18+
> - OpenAI Embedding automatically appends `/v1` at request time. For example, if you enter `https://api.example.com`, the actual request URL will be `https://api.example.com/v1`.
19+
> - If your API Base URL already contains `/v1`, there's no need to add it again; the system handles this automatically.
20+
>
21+
> **Gemini Embedding API Base URL**
22+
> - Use `https://generativelanguage.googleapis.com` without manually adding `/v1beta`.
23+
1724
After completing the configuration, click Save.
1825

26+
### Automatic Vector Dimension Detection
27+
28+
When creating an embedding model provider, AstrBot automatically detects the model's vector dimension. The system probes the dimension through actual API requests, so you don't need to fill it in manually.
29+
30+
> [!TIP]
31+
> If automatic detection fails, please check that your API Key and API Base URL are correctly configured, and that your network is accessible.
32+
1933
## Configuring Reranker Model (Optional)
2034

2135
A reranker model can improve the precision of final retrieval results to some extent.
@@ -54,6 +68,6 @@ In the configuration file, you can specify different knowledge bases for differe
5468
3. Click on BAAI:BGE-M3 (as of 2025-06-02, this model is free on this platform).
5569
4. Find the API integration guide and apply for a Key.
5670
5. Fill in the AstrBot OpenAI Embedding model provider configuration:
57-
1. API Key is the PPIO API Key you just applied for
58-
2. embedding api base: enter `https://api.ppinfra.com/v3/openai`
59-
3. model: enter the model you selected, in this example `baai/bge-m3`.
71+
1. API Key is the PPIO API Key you just applied for
72+
2. embedding api base: enter `https://api.ppinfra.com/v3/openai`
73+
3. model: enter the model you selected, in this example `baai/bge-m3`.

zh/use/knowledge-base.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,23 @@
1515

1616
点击上面的提供商卡片进入配置页面,填写配置。
1717

18+
> [!NOTE]
19+
> **OpenAI Embedding API Base URL 说明**
20+
> - OpenAI Embedding 会在请求时自动补上 `/v1` 后缀。例如,您填写 `https://api.example.com`,实际请求地址为 `https://api.example.com/v1`
21+
> - 如果您的 API Base URL 已经包含 `/v1`,无需重复添加,系统会自动处理。
22+
>
23+
> **Gemini Embedding API Base URL 说明**
24+
> - 建议填写 `https://generativelanguage.googleapis.com`,无需手动添加 `/v1beta`
25+
1826
配置完成后,点击保存。
1927

28+
### 向量维度自动检测
29+
30+
创建嵌入模型提供商时,AstrBot 会自动检测模型的向量维度。系统会通过实际请求探测模型的维度信息,无需手动填写。
31+
32+
> [!TIP]
33+
> 如果自动检测失败,请检查 API Key 和 API Base URL 是否正确配置,以及网络是否通畅。
34+
2035
## 配置重排序模型(可选)
2136

2237
重排序模型可以一定程度上提高最终召回结果的精度。
@@ -55,6 +70,6 @@ AstrBot 支持多知识库管理。在聊天时,您可以**自由指定知识
5570
3. 点击 BAAI:BGE-M3 (截止至 2025-06-02,该模型在该平台免费)。
5671
4. 找到 API 接入指南,申请 Key。
5772
5. 填写 AstrBot OpenAI Embedding 模型提供商配置:
58-
1. API Key 为刚刚申请的 PPIO 的 API Key
59-
2. embedding api base 填写 `https://api.ppinfra.com/v3/openai`
60-
3. model 填写你选择的模型,此例子中为 `baai/bge-m3`
73+
1. API Key 为刚刚申请的 PPIO 的 API Key
74+
2. embedding api base 填写 `https://api.ppinfra.com/v3/openai`
75+
3. model 填写你选择的模型,此例子中为 `baai/bge-m3`

0 commit comments

Comments
 (0)