📝 docs: update provider docs (lobehub#4865)

* 📝 docs: update docs for providers * 📝 docs: update provider doc * docs: add doc for cloudflare * 📝 docs: update provider docs --------- Co-authored-by: GH Action - Upstream Sync <[email protected]>
liquescentremedies · Dec 2, 2024 · e290230 · e290230
1 parent aa47cd8
commit e290230
Show file tree

Hide file tree

Showing 8 changed files with 580 additions and 0 deletions.
diff --git a/docs/usage/providers/giteeai.mdx b/docs/usage/providers/giteeai.mdx
@@ -0,0 +1,79 @@
+---
+title: Using Gitee AI in LobeChat
+description: >-
+  Learn how to configure and use Gitee AI's API Key in LobeChat to start
+  conversations and interactions.
+tags:
+  - LobeChat
+  - Gitee AI
+  - API Key
+  - Web UI
+---
+
+# Using Gitee AI in LobeChat
+
+<Image
+  cover
+  src={'https://github.com/user-attachments/assets/f9ccce84-4fd4-48ca-9450-40660112d0d7'}
+/>
+
+[Gitee AI](https://ai.gitee.com/) is an open-source platform based on Git code hosting technology, specifically designed for AI application scenarios. It aims to provide developers and businesses with a one-stop solution for AI application development services, including model experience, inference, fine-tuning, and deployment.
+
+This article will guide you on how to use Gitee AI in LobeChat.
+
+<Steps>
+
+### Step 1: Obtain the Gitee AI API Key
+
+- Register and log in to the [Gitee AI official website](https://ai.gitee.com/)
+- Purchase and recharge `Serverless API` from your dashboard
+
+<Image
+  alt={'Gitee Serverless API'}
+  inStep
+  src={'https://github.com/user-attachments/assets/c77fcf70-9039-49ff-86e4-f8eaa267bbf6'}
+/>
+
+- In `Settings`, click on the `Access Tokens` section
+- Create a new access token
+- Save the access token in the pop-up window
+
+<Image
+  alt={'Gitee Serverless API'}
+  inStep
+  src={'https://github.com/user-attachments/assets/0af85438-ac99-4c95-b888-a17e88ede043'}
+/>
+
+<Callout type={'warning'}>
+  Please keep the access token safe as it will only appear once. If you accidentally lose it, you
+  will need to create a new one.
+</Callout>
+
+### Step 2: Configure Gitee AI in LobeChat
+
+- Access the `Settings` page in LobeChat
+- Under `Language Models`, find the settings for `Gitee AI`
+
+<Image
+  alt={'Enter API Key'}
+  inStep
+  src={'https://github.com/user-attachments/assets/eaa2a1fb-41ad-473d-ac10-a39c05886425'}
+/>
+
+- Enter the obtained API key
+- Select a Gitee AI model for your AI assistant to begin chatting
+
+<Image
+  alt={'Select Gitee AI Model and Start Chatting'}
+  inStep
+  src={'https://github.com/user-attachments/assets/ab87120c-15ff-4bc7-bb28-4b0b43cfe91a'}
+/>
+
+<Callout type={'warning'}>
+  During usage, you may need to make payments to the API service provider; please refer to Gitee
+  AI's relevant pricing policy.
+</Callout>
+
+</Steps>
+
+Now you can start having conversations using the models provided by Gitee AI in LobeChat!
diff --git a/docs/usage/providers/giteeai.zh-CN.mdx b/docs/usage/providers/giteeai.zh-CN.mdx
@@ -0,0 +1,75 @@
+---
+title: 在 LobeChat 中使用 Gitee AI
+description: 学习如何在 LobeChat 中配置和使用 Gitee AI 的 API Key，以便开始对话和交互。
+tags:
+  - LobeChat
+  - Gitee AI
+  - API密钥
+  - Web UI
+---
+
+# 在 LobeChat 中使用 Gitee AI
+
+<Image
+  cover
+  src={'https://github.com/user-attachments/assets/f9ccce84-4fd4-48ca-9450-40660112d0d7'}
+/>
+
+[Gitee AI](https://ai.gitee.com/) 是一个基于 Git 代码托管技术的开源平台，专为人工智能（AI）应用场景设计。它旨在为开发者和企业提供一站式的 AI 应用开发服务，包括模型体验、推理、微调和部署等功能。
+
+本文将指导你如何在 LobeChat 中使用 Gitee AI。
+
+<Steps>
+
+### 步骤一: 获取 Gitee AI 的 API 密钥
+
+- 注册并登录 [Gitee AI 官网](https://ai.gitee.com/)
+- 在工作台中购买并充值 `Serverless API`
+
+<Image
+  alt={'Gitee Serverless API'}
+  inStep
+  src={'https://github.com/user-attachments/assets/c77fcf70-9039-49ff-86e4-f8eaa267bbf6'}
+/>
+
+- 在 `设置` 中点击 `访问令牌` 界面
+- 创建一个新的访问令牌
+- 在弹出窗口中保存访问令牌
+
+<Image
+  alt={'Gitee Serverless API'}
+  inStep
+  src={'https://github.com/user-attachments/assets/0af85438-ac99-4c95-b888-a17e88ede043'}
+/>
+
+<Callout type={'warning'}>
+  妥善保存弹窗中的访问令牌，它只会出现一次，如果不小心丢失了，你需要重新创建一个访问令牌。
+</Callout>
+
+### 步骤二：在 LobeChat 中配置 Gitee AI
+
+- 访问 LobeChat 的`设置`界面
+- 在`语言模型`下找到 `Gitee AI` 的设置项
+
+<Image
+  alt={'填入 API 密钥'}
+  inStep
+  src={'https://github.com/user-attachments/assets/eaa2a1fb-41ad-473d-ac10-a39c05886425'}
+/>
+
+- 填入获得的 API 密钥
+- 为你的 AI 助手选择一个 Gitee AI 的模型即可开始对话
+
+<Image
+  alt={'选择 Gitee AI 模型并开始对话'}
+  inStep
+  src={'https://github.com/user-attachments/assets/ab87120c-15ff-4bc7-bb28-4b0b43cfe91a'}
+/>
+
+<Callout type={'warning'}>
+  在使用过程中你可能需要向 API 服务提供商付费，请参考 Gitee AI 的相关费用政策。
+</Callout>
+
+</Steps>
+
+至此你已经可以在 LobeChat 中使用 Gitee AI 提供的模型进行对话了。
diff --git a/docs/usage/providers/internlm.mdx b/docs/usage/providers/internlm.mdx
@@ -0,0 +1,70 @@
+---
+title: Using InternLM in LobeChat
+description: >-
+  Learn how to configure and use SenseNova's API Key in LobeChat to start
+  conversations and interactions.
+tags:
+  - LobeChat
+  - InternLM
+  - API Key
+  - Web UI
+---
+
+# Using InternLM in LobeChat
+
+<Image
+  cover
+  src={'https://github.com/user-attachments/assets/be7dcd49-0165-4f7b-bf90-0739cc9dd212'}
+/>
+
+[InternLM](https://platform.sensenova.cn/home) is a large pre-trained language model jointly launched by the Shanghai Artificial Intelligence Laboratory and Shusheng Group. This model focuses on natural language processing, aimed at understanding and generating human language, boasting powerful semantic comprehension and text generation capabilities.
+
+This article will guide you on how to use InternLM in LobeChat.
+
+<Steps>
+
+### Step 1: Obtain the InternLM API Key
+
+- Register and log in to [InternLM API](https://InternLM.intern-ai.org.cn/api/tokens)
+- Create an API token
+- Save the API token in the pop-up window
+
+<Image
+  alt={'Save API Token'}
+  inStep
+  src={'https://github.com/user-attachments/assets/0e2fdc5d-9623-4a74-a7f6-dcb802d52297'}
+/>
+
+<Callout type={'warning'}>
+  Please store the API token shown in the pop-up securely; it will only appear once. If you lose it,
+  you will need to create a new API token.
+</Callout>
+
+### Step 2: Configure InternLM in LobeChat
+
+- Go to the `Settings` interface in LobeChat
+- Find the settings option for `InternLM` under `Language Models`
+
+<Image
+  alt={'Enter API Key'}
+  inStep
+  src={'https://github.com/user-attachments/assets/8ec7656e-1e3d-41e0-95a0-f6883135c2fc'}
+/>
+
+- Enter the obtained `AccessKey ID` and `AccessKey Secret`
+- Choose a InternLM model for your AI assistant to start a conversation
+
+<Image
+  alt={'Select InternLM Model and Start Conversation'}
+  inStep
+  src={'https://github.com/user-attachments/assets/76ad163e-ee19-4f95-a712-85bea764d3ec'}
+/>
+
+<Callout type={'warning'}>
+  During usage, you may need to pay the API service provider; please refer to the pricing policy
+  regarding InternLM.
+</Callout>
+
+</Steps>
+
+You are now ready to engage in conversations using the models provided by InternLM in LobeChat.
diff --git a/docs/usage/providers/internlm.zh-CN.mdx b/docs/usage/providers/internlm.zh-CN.mdx
@@ -0,0 +1,66 @@
+---
+title: 在 LobeChat 中使用书生浦语
+description: 学习如何在 LobeChat 中配置和使用书生浦语的 API Key，以便开始对话和交互。
+tags:
+  - LobeChat
+  - 书生浦语
+  - API密钥
+  - Web UI
+---
+
+# 在 LobeChat 中使用书生浦语
+
+<Image
+  cover
+  src={'https://github.com/user-attachments/assets/be7dcd49-0165-4f7b-bf90-0739cc9dd212'}
+/>
+
+[书生浦语（InternLM）](https://platform.sensenova.cn/home) 是由上海人工智能实验室与书生集团联合推出的一款大型预训练语言模型。该模型专注于自然语言处理，旨在理解和生成自然语言，具备强大的语义理解和文本生成能力。
+
+本文将指导你如何在 LobeChat 中使用书生浦语。
+
+<Steps>
+
+### 步骤一: 获取书生浦语的 API 密钥
+
+- 注册并登录 [浦语 API](https://internlm.intern-ai.org.cn/api/tokens)
+- 创建一个 API 令牌
+- 在弹出窗口中保存 API 令牌
+
+<Image
+  alt={'保存 API Token'}
+  inStep
+  src={'https://github.com/user-attachments/assets/0e2fdc5d-9623-4a74-a7f6-dcb802d52297'}
+/>
+
+<Callout type={'warning'}>
+  妥善保存弹窗中的 API 令牌，它只会出现一次，如果不小心丢失了，你需要重新创建一个 API 令牌。
+</Callout>
+
+### 步骤二：在 LobeChat 中配置书生浦语
+
+- 访问 LobeChat 的`设置`界面
+- 在`语言模型`下找到 `书生浦语` 的设置项
+
+<Image
+  alt={'填入 API 密钥'}
+  inStep
+  src={'https://github.com/user-attachments/assets/8ec7656e-1e3d-41e0-95a0-f6883135c2fc'}
+/>
+
+- 填入获得的 `AccessKey ID` 和 `AccessKey Secret`
+- 为你的 AI 助手选择一个书生浦语的模型即可开始对话
+
+<Image
+  alt={'选择书生浦语模型并开始对话'}
+  inStep
+  src={'https://github.com/user-attachments/assets/76ad163e-ee19-4f95-a712-85bea764d3ec'}
+/>
+
+<Callout type={'warning'}>
+  在使用过程中你可能需要向 API 服务提供商付费，请参考书生浦语的相关费用政策。
+</Callout>
+
+</Steps>
+
+至此你已经可以在 LobeChat 中使用书生浦语提供的模型进行对话了。
diff --git a/docs/usage/providers/sensenova.mdx b/docs/usage/providers/sensenova.mdx
@@ -0,0 +1,79 @@
+---
+title: Using SenseNova in LobeChat
+description: >-
+  Learn how to configure and use SenseNova's API Key in LobeChat to start
+  conversations and interactions.
+tags:
+  - LobeChat
+  - SenseNova
+  - API Key
+  - Web UI
+---
+
+# Using SenseNova in LobeChat
+
+<Image
+  cover
+  src={'https://github.com/user-attachments/assets/420379cd-d8a4-4ab3-9a46-75dcc3d56920'}
+/>
+
+[SenseNova](https://platform.sensenova.cn/home) is a large model system introduced by SenseTime, aimed at promoting the rapid iteration and practical application of artificial intelligence (AI) technology.
+
+This article will guide you on how to use SenseNova in LobeChat.
+
+<Steps>
+
+### Step 1: Obtain the API Key for SenseNova
+
+- Register and log in to the [SenseCore Development Platform](https://www.sensecore.cn/product/aistudio).
+- Locate the `SenseNova Large Model` in the product menu and activate the service.
+
+<Image
+  alt={'Activate SenseNova Large Model'}
+  inStep
+  src={'https://github.com/user-attachments/assets/c6319e83-c4e7-48cf-9625-2edfc4aa77b3'}
+/>
+
+- Go to the [AccessKey Management](https://console.sensecore.cn/iam/Security/access-key) page.
+- Create an access key.
+- Save the Access Key ID and secret in the pop-up window.
+
+<Image
+  alt={'Save Access Key'}
+  inStep
+  src={'https://github.com/user-attachments/assets/f9f7ed26-e506-4c52-a118-e0bb5e0918db'}
+/>
+
+<Callout type={'warning'}>
+  Please keep the access key from the pop-up window secure, as it will only appear once. If you lose
+  it, you will need to create a new access key.
+</Callout>
+
+### Step 2: Configure SenseNova in LobeChat
+
+- Access the `Settings` interface on LobeChat.
+- Find the setting for `SenseNova` under `Language Models`.
+
+<Image
+  alt={'Enter Access Key'}
+  inStep
+  src={'https://github.com/user-attachments/assets/0c73c453-6ee3-4f90-bc5d-119c52c38fef'}
+/>
+
+- Input the obtained `Access Key ID` and `Access Key Secret`.
+- Choose a SenseNova model for your AI assistant and start the conversation.
+
+<Image
+  alt={'Choose SenseNova model and start conversation'}
+  inStep
+  src={'https://github.com/user-attachments/assets/aea782b1-27bd-4d9c-b521-c172c2095fe6'}
+/>
+
+<Callout type={'warning'}>
+  During usage, you may need to pay the API service provider, please refer to the relevant fee
+  policy for SenseNova.
+</Callout>
+
+</Steps>
+
+You can now have conversations using the models provided by SenseNova in LobeChat.