Update readme with seekdb embedded model instructions (#76)

* Update readme with seekdb embedded model instructions

* doc: en and ja

---------

Co-authored-by: Junyan Qin <[email protected]>
This commit is contained in:
huanghuoguoguo
2025-12-20 23:13:07 +08:00
committed by GitHub
co-authored by Junyan Qin
parent cb0b2783af
commit 00107dbef3
3 changed files with 42 additions and 4 deletions
+18 -2
View File
@@ -1,12 +1,14 @@
# Configure Models (Models)
## LLM Model
Models will be used by pipelines to process messages. The first model you configure will be set as the model for the default pipeline.
![arch](/assets/image/zh/deploy/models/arch.png)
You can add multiple models, and then select which model to use in the pipeline.
![Model Configuration](/assets/image/zh/deploy/models/model_config.png)
<img width="400px" src="/assets/image/zh/deploy/models/model_config.png" alt="model_config" />
Enter these four parameters: `Model Name`, `Model Provider`, `Request URL`, and `API Key`, then submit.
@@ -26,6 +28,20 @@ Select `OpenAI`
Fill in the relay's Base URL for the Request URL, for example:
![Model Configuration](/assets/image/zh/deploy/models/other_provider.png)
<img width="400px" src="/assets/image/zh/deploy/models/other_provider.png" alt="other_provider" />
:::
## Embedding Model
Embedding models are used to compute vector representations of messages. If you need to use knowledge bases, please configure this model.
<img width="400px" src="/assets/image/zh/deploy/models/embedding_model.png" alt="embedding_model" />
Enter these four parameters: `Model Name`, `Model Provider`, `Request URL`, and `API Key`, then submit. After that, please configure the knowledge base to use this model.
### Using seekdb Built-in Embedding Model (Zero Configuration)
The system has integrated the official embedding model provided by seekdb, no parameters required.
- On the "Embedding Model" page, select "seekdb-built-in";
- Click "Save" to use it immediately;
- Then select this model in your knowledge base to take effect.
+18 -2
View File
@@ -1,12 +1,14 @@
# モデルの設定(Models)
## 対話モデル (LLM Model)
モデルはパイプラインによってメッセージ処理に使用されます。最初に設定したモデルがデフォルトパイプラインのモデルとして設定されます。
![arch](/assets/image/zh/deploy/models/arch.png)
複数のモデルを追加して、パイプラインでどのモデルを使用するかを選択できます。
![モデル設定](/assets/image/zh/deploy/models/model_config.png)
<img width="400px" src="/assets/image/zh/deploy/models/model_config.png" alt="model_config" />
これら4つのパラメータを入力します: `モデル名`、`モデルプロバイダー`、`リクエストURL`、`APIキー`、そして送信します。
@@ -26,6 +28,20 @@
リクエストURLにリレーのBase URLを入力します。例:
![モデル設定](/assets/image/zh/deploy/models/other_provider.png)
<img width="400px" src="/assets/image/zh/deploy/models/other_provider.png" alt="other_provider" />
:::
## 埋め込みモデル (Embedding Model)
埋め込みモデルはメッセージのベクトル表現を計算するために使用されます。ナレッジベースを使用する場合は、このモデルを設定してください。
<img width="400px" src="/assets/image/zh/deploy/models/embedding_model.png" alt="embedding_model" />
これら4つのパラメータを入力します: `モデル名`、`モデルプロバイダー`、`リクエストURL`、`APIキー`、そして送信します。その後、ナレッジベースでこのモデルを使用するように設定してください。
### seekdb内蔵埋め込みモデルの使用(ゼロ設定)
システムにはseekdbが提供する公式埋め込みモデルが統合されており、パラメータの入力は不要です。
- 「埋め込みモデル」ページで「seekdb-内蔵」を選択します;
- 「保存」をクリックするとすぐに使用できます;
- その後、ナレッジベースでこのモデルを選択すると有効になります。
+6
View File
@@ -39,3 +39,9 @@
<img width="400px" src="/assets/image/zh/deploy/models/embedding_model.png" alt="embedding_model" />
填入这四个参数`模型名称`、`模型供应商`、`请求 URL`、`API Key`,然后提交即可,之后请在知识库中配置使用此模型。
### 使用 seekdb 内置嵌入模型(零配置)
系统已集成 seekdb 提供的官方嵌入模型,无需填写任何参数。
- 在“嵌入模型”页面选择「seekdb-内置」;
- 点击「保存」即可立即使用;
- 后续在知识库中选择该模型即可生效。