📝 docs: update docs for providers (lobehub#4326)

code · Oct 11, 2024 · eda92e2 · eda92e2
1 parent 23c5bf7
commit eda92e2
Show file tree

Hide file tree

Showing 20 changed files with 1,232 additions and 55 deletions.
diff --git a/docs/usage/providers/ai21.mdx b/docs/usage/providers/ai21.mdx
@@ -0,0 +1,63 @@
+---
+title: Using AI21 Labs in LobeChat
+description: Learn how to integrate and utilize AI21 Labs's language model APIs in LobeChat. 
+tags:
+  - LobeChat
+  - AI21 Labs
+  - API Key
+  - Web UI
+---
+# Using AI21 Labs in LobeChat
+
+<Image
+cover
+src={
+'https://github.com/user-attachments/assets/ae03eab5-a319-4d2a-a5f6-1683ab7739ee'
+}
+/>
+
+[AI21 Labs](https://www.ai21.com/) is a company focused on artificial intelligence, offering advanced language models and API services designed to help developers and businesses leverage natural language processing technology. Their flagship product, the "Jamba" series of models, can perform complex language understanding and generation tasks, widely utilized in fields such as content creation and conversational systems.
+
+This article will guide you on how to use AI21 Labs within LobeChat.
+
+<Steps>
+### Step 1: Obtain the AI21 Labs API Key
+
+- Register and log in to [AI21 Studio](https://studio.ai21.com)
+- Click on the `User Avatar` menu, then select `API Key`
+- Copy and save the generated API key
+
+<Image
+alt={'Copy API Key'}
+inStep
+src={'https://github.com/user-attachments/assets/a42ba52b-491e-4993-8e2f-217aa1776e0f'}
+/>
+
+### Step 2: Configure AI21 Labs in LobeChat
+
+- Go to the `Settings` page in LobeChat
+- Under `Language Model`, find the setting for `AI21 Labs`
+
+<Image
+alt={'Enter API Key'}
+inStep
+src={'https://github.com/user-attachments/assets/9336d6c5-2a83-4aa9-854e-75e245b665cb'}
+/>
+
+- Enter the API key you obtained
+- Choose an AI21 Labs model for your AI assistant to begin the conversation
+
+<Image
+alt={'Select AI21 Labs Model and Start Conversation'}
+inStep
+src={'https://github.com/user-attachments/assets/63e5ced7-1d23-44e1-b933-cc3b5df47eab'}
+/>
+
+<Callout type={'warning'}>
+During use, you may need to pay the API service provider; please refer to the relevant fee policy of AI21 Labs.
+</Callout>
+
+</Steps>
+
+Now you are ready to engage in conversations using the models provided by AI21 Labs in LobeChat.
+
diff --git a/docs/usage/providers/ai21.zh-CN.mdx b/docs/usage/providers/ai21.zh-CN.mdx
@@ -0,0 +1,63 @@
+---
+title: 在 LobeChat 中使用 AI21 Labs
+description: 学习如何在 LobeChat 中配置和使用 AI21 Labs 的API Key，以便开始对话和交互。
+tags:
+  - LobeChat
+  - AI21 Labs
+  - API密钥
+  - Web UI
+---
+
+# 在 LobeChat 中使用 AI21 Labs
+
+<Image
+  cover
+  src={
+    'https://github.com/user-attachments/assets/ae03eab5-a319-4d2a-a5f6-1683ab7739ee'
+  }
+/>
+
+[AI21 Labs](https://www.ai21.com/) 是一家专注于人工智能的公司，提供先进的语言模型和API服务，旨在帮助开发者和企业利用自然语言处理技术。其旗舰产品 "Jamba" 系列模型能够进行复杂的语言理解和生成任务，广泛应用于内容创作、对话系统等领域。
+
+本文将指导你如何在 LobeChat 中使用 AI21 Labs。
+
+<Steps>
+### 步骤一：获得 AI21 Labs 的 API Key
+
+- 注册并登录 [AI21 Studio](https://studio.ai21.com)
+- 点击 `用户头像` 菜单，点击 `API Key`
+- 复制并保存生成的 API 密钥
+
+<Image
+  alt={'复制 API 密钥'}
+  inStep
+  src={'https://github.com/user-attachments/assets/a42ba52b-491e-4993-8e2f-217aa1776e0f'}
+/>
+
+### 步骤二：在 LobeChat 中配置 AI21 Labs
+
+- 访问 LobeChat 的`设置`界面
+- 在`语言模型`下找到 `AI21labs` 的设置项
+
+<Image
+  alt={'填入 API 密钥'}
+  inStep
+  src={'https://github.com/user-attachments/assets/9336d6c5-2a83-4aa9-854e-75e245b665cb'}
+/>
+
+- 填入获得的 API 密钥
+- 为你的 AI 助手选择一个 AI21 Labs 的模型即可开始对话
+
+<Image
+  alt={'选择 AI21 Labs 模型并开始对话'}
+  inStep
+  src={'https://github.com/user-attachments/assets/63e5ced7-1d23-44e1-b933-cc3b5df47eab'}
+/>
+
+<Callout type={'warning'}>
+  在使用过程中你可能需要向 API 服务提供商付费，请参考 AI21 Labs 的相关费用政策。
+</Callout>
+
+</Steps>
+
+至此你已经可以在 LobeChat 中使用 AI21 Labs 提供的模型进行对话了。
diff --git a/docs/usage/providers/ai360.mdx b/docs/usage/providers/ai360.mdx
@@ -0,0 +1,63 @@
+---
+title: Using the 360AI in LobeChat
+description: Learn how to integrate and utilize 360AI's language model APIs in LobeChat. 
+tags:
+  - LobeChat
+  - 360AI
+  - API Key
+  - Web UI
+---
+# Using the 360AI in LobeChat
+
+<Image
+cover
+src={
+'https://github.com/user-attachments/assets/e617def1-ce50-4acc-974b-12f5ed592a0e'
+}
+/>
+
+The [360AI](https://ai.360.com/) is a cognitive general model independently developed by 360 Company, aimed at providing powerful natural language processing capabilities for enterprises and developers. This model has been upgraded to version 4.0 and supports various application scenarios, including conversational services, image generation, vector database services, and more.
+
+This article will guide you on how to use the 360AI in LobeChat.
+
+<Steps>
+### Step 1: Obtain the 360AI API Key
+
+- Register and log in to the [360AI API Open Platform](https://ai.360.com/platform/keys)
+- Click on the `API Keys` menu on the left
+- Create an API key and copy it
+
+<Image
+alt={'Create API Key'}
+inStep
+src={'https://github.com/user-attachments/assets/72da7af1-e180-4759-84a5-a6f6ca28392e'}
+/>
+
+### Step 2: Configure 360AI in LobeChat
+
+- Access the `Settings` interface in LobeChat
+- Under `Language Models`, find the option for `360`
+
+<Image
+alt={'Enter API Key'}
+inStep
+src={'https://github.com/user-attachments/assets/a53deb11-2c14-441a-8a5c-a0f3a74e2a63'}
+/>
+
+- Enter the API key you obtained
+- Choose a 360AI model for your AI assistant to start chatting
+
+<Image
+alt={'Select 360 Model and Start Chatting'}
+inStep
+src={'https://github.com/user-attachments/assets/452d0b48-5ff7-4f42-a46e-68a62b87632b'}
+/>
+
+<Callout type={'warning'}>
+Please note that you may need to pay the API service provider during use, refer to the relevant pricing policy of the 360AI.
+</Callout>
+
+</Steps>
+
+You can now use the models provided by the 360AI for conversations in LobeChat.
+
diff --git a/docs/usage/providers/ai360.zh-CN.mdx b/docs/usage/providers/ai360.zh-CN.mdx
@@ -0,0 +1,63 @@
+---
+title: 在 LobeChat 中使用360智脑
+description: 学习如何在 LobeChat 中配置和使用360智脑的API Key，以便开始对话和交互。
+tags:
+  - LobeChat
+  - 360智脑
+  - API密钥
+  - Web UI
+---
+
+# 在 LobeChat 中使用360智脑
+
+<Image
+  cover
+  src={
+    'https://github.com/user-attachments/assets/e617def1-ce50-4acc-974b-12f5ed592a0e'
+  }
+/>
+
+[360智脑](https://ai.360.com/)是360公司自主研发的认知型通用大模型，旨在为企业和开发者提供强大的自然语言处理能力。该模型已升级至4.0版本，能够支持多种应用场景，包括对话服务、图片生成、向量数据库服务等。
+
+本文将指导你如何在 LobeChat 中使用360智脑。
+
+<Steps>
+### 步骤一：获得360智脑的 API Key
+
+- 注册并登录 [360智脑 API 开放平台](https://ai.360.com/platform/keys)
+- 点击左侧 `API Keys` 菜单
+- 创建一个 API 密钥并复制
+
+<Image
+  alt={'创建API密钥'}
+  inStep
+  src={'https://github.com/user-attachments/assets/72da7af1-e180-4759-84a5-a6f6ca28392e'}
+/>
+
+### 步骤二：在 LobeChat 中配置360智脑
+
+- 访问 LobeChat 的`设置`界面
+- 在`语言模型`下找到 `360` 的设置项
+
+<Image
+  alt={'填入 API 密钥'}
+  inStep
+  src={'https://github.com/user-attachments/assets/a53deb11-2c14-441a-8a5c-a0f3a74e2a63'}
+/>
+
+- 填入获得的 API 密钥
+- 为你的 AI 助手选择一个360智脑的模型即可开始对话
+
+<Image
+  alt={'选择360模型并开始对话'}
+  inStep
+  src={'https://github.com/user-attachments/assets/452d0b48-5ff7-4f42-a46e-68a62b87632b'}
+/>
+
+<Callout type={'warning'}>
+  在使用过程中你可能需要向 API 服务提供商付费，请参考360智脑的相关费用政策。
+</Callout>
+
+</Steps>
+
+至此你已经可以在 LobeChat 中使用360智脑提供的模型进行对话了。
diff --git a/docs/usage/providers/fireworksai.mdx b/docs/usage/providers/fireworksai.mdx
@@ -0,0 +1,75 @@
+---
+title: Using Fireworks AI in LobeChat
+description: Learn how to integrate and utilize Fireworks AI's language model APIs in LobeChat. 
+tags:
+  - LobeChat
+  - Fireworks AI
+  - API Key
+  - Web UI
+---
+# Using Fireworks AI in LobeChat
+
+<Image
+cover
+src={
+'https://github.com/user-attachments/assets/facdc83c-e789-4649-8060-7f7a10a1b1dd'
+}
+/>
+
+[Fireworks.ai](https://fireworks.ai/) is a high-performance generative AI model inference platform that allows users to access and utilize various models through its API. The platform supports multiple modalities, including text and visual language models, and offers features like function calls and JSON schemas to enhance the flexibility of application development.
+
+This article will guide you on how to use Fireworks AI in LobeChat.
+
+<Steps>
+### Step 1: Obtain an API Key for Fireworks AI
+
+- Log in to the [Fireworks.ai Console](https://fireworks.ai/account/api-keys)
+- Navigate to the `User` page and click on `API Keys`
+- Create a new API key
+
+<Image
+alt={'Create API Key'}
+inStep
+src={'https://github.com/user-attachments/assets/eb027093-5ceb-4a9d-8850-b791fbf69a71'}
+/>
+
+- Copy and securely save the generated API key
+
+<Image
+alt={'Save API Key'}
+inStep
+src={'https://github.com/user-attachments/assets/28590f7f-bfee-4215-b50b-8feddbf72366'}
+/>
+
+<Callout type={'warning'}>
+Please store the key securely, as it will appear only once. If you accidentally lose it, you will need to create a new key.
+</Callout>
+
+### Step 2: Configure Fireworks AI in LobeChat
+
+- Access the `Settings` interface in LobeChat
+- Under `Language Model`, locate the settings for `Fireworks AI`
+
+<Image
+alt={'Enter API Key'}
+inStep
+src={'https://github.com/user-attachments/assets/12c1957d-f050-4235-95da-d55ddedfa6c9'}
+/>
+
+- Enter the obtained API key
+- Select a Fireworks AI model for your AI assistant to start a conversation
+
+<Image
+alt={'Select Fireworks AI Model and Start Conversation'}
+inStep
+src={'https://github.com/user-attachments/assets/378df8df-8ec4-436e-8451-fbc52705faee'}
+/>
+
+<Callout type={'warning'}>
+Please note that you may need to pay fees to the API service provider during use; refer to Fireworks AI's pricing policy for details.
+</Callout>
+
+</Steps>
+
+You are now ready to use the models provided by Fireworks AI for conversations in LobeChat.
+