[Official Guide] Knowledge Base

[quasi iron]

Introduction to Knowledge Base

The knowledge base is like an external brain for robots, providing them with knowledge beyond the large language model, giving robots more accurate information and stronger capabilities in specific fields.

The knowledge base has a wide range of applications:

• Access to project/product documentation for precise Q&A.
• Access to academic literature to become a domain expert.
• Access to blogs/tweets to build digital life.
• Access to game/animation wikis for high-precision role-playing.
• ...more application scenarios for you to imagine!

How to Use the Knowledge Base?

In the robot's editing page, go to the "Knowledge Base" panel in "Advanced Settings", turn on the knowledge base switch, and import the link to connect the knowledge base to the robot.

Currently supported link contents include:

• Gitbook
• Docusaurus
• Ordinary web pages with text content as the main content
  If you have a large amount of text content that requires multi-level parsing, please use Gitbook or Docusaurus. If you only need single-level parsing, import any text-rich web page.

When you import, the status will first show "Importing", indicating that the web page is being parsed.
After the import is successful, the status changes to green "Active", and you can use the knowledge base function normally!
If the import fails and shows "Invalid", you need to check the validity of the input link. If you enter a Gitbook link, please check if the link you imported is publicly available.

Precautions for Using the Knowledge Base

1. Only the pure text part will be used as the knowledge base content. Multimedia content such as files, online links, images, and audio attached to the page cannot be read at present.
2. Import natural language text paragraphs as much as possible and avoid complex formatted content such as tables.
3. When importing multiple knowledge bases, try to import knowledge bases with close relationships, which can achieve better results.

Tips for Using Gitbook

Gitbook is an important way to feed the bot's knowledge base. You can use it to edit structured knowledge bases and input a large amount of information. It is recommended that you use a format similar to the official documentation of MyShell for content organization.

Usage:

1. Create a "Space" in Gitbook and edit documents inside the "Space".
2. You can import a large amount of content through Gitbook's "Import content", or manually edit the knowledge base.
3. If the content hierarchy is complex, you can create a "Subpage" in the left sidebar.
4. When the knowledge base content is completed, click "Share" in the upper right corner, open "Publish to the web", and copy the link you obtained.
5. Copy and paste the link to the MyShell knowledge base interface and click import.
6. When the knowledge base is successfully parsed, the green "Active" will appear below.

Now, you have successfully imported a large amount of information through Gitbook!
If you need to modify the knowledge base content, you can click "Edit" to enter the editing page. After editing is completed, click "Merge", and the updated content will be automatically synchronized to your robot.

[sour grove]

thank you very much for such a detailed guide of knowledge base, rly important information!!!
i will go try to create my own GitBook and train my bot!

[hollow mortar]

thank X2 i didn’t know all this but now i’m almost a pro at creating robots

[bleak sentinel]

nice, will make use of this now in my bot , i have been habving issues with this

[sour patrol]

This is a really advanced feature! 👍

[gilded radish]

Amazing

[ornate holly]

[lost lotus]

Anyone knows if GitBook content can be dynamic?
Seems to be yea, but can the MyShell Knowledge Base still reads them(the dynamic content) properly though? Hmm