Skip to content

Cheshire Cat AI docs

The Rabbit Hole

Cheshire Cat AI docs

Hello, dear
Quickstart
Quickstart
Plugins
Plugins
- Plugin
- Tools
- Hooks
- Forms
- Logging
- Settings
- Dependencies
- Examples
- Python Reference
  Python Reference
  - agents
    agents
    
    base_agent
    
    form_agent
    
    main_agent
    
    memory_agent
    
    procedures_agent
  - auth
    auth
    
    auth_utils
  - log
  - looking_glass
    looking_glass
    
    cheshire_cat
    
    stray_cat
  - mad_hatter
    mad_hatter
    
    core_plugin
    core_plugin
    
    hooks
    hooks
    
    agent
    
    flow
    
    prompt
    
    rabbithole
    
    mad_hatter
    
    plugin
  - memory
    memory
    
    vector_memory
    
    vector_memory_collection
    
    working_memory
  - rabbit_hole
  - routes
    routes
    
    settings
  - utils
- Registry
  Registry
  - Using the Plugin Template
  - Publishing a Plugin
- Debugging
  Debugging
  - Visual Studio Code
Framework
Framework
- Cat Components
  Cat Components
  - The Core
  - The Stray Cat
  - The Agent
    The Agent
    
    Introduction
    
    Procedures Chain
    
    Memory Chain
  - The Prompts
    The Prompts
    
    Main Prompt
    
    Instruction Prompt
  - The Vector Memory
    The Vector Memory
    
    Vector Memory Collections
  - The Long Term Memory
    The Long Term Memory
    
    Introduction
    
    Episodic Memory
    
    Declarative Memory
    
    Procedural Memory
  - The Working Memory
  - The Rabbit Hole
  - The White Rabbit
  - The Mad Hatter
- Technical Diagrams
  Technical Diagrams
Administration
Administration
- Make the Cat Private
- Docker Compose
- Environment Variables
- Automatic Tests
- Backups and Updates
- Network
  Network
- Auth
  Auth
- Use Cases
  Use Cases
  - Integrations
  - Examples
FAQ
FAQ
- General
- Basic Info
- Errors
- Customization
- Security & Spending
- Concepts
  Concepts

Rabbit Hole

The Rabbit Hole is the Cat's component that takes care of ingesting documents and storing them in the declarative memory. You can interact with it either through its endpoint, the GUI or a Python script.

Currently supported file formats are: .txt, .md, .pdf or .html via web URL.

Schema of the Cheshire Cat components

TODO: Describe how customize ingestion using hooks. TODO: Link Rabbit Hole Ingestion Diagram.