💿 Developers - Installation via Python

• Step 1. Clone the repo

  git clone https://github.com/ayushkmr/MathTutor.git && cd MathTutor

• Step 2. Install requirements

  Install portaudio and ffmpeg for audio

  # for mac
  brew install portaudio
  brew install ffmpeg

  # for ubuntu
  sudo apt update
  sudo apt install portaudio19-dev
  sudo apt install ffmpeg

  Note:

  • ffmpeg>=4.4 is needed to work with torchaudio>=2.1.0

  • Mac users may need to add ffmpeg library path to DYLD_LIBRARY_PATH for torchaudio to work:

    export DYLD_LIBRARY_PATH=/opt/homebrew/lib:$DYLD_LIBRARY_PATH

  Then install all python requirements

  pip install -r requirements.txt

  If you need a faster local speech to text, install whisperX

  pip install git+https://github.com/m-bain/whisperx.git

• Step 3. Create an empty sqlite database if you have not done so before

  sqlite3 test.db "VACUUM;"

• Step 4. Run db upgrade

  alembic upgrade head

  This ensures your database schema is up to date. Please run this after every time you pull the main branch.

• Step 5. Setup .env:

  cp .env.example .env

  Update API keys and configs following the instructions in the .env file.

  Note that some features require a working login system. You can get your own OAuth2 login for free with Firebase if needed. To enable, set USE_AUTH to true and fill in the FIREBASE_CONFIG_PATH field. Also fill in Firebase configs in client/next-web/.env.

• Step 6. Run backend server with cli.py or use uvicorn directly

  python cli.py run-uvicorn
  # or
  uvicorn realtime_ai_character.main:app

• Step 7. Run frontend client:

  • web client:

    Create an .env file under client/next-web/

    cp client/next-web/.env.example client/next-web/.env

    Adjust .env according to the instruction in client/next-web/README.md.

    Start the frontend server:

    python cli.py next-web-dev
    # or
    cd client/next-web && npm run dev
    # or
    cd client/next-web && npm run build && npm run start

    After running these commands, a local development server will start, and your default web browser will open a new tab/window pointing to this server (usually http://localhost:3000).

  • (Optional) Terminal client:

    Run the following command in your terminal

    python client/cli.py

  • (Optional) mobile client:

    open client/mobile/ios/rac/rac.xcodeproj/project.pbxproj in Xcode and run the app

• Step 8. Select one character to talk to, then start talking. Use GPT4 for better conversation and Wear headphone for best audio(avoid echo)

Note if you want to remotely connect to a RealChar server, SSL set up is required to establish the audio connection.

👨‍🚀 API Keys and Configurations

1. LLMs

1.1 ReByte API Key

To get your ReByte API key, follow these steps:

1. Go to the ReByte website and sign up for an account if you haven't already.
2. Once you're logged in, go to Settings > API Keys.
3. Generate a new API key by clicking on the "Generate" button.

1.2 (Optional) OpenAI API Token

👇click me

This application utilizes the OpenAI API to access its powerful language model capabilities. In order to use the OpenAI API, you will need to obtain an API token.

To get your OpenAI API token, follow these steps:

1. Go to the OpenAI website and sign up for an account if you haven't already.
2. Once you're logged in, navigate to the API keys page.
3. Generate a new API key by clicking on the "Create API Key" button.

(Optional) To use Azure OpenAI API instead, refer to the following section:

1. Set API type in your .env file: OPENAI_API_TYPE=azure

If you want to use the earlier version 2023-03-15-preview:

OPENAI_API_VERSION=2023-03-15-preview

2. To set the base URL for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource.

OPENAI_API_BASE=https://your-base-url.openai.azure.com

3. To set the OpenAI model deployment name for your Azure OpenAI resource.

OPENAI_API_MODEL_DEPLOYMENT_NAME=gpt-35-turbo-16k

4. To set the OpenAIEmbeddings model deployment name for your Azure OpenAI resource.

OPENAI_API_EMBEDDING_DEPLOYMENT_NAME=text-embedding-ada-002

1.3 (Optional) Anthropic(Claude 2) API Token

👇click me

To get your Anthropic API token, follow these steps:

1. Go to the Anthropic website and sign up for an account if you haven't already.
2. Once you're logged in, navigate to the API keys page.
3. Generate a new API key by clicking on the "Create Key" button.

1.4 (Optional) Anyscale API Token

👇click me

To get your Anyscale API token, follow these steps:

1. Go to the Anyscale website and sign up for an account if you haven't already.
2. Once you're logged in, navigate to the Credentials page.
3. Generate a new API key by clicking on the "Generate credential" button.

2. Speech to Text

We support faster-whisper and whisperX as the local speech to text engines. Work with CPU and NVIDIA GPU.

2.1 (Optional) Google Speech-to-Text API

👇click me

To get your Google Cloud API credentials.json, follow these steps:

1. Go to the GCP website and sign up for an account if you haven't already.
2. Follow the guide to create a project and enable Speech to Text API
3. Put google_credentials.json in the root folder of this project. Check Create and delete service account keys
4. Change SPEECH_TO_TEXT_USE to use GOOGLE in your .env file

2.2 (Optional) OpenAI Whisper API

👇click me

Same as OpenAI API Token

3. Text to Speech

Edge TTS is the default and is free to use.

3.1 (Optional) ElevenLabs API Key

👇click me

1. Creating an ElevenLabs Account

   Visit ElevenLabs to create an account. You'll need this to access the text to speech and voice cloning features.

2. In your Profile Setting, you can get an API Key.

3.2 (Optional) Google Text-to-Speech API

👇click me

To get your Google Cloud API credentials.json, follow these steps:

1. Go to the GCP website and sign up for an account if you haven't already.
2. Follow the guide to create a project and enable Text to Speech API
3. Put google_credentials.json in the root folder of this project. Check Create and delete service account keys

(Optional) 🔥 Create Your Own Characters

👇click me

Create Characters Locally

see realtime_ai_character/character_catalog/README.md