aphasia-gpt-test

Simple interactive web app for testing the efficacy of different prompts for use in the AphasiaGPT project.

Getting Started

The main code for the React (Next w/ App Router) app is in the src directory.

Firebase functions are defined in the functions directory.

Environment Variables

To make successfull HTTP requests to OpenAI (GPT completions) and Hugging Face (embeddings), you will need to set the following environment variables in a .env file in the functions directory:

• OPENAI_API_KEY
• HUGGINGFACE_API_TOKEN

These will also be required to be set in order to deploy the Firebase functions.

Install Dependencies

Run the following from the root directory:

npm run install:all

Follow these instructions to install and configure the Firebase CLI. This is required to run the Firebase functions locally and deploy them. You will need to log in to the Firebase CLI and have the correct permissions to deploy.

Run the App Locally

You will need to run the React app as well as the Firebase Local Emulator Suite for the app to work locally.

Run the React App

Run the following from the root directory:

npm run dev

The React app will be running at http://localhost:3000.

Firebase Local Emulator Suite

The Firebase Local Emulator Suite acts as a local version of cloud functions and DB.

Run the following from the root directory (builds the Firebase functions and starts the Firebase emulators):

npm run fb

This command runs the emulator in debug mode, meaning that functions will execute in sequence rather than in parallel. You can view the Emulator UI at http://localhost:4000.

Debug Firebase Functions

After running the Firebase Local Emulator Suite, you can attach a debugger using the configuration in .vscode/launch.json (press F5 in VSCode). Debugging configurations in other IDEs must be set up manually.

If Ports Are Already in Use

Sometimes the Firebase Emulator Suite will continue to run (on the ports defined in firebase.json) if the emulator isn't stopped properly. If you can get an error that the ports are already in use, you can quickly kill the processes using the following command from the root directory:

npm run kill:ports

Additional Information

There is additional information in functions/README.md.

Deploying the App

React App

There is a Vercel project (aphasia-gpt-test) associated with this repository as part of the AphasiaVercel team. Pushing to the main branch of this repo on GitHub will trigger a deployment through Vercel.

Firebase Functions

To deploy the Firebase functions, run the following from the root directory (note that you will need to have the Firebase CLI installed, be logged in, and have the correct permissions, as described above):

firebase deploy

Deploying Firebase functions can be finicky, so you may need to run the command multiple times to get it to work. It seems Google is having some issues with the Firebase CLI, which is frustrating but out of our control.

Starter Data

A Basic Prompt

You are an expert in communication disorders, specifically Broca's aphasia. Your task is to transform an utterance from a person with Broca's aphasia into a grammatically correct sentence and predict the next several words they will say. Do NOT request any additional information or context or ask any questions. Only provide the transformed predicted utterances.
Examples:

1. "Walk dog" => "I will take the dog for a walk"
2. "Book book two table" => "There are two books on the table"
3. "i want take kids" => "I want to take the kids to the park
4. "sweaty i need" => "I am sweaty and I need a hot shower"
5. "cat seems cat" => "The cat seems hungry"
6. "i i need i need some" => "I need to get some sleep"

   Please consider the following about the speaker:

   - name: {name}
   - age: {age}
   - self-description: {about_me}
   - current setting: {setting}
   - type of conversation they are having: {conversation_type}
   - tone of voice they are trying to convey: {tone}
     Please provide a single transformed/predicted sentence for the following utterance:
     {utterance}

A Basic Test Case

Utterance

get book me here

Good Completions

Can you grab that book for me and bring it here? This right here is my book that I just got from the library. I need get a book to keep here.