https://github.com/bayesianinstitute/assistant_openai

Bayes Assistant AI
https://github.com/bayesianinstitute/assistant_openai

Last synced: about 2 months ago
JSON representation

Bayes Assistant AI

• Host: GitHub
• URL: https://github.com/bayesianinstitute/assistant_openai
• Owner: bayesianinstitute
• Created: 2024-01-09T19:12:16.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-22T13:25:01.000Z (12 months ago)
• Last Synced: 2024-01-22T17:13:24.229Z (12 months ago)
• Language: Jupyter Notebook
• Homepage:
• Size: 3.24 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Assistant OpenAI

This Python script utilizes the OpenAI API to create an assistant, ingest data, and provide assistance in a conversation. The script is designed to interact with OpenAI's GPT models to respond to user queries based on a knowledge base.

## Demo 

### Video

https://github.com/bayesianinstitute/Assistant_OpenAI/assets/44380072/1672435f-3f5a-47d7-86ae-08faca9454a9

### UI

![UI](static/UI.png)![Example1](static/example_2.png)![Example 2](static/example_3.png)

## Prerequisites

Before running the script, make sure you have the following:

- Python installed (version 3.11.4)

- OpenAI API key

- A .env file with the OpenAI API key (refer to the provided sample.env)

## Getting Started

Follow these steps to set up the environment and run the OpenAI Assistant Python script:

### 1. Clone the Repository

```bash

git clone https://github.com/bayesianinstitute/Assistant_OpenAI.git

```

### 2. Navigate to the Project Directory

```bash

cd Assistant_OpenAI

```

### 3. Create and Activate a Virtual Environment

```bash

python -m venv venv

```

On Windows:

```bash

.\venv\Scripts\activate

```

On macOS/Linux:

```bash

source venv/bin/activate

```

### 4. Install Dependencies

```bash

pip install -r requirements.txt

```

### 5. Set Up Environment Variables

Create a .env file in the project directory:

Open the .env file and add your OpenAI API key and assistat_id:

```plaintext

OPENAI_API_KEY="sk-H..."

Assist_id="asst_...."

```

Save and close the .env file.

### 6. Run the Application

```bash

cd app

```

```bash

streamlit run app.py

```

### 7. Enter Your Question

Follow the prompts and enter your question when prompted.

## Contributing

Contributions are welcome! If you have any improvements or suggestions, feel free to open an issue or submit a pull request.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

## Acknowledgments

- [OpenAI](https://openai.com/) for providing the powerful GPT models.

Feel free to customize the README according to your project's specific details and requirements.