Cheshire Cat AI

🇮🇹 Stregatto - 🇨🇳 柴郡貓 - 🇮🇳 चेशायर बिल्ली - 🇷🇺 Чеширский кот

微服务化 AI Agent

Cheshire Cat 是一个用于构建自定义 AI Agent 的框架：

⚡️ API 优先：轻松为您的应用程序添加对话层
💬 通过 WebSocket 进行对话，并使用可自定义的 REST API 管理您的 Agent
🐘 内置基于 Qdrant 的 RAG（检索增强生成）
🚀 可通过插件进行扩展
🪛 提供事件回调、函数调用（Tools）、对话式表单功能
🏛 易于使用的管理面板
🌍 通过 langchain 支持任何语言模型
👥 支持多用户及细粒度权限控制，兼容任何身份验证提供商
🐋 100% Docker 化
🦄 活跃的 Discord 社区以及易于理解的文档

快速入门

要让 Cheshire Cat 在您的机器上运行，您只需要安装 docker：

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

在 localhost:1865/admin 与 Cheshire Cat 聊天
在 localhost:1865/docs 试用 REST API

享受这只猫带来的乐趣吧！请按照 docker compose 和卷挂载的指南正确运行它。

最小插件示例

Hooks (事件)

from cat.mad_hatter.decorators import hook

# hooks 是一个事件系统，用于对您的助手进行精细化控制
@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

Tools

from cat.mad_hatter.decorators import tool

# 受 langchain 启发的工具（函数调用）
@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!"

对话式表单示例

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

# 需要填充的数据结构
class PizzaOrder(BaseModel):
    pizza_type: str
    phone: int

# 表单让您可以控制目标导向的对话
@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):
        
        # 在此处执行实际下单操作！

        # 返回对话
        return {
            "output": f"Pizza order on its way: {form_data}"
        }

文档与资源

路线图与贡献

注意：在开发第 2 版本期间，我们仅接受 v1 版本的 bug 修复。请将 v1 版本的 PR 发送到 develop 分支。除非在 Issue 中讨论并达成一致，否则请勿期望未经过沟通的 PR 被合并。

详细路线图请查看此处。请将您的 Pull Request 发送到 develop 分支。这里有一份完整的贡献指南。

我们致力于开放、隐私和创造力，我们希望将 AI 带入长尾市场。如果您想了解更多关于我们的愿景和价值观，请阅读道德准则。

加入我们的 Discord 社区并为项目点个星 ⭐！再次感谢！🙏

许可证与商标

代码采用 GPL3 许可。 Cheshire Cat AI 的徽标和名称归 Piero Savastano（创始人和维护者）所有。

该走哪条路？

(回到顶部)

"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)