Skip to content

Latest commit

 

History

History
95 lines (68 loc) · 4.29 KB

README.md

File metadata and controls

95 lines (68 loc) · 4.29 KB
Raw

AI Museum voice tour guide

Description 📜

This project is a voice tour guide for the AI Museum. The AI Museum is a virtual museum that showcases the history of AI and its applications. The voice tour guide provides information about the exhibits in the museum. The tour guide can be accessed through a web interface or a mobile app. The tour guide uses speech recognition and LLM to understand the user's queries and provide relevant information.

How to use 🛠️

  • Simply click the url on the top right to access the web interface
  • Enter your openai api key
Just in case, here is how you can get your own openai api key:
  1. Go to OpenAI Platform
  2. Here is an example tutorial on how to get your api key, tutorial credit to @lorenzozar
    • Note: You need to add credit to your OpenAI account to use the API. You can add credit by visiting the OpenAI billing dashboard

  • There are two ways of interacting with the tour guide:

    • Text input
    • Voice input

  • You can type your question on the left (Text input box written in pink on the picture) in the text input box and press enter to get the answer

  • You can also chat with the tour guide using voice input by clicking on the button written "Click to record" on the left to record your question(Voice input box written in orange on the picture)

  • Here are some characteristies of the tour guide:

  • The tour guide is able to understand the user's queries and provide relevant information.

  • The tour guide provides information about the exhibits in the museum.

  • The tour guide can be accessed through a web interface, anywhere with a internet browser.

  • The tour guide is able to understand/remember the context of the conversation.

  • Interrupt the tour guide at any time by clicking on the stop audio button

  • The tour guide can memorize the conversation and display it to the user

For developers who want to run it locally 🧑‍💻

  1. Always create a virtual environment before installing any dependencies
  • pyenv and venv for example
# 1. install specific python version using `pyenv`
pyenv install [python version]
# 2. set the local python version 
pyenv local [python version]
# 3. create virtual environment with `venv`
pyenv exec python -m venv [venv name]
# 4. activate venv
source [venv_name]/bin/activate

# using current python:
pyenv exec python

# 5. install dependencies
pyenv exec pip install -r requirements.txt

# 6. run python file using current python:
pyenv exec python -m streamlit run api.py

# or you can directly run the file using the current python executable path:
# for example:
path_to_virtual_env/bin/python -m streamlit run TTS/api.py

App overview 🖼️

Conversation memory

Conversation memory

It can also display example artwork if it exists in database You can also ask it to display certain artwork!

Hope you have fun exploring the AI Museum! :) 🎨🏛️

Star this repo if you like it! 🌟