Skip to content

Commit

Permalink
📝 docs: add knowledge base in Readme (lobehub#3702)
Browse files Browse the repository at this point in the history
* 📝 docs: add knowledge base

* Update README.zh-CN.md

* Update README.zh-CN.md

* Update README.md
  • Loading branch information
arvinxx authored Aug 31, 2024
1 parent d0652c8 commit b95f70b
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 24 deletions.
45 changes: 33 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,28 @@ Whether for users or professional developers, LobeHub will be your AI Agent play

## ✨ Features

[![][image-feat-knowledgebase]][docs-feat-knowledgebase]

### `1` [File Upload/Knowledge Base][docs-feat-knowledgebase]

LobeChat supports file upload and knowledge base functionality. You can upload various types of files including documents, images, audio, and video, as well as create knowledge bases, making it convenient for users to manage and search for files. Additionally, you can utilize files and knowledge base features during conversations, enabling a richer dialogue experience.

https://github.com/user-attachments/assets/faa8cf67-e743-4590-8bf6-ebf6ccc34175


> \[!TIP]
>
> Learn more on [📘 LobeChat Knowledge Base Launch — From Now On, Every Step Counts](https://lobehub.com/blog/knowledge-base)
<div align="right">

[![][back-to-top]](#readme-top)

</div>

[![][image-feat-privoder]][docs-feat-provider]

### `1` [Multi-Model Service Provider Support][docs-feat-provider]
### `2` [Multi-Model Service Provider Support][docs-feat-provider]

In the continuous development of LobeChat, we deeply understand the importance of diversity in model service providers for meeting the needs of the community when providing AI conversation services. Therefore, we have expanded our support to multiple model service providers, rather than being limited to a single one, in order to offer users a more diverse and rich selection of conversations.

Expand Down Expand Up @@ -146,7 +165,7 @@ At the same time, we are also planning to support more model service providers,

[![][image-feat-local]][docs-feat-local]

### `2` [Local Large Language Model (LLM) Support][docs-feat-local]
### `3` [Local Large Language Model (LLM) Support][docs-feat-local]

To meet the specific needs of users, LobeChat also supports the use of local models based on [Ollama](https://ollama.ai), allowing users to flexibly use their own or third-party models.

Expand All @@ -162,7 +181,7 @@ To meet the specific needs of users, LobeChat also supports the use of local mod

[![][image-feat-vision]][docs-feat-vision]

### `3` [Model Visual Recognition][docs-feat-vision]
### `4` [Model Visual Recognition][docs-feat-vision]

LobeChat now supports OpenAI's latest [`gpt-4-vision`](https://platform.openai.com/docs/guides/vision) model with visual recognition capabilities,
a multimodal intelligence that can perceive visuals. Users can easily upload or drag and drop images into the dialogue box,
Expand All @@ -180,7 +199,7 @@ Whether it's sharing images in daily use or interpreting images within specific

[![][image-feat-tts]][docs-feat-tts]

### `4` [TTS & STT Voice Conversation][docs-feat-tts]
### `5` [TTS & STT Voice Conversation][docs-feat-tts]

LobeChat supports Text-to-Speech (TTS) and Speech-to-Text (STT) technologies, enabling our application to convert text messages into clear voice outputs,
allowing users to interact with our conversational agent as if they were talking to a real person. Users can choose from a variety of voices to pair with the agent.
Expand All @@ -197,7 +216,7 @@ Users can choose the voice that suits their personal preferences or specific sce

[![][image-feat-t2i]][docs-feat-t2i]

### `5` [Text to Image Generation][docs-feat-t2i]
### `6` [Text to Image Generation][docs-feat-t2i]

With support for the latest text-to-image generation technology, LobeChat now allows users to invoke image creation tools directly within conversations with the agent. By leveraging the capabilities of AI tools such as [`DALL-E 3`](https://openai.com/dall-e-3), [`MidJourney`](https://www.midjourney.com/), and [`Pollinations`](https://pollinations.ai/), the agents are now equipped to transform your ideas into images.

Expand All @@ -211,7 +230,7 @@ This enables a more private and immersive creative process, allowing for the sea

[![][image-feat-plugin]][docs-feat-plugin]

### `6` [Plugin System (Function Calling)][docs-feat-plugin]
### `7` [Plugin System (Function Calling)][docs-feat-plugin]

The plugin ecosystem of LobeChat is an important extension of its core functionality, greatly enhancing the practicality and flexibility of the LobeChat assistant.

Expand Down Expand Up @@ -246,7 +265,7 @@ In addition, these plugins are not limited to news aggregation, but can also ext

[![][image-feat-agent]][docs-feat-agent]

### `7` [Agent Market (GPTs)][docs-feat-agent]
### `8` [Agent Market (GPTs)][docs-feat-agent]

In LobeChat Agent Marketplace, creators can discover a vibrant and innovative community that brings together a multitude of well-designed agents,
which not only play an important role in work scenarios but also offer great convenience in learning processes.
Expand Down Expand Up @@ -291,7 +310,7 @@ Please tell me what issue you would like to explore?<br/>`backtracking-questions

[![][image-feat-database]][docs-feat-database]

### `8` [Support Local / Remote Database][docs-feat-database]
### `9` [Support Local / Remote Database][docs-feat-database]

LobeChat supports the use of both server-side and local databases. Depending on your needs, you can choose the appropriate deployment solution:

Expand All @@ -308,7 +327,7 @@ Regardless of which database you choose, LobeChat can provide you with an excell

[![][image-feat-auth]][docs-feat-auth]

### `9` [Support Multi-User Management][docs-feat-auth]
### `10` [Support Multi-User Management][docs-feat-auth]

LobeChat supports multi-user management and provides two main user authentication and management solutions to meet different needs:

Expand All @@ -326,7 +345,7 @@ Regardless of which user management solution you choose, LobeChat can provide yo

[![][image-feat-pwa]][docs-feat-pwa]

### `10` [Progressive Web App (PWA)][docs-feat-pwa]
### `11` [Progressive Web App (PWA)][docs-feat-pwa]

We deeply understand the importance of providing a seamless experience for users in today's multi-device environment.
Therefore, we have adopted Progressive Web Application ([PWA](https://support.google.com/chrome/answer/9658361)) technology,
Expand All @@ -353,7 +372,7 @@ providing smooth animations, responsive layouts, and adapting to different devic

[![][image-feat-mobile]][docs-feat-mobile]

### `11` [Mobile Device Adaptation][docs-feat-mobile]
### `12` [Mobile Device Adaptation][docs-feat-mobile]

We have carried out a series of optimization designs for mobile devices to enhance the user's mobile experience. Currently, we are iterating on the mobile user experience to achieve smoother and more intuitive interactions. If you have any suggestions or ideas, we welcome you to provide feedback through GitHub Issues or Pull Requests.

Expand All @@ -365,7 +384,7 @@ We have carried out a series of optimization designs for mobile devices to enhan

[![][image-feat-theme]][docs-feat-theme]

### `12` [Custom Themes][docs-feat-theme]
### `13` [Custom Themes][docs-feat-theme]

As a design-engineering-oriented application, LobeChat places great emphasis on users' personalized experiences,
hence introducing flexible and diverse theme modes, including a light mode for daytime and a dark mode for nighttime.
Expand Down Expand Up @@ -711,6 +730,7 @@ This project is [Apache 2.0](./LICENSE) licensed.
[docs-env-var]: https://lobehub.com/docs/self-hosting/environment-variables
[docs-feat-agent]: https://lobehub.com/docs/usage/features/agent-market
[docs-feat-auth]: https://lobehub.com/docs/usage/features/auth
[docs-feat-knowledgebase]: https://lobehub.com/blog/knowledge-base
[docs-feat-database]: https://lobehub.com/docs/usage/features/database
[docs-feat-local]: https://lobehub.com/docs/usage/features/local-llm
[docs-feat-mobile]: https://lobehub.com/docs/usage/features/mobile
Expand Down Expand Up @@ -760,6 +780,7 @@ This project is [Apache 2.0](./LICENSE) licensed.
[image-feat-plugin]: https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/268670883-33c43a5c-a512-467e-855c-fa299548cce5.png
[image-feat-privoder]: https://github.com/lobehub/lobe-chat/assets/28616219/b164bc54-8ba2-4c1e-b2f2-f4d7f7e7a551
[image-feat-pwa]: https://gw.alipayobjects.com/zos/kitchen/69x6bllkX3/pwa.webp
[image-feat-knowledgebase]: https://github.com/user-attachments/assets/77e58e1c-c82f-4341-b159-f4eeede9967f
[image-feat-t2i]: https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/297746445-0ff762b9-aa08-4337-afb7-12f932b6efbb.png
[image-feat-theme]: https://gw.alipayobjects.com/zos/kitchen/pvus1lo%26Z7/darkmode.webp
[image-feat-tts]: https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/284072124-c9853d8d-f1b5-44a8-a305-45ebc0f6d19a.png
Expand Down
46 changes: 34 additions & 12 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,29 @@

## ✨ 特性一览

[![][image-feat-knowledgebase]][docs-feat-knowledgebase]

### `1` [文件上传/知识库][docs-feat-knowledgebase]

LobeChat 支持文件上传与知识库功能,你可以上传文件、图片、音频、视频等多种类型的文件,以及创建知识库,方便用户管理和查找文件。同时在对话中使用文件和知识库功能,实现更加丰富的对话体验。

https://github.com/user-attachments/assets/faa8cf67-e743-4590-8bf6-ebf6ccc34175


> \[!TIP]
>
> 查阅 [📘 LobeChat 知识库上线 —— 此刻起,跬步千里](https://lobehub.com/zh/blog/knowledge-base) 了解详情。

<div align="right">

[![][back-to-top]](#readme-top)

</div>

[![][image-feat-privoder]][docs-feat-provider]

### `1` [多模型服务商支持][docs-feat-provider]
### `2` [多模型服务商支持][docs-feat-provider]

在 LobeChat 的不断发展过程中,我们深刻理解到在提供 AI 会话服务时模型服务商的多样性对于满足社区需求的重要性。因此,我们不再局限于单一的模型服务商,而是拓展了对多种模型服务商的支持,以便为用户提供更为丰富和多样化的会话选择。

Expand Down Expand Up @@ -145,7 +165,7 @@

[![][image-feat-local]][docs-feat-local]

### `2` [支持本地大语言模型 (LLM)][docs-feat-local]
### `3` [支持本地大语言模型 (LLM)][docs-feat-local]

为了满足特定用户的需求,LobeChat 还基于 [Ollama](https://ollama.ai) 支持了本地模型的使用,让用户能够更灵活地使用自己的或第三方的模型。

Expand All @@ -161,7 +181,7 @@

[![][image-feat-vision]][docs-feat-vision]

### `3` [模型视觉识别 (Model Visual)][docs-feat-vision]
### `4` [模型视觉识别 (Model Visual)][docs-feat-vision]

LobeChat 已经支持 OpenAI 最新的 [`gpt-4-vision`](https://platform.openai.com/docs/guides/vision) 支持视觉识别的模型,这是一个具备视觉识别能力的多模态应用。
用户可以轻松上传图片或者拖拽图片到对话框中,助手将能够识别图片内容,并在此基础上进行智能对话,构建更智能、更多元化的聊天场景。
Expand All @@ -176,7 +196,7 @@ LobeChat 已经支持 OpenAI 最新的 [`gpt-4-vision`](https://platform.openai.

[![][image-feat-tts]][docs-feat-tts]

### `4` [TTS & STT 语音会话][docs-feat-tts]
### `5` [TTS & STT 语音会话][docs-feat-tts]

LobeChat 支持文字转语音(Text-to-Speech,TTS)和语音转文字(Speech-to-Text,STT)技术,这使得我们的应用能够将文本信息转化为清晰的语音输出,用户可以像与真人交谈一样与我们的对话助手进行交流。
用户可以从多种声音中选择,给助手搭配合适的音源。 同时,对于那些倾向于听觉学习或者想要在忙碌中获取信息的用户来说,TTS 提供了一个极佳的解决方案。
Expand All @@ -191,7 +211,7 @@ LobeChat 支持文字转语音(Text-to-Speech,TTS)和语音转文字(Spe

[![][image-feat-t2i]][docs-feat-t2i]

### `5` [Text to Image 文生图][docs-feat-t2i]
### `6` [Text to Image 文生图][docs-feat-t2i]

支持最新的文本到图片生成技术,LobeChat 现在能够让用户在与助手对话中直接调用文生图工具进行创作。
通过利用 [`DALL-E 3`](https://openai.com/dall-e-3)[`MidJourney`](https://www.midjourney.com/)[`Pollinations`](https://pollinations.ai/) 等 AI 工具的能力, 助手们现在可以将你的想法转化为图像。
Expand All @@ -205,7 +225,7 @@ LobeChat 支持文字转语音(Text-to-Speech,TTS)和语音转文字(Spe

[![][image-feat-plugin]][docs-feat-plugin]

### `6` [插件系统 (Function Calling)][docs-feat-plugin]
### `7` [插件系统 (Tools Calling)][docs-feat-plugin]

LobeChat 的插件生态系统是其核心功能的重要扩展,它极大地增强了 ChatGPT 的实用性和灵活性。

Expand Down Expand Up @@ -238,7 +258,7 @@ LobeChat 的插件生态系统是其核心功能的重要扩展,它极大地

[![][image-feat-agent]][docs-feat-agent]

### `7` [助手市场 (GPTs)][docs-feat-agent]
### `8` [助手市场 (GPTs)][docs-feat-agent]

在 LobeChat 的助手市场中,创作者们可以发现一个充满活力和创新的社区,它汇聚了众多精心设计的助手,这些助手不仅在工作场景中发挥着重要作用,也在学习过程中提供了极大的便利。
我们的市场不仅是一个展示平台,更是一个协作的空间。在这里,每个人都可以贡献自己的智慧,分享个人开发的助手。
Expand Down Expand Up @@ -279,7 +299,7 @@ LobeChat 的插件生态系统是其核心功能的重要扩展,它极大地

[![][image-feat-database]][docs-feat-database]

### `8` [支持本地 / 远程数据库][docs-feat-database]
### `9` [支持本地 / 远程数据库][docs-feat-database]

LobeChat 支持同时使用服务端数据库和本地数据库。根据您的需求,您可以选择合适的部署方案:

Expand All @@ -296,7 +316,7 @@ LobeChat 支持同时使用服务端数据库和本地数据库。根据您的

[![][image-feat-auth]][docs-feat-auth]

### `9` [支持多用户管理][docs-feat-auth]
### `10` [支持多用户管理][docs-feat-auth]

LobeChat 支持多用户管理,提供了两种主要的用户认证和管理方案,以满足不同需求:

Expand All @@ -314,7 +334,7 @@ LobeChat 支持多用户管理,提供了两种主要的用户认证和管理

[![][image-feat-pwa]][docs-feat-pwa]

### `10` [渐进式 Web 应用 (PWA)][docs-feat-pwa]
### `11` [渐进式 Web 应用 (PWA)][docs-feat-pwa]

我们深知在当今多设备环境下为用户提供无缝体验的重要性。为此,我们采用了渐进式 Web 应用 [PWA](https://support.google.com/chrome/answer/9658361) 技术,
这是一种能够将网页应用提升至接近原生应用体验的现代 Web 技术。通过 PWA,LobeChat 能够在桌面和移动设备上提供高度优化的用户体验,同时保持轻量级和高性能的特点。
Expand All @@ -337,7 +357,7 @@ LobeChat 支持多用户管理,提供了两种主要的用户认证和管理

[![][image-feat-mobile]][docs-feat-mobile]

### `11` [移动设备适配][docs-feat-mobile]
### `12` [移动设备适配][docs-feat-mobile]

针对移动设备进行了一系列的优化设计,以提升用户的移动体验。目前,我们正在对移动端的用户体验进行版本迭代,以实现更加流畅和直观的交互。如果您有任何建议或想法,我们非常欢迎您通过 GitHub Issues 或者 Pull Requests 提供反馈。

Expand All @@ -349,7 +369,7 @@ LobeChat 支持多用户管理,提供了两种主要的用户认证和管理

[![][image-feat-theme]][docs-feat-theme]

### `12` [自定义主题][docs-feat-theme]
### `13` [自定义主题][docs-feat-theme]

作为设计工程师出身,LobeChat 在界面设计上充分考虑用户的个性化体验,因此引入了灵活多变的主题模式,其中包括日间的亮色模式和夜间的深色模式。
除了主题模式的切换,还提供了一系列的颜色定制选项,允许用户根据自己的喜好来调整应用的主题色彩。无论是想要沉稳的深蓝,还是希望活泼的桃粉,或者是专业的灰白,用户都能够在 LobeChat 中找到匹配自己风格的颜色选择。
Expand Down Expand Up @@ -736,6 +756,7 @@ This project is [Apache 2.0](./LICENSE) licensed.
[docs-feat-local]: https://lobehub.com/docs/usage/features/local-llm
[docs-feat-mobile]: https://lobehub.com/docs/usage/features/mobile
[docs-feat-plugin]: https://lobehub.com/docs/usage/features/plugin-system
[docs-feat-knowledgebase]: https://lobehub.com/blog/knowledge-base
[docs-feat-provider]: https://lobehub.com/docs/usage/features/multi-ai-providers
[docs-feat-pwa]: https://lobehub.com/docs/usage/features/pwa
[docs-feat-t2i]: https://lobehub.com/docs/usage/features/text-to-image
Expand Down Expand Up @@ -781,6 +802,7 @@ This project is [Apache 2.0](./LICENSE) licensed.
[image-feat-local]: https://github.com/lobehub/lobe-chat/assets/28616219/ca9a21bc-ea6c-4c90-bf4a-fa53b4fb2b5c
[image-feat-mobile]: https://gw.alipayobjects.com/zos/kitchen/R441AuFS4W/mobile.webp
[image-feat-plugin]: https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/268670883-33c43a5c-a512-467e-855c-fa299548cce5.png
[image-feat-knowledgebase]: https://github.com/user-attachments/assets/77e58e1c-c82f-4341-b159-f4eeede9967f
[image-feat-privoder]: https://github.com/lobehub/lobe-chat/assets/28616219/b164bc54-8ba2-4c1e-b2f2-f4d7f7e7a551
[image-feat-pwa]: https://gw.alipayobjects.com/zos/kitchen/69x6bllkX3/pwa.webp
[image-feat-t2i]: https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/297746445-0ff762b9-aa08-4337-afb7-12f932b6efbb.png
Expand Down

0 comments on commit b95f70b

Please sign in to comment.