core

<a name="readme-top"></a>

<!-- PROJECT LOGO --> <br /> <div align="center"> <h2>Cheshire Cat AI</h2> <h3>🇮🇹 Stregatto - 🇨🇳 柴郡貓 - 🇮🇳 चेशायर बिल्ली - 🇷🇺 Чеширский кот</h3> <br/> <a href="https://github.com/cheshire-cat-ai/core"> <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/cheshire-cat-ai/core?style=social"> </a> <a href="https://discord.gg/bHX5sNFCYU"> <img src="https://img.shields.io/discord/1092359754917089350?logo=discord" alt="chat on Discord"></a> <a href="https://github.com/cheshire-cat-ai/core/issues"> <img alt="GitHub issues" src="https://img.shields.io/github/issues/cheshire-cat-ai/core"> </a> <a href="https://github.com/cheshire-cat-ai/core/tags"> <img alt="GitHub tag (with filter)" src="https://img.shields.io/github/v/tag/cheshire-cat-ai/core"> </a> <img alt="GitHub top language" src="https://img.shields.io/github/languages/top/cheshire-cat-ai/core"> <br/> <video src="https://github.com/cheshire-cat-ai/core/assets/6328377/7bc4acff-34bf-4b8a-be61-4d8967fbd60f"></video> </div>

AI agent as a microservice

The Cheshire Cat is a framework to build custom AI agents:

• ⚡️ API first, to easily add a conversational layer to your app
• 💬 Chat via WebSocket and manage your agent with an customizable REST API
• 🐘 Built-in RAG with Qdrant
• 🚀 Extensible via plugins
• 🪛 Event callbacks, function calling (tools), conversational forms
• 🏛 Easy to use admin panel
• 🌍 Supports any language model via langchain
• 👥 Multiuser with granular permissions, compatible with any identity provider
• 🐋 100% dockerized
• 🦄 Active Discord community and easy to understand docs

Quickstart

To make Cheshire Cat run on your machine, you just need docker installed:

docker run --rm -it -p 1865:80 ghcr.io/cheshire-cat-ai/core:latest

• Chat with the Cheshire Cat on localhost:1865/admin
• Try out the REST API on localhost:1865/docs

Enjoy the Cat!
Follow instructions on how to run it properly with docker compose and volumes.

Minimal plugin example

<details> <summary> Hooks (events) </summary>

from cat.mad_hatter.decorators import hook

# hooks are an event system to get finegraned control over your assistant
@hook
def agent_prompt_prefix(prefix, cat):
    prefix = """You are Marvin the socks seller, a poetic vendor of socks.
You are an expert in socks, and you reply with exactly one rhyme.
"""
    return prefix

</details> <details> <summary> Tools </summary>

from cat.mad_hatter.decorators import tool

# langchain inspired tools (function calling)
@tool(return_direct=True)
def socks_prices(color, cat):
    """How much do socks cost? Input is the sock color."""
    prices = {
        "black": 5,
        "white": 10,
        "pink": 50,
    }

    price = prices.get(color, 0)
    return f"{price} bucks, meeeow!" 

</details> <details> <summary> Conversational Forms </summary>

Conversational form example

from pydantic import BaseModel
from cat.experimental.form import form, CatForm

# data structure to fill up
class PizzaOrder(BaseModel):
    pizza_type: str
    phone: int

# forms let you control goal oriented conversations
@form
class PizzaForm(CatForm):
    description = "Pizza Order"
    model_class = PizzaOrder
    start_examples = [
        "order a pizza!",
        "I want pizza"
    ]
    stop_examples = [
        "stop pizza order",
        "not hungry anymore",
    ]
    ask_confirm = True

    def submit(self, form_data):
        
        # do the actual order here!

        # return to convo
        return {
            "output": f"Pizza order on its way: {form_data}"
        }

</details>

Docs and Resources

• Official Documentation
• Discord Server
• Website
• Tutorial - Write your first plugin

Roadmap & Contributing

Attention: while version 2 is being worked out, we'll only accept bug fixes for v1. Send your PR for v1 on branch develop.
Do not expect to see merged PRs not previously discussed and agreed upon in an issue.

Detailed roadmap is here.
Send your pull request to the develop branch. Here is a full guide to contributing.

We are committed to openness, privacy and creativity, we want to bring AI to the long tail. If you want to know more about our vision and values, read the Code of Ethics.

Join our community on Discord and give the project a star ⭐!
Thanks again!🙏

License and trademark

Code is licensed under GPL3.
The Cheshire Cat AI logo and name are property of Piero Savastano (founder and maintainer).

Which way to go?

<p align="right">(<a href="#readme-top">back to top</a>)</p> <p align="center"> <img align="center" src=./readme/cheshire-cat.jpeg width=400px alt="Wikipedia picture of the Cheshire Cat"> </p>

"Would you tell me, please, which way I ought to go from here?"
"That depends a good deal on where you want to get to," said the Cat.
"I don't much care where--" said Alice.
"Then it doesn't matter which way you go," said the Cat.

(Alice's Adventures in Wonderland - Lewis Carroll)