Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hwchase17/notion-qa
https://github.com/hwchase17/notion-qa
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/hwchase17/notion-qa
- Owner: hwchase17
- License: mit
- Created: 2022-11-07T02:39:10.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-06T05:18:06.000Z (5 months ago)
- Last Synced: 2025-02-06T12:06:09.014Z (8 days ago)
- Language: Python
- Size: 48.1 MB
- Stars: 2,141
- Watchers: 22
- Forks: 371
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-langchain-zh - Notion QA - qa?style=social): Notion 问题回答机器人 (开源项目 / 其他聊天机器人)
- awesome-langchain - Notion QA - Answering Bot  (Open Source Projects / Other / Chatbots)
- awesome-ml-dev-tools - Q&A over Notion database
README
# Notion Question-Answering
🤖Ask questions to your Notion database in natural language🤖
💪 Built with [LangChain](https://github.com/hwchase17/langchain)
# 🌲 Environment Setup
In order to set your environment up to run the code here, first install all requirements:
```shell
pip install -r requirements.txt
```
Then set your OpenAI API key (if you don't have one, get one [here](https://beta.openai.com/playground))
```shell
export OPENAI_API_KEY=....
```
# 📄 What is in here?
- Example data from Blendle
- Python script to query Notion with a question
- Code to deploy on StreamLit
- Instructions for ingesting your own dataset
## 📊 Example Data
This repo uses the [Blendle Employee Handbook](https://www.notion.so/Blendle-s-Employee-Handbook-7692ffe24f07450785f093b94bbe1a09) as an example.
It was downloaded October 18th so may have changed slightly since then!
## 💬 Ask a question
In order to ask a question, run a command like:
```shell
python qa.py "is there food in the office?"
```
You can switch out `is there food in the office?` for any question of your liking!
This exposes a chat interface for interacting with a Notion database.
IMO, this is a more natural and convenient interface for getting information.
## 🚀 Code to deploy on StreamLit
The code to run the StreamLit app is in `main.py`.
Note that when setting up your StreamLit app you should make sure to add `OPENAI_API_KEY` as a secret environment variable.
## 🧑 Instructions for ingesting your own dataset
Export your dataset from Notion. You can do this by clicking on the three dots in the upper right hand corner and then clicking `Export`.
When exporting, make sure to select the `Markdown & CSV` format option.
This will produce a `.zip` file in your Downloads folder. Move the `.zip` file into this repository.
Run the following command to unzip the zip file (replace the `Export...` with your own file name as needed).
```shell
unzip Export-d3adfe0f-3131-4bf3-8987-a52017fc1bae.zip -d Notion_DB
```
Run the following command to ingest the data.
```shell
python ingest.py
```
Boom! Now you're done, and you can ask it questions like:
```shell
python qa.py "is there food in the office?"
```