Skip to content

Setting Up Required Services

OpenAI

The OpenAI API will be used both for the chat (using ChatGPT) and Speech-to-Text (using Whisper).

  1. Create an account on OpenAI's website
  2. Set up a Paid Account
  3. Create an API token
  4. Save your token as an environment variable named OPENAI_API_KEY:
    export OPENAI_API_KEY="YOUR_KEY"
    

Using a keys file

If you're unable to save your OpenAI API key as a permanent environment variable, you can add it to a keys file. See Keys file on Installing Dependencies.

Google Cloud

Google Text-to-Speech is used to narrate your tutor, and Google Translate is used to translate your tutor's messages to your own language.

1. Setting up a Google Cloud Project

  1. Go to the Google Cloud Console
  2. Click on the project drop-down and then click on the "New Project" button
  3. In the "New Project" dialog, enter a name for your project
  4. Click on the "Create" button to create the project

Google Cloud project ID

The SDK installation process (see below) will require your project ID, and not the name you gave it. You can find your project ID on your Google Cloud Dashboard. Choose your project from the dropdown at the top of the screen, and you'll see your project ID under Project Info.

2. Setting up Google Cloud SDK

  1. Download the Google Cloud SDK client. Follow the installation instructions for your operating system.
  2. Create your credential file by running:
    gcloud auth application-default login
    

3. Enable APIs

Check your Google Cloud project

When accessing the links below, make sure the project you created is the one appearing on the dropdown box at the top

  1. Enable Google Translate API for your project
  2. Enable Google Text-to-Speech API for your project