Update README.md with improved description and formatting
This commit is contained in:
32
README.md
32
README.md
@@ -4,41 +4,43 @@
|
|||||||
|
|
||||||
> ⚠️ **This README.md has been automatically generated using AI and might contain hallucinations or inaccuracies. Please proceed with caution!**
|
> ⚠️ **This README.md has been automatically generated using AI and might contain hallucinations or inaccuracies. Please proceed with caution!**
|
||||||
|
|
||||||
# Empathy AI Chatbot
|
# Empathy Chatbot
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
This repository contains a Python script for an empathetic AI chatbot that analyzes user input from multiple perspectives (Sachebene, Selbstkundgabe, Beziehungsebene, Appell) and generates a personalized response. The chatbot uses the LangChain and Ollama models to perform these analyses.
|
Empathy Chatbot is an AI-powered conversational assistant designed to provide empathetic and insightful responses by analyzing user input from four distinct perspectives: factual content (Sache), self-disclosure (Selbst), relationship dynamics (Beziehung), and underlying appeals or desires (Appell).
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
- **Multi-Perspective Analysis**: Analyzes user input on four levels: what is said (Sache), what it reveals about the self (Selbstkundgabe), how it perceives the relationship (Beziehungsebene), and underlying appeals or wishes (Appell).
|
- **Multi-Perspective Analysis**: Breaks down user messages into four key components for a comprehensive understanding.
|
||||||
- **Empathetic Response Generation**: Generates responses that are empathetic, considerate of user feelings, and tailored to the context.
|
- **Empathetic Responses**: Generates replies that are sensitive to the user's emotional state, wishes, and relational expectations.
|
||||||
- **Debugging Mode**: Includes a debug mode for detailed logging of the analysis process.
|
- **Debug Mode**: Provides detailed debug information for developers and testers.
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
- Python 3.8+
|
- Python 3.8 or higher
|
||||||
- `langchain_ollama` library
|
- `langchain_ollama` library
|
||||||
- Ollama model server running locally or accessible via an API
|
- Ollama model server running locally
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
1. Clone the repository:
|
1. Clone the repository:
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/yourusername/empathy-chatbot.git
|
git clone https://github.com/your-repo/empathy-chatbot.git
|
||||||
cd empathy-chatbot
|
cd empathy-chatbot
|
||||||
|
|
||||||
|
|
||||||
2. Install dependencies:
|
2. Install dependencies:
|
||||||
```bash
|
```bash
|
||||||
pip install langchain_ollama
|
pip install -r requirements.txt
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
3. Ensure Ollama model server is running locally on `http://localhost:11434`.
|
||||||
Run the script with Python:
|
|
||||||
bash
|
## Usage
|
||||||
python Neuer\ Ordner\ mit\ Objekten/empathy\ Kopie.py --debug
|
Run the chatbot with optional debug mode:
|
||||||
|
bash
|
||||||
|
python Neuer_Ordner_mit_Objekten/empathy_Kopie.py --debug
|
||||||
|
|
||||||
- The `--debug` flag is optional and enables detailed debug output.
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
Contributions are welcome! Please open an issue or submit a pull request with your changes.
|
Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to contribute to this project.
|
||||||
Reference in New Issue
Block a user