Skip to content

Commit 933937a

Browse files
committed
add llm notice
1 parent 4093118 commit 933937a

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

  • docs/user-guide/backend
  • i18n/en/docusaurus-plugin-content-docs/current/user-guide/backend

docs/user-guide/backend/llm.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ import TabItem from '@theme/TabItem';
99

1010
本项目支持多种大语言模型后端与模型。
1111

12+
:::note
13+
几乎所有的大语言模型 API 和推理引擎都支持 OpenAI 格式,所以如果你发现你想用的那个 LLM API 在我们项目中没有明确的被支持,直接把相关信息 (base url, api key, 模型名称) 填到 `openai_compatible_llm` 里面,基本都能直接用。
14+
15+
实际上,除了 llama.cpp 和 claude 以外,其他所有本项目支持的 LLM api 或 llm 后端都是 `openai_compatible_llm` 的换皮 (Ollama 我们加了个模型加载的逻辑),代码完全相同。区别只是 base url 和一些设定被提前填好了。
16+
:::
17+
1218
### 如何配置和切换不同的大语言模型后端
1319

1420
> 项目预设的智能体 (Agent) 是 `basic_memory_agent`,所以要切换预设 Agent 的语言模型,在 `basic_memory_agent``llm_provider` 选项下进行选择。

i18n/en/docusaurus-plugin-content-docs/current/user-guide/backend/llm.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ import TabItem from '@theme/TabItem';
99

1010
This project supports multiple large language model backends and models.
1111

12+
:::note
13+
Almost all large language model (LLM) APIs and inference engines support the OpenAI format. So, if you find that an LLM API you want to use isn't explicitly supported in our project, you can usually just fill in the relevant information (base URL, API key, model name) into the `openai_compatible_llm` section, and it should work right away.
14+
15+
In fact, apart from llama.cpp and Claude, all other LLM APIs or backends supported by this project are essentially just variations of `openai_compatible_llm` (we added some model loading logic for Ollama), using the exact same code. The only difference is that we've pre-filled the base URL and some other settings for you.
16+
:::
17+
1218
### How to configure and switch between different large language model backends
1319

1420
> The project's default agent is `basic_memory_agent`, so to switch the language model for the default agent, make selections under the `llm_provider` option of `basic_memory_agent`.

0 commit comments

Comments
 (0)