Amy

Amy is a chatbot with memory. Amy is designed to have conversations with a user, asking open-ended questions and saving the answers to generate the user's life story. This could be used for recording family history, creating a memoir, or just for enterainment.

Amy leverages Open AI's GPT-4 Large Language Model and the Pinecone vector database to classify and summarize your conversations to generate a smooth flowing life story.

Running Amy

Prerequisites

• Python 3.8
• Anaconda
• VSCode

Install

Amy is written in Python using the Django framework. Create a Python 3.8 environment and install requirements:

git checkout https://github.com/jonfleming/Amy
cd Amy
conda create --name=django python=3.8
conda activate django
pip install -r requirements.txt

Configuration

There are a few settings that are needed to run. These settings should be placed in a .env file in the root Amy folder. Copy the example.env to get started.

cp example.env .env

Edit .env to set your values:

Amy/.env

# Secret Key for your Django installation
SECRET_KEY=q5pEroX6onq8YzQrspJJp4JRBEtEEXGx

# URL to access the app
ALLOWED_HOSTS=["localhost", "www.example.com"]
ORIGINS=["http://localhost:8000", "https://www.example.com"]

# Django debug setting
DEBUG=True

# OpenAI API Key
OPENAI_API_KEY=xyzzyexampleapikeyxyzzy

# Pinecone API Key
PINCONE_API_KEY=pineconeapikeyexample

# Your SMTP Server Settings
EMAIL_HOST=mail.jonfleming.info
EMAIL_HOST_USER=support@fleming.ai
EMAIL_PASSWORD=emailpassword

Amy uses Pinecone to store and search text embeddings. It expects an index named history to exist. To create the index, run create_pinecone_index.py from your Python environment (this will take several minutes):

Run

In VSCode:

1. Open the Amy Folder.
2. Install the Microsoft Python extension.
3. Open the Command Palette (Ctrl+Shift+P) and type Python: Select Interpreter and choose your django environment.
4. Click the Run icon in the Activity Bar and select Python Django from the RUN AND DEBUG dropdown.
5. Press F5 to run.

Or bash:

conda activate django
python manage.py runserver

Then navigate to http://localhost:8000 in your browser

To Debug unit tests

1. Install Pytest
2. Edit launch.json and set the program to the path for pytest
3. Click the Run icon in the Activity Bar and select Debug Unit Tests from the RUN AND DEBUG dropdown.
4. Press F5 to run.

Create an Admin user

To manage your Django application and database records you need to create an admin user. For details see Creating an admin user.

Setting up an SMTP server to send Password-Reset emails

Edit your .env file to specify your mail server, username, and password

twisted-iocpsupport

If you get the following error on Linux, remove the requirement from requirements.txt:

twisted_iocpsupport/iocpsupport.c:771:10: fatal error: io.h: No such file or directory

Redis

The latest version of Amy uses Celery Task Queue and Redis to handle Websocket communication.

Abandonded.