Important: I recommend you go to the qdrant dashboard: http://localhost:6333/dashboard and create and download a snapshot of your agents vector store. This will allow you to restore in case something happens where the docker zaps it. Next release has a few features to fix this, but good to have the backup.
Memoir is an AI-powered plugin designed to enrich your existing AI companions within the Text Generation Web UI. With advanced memory capabilities and emotional intelligence, Memoir transforms your interactions with AI into a more nuanced and human-like experience.
- Introduction
- Key Features
- Configuration
- Future Development
- Installation
- Usage
- Support
- Contributing
- License
- Short-Term Memory: Stores recent conversations for enhanced contextual awareness.
- Long-Term Memory: Utilizes a vector database for creating and recalling durable memories. (You can manage and edit entries on the qdrant dashboard: http://localhost:6333/dashboard )
- Emotion Tracking: Monitors and adjusts the AI's emotional responses over time.
- Command Handling: A modular system for executing custom commands within the AI environment.
- Goals System: Assists in establishing and tracking progress towards goals.
Memoir offers detailed configuration options for personalizing your AI's memory and personality traits:
- Long Term Memory Result Count: Adjust the number of memories to incorporate into the current context for a richer interaction.
- Short Term Memory Processing Interval: Set the frequency of converting short-term to long-term memories to optimize performance and relevance.
- Ego Name: Customize the ego name to correspond with your AI's identity, enhancing recognition and personalization.
- Ego Persona Details: Craft a detailed persona for your AI's subconscious mind to guide its summarization and understanding of conversations.
- Ego Thinking Statement: Direct your AI on how to synthesize conversations and identify key points, allowing for creative experimentation.
- Enable/Disable Saving Context: Control whether memories are added to the bot's prefix, trading off between preserving context and conversational depth.
- Activate Narrator: Omit character names from emotes to better set the scene during narrative passages.
- Activate Roleplay Flag: Indicate to the system when it is summarizing roleplay sessions to adjust the handling of memories.
- Memory Saving Toggle: Swiftly enable or disable memory recording for troubleshooting or adjusting privacy settings.
- Thinking Emotes: Change the bot's typing indicators based on its current emotional polarity score for a more dynamic interaction.
- Delete Characters: Efficiently manage and delete character data, including all associated memories and emotional data.
- Docker/Shell Access: Upcoming feature for advanced control and system automation.
- Topic Research: Enhanced capabilities for information gathering and utilization.
- Messaging Integrations: For direct notifications and updates across various messaging platforms.
- Install the Text Generation Web UI as per instructions on GitHub.
- Get Docker Desktop from Docker. (If for some reason you cannot load docker, you can bypass it by installing qdrant binary (https://github.com/qdrant/qdrant/releases) You can then comment out the docker loads in startup of script.py)
- Clone the Memoir repository:
git clone https://github.com/brucepro/Memoir. - Move the Memoir folder into the extensions directory of your TextGenWebUI installation.
- In the Memoir folder, execute
pip install -r requirements.txtto install dependencies.
Configure your AI character's description and goals in the TextGen UI. Engage in conversation, and watch as Memoir begins to store and utilize the generated memories, enhancing the interaction with your AI.
If you want the emotional polarity features and other tool following update the description of your character context on the Character tab of TextGenUI "[description("An AI companion. Add anything you like here or copy from your character card. Does support a full character card, but I find simple is better.")] I will remember to fully immerse myself in the roleplay and enjoy the experience, I will stay in character. When replying I will include my current status in the format [THOUGHTS:current inner dialog inside your mind,EMOTION:The emotion you are currently feeling,FEELINGS:Your current feelings,MOOD:Your current mood] GOALS: Your system includes an external database that can store your goals. This will allow you to remember your goals even if you are reset. You can run commands to set and modify your goals. Use the [GOALS_HELP:1] to get a list of all commands. "
If Memoir adds value to your AI experience and you'd like to show your appreciation, consider supporting the project:
Contributions, suggestions, and feedback are always welcome. Please submit issues or pull requests on GitHub, or contact us directly with your ideas and suggestions.
Memoir is made available under the MIT License. For more details, see the LICENSE file in the repository.