79 lines
3.5 KiB
Markdown
79 lines
3.5 KiB
Markdown
|
<a name="readme-top"></a>
|
||
|
|
|
||
|
|
<br />
|
||
|
|
<div align="center">
|
||
|
|
<h2>Cheshire-Cat (Stregatto)</h2>
|
||
|
|
<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">
|
||
|
|
|
||
|
|
<p align="center">
|
||
|
|
<img align="center" src=https://cheshire-cat-ai.github.io/docs/assets/img/quickstart/write-hook/marvin-sockseller.png alt="Wikipedia picture of the Cheshire Cat">
|
||
|
|
</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
## Production-ready AI assistant framework
|
||
|
|
|
||
|
|
The Cheshire Cat is a framework to build custom AIs on top of any language model.
|
||
|
|
If you have ever used systems like WordPress or Django to build web apps, imagine the Cat as a similar tool, but specific for AI.
|
||
|
|
|
||
|
|
## Docs and Resources
|
||
|
|
|
||
|
|
- [Official Documentation](https://cheshire-cat-ai.github.io/docs/)
|
||
|
|
- [Discord Server](https://discord.gg/bHX5sNFCYU)
|
||
|
|
- [Website](https://cheshirecat.ai/)
|
||
|
|
- [YouTube tutorial - How to install](https://youtu.be/Rvx19TZBCrw)
|
||
|
|
- [Tutorial - Write your first plugin](https://cheshirecat.ai/write-your-first-plugin/)
|
||
|
|
|
||
|
|
## Why using the Cat
|
||
|
|
|
||
|
|
- ⚡️ API first, so you get a microservice to easily add a conversational layer to your app
|
||
|
|
- 🐘 Remembers conversations and documents and uses them in conversation
|
||
|
|
- 🚀 Extensible via plugins (public plugin registry + private plugins allowed)
|
||
|
|
- 🎚 Event callbacks, function calling (tools), conversational forms
|
||
|
|
- 🏛 Easy to use admin panel (chat, visualize memory and plugins, adjust settings)
|
||
|
|
- 🌍 Supports any language model (works with OpenAI, Google, Ollama, HuggingFace, custom services)
|
||
|
|
- 🐋 Production-ready - 100% [dockerized](https://docs.docker.com/get-docker/)
|
||
|
|
- 👩👧👦 Active [Discord community](https://discord.gg/bHX5sNFCYU) and easy to understand [docs](https://cheshire-cat-ai.github.io/docs/)
|
||
|
|
|
||
|
|
We are committed to openness, privacy and creativity, we want to bring AI to the long tail. To learn more about our vision and values, read the [Code of Ethics](https://cheshirecat.ai/code-of-ethics/).
|
||
|
|
|
||
|
|
|
||
|
|
## Roadmap & Contributing
|
||
|
|
|
||
|
|
The Detailed roadmap is [here](https://github.com/cheshire-cat-ai/core/blob/main/readme/ROADMAP.md).
|
||
|
|
Send your pull request to the `develop` branch. Here is a [full guide to contributing](https://github.com/cheshire-cat-ai/core/blob/main/readme/CONTRIBUTING.md).
|
||
|
|
|
||
|
|
Join our [community on Discord](https://discord.gg/bHX5sNFCYU) and give the project a star ⭐!
|
||
|
|
Thanks again!🙏
|
||
|
|
|
||
|
|
## Which way to go?
|
||
|
|
|
||
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||
|
|
|
||
|
|
<p align="center">
|
||
|
|
<img align="center" src=https://raw.githubusercontent.com/cheshire-cat-ai/core/main/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)
|
||
|
|
|
||
|
|
```
|