https://github.com/carolinedlu/llamaindex-chat-with-streamlit-docs

Build a chatbot powered by LlamaIndex that augments GPT 3.5 with the contents of the Streamlit docs (or your own data).
https://github.com/carolinedlu/llamaindex-chat-with-streamlit-docs

Last synced: 7 days ago
JSON representation

Build a chatbot powered by LlamaIndex that augments GPT 3.5 with the contents of the Streamlit docs (or your own data).

• Host: GitHub
• URL: https://github.com/carolinedlu/llamaindex-chat-with-streamlit-docs
• Owner: carolinefrasca
• Created: 2023-08-20T21:28:43.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-28T01:30:17.000Z (3 months ago)
• Last Synced: 2024-09-26T20:04:43.371Z (about 1 month ago)
• Language: Python
• Homepage:
• Size: 859 KB
• Stars: 190
• Watchers: 4
• Forks: 274
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome - carolinedlu/llamaindex-chat-with-streamlit-docs - Build a chatbot powered by LlamaIndex that augments GPT 3.5 with the contents of the Streamlit docs (or your own data). (Python)
• awesome-rag - llamaindex-chat-with-streamlit-docs

README

        
# 🦙📚 LlamaIndex - Chat with the Streamlit docs

Build a chatbot powered by LlamaIndex that augments GPT 3.5 with the contents of the Streamlit docs (or your own data).

## Overview of the App



- Takes user queries via Streamlit's `st.chat_input` and displays both user queries and model responses with `st.chat_message`

- Uses LlamaIndex to load and index data and create a chat engine that will retrieve context from that data to respond to each user query

## Demo App

[![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://llamaindex-chat-with-docs.streamlit.app/)

## Get an OpenAI API key

You can get your own OpenAI API key by following the following instructions:

1. Go to https://platform.openai.com/account/api-keys.

2. Click on the `+ Create new secret key` button.

3. Next, enter an identifier name (optional) and click on the `Create secret key` button.

4. Add your API key to your `secrets.toml` file. If you don't already have a `secrets.toml` file, add a folder named `.streamlit`, create a file called `secrets.toml` within the folder, and add the following to it:

``` openai_key =  ```

   

Alternatively, you can use [Streamlit Community Cloud's secrets management feature](https://docs.streamlit.io/deploy/streamlit-community-cloud/deploy-your-app/secrets-management) to add your API key via the web interface.

> [!CAUTION]

> Don't commit your secrets file to your GitHub repository. The `.gitignore` file in this repo includes `.streamlit/secrets.toml` and `secrets.toml`. 

## Try out the app

Once the app is loaded, enter your question about the Streamlit library and wait for a response.