From 3be0cc76bdce79ece6b456f8b5183b38fe53cd67 Mon Sep 17 00:00:00 2001 From: dingyi Date: Sat, 12 Oct 2024 16:28:50 +0800 Subject: [PATCH] docs: add new model platform guide for OpenAI Like - Add new section for OpenAI Like in model platform guide - Update sidebar to include OpenAI Like link - Extend introduction to mention OpenAI Like configuration --- docs/.vitepress/config.ts | 4 ++ .../configure-model-platform/introduction.md | 2 +- .../configure-model-platform/openai-like.md | 42 +++++++++++++++++++ 3 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 docs/guide/configure-model-platform/openai-like.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 7c60bed..938fe80 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -156,6 +156,10 @@ function sidebarGuide() { text: 'Moonshot', link: '/guide/configure-model-platform/moonshot', }, + { + text: 'OpenAI Like', + link: '/guide/configure-model-platform/openai-like', + }, { text: 'Ollama', link: '/guide/configure-model-platform/ollama', diff --git a/docs/guide/configure-model-platform/introduction.md b/docs/guide/configure-model-platform/introduction.md index ab13aba..97df4ca 100644 --- a/docs/guide/configure-model-platform/introduction.md +++ b/docs/guide/configure-model-platform/introduction.md @@ -8,4 +8,4 @@ ChatLuna 的模型平台无疑是最基础的功能。它为 ChatLuna 本体和 在接下来的章节中，我们将详细介绍 ChatLuna 各类的模型平台，包括其的配置项，如何接入和常见问题等。 -继续向下滚动，你将在每一页的底部看到前往下一节的链接。 \ No newline at end of file +继续向下滚动，你将在每一页的底部看到前往下一节的链接。 diff --git a/docs/guide/configure-model-platform/openai-like.md b/docs/guide/configure-model-platform/openai-like.md new file mode 100644 index 0000000..fd3e8c9 --- /dev/null +++ b/docs/guide/configure-model-platform/openai-like.md @@ -0,0 +1,42 @@ +# OpenAI Like + +ChatLuna 为其他任意兼容 OpenAI 格式的 API提供了一个统一的 `openai-like-adapter`。 + +`openai-like-adapter` 具有以下特性： + +- 可以设置 `platform` 的名称，并支持同时启用多个模型适配器（只需要确保 `platform` 不同即可。） + +## 安装 + +前往插件市场，搜索 `chatluna-openai-like-adapter`，安装即可。 + +![openai-like-adapter](../../public/images/image-11.png) + +## 配置 + +只需要从你的 API 提供商获取 API Key 和 API Host 即可转到下一把 + +::: tip 提示 +未来我们可能会录制官方教程，敬请期待。 +::: + +获取到 API key 后，转到 `openai-like-adapter` 的配置页面。 + +在 `openai-like-adapter` 配置页里可以更改平台名，你需要更改为与其他模型适配器都不一样的平台名，防止冲突。 +当然，你也可以更改你喜欢的其他平台名。 + +然后在请求设置里填入你的 API key 和 OpenAI 兼容的请求地址。一般 OpenAI 兼容的格式为 `https://xxx.com/api/v1`。 + +也就是在调用 OpenAI 库时的 `baseUrl`，但是注意后面需要添加 `v1` 后缀。 + +![alt text](../../public/images/image-20.png) + +记得点击右上角的保存按钮。 + +## 使用 + +在适配器的配置页面，点击运行按钮，如无误，你应该看不到任何错误 log，那即可转到 ChatLuna 的主插件页面。 + +在主插件页面，下划到 [模版房间选项](../useful-configurations.md#模版房间选项)，查看 [defaultModel](../useful-configurations.md#defaultmodel) 的选项里是否含有相关模型，如果有，则说明你已经成功地接入了相关平台。 + +![alt text](../../public/images/image-21.png)