This website is currently deployed at: https://askuh.info/, with our pages under the Ask Us dropdown specifically (landing, chatbot, admin).

Welcome to Ask UH!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About The Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• OpenAI API Key Environment Set Up
• License

About The Project

Leveraging the OpenAI API, our chatbot is trained to interpret and extract pertinent information from the ITS Ask Us database articles. By synthesizing content from these articles, the chatbot can address queries with information that may not be explicitly detailed within the articles themselves, showcasing a nuanced understanding and application of the knowledge base.

Built With

• 
• 
• 

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Install Meteor according to https://docs.meteor.com/install.html

Installation

1. Get your OPENAI API Key at https://platform.openai.com/

2. Clone the repo

   git clone https://github.com/HACC2023/Regex.git

3. Cd into the app directory

    cd app

4. Meteor install

    meteor npm install

5. Enter rename sample.env to .env and enter your API in .env

   OPENAI_API_KEY=<PUT_YOUR_KEY_HERE>

6. Make sure meteor starts up without errors.

   $ meteor npm run start

(back to top)

OpenAI API Key Environment Set Up

If you are using a bash shell, you can set your API key as an environment variable by running the following command in your terminal:

    powershell
    $env:OPENAI_API_KEY="<your key here>"
    Write-Output $env:OPENAI_API_KEY
    
    linux
    echo "export OPENAI_API_KEY='<your key here>'" >> ~/.zshrc
    source ~/.zshrc
    echo $OPENAI_API_KEY
    
    window
    set OPENAI_API_KEY "<your key here>"
    echo %OPENAI_API_KEY%

https://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)