add: Cheshire Cat AI app (#3073)

* add: Cheshire Cat AI app

meow

* fix(cheshire-cat-ai): fix some small config options

---------

Co-authored-by: Stavros <steveiliop56@gmail.com>
This commit is contained in:
Adelina 2024-04-23 16:53:08 +02:00 committed by GitHub
parent bb85594efd
commit 0485a26b3d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 146 additions and 0 deletions

View File

@ -0,0 +1,23 @@
{
"name": "Cheshire Cat AI",
"available": true,
"port": 1865,
"exposable": true,
"id": "cheshire-cat-ai",
"description": "The Cheshire Cat is an open-source, hackable and production-ready framework that allows developing intelligent personal AI assistant agents on top of Large Language Models (LLM).",
"tipi_version": 1,
"version": "1.5.3",
"categories": [
"ai"
],
"short_desc": "A production-ready AI framework to develop AI agents.",
"author": "pieroit",
"source": "https://github.com/cheshire-cat-ai/core",
"website": "https://cheshirecat.ai",
"form_fields": [],
"url_suffix": "/admin",
"supported_architectures": [
"amd64",
"arm64"
]
}

View File

@ -0,0 +1,45 @@
version: '3.7'
services:
cheshire-cat-ai:
networks:
- tipi_main_network
image: ghcr.io/cheshire-cat-ai/core:1.5.3
container_name: cheshire-cat-ai
ports:
- ${APP_PORT}:80
environment:
- PYTHONUNBUFFERED=1
- WATCHFILES_FORCE_POLLING=true
volumes:
- ${APP_DATA_DIR}/data/static:/app/cat/static
- ${APP_DATA_DIR}/data/plugins:/app/cat/plugins
- ${APP_DATA_DIR}/data/data:/app/cat/data
labels:
# Main
traefik.enable: true
traefik.http.middlewares.cheshire-web-redirect.redirectscheme.scheme: https
traefik.http.services.cheshire.loadbalancer.server.port: 1865
# Web
traefik.http.routers.cheshire-insecure.rule: Host(`${APP_DOMAIN}`)
traefik.http.routers.cheshire-insecure.entrypoints: web
traefik.http.routers.cheshire-insecure.service: cheshire-cat-ai
traefik.http.routers.cheshire-insecure.middlewares: cheshire-cat-ai-web-redirect
# Websecure
traefik.http.routers.cheshire.rule: Host(`${APP_DOMAIN}`)
traefik.http.routers.cheshire.entrypoints: websecure
traefik.http.routers.cheshire.service: cheshire-cat-ai
traefik.http.routers.cheshire.tls.certresolver: myresolver
# Local domain
traefik.http.routers.cheshire-local-insecure.rule: Host(`cheshire-cat-ai.${LOCAL_DOMAIN}`)
traefik.http.routers.cheshire-local-insecure.entrypoints: web
traefik.http.routers.cheshire-local-insecure.service: cheshire-cat-ai
traefik.http.routers.cheshire-local-insecure.middlewares: cheshire-cat-ai-web-redirect
# Local domain secure
traefik.http.routers.cheshire-local.rule: Host(`cheshire-cat-ai.${LOCAL_DOMAIN}`)
traefik.http.routers.cheshire-local.entrypoints: websecure
traefik.http.routers.cheshire-local.service: cheshire-cat-ai
traefik.http.routers.cheshire-local.tls: true
networks:
tipi-main-network:
driver: bridge

View File

@ -0,0 +1,78 @@
<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)
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB