Cheshire Cat AI

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

微服务化 AI 智能体

Cheshire Cat 是一个用于构建自定义 AI 智能体的框架，具有以下特性：

• ⚡️ 优先提供 API，便于为应用轻松添加对话层
• 💬 通过 WebSocket 进行聊天，并通过可自定义的 REST API 管理智能体
• 🐘 内置基于 Qdrant 的 RAG（检索增强生成）功能
• 🚀 支持通过插件扩展功能
• 🪛 事件回调、函数调用（工具）、对话表单
• 🏛 易用的管理面板
• 🌍 通过 langchain 支持任何语言模型
• 👥 多用户支持及细粒度权限控制，兼容任何身份提供商
• 🐋 100% 容器化（Docker）
• 🦄 活跃的 *** 社区 和易于理解的 https://cheshire-cat-ai.github.io/docs/

快速开始

要在本地运行 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

尽情使用吧！
有关如何通过 https://cheshire-cat-ai.github.io/docs/quickstart/installation-configuration/ 正确运行的详细说明，请参考官方文档。

插件示例（极简版）

钩子（事件）

from cat.mad_hatter.decorators import hook

# 钩子是一种事件系统，用于对助手进行精细控制
@hook
def agent_prompt_prefix(prefix, cat):
    prefix = """你是卖袜子的马文，一位富有诗意的袜子小贩。
    你是袜子专家，且每次回复必须包含一句押韵。
    """
    return prefix

工具

from cat.mad_hatter.decorators import tool

# 受 langchain 启发的工具（函数调用）
@tool(return_direct=True)
def socks_prices(color, cat):
    """袜子的价格是多少？输入为袜子颜色。"""
    prices = {
        "black": 5,
        "white": 10,
        "pink": 50,
    }

    price = prices.get(color, 0)
    return f"{price} 美元，喵呜！"

对话表单示例

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

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

# 表单用于控制目标导向的对话
@form
class PizzaForm(CatForm):
    description = "披萨订单"
    model_class = PizzaOrder
    start_examples = [
        "点一份披萨！",
        "我想要披萨"
    ]
    stop_examples = [
        "取消披萨订单",
        "不饿了"
    ]
    ask_confirm = True

    def submit(self, form_data):
        # 在此处执行实际订单逻辑
        
        # 返回对话
        return {
            "output": f"披萨订单已送出：{form_data}"
        }

文档与资源

• https://cheshire-cat-ai.github.io/docs/
• *** 服务器
• 官方网站
• 教程 - 编写你的第一个插件

路线图与贡献

[!IMPORTANT]
注意：在版本 2 开发期间，我们仅接受针对 v1 的 bug 修复。请将 v1 的 PR 提交至 develop 分支。未在 issue 中预先讨论并达成一致的 PR 将不会被合并。

详细路线图见 此处。
请将拉取请求提交至 develop 分支。贡献指南详见 完整说明。

我们致力于开放、隐私与创造力，希望将 AI 带给更多长尾用户。如需了解我们的愿景与价值观，请阅读 伦理准则。

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

许可与商标

代码基于 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)