Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mayooear/notion-chat-langchain
A notion chatbot for your knowledge base built with langchain, typescript/javascript and pinecone.
https://github.com/mayooear/notion-chat-langchain
langchain langchain-typescript notion notion-database openai pinecone
Last synced: about 6 hours ago
JSON representation
A notion chatbot for your knowledge base built with langchain, typescript/javascript and pinecone.
- Host: GitHub
- URL: https://github.com/mayooear/notion-chat-langchain
- Owner: mayooear
- Created: 2023-03-07T12:54:26.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-18T21:21:19.000Z (over 1 year ago)
- Last Synced: 2024-12-24T01:09:42.855Z (7 days ago)
- Topics: langchain, langchain-typescript, notion, notion-database, openai, pinecone
- Language: TypeScript
- Homepage: https://www.youtube.com/watch?v=prbloUGlvLE
- Size: 2.54 MB
- Stars: 310
- Watchers: 6
- Forks: 81
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A ChatBot for Your Notion Knowledge Base
Create a simple chatbot for question-answering your Notion knowledge base/docs using Openai, Typescript, LangChain and Pinecone.
[Tutorial video](https://www.youtube.com/watch?v=prbloUGlvLE)
## 📊 Example Data
This repo uses a Notion template of the support docs from [cron](https://cronhq.notion.site/Cron-Calendar-5625be54feac4e13a75b10271b65ddb7) - a next-generation calendar for professionals and teams
## Development
1. Clone the repo
2. Install packages
```
pnpm install
```
3. Set up your `.env` file
- Copy `.env.example` into `.env`
Your `.env` file should look like this:
```
OPENAI_API_KEY=
PINECONE_API_KEY=
PINECONE_ENVIRONMENT=
```
- Visit [openai](https://help.openai.com/en/articles/4936850-where-do-i-find-my-secret-api-key) and [pinecone](https://www.pinecone.io/) to retrieve API keys and insert into your `.env` file.
4. In the `config` folder, go into `pinecone-index.ts` and replace `PINECONE_INDEX_NAME` with the index name in your pinecone dashboard.
## 🧑 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`.
Follow these Notion instructions: [Exporting your content](https://www.notion.so/help/export-your-content)
When exporting, make sure to select the `Markdown & CSV` format option.
Select `Everything`, `include subpages` and `Create folders for subpages.` Then click `Export`
This will produce a `.zip` file in your Downloads folder. Move the `.zip` file into the root of this repository.
Either unzip the folder using 7-Zip (or WinZip) or run the following Unix/Linux command to unzip the zip file (replace the `Export...` with your own file name).
```shell
unzip Export-d3adfe0f-3131-4bf3-8987-a52017fc1bae.zip -d Notion_DB
```
You should see a `Notion_DB` folder in your root folder that contains markdown files and folders of your knowledge base.
## Ingest data
Now we need to `ingest` your docs. In **very** simple terms, ingesting is the process of converting your docs into numbers (embedding) that can be easily stored and analyzed for similarity searches.
```bash
npm run ingest
```
## Running the app
Run your local dev environment `npm run dev`.
Use the search bar to ask a question about your docs.
Simple.
## Deployment
You can deploy this app to the cloud with [Vercel](https://vercel.com) ([Documentation](https://nextjs.org/docs/deployment)).
## Credit
This repo is inspired by [notion-qa](https://github.com/hwchase17/notion-qa)