Skip to content

Cheshire Cat AI Toolkit for Industry 4.0/5.0 applications

License

Notifications You must be signed in to change notification settings

rmoscetti/cheshire-cat-ai-tools

Repository files navigation

Cheshire Cat AI Toolkit for Industry 4.0/5.0 applications

Cheshire Cat 4.0

Introduction

The Cheshire Cat AI Toolkit for Industry 4.0/5.0 it is a young (no-budget) project dedicated to harnessing the power of conversational AI in industrial applications, enabling the integration of advanced Large Language Models (LLMs) in critical areas such as process monitoring, control and optimisation. Seamlessly integrated with the Cheshire Cat AI, an open source and AI-agnostic conversational framework for building AI agents, these tools provide a foundation for developing intelligent and adaptive industrial systems. The initial (ambitious) idea is to integrate it into a smart food drying system to monitor and (hopefully) control the process by interacting with an LLM via dedicated CLIs and plugins. Below is a schematic of the idea:

Cheshire Cat 4.0

At the moment, the toolkit includes a Python-based CLI to chat with LLMs and a tool to access a structured SQL database connected to the process. More to come...

Requirements

  • Python 3.10 or higher
  • cheshire_cat_api library
  • requests library (for HTTP operations)

Installation

  1. Install Cheshire Cat AI on your server and configure it
  2. Clone this repository:
    git clone https://github.com/rmoscetti/chashire-cat-ai-tools.git
    cd cheshire-cat-ai-tools
  3. Install the required dependencies:
    pip install -r requirements.txt

Cheshire Cat CLI (version 1.1)

cat_chat.py is a python-based CLI for chatting with the Cheshire Cat AI. The script establishes a WebSocket connection to send messages and retrieve responses in real time. Its primary purpose is to communicate with the Cheshire Cat AI while prioritising the use of procedural memory by (optionally) eliminating history communications, which may currently be responsible for the AI agent not suggesting the use of procedural memory to the LLM. It also supports saving AI responses to a JSON file.

Features

  • Send Messages: Communicate with the Cheshire Cat AI server via WebSocket.
  • History Management: Option to maintain or clear conversation history before sending messages.
  • Save Responses: Store server responses in a JSON file.
  • Configurable: Set user ID, authentication key, server URL, and other parameters via command-line arguments.
  • Enable Logging: Use --log to enable logging for debugging purposes.
  • Customize Timeout: Adjust the maximum wait time for AI responses using --timeout.
  • Toggle Response Formats: Use --notext to display the full JSON response instead of just AI-generated text.
  • View AI Reasoning: Enable --reasoning to display AI's thought process if available.

Usage

  1. Ensure the Cheshire Cat AI server is running and accessible at the specified --base_url and --port.

  2. Run the script with the following command:

python cat_chat.py "your message here" --user_id YOUR_USER_ID --auth_key YOUR_AUTH_KEY [OPTIONS]

Command-Line Arguments

Argument Description Default Required
message The message to send to the server. N/A Yes
--user_id The user ID for authentication. N/A Yes
--auth_key The authentication key (password) for the server. N/A Yes
--base_url The base URL (IP address) of the server. 127.0.0.1 No
--port The port number of the server. 1865 No
--history Clears chat history before sending a message when false. false No
--filename The filename to save the JSON response from the server. N/A No
--log Enables logging to display debug information. Disabled No
--timeout Maximum wait time for AI response (in seconds). 300 sec No
--notext Displays the full JSON response instead of just AI text. Disabled No
--reasoning Displays AI reasoning alongside the response if available. Disabled No

Examples

To save the AI response to a JSON file:

python cat_chat.py "your question" --user_id USER123 --auth_key ABC123 --filename response.json

To send a message without clearing the chat history:

python cat_chat.py "your question" --user_id USER123 --auth_key ABC123 --history

To clear history before sending a message:

python cat_chat.py "your question" --user_id USER123 --auth_key ABC123

To enable logging and see debug output:

python cat_chat.py "your question" --user_id USER123 --auth_key ABC123 --log

To adjust the response timeout to 600 seconds:

python cat_chat.py "your question" --user_id USER123 --auth_key ABC123 --timeout 600

To display AI reasoning alongside its response:

python cat_chat.py "your question" --user_id USER123 --auth_key ABC123 --reasoning

To receive the full JSON response instead of extracted AI text:

python cat_chat.py "your question" --user_id USER123 --auth_key ABC123 --notext

Contributing

Contributions are welcome! Feel free to fork this repository, make your changes, and submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE for details.

Author

Roberto Moscetti [email protected]

(pls contact me if you want to contribute to the project)

About

Cheshire Cat AI Toolkit for Industry 4.0/5.0 applications

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published