diff --git a/README.md b/README.md index aec04b8..baec87e 100644 --- a/README.md +++ b/README.md @@ -7,34 +7,50 @@ # Empathy Chatbot ## Description -Empathy Chatbot is an AI-powered assistant designed to understand and respond to user messages with empathy by analyzing them from four different perspectives: content (Sache), self-disclosure (Selbst), relationship (Beziehung), and underlying appeals or wishes (Appell). The chatbot uses a state graph to process these analyses and generate a personalized, empathetic response. +The Empathy Chatbot is a conversational AI designed to understand and respond to user messages with empathy by analyzing them from four different perspectives: factual content (Sache), self-disclosure (Selbst), relationship dynamics (Beziehung), and underlying appeals or desires (Appell). ## Features -- **Content Analysis**: Understands the main message and categorizes it. -- **Self-Disclosure Interpretation**: Analyzes feelings, desires, moods, or values expressed by the user. -- **Relationship Perception**: Interprets how the user perceives their relationship with the chatbot. -- **Appeal Detection**: Identifies underlying wishes or appeals in the user's message. +- **Factual Analysis**: Extracts the core message and categorizes it. +- **Self-Disclosure Interpretation**: Identifies feelings, wishes, moods, or values expressed by the user. +- **Relationship Dynamics**: Assesses how the user perceives their relationship with the chatbot. +- **Appeal Detection**: Recognizes hidden desires or appeals within the user's message. +- **Empathetic Response**: Generates a response that addresses all four aspects in an empathetic and personal manner. + +## Requirements +- Python 3.8+ +- `langgraph` +- `langchain_ollama` +- Ollama model (`mistral-small3.1:24b`) ## Installation -1. Clone this repository: +1. Clone the repository: ```bash - git clone https://github.com/your-repository/empathy-chatbot.git + git clone https://github.com/yourusername/empathy-chatbot.git cd empathy-chatbot -2. Install dependencies (ensure you have Python and pip installed): +2. Install dependencies: ```bash pip install -r requirements.txt ## Usage -Run the chatbot using: +Run the chatbot with the following command: bash python Neuer_Ordner_mit_Objekten/empathy_Kopie.py --debug -- Use `--debug` to enable detailed debug output. +Use `--debug` to enable detailed debug output. ## License -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. +The Empathy Chatbot is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details. ## Contributing -Contributions are welcome! Please feel free to open issues or submit pull requests. \ No newline at end of file +Contributions are welcome! Please open an issue or submit a pull request with your changes. + +## Contact +For any questions, feel free to reach out: +- Email: your.email@example.com +- GitHub: [yourusername](https://github.com/yourusername) + +--- + +**Note**: Replace `your.username` and `your.email@example.com` with the actual username and email address of the repository owner or maintainer. \ No newline at end of file