📝 docs: update docs (lobehub#3209)

LovelyGuYiMeng · Jul 13, 2024 · 0e4ed20 · 0e4ed20
1 parent 4756e5e
commit 0e4ed20
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 4 deletions.
diff --git a/docs/self-hosting/platform/docker.zh-CN.mdx b/docs/self-hosting/platform/docker.zh-CN.mdx
@@ -23,6 +23,8 @@ tags:
 
 我们提供了 [Docker 镜像][docker-release-link]，供你在自己的私有设备上部署 LobeChat 服务。
 
+## 部署指南
+
 <Steps>
   ### 安装 Docker 容器环境
 
@@ -60,7 +62,7 @@ $ docker run -d -p 3210:3210 \
 指令说明：
 
 - 默认映射端口为 `3210`, 请确保未被占用或手动更改端口映射
-- 使用你的 OpenAI API Key 替换上述命令中的 `sk-xxxx`
+- 使用你的 OpenAI API Key 替换上述命令中的 `sk-xxxx` ，获取 API Key 的方式详见最后一节。
 
 <Callout type={'tip'}>
   LobeChat 支持的完整环境变量列表请参考 [📘 环境变量](/docs/self-hosting/environment-variables) 部分
@@ -159,6 +161,64 @@ echo "Removed old images."
 
 </Steps>
 
+## 获取 OpenAI API Key
+
+API Key 是使用 LobeChat 进行大语言模型会话的必要信息，本节以 OpenAI 模型服务商为例，简要介绍获取 API Key 的方式。
+
+### `A` 通过 OpenAI 官方渠道
+
+- 注册一个 [OpenAI 账户](https://platform.openai.com/signup)，你需要使用国际手机号、非大陆邮箱进行注册；
+- 注册完毕后，前往 [API Keys](https://platform.openai.com/api-keys) 页面，点击 `Create new secret key` 创建新的 API Key:
+
+<Steps>
+
+#### 步骤 1：打开创建窗口
+
+<Image
+  alt={'打开创建窗口'}
+  height={600}
+  src="https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/296253192-ff2193dd-f125-4e58-82e8-91bc376c0d68.png"
+/>
+
+#### 步骤 2：创建 API Key
+
+<Image
+  alt={'创建 API Key'}
+  height={600}
+  src="https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/296254170-803bacf0-4471-4171-ae79-0eab08d621d1.png"
+/>
+
+#### 步骤 3：获取 API Key
+
+<Image
+  alt={'获取 API Key'}
+  height={600}
+  src="https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/296255167-f2745f2b-f083-4ba8-bc78-9b558e0002de.png"
+/>
+
+</Steps>
+
+将此 API Key 填写到 LobeChat 的 API Key 配置中，即可开始使用。
+
+<Callout type={'tip'}>
+  账户注册后，一般有 5 美元的免费额度，但有效期只有三个月。如果你希望长期使用你的 API
+  Key，你需要完成支付的信用卡绑定。由于 OpenAI
+  只支持外币信用卡，因此你需要找到合适的支付渠道，此处不再详细展开。
+</Callout>
+
+### `B` 通过 OpenAI 第三方代理商
+
+如果你发现注册 OpenAI 账户或者绑定外币信用卡比较麻烦，可以考虑借助一些知名的 OpenAI 第三方代理商来获取 API Key，这可以有效降低获取 OpenAI API Key 的门槛。但与此同时，一旦使用三方服务，你可能也需要承担潜在的风险，请根据你自己的实际情况自行决策。以下是常见的第三方模型代理商列表，供你参考：
+
+| Logo | 服务商 | 特性说明 | Proxy 代理地址 | 链接 |
+| --- | --- | --- | --- | --- |
+| <img src="https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/296272721-c3ac0bf3-e433-4496-89c4-ebdc20689c17.jpg" width="40" /> | **AiHubMix** | 使用 OpenAI 企业接口，全站模型价格为官方 **86 折**（含 GPT-4 、Cluade 3.5 等） | `https://aihubmix.com/v1` | [获取](https://lobe.li/CnsM6fH) |
+
+<Callout type={'warning'}>
+  **免责申明**: 在此推荐的 OpenAI API Key 由第三方代理商提供，所以我们不对 API Key 的 **有效性** 和
+  **安全性** 负责，请你自行承担购买和使用 API Key 的风险。
+</Callout>
+
 [docker-pulls-link]: https://hub.docker.com/r/lobehub/lobe-chat
 [docker-pulls-shield]: https://img.shields.io/docker/pulls/lobehub/lobe-chat?color=45cc11&labelColor=black&style=flat-square
 [docker-release-link]: https://hub.docker.com/r/lobehub/lobe-chat

diff --git a/docs/usage/tools-calling/google.zh-CN.mdx b/docs/usage/tools-calling/google.zh-CN.mdx
@@ -1,6 +1,8 @@
 ---
-title: Google Gemini 系列 Tool Calling  评测
-description: 使用 LobeChat 测试 Google Gemini 系列模型（Gemini 1.5 Pro / Gemini 1.5 Flash）的工具调用（Function Calling）能力，并展现评测结果
+title: Google Gemini 系列 Tools Calling  评测
+description: >-
+  使用 LobeChat 测试 Google Gemini 系列模型（Gemini 1.5 Pro / Gemini 1.5
+  Flash）的工具调用（Function Calling）能力，并展现评测结果
 tags:
   - Tools Calling
   - Benchmark
@@ -9,7 +11,7 @@ tags:
   - 插件
 ---
 
-# Google Gemini 系列 Tool Calling
+# Google Gemini 系列 Tools Calling
 
 Google Gemini 系列模型 Tools Calling 能力一览：