Skip to content

Commit

Permalink
📝 docs: Add more usage docs (lobehub#3286)
Browse files Browse the repository at this point in the history
  • Loading branch information
canisminor1990 authored Jul 22, 2024
1 parent 2a81236 commit a17b97e
Show file tree
Hide file tree
Showing 18 changed files with 946 additions and 0 deletions.
69 changes: 69 additions & 0 deletions docs/usage/agents/agent-organization.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
title: Efficiently Organize Your AI Assistants with LobeChat
description: >-
Learn how to use LobeChat's grouping, search, and pinning functions to
efficiently organize and locate your AI assistants.
tags:
- LobeChat
- AI assistants
- assistant organization
- grouping
- search function
- pinning function
---

# Assistant Organization Guide

<Image
alt={'Assistant Organization'}
cover
src={'https://github.com/user-attachments/assets/5e04b71a-4c25-4f3d-ae7d-9237ffcb37be'}
/>

LobeChat provides a rich variety of AI assistant resources. Users can easily add various assistants through the assistant market, offering a wide range of application scenarios for AI applications.

When you have added a large number of assistants, finding a specific assistant in the list may become challenging. LobeChat provides `search`, `grouping`, and `pinning` functions to help you better organize assistants and improve efficiency in locating them.

## Assistant Grouping

Firstly, LobeChat's AI assistants support organization through grouping. You can categorize assistants of the same type together and easily search for the required assistants by collapsing and expanding groups.

### Assistant Settings

<Image
alt={'Assistant Grouping'}
src={'https://github.com/user-attachments/assets/97a9d713-f4c1-4170-a707-d2060eeab35c'}
/>

- In the menu of an individual assistant, selecting the `Move to Group` option can quickly categorize the assistant into the specified group.
- If you don't find the group you want, you can choose `Add Group` to quickly create a new group.

### Group Settings

<Image
alt={'Group Menu'}
src={'https://github.com/user-attachments/assets/b9ca37db-0f0b-449f-b3b7-f147bec3a735'}
/>

- In the group menu, you can quickly create a new assistant under that group.
- Clicking the `Group Management` button allows you to `rename`, `delete`, `sort`, and perform other operations on all groups.

## Assistant Search

<Image
alt={'Assistant Search'}
src={'https://github.com/user-attachments/assets/816ad463-e1ef-478b-9930-c40948247288'}
/>

- At the top of the assistant list, you can use the assistant search function to easily locate the assistant you need using keywords.

## Assistant Pinning

<Image
alt={'Assistant Pinning'}
src={'https://github.com/user-attachments/assets/d574b08e-ab93-4723-9d1b-9e9be2bff7ee'}
/>

- In the assistant menu, you can use the `Pin` function to pin the assistant to the top.
- After pinning an assistant, a pinned area will appear at the top of the assistant list, displaying all pinned assistants.
- For pinned assistants, you can choose `Unpin` to remove them from the pinned area.
67 changes: 67 additions & 0 deletions docs/usage/agents/agent-organization.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: LobeChat 助手组织指南 - 提升助手管理效率
description: 了解如何通过分组、搜索和固定功能更好地组织 LobeChat 的 AI 助手,提升助手管理效率和定位效率。
tags:
- LobeChat
- AI 助手
- 助手组织
- 分组设置
- 助手搜索
- 助手固定
---

# 助手组织指南

<Image
alt={'助手组织'}
cover
src={'https://github.com/user-attachments/assets/5e04b71a-4c25-4f3d-ae7d-9237ffcb37be'}
/>

LobeChat 提供了丰富的 AI 助手资源,用户可以通过助手市场方便地添加各类助手,为 AI 应用提供了广泛的应用场景。

当你添加了大量助手后,在列表中寻找特定助手可能会变得比较困难。LobeChat 提供了`搜索``分组``固定`功能,帮助您更好地组织助手,提升定位效率。

## 助手分组

首先 LobeChat 的 AI 助手支持以分组的方式进行组织。你可以将同类型的助手归类到一起,并通过折叠和展开分组的方式方便地查询所需助手。

### 助手设置

<Image
alt={'助手分组'}
src={'https://github.com/user-attachments/assets/97a9d713-f4c1-4170-a707-d2060eeab35c'}
/>

- 在单个助手的菜单中,选择`移动到分组`选项可以快速将该助手归类到指定分组。
- 如果没有你想要的分组,可以选择`添加分组`,快速创建一个新的分组。

### 分组设置

<Image
alt={'分组菜单'}
src={'https://github.com/user-attachments/assets/b9ca37db-0f0b-449f-b3b7-f147bec3a735'}
/>

- 在分组菜单中,可以快速在该分组下新建助手
- 点击`分组管理`按钮可以对所有分组进行`重命名``删除``排序`等操作。

## 助手搜索

<Image
alt={'助手搜索'}
src={'https://github.com/user-attachments/assets/816ad463-e1ef-478b-9930-c40948247288'}
/>

- 在助手列表的顶部,您可以通过助手搜索功能,方便地使用关键词定位到您所需的助手。

## 助手固定

<Image
alt={'助手固定'}
src={'https://github.com/user-attachments/assets/d574b08e-ab93-4723-9d1b-9e9be2bff7ee'}
/>

- 在助手菜单中,你可以使用`固定`功能将该助手固定在顶部。
- 固定助手后,助手列表的上方将出现一个固定区域,显示所有已固定的助手列表。
- 对于已固定的助手,你可以选择`解除固定`,将其移出固定区域。
55 changes: 55 additions & 0 deletions docs/usage/foundation/basic.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: Basic Usage Guide for Conversations - Large Language Models (LLMs)
description: >-
Learn about the fundamental functions for interacting with Large Language
Models (LLMs) and how to utilize features like model selection, file/image
upload, temperature setting, and more.
tags:
- Large Language Models
- Model Selection
- File Upload
- Temperature Setting
- Voice Input
- Plugin Setting
---

# Basic Usage Guide for Conversations

<Image
alt={'Basic Functions'}
cover
src={'https://github.com/user-attachments/assets/ca6baea8-d782-4611-8555-7c81078028db'}
/>

In general, the basic interaction with Large Language Models (LLMs) can be done through the fundamental functions provided in this area (as shown above).

## Basic Function Description

<Image
alt={'Basic Function Description'}
src={'https://github.com/user-attachments/assets/de9f188e-8a3a-49a0-bec6-ab628cdda7e6'}
/>

1. **Model Selection**: Choose the Large Language Model (LLM) to be used in the current conversation. For model settings, refer to [Model Providers](https://lobehub.com/docs/usage/providers).
2. **File/Image Upload**: When the selected model supports file or image recognition, users can upload files or images during the conversation with the model.
3. **Temperature Setting**: Adjust the randomness level of the model's output. The higher the value, the more random the output results. For detailed information, refer to the [Large Language Model Guide](https://lobehub.com/docs/usage/agents/model).
4. **History Record Setting**: Set the number of chat records the model needs to remember in this conversation. The longer the history, the more conversation content the model can remember, but it will also consume more context tokens.
5. **Voice Input**: Click this button to convert speech to text input. For more information, refer to [Speech-to-Text Conversion](https://lobehub.com/docs/usage/foundation/tts-stt).
6. **Plugin Setting**: Choose the plugins to enable in this conversation. For more information, refer to [Plugin Usage](https://lobehub.com/docs/usage/plugins/basic-usage).
7. **Token Usage**: Display the context length and token consumption of this conversation.
8. **Start New Topic**: End the current conversation and start a new topic. For more information, refer to [Topic Usage](https://lobehub.com/docs/usage/agents/topics).
9. **Send Button**: Send the current input content to the model. The dropdown menu provides additional send operation options.

<Image
alt={'Send Button'}
inStep
src={'https://github.com/user-attachments/assets/0833184e-91df-4b8e-a88e-99a19c20b86a'}
/>

<Callout type={'info'}>
- **Send Shortcut**: Set a shortcut to send messages and line breaks using the Enter key or ⌘ +
Enter key. - **Add an AI Message**: Manually add and edit a message input by an AI character in
the conversation context, which will not trigger a model response. - **Add a User Message**: Add
the current input content as a message input by the user character to the conversation context,
which will not trigger a model response.
</Callout>
56 changes: 56 additions & 0 deletions docs/usage/foundation/basic.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: 会话基本使用指南 - 大型语言模型交互指南
description: 了解如何使用大型语言模型进行基本交互,包括模型选择、文件/图片上传、温度设置、历史记录设置等。
tags:
- 大型语言模型
- LLM
- 模型选择
- 文件上传
- 温度设置
- 历史记录设置
- 语音输入
- 插件设置
- Token 用量
- 新建话题
- 发送按钮
---

# 会话基本使用指南

<Image
alt={'基本功能'}
cover
src={'https://github.com/user-attachments/assets/ca6baea8-d782-4611-8555-7c81078028db'}
/>

通常情况下,与大型语言模型 (LLMs) 的基本交互可以通过此区域(如上图)提供的基础功能进行。

## 基本功能说明

<Image
alt={'基本功能说明'}
src={'https://github.com/user-attachments/assets/de9f188e-8a3a-49a0-bec6-ab628cdda7e6'}
/>

1. **模型选择**:选择当前对话所使用的大型语言模型 (LLM)。模型的设置详见[模型服务商](https://lobehub.com/docs/usage/providers)
2. **文件/图片上传**:当所选模型支持文件或图片识别功能时,用户可以在与模型的对话中上传文件或图片。
3. **温度设置**:调节模型输出的随机性程度。数值越高,输出结果越随机。详细说明请参考[大语言模型指南](https://lobehub.com/docs/usage/agents/model)
4. **历史记录设置**:设定本次对话中模型需要记忆的聊天记录数量。历史记录越长,模型能够记忆的对话内容越多,但同时也会消耗更多的上下文 token。
5. **语音输入**:点击该按钮后,可以将语音转换为文字输入。有关详细信息,请参考[语音文字转换](https://lobehub.com/docs/usage/foundation/tts-stt)
6. **插件设置**:选择本次对话中需要启用的插件。有关详细信息,请参考[插件使用](https://lobehub.com/docs/usage/plugins/basic-usage)
7. **Token 用量**:显示本次对话的上下文长度以及 Token 消耗情况。
8. **新建话题**:结束当前对话并开启一个新的对话主题。有关详细信息,请参考[话题使用](https://lobehub.com/docs/usage/agents/topics)
9. **发送按钮**:将当前输入内容发送至模型。下拉菜单提供额外的发送操作选项。

<Image
alt={'发送按钮'}
inStep
src={'https://github.com/user-attachments/assets/0833184e-91df-4b8e-a88e-99a19c20b86a'}
/>

<Callout type={'info'}>
- **发送快捷键**:设置使用 Enter 键或 ⌘ + Enter 键发送消息和换行的快捷方式。 -
**添加一条AI消息**:在对话上下文中手动添加并编辑一条由 AI 角色输入的消息,该操作不会触发模型响应。
-
**添加一条用户消息**:将当前输入内容作为用户角色输入的消息添加到对话上下文中,该操作不会触发模型响应。
</Callout>
46 changes: 46 additions & 0 deletions docs/usage/foundation/share.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Share Conversation Records - Screenshot Sharing & ShareGPT
description: >-
Learn how to share conversation records in LobeChat using Screenshot Sharing
and ShareGPT methods. Capture conversation details in images or generate
permanent links effortlessly.
tags:
- Share Conversation Records
- Screenshot Sharing
- ShareGPT
- Conversation Sharing
- AI Conversation Sharing
---

# Share Conversation Records

<Image
alt={'Share Conversation'}
cover
src={'https://github.com/user-attachments/assets/00acc7d6-dc66-4998-b1c6-15238be4c3c8'}
/>

By clicking the `Share` button in the top right corner of the chat window, you can share the current conversation records with others. LobeChat supports two sharing methods: `Screenshot Sharing` and `ShareGPT Sharing`.

## Screenshot Sharing

<Image
alt={'Screenshot Sharing'}
src={'https://github.com/user-attachments/assets/ccea7b00-6f92-4213-82ea-88789ef6f3b3'}
/>

The screenshot sharing feature will generate and save an image of the current conversation records, with the following options:

- Include Assistant Role Settings: Display the assistant's Prompt information in the screenshot.
- Include Background Image: Add a gradient background to the generated image.
- Include Footer: Add LobeChat footer information to the generated image.
- Image Format: Choose the format for saving the image.

## ShareGPT

<Image
alt={'ShareGPT Sharing'}
src={'https://github.com/user-attachments/assets/dea7c748-36e6-4f1b-aa21-acee2bf70d7d'}
/>

[ShareGPT](https://sharegpt.com/) is an AI conversation sharing platform that allows users to easily share their conversations with Large Language Models (LLMs). Users can generate a permanent link with just one click, making it convenient to share these conversations with friends or others. By integrating ShareGPT functionality, LobeChat can generate links for conversation records with just one click, making sharing easy.
43 changes: 43 additions & 0 deletions docs/usage/foundation/share.zh-CN.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: 分享会话记录 - LobeChat 分享功能介绍
description: 了解如何通过 LobeChat 的分享功能分享会话记录,包括截图分享和 ShareGPT 分享方式。通过分享功能,轻松与他人分享您的对话。
tags:
- LobeChat
- 分享会话记录
- 截图分享
- ShareGPT
- 对话分享
---

# 分享会话记录

<Image
alt={'分享会话'}
cover
src={'https://github.com/user-attachments/assets/00acc7d6-dc66-4998-b1c6-15238be4c3c8'}
/>

通过会话窗口右上角的`分享`按钮,您可以将当前会话记录分享给其他人。LobeChat 支持两种分享方式:`截图分享``ShareGPT 分享`

## 截图分享

<Image
alt={'截图分享'}
src={'https://github.com/user-attachments/assets/ccea7b00-6f92-4213-82ea-88789ef6f3b3'}
/>

截图分享功能将生成当前会话记录的图片并保存,其选项说明如下:

- 包含助手角色设置:在截图中显示助手的 Prompt 信息。
- 包含背景图:在生成的图片中添加渐变背景。
- 包含页脚:在生成的图片中添加 LobeChat 页脚信息。
- 图片格式:选择保存图片的格式。

## ShareGPT

<Image
alt={'ShareGPT 分享'}
src={'https://github.com/user-attachments/assets/dea7c748-36e6-4f1b-aa21-acee2bf70d7d'}
/>

[ShareGPT](https://sharegpt.com/) 是一个 AI 对话分享平台,允许用户便捷地分享他们与大型语言模型 (LLM) 的对话。用户只需点击即可生成永久链接,方便与朋友或其他人分享这些对话。LobeChat 通过集成 ShareGPT 功能,可以一键将对话记录生成链接,方便分享。
49 changes: 49 additions & 0 deletions docs/usage/foundation/text2image.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: Guide to Using Text-to-Image Models in LobeChat
description: >-
Learn how to utilize text-to-image generation in LobeChat using DALL-E and
Midjourney plugins. Generate images seamlessly with AI assistance.
tags:
- Text-to-Image Models
- LobeChat
- DALL-E
- Midjourney
- Plugin Installation
- AI Assistance
---

# Guide to Using Text-to-Image Models in LobeChat

LobeChat supports text-to-image generation through a plugin mechanism. Currently, LobeChat comes with the built-in DALL-E plugin, which allows users to generate images using OpenAI's DALL-E model. Additionally, users can also install the official Midjourney plugin to utilize the Midjourney text-to-image feature.

## DALL-E Model

If you have configured the OpenAI API, you can enable the DALL-E plugin directly in the assistant interface and input prompts in the conversation for AI to generate images for you.

<Image
alt={'DALL-E Plugin'}
src={'https://github.com/user-attachments/assets/7b11b795-4dd3-4020-a9ba-a3723d5f1f28'}
/>

If the DALL-E plugin is not available, please check if the OpenAI API key has been correctly configured.

## Midjourney Model

LobeChat also offers the Midjourney plugin, which generates images by calling the Midjourney API. Please install the Midjourney plugin in the plugin store beforehand.

<Image
alt={'Midjourney Plugin'}
src={'https://github.com/user-attachments/assets/5f526846-02cd-4dbc-b6e3-a603fa5ac8e7'}
/>

<Callout type={'info'}>
info For plugin installation, please refer to [Plugin
Usage](https://lobehub.com/docs/usage/plugins/basic-usage)
</Callout>

When using the Midjourney plugin for the first time, you will need to fill in your Midjourney API key in the plugin settings.

<Image
alt={'Midjourney Plugin Settings'}
src={'https://github.com/user-attachments/assets/a5d7a543-aec5-457e-a36c-aa1f82f7bc8a'}
/>
Loading

0 comments on commit a17b97e

Please sign in to comment.