-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
29 additions
and
25 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,43 +1,47 @@ | ||
# Clients | ||
|
||
Below are listed the Official and Community Client Libraries, Widget-chats and Apps. | ||
How do you talk with the Cat from a script, from the browser or from a server? | ||
The Cat is an AI microservice, which means it is intended to be added to any application as a conversational layer. | ||
|
||
You can check out the REST API playground directly on your installation, at [`localhost:1865/docs`](http://localhost:1865/docs). | ||
|
||
There are several client libraries that may help you to easily chat with the Cat and call its endpoints from another application. | ||
Below we list client libraries in many languages, web widgets and client apps. | ||
|
||
## Libraries | ||
Some of the clients are maintained from the community, some others come from individual contributors. If you find any problem, open an issue or PR on the dedicated repository - be nice! | ||
|
||
### Official | ||
## Client Libraries | ||
|
||
| Language | Installation | Client Repository | | ||
| ------------------------------------------------------------------------------------ | ------------------------------ | ---------------------------------------------------------------------------------------------- | | ||
| ![Image title](../../assets/img/clientlib/1869px-Python-logo-notext.png){ width="40" } | `pip install cheshire_cat_api` | [Cheshire Cat Python API Client](https://pypi.org/project/cheshire_cat_api/){:target="_blank"} | | ||
| ![Image title](../../assets/img/clientlib/512px-Typescript_logo_2020.png){ width="40" } | `bun install ccat-api` | [Cheshire Cat Typescript API Client](https://github.com/cheshire-cat-ai/api-client-ts) | | ||
| Language | Repository | | ||
| ----------------------------------------------------------------------------------------| -------------------------------------------------------------------------------------------------- | | ||
| ![Image title](../../assets/img/clientlib/512px-Typescript_logo_2020.png){ width="40" } | [Typescript/Javascript Client](https://github.com/cheshire-cat-ai/api-client-ts){:target="_blank"} | | ||
| ![Image title](../../assets/img/clientlib/1869px-Python-logo-notext.png){ width="40" } | [Python Client](https://github.com/cheshire-cat-ai/api-client-py){:target="_blank"} | | ||
| ![Image title](../../assets/img/clientlib/1200px-Logo_C_sharp.png){ width="40" } | [C# Client](https://github.com/cheshire-cat-ai/api-client-csharp){:target="_blank"} | | ||
| ![Image title](../../assets/img/clientlib/711px-PHP-logo.png){ width="40" } | [PHP Client](https://github.com/AlboCode/ccatphp-sdk){:target="_blank"} | | ||
| ![Image title](../../assets/img/clientlib/198px-Ruby_logo.png){ width="40" } | [Ruby Client](https://github.com/Jhonnyr97/cheshire_cat_api){:target="_blank"} | | ||
| ![Image title](../../assets/img/clientlib/Go_logo.png){ width="80" } | [Go Client](https://github.com/saniales/ccat-api){:target="_blank"} | | ||
| ![Image title](../../assets/img/clientlib/Java_Logo.png){ width="40" } | [Java Client](https://github.com/matteobaccan/cheshire-cat-api-client-java){:target="_blank"} | | ||
|
||
### Community | ||
## Frontend Chat Widgets | ||
|
||
| Language | Installation | Client Repository | | ||
| ----------------------------------------------------------------------------- | --------------------------------------- | ----------------------------------------------------------------------------------------------- | | ||
| ![Image title](../../assets/img/clientlib/198px-Ruby_logo.png){ width="40" } | `bundle add cheshire_cat_api` | [Cheshire Cat Ruby API Client](https://github.com/Jhonnyr97/cheshire_cat_api){:target="_blank"} | | ||
| ![Image title](../../assets/img/clientlib/711px-PHP-logo.png){ width="40" } | `composer require albocode/ccatphp-sdk` | [Cheshire Cat PHP API Client](https://github.com/AlboCode/ccatphp-sdk){:target="_blank"} | | ||
| ![Image title](../../assets/img/clientlib/1200px-Logo_C_sharp.png){ width="40" } | None | :construction_worker: Working in progress... | | ||
| ![Image title](../../assets/img/clientlib/Java_Logo.png){ width="40" } | None | :construction_worker: Working in progress... | | ||
| Name | Framework | Repository | | ||
| ----------------- | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | ||
| widget-vue | ![Image title](../../assets/img/clientlib/Vue.js.png){ width="40" } | [Vue Widget](https://github.com/cheshire-cat-ai/widget-vue){:target="_blank"} | | ||
| widget-alpine | ![Image title](../../assets/img/clientlib/Alpine.js.png){ width="40" } | [Alpine Widget](https://github.com/cheshire-cat-ai/widget-alpine){:target="_blank"} | | ||
| widget-svelte | ![Image title](../../assets/img/clientlib/Svelte.js.png){ width="40" } | [Svelte Widget](https://github.com/cheshire-cat-ai/widget-svelte){:target="_blank"} | | ||
| widget-CCAT-react | ![Image title](../../assets/img/clientlib/React.js.png){ width="40" } | [React Widget](https://github.com/AndreaPesce2002/widget-CCAT-react){:target="_blank"} | | ||
|
||
## Widget | ||
|
||
### Official | ||
## Apps | ||
|
||
| Name | Language | Repository | | ||
| ------------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------- | | ||
| widget-alpine | ![Image title](../../assets/img/clientlib/Alpine.js.png){ width="40" } | [Cheshire Cat Alpine.JS Widget](https://github.com/cheshire-cat-ai/widget-alpine) | | ||
| Widget-Vue | ![Image title](../../assets/img/clientlib/Vue.js.png){ width="40" } | [Cheshire Cat Vue Widget](https://github.com/cheshire-cat-ai/widget-vue) | | ||
| Name | Platform | Repository | | ||
| -------------- | --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | ||
| Meowgram | ![Image title](../../assets/img/clientlib/2048px-Telegram_logo.png){ width="40" } | [Telegram bot](https://github.com/Pingdred/Meowgram){:target="_blank"} | | ||
| discord-bot-ts | ![Image title](../../assets/img/clientlib/discord.png){ width="40" } | [Discord bot](https://github.com/cheshire-cat-ai/discord-bot-ts){:target="_blank"} | | ||
|
||
|
||
## Apps | ||
## Command Line Interfaces | ||
|
||
| Name | Platform | Repository | | ||
| -------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------- | | ||
| Meowgram | ![Image title](../../assets/img/clientlib/2048px-Telegram_logo.png){ width="40" } | [Cheshire Cat Telegram](https://github.com/Pingdred/Meowgram) | | ||
| | ![Image title](../../assets/img/clientlib/discord.png){ width="40" } | :construction_worker: Working in progress... | | ||
| Language | Repository | | ||
| ---------------------------------------------------------------------| ------------------------------------------------------------------ | | ||
| ![Image title](../../assets/img/clientlib/Go_logo.png){ width="80" } | [Meow CLI](https://github.com/saniales/meow){:target="_blank"} | |