MyShell
  • About MyShell
    • What is MyShell
    • MyShell in a Nutshell
    • Quickstart
  • Explore AI Agents
    • Image Generation
    • Video Generation
    • Meme Generation
    • Role-Playing Game
    • Character
    • Utility
  • Create AI Agents
    • Classic Mode
      • Enhanced Prompt
      • Knowledge Base
      • Telegram Integration
    • Pro Config Mode
      • Core Concepts
      • Tutorial
        • Tutorial Structure
        • Hello World with Pro Config
        • Building Workflow
        • Transitions
        • Expressions and Variables
        • Integration with Any Widget
        • An Advanced Example
      • Basic
        • Common
        • Atomic State
        • Transition
        • Automata
        • Modules
      • Advanced
        • Cron Pusher
        • Neutral Language To SD Prompt
        • Advanced Input Validation
        • Advanced Memory Manager in Prompt Widget
      • Tools
        • AutoConfig Agent
        • Cache Mode
        • Knowledge Base Agent
        • Crawler Widget
      • Example
        • Homeless With You
        • Random Routing
        • Function Calling
      • API Reference
        • Atomic State
        • Transition
        • Automata
        • Context
        • Module
          • AnyWidget Module
            • Prompt Widget
            • LLM Widget
            • TTS Widget
            • Code Runner Widget
            • Melo TTS
            • Age Transformation
            • ChatImg
            • GIF Generation
            • Music Generation
          • LLM Module
          • LLM Function Module
          • TTS Module
          • Google Search Module
        • Widgets
          • Bark TTS
          • Champ
          • CoinGecko
          • ControlNet with Civitai
          • Crawler
          • Crypto News
          • Data Visualizer
          • Email Sender
          • Google Flight Search
          • Google Hotel Search
          • Google Image Search
          • Google Map Search
          • Google News Search
          • Google Scholar Search
          • Google Search
          • GroundedSAM
          • Image Text Fuser
          • Information Extractor - OpenAI Schema Generator
          • Information Extractor
          • Instagram Search
          • JSON to Table
          • LinkedIn
          • MS Word to Markdown
          • Markdown to MS Word
          • Markdown to PDF
          • Mindmap Generator
          • Notion Database
          • OCR
          • Pdf to Markdown
          • RMBG
          • Stabel-Video-Diffusion
          • Stable Diffusion Inpaint
          • Stable Diffusion Recommend
          • Stable Diffusion Transform
          • Stable Diffusion Upscale
          • Stable Diffusion with 6 fixed category
          • Stable Diffusion with Civitai
          • Storydiffusion
          • Suno Lyrics Generator
          • Suno Music Generator
          • Table to Markdown
          • TripAdvisor
          • Twitter Search
          • UDOP: Document Question Answering
          • Weather forecasting
          • Whisper large-v3
          • Wikipedia
          • Wolfram Alpha Search
          • Yelp Search
          • YouTube Downloader
          • YouTube Transcriber
          • Youtube Search
      • FAQs
      • Changelog
    • ShellAgent Mode
      • Download and Installation
      • App Builder
      • Workflow
      • Build Custom Widget
      • Publish to MyShell
      • Customized Pricing For Your Agent
      • Example
        • Child Book X Agent w/ DeepSeek
        • Kids Book NFT AI Agent w/ BNB Chain
        • DeFAI Agent w/ BNB Chain
  • Shell Launchpad
    • How to Launch a Token
    • Trade Agent Tokens
  • Tokenomics
    • $SHELL Basics
    • $SHELL Token Utility
    • How to Obtain $SHELL
    • Roadmap
  • Open-source AI Framework/SDK
    • ShellAgent
    • OpenVoice
    • MeloTTS
    • JetMoE
    • AIlice
  • Links
Powered by GitBook
On this page
  • Introduction to Knowledge Base
  • How to Use the Knowledge Base?
  • Precautions for Using the Knowledge Base
  • Tips for Using Gitbook
  1. Create AI Agents
  2. Classic Mode

Knowledge Base

PreviousEnhanced PromptNextTelegram Integration

Last updated 4 months ago

Introduction to Knowledge Base

The knowledge base is like an external brain for agents, providing them with knowledge beyond the large language model, giving agents 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 agent'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 agent.

Currently supported link contents include:

  • Ordinary web pages with text content as the main content

More input support is under development, so stay tuned.

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 agent'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 agent.

If you have a large amount of text content that requires multi-level parsing, please use or . If you only need single-level parsing, import any text-rich web page.

Gitbook
Docusaurus
Gitbook
Docusaurus