https://github.com/mongodb-developer/meeting-mate
MVP to showcase how MongoDB can be used to implement an end-to-end user-facing app
https://github.com/mongodb-developer/meeting-mate
Last synced: 3 months ago
JSON representation
MVP to showcase how MongoDB can be used to implement an end-to-end user-facing app
- Host: GitHub
- URL: https://github.com/mongodb-developer/meeting-mate
- Owner: mongodb-developer
- License: mit
- Created: 2024-07-11T06:45:12.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-07-25T15:18:55.000Z (11 months ago)
- Last Synced: 2025-03-22T13:51:27.632Z (3 months ago)
- Language: Python
- Size: 146 KB
- Stars: 4
- Watchers: 0
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
> [!IMPORTANT]
> This is ***not*** meant to be a starter project, an accelerator, a library or anything similar.
> This little application aims to provide a complete end-to-end example of how one might implement
> fact extraction while also considering several operational aspects of such an app,
> such as storing processing metadata, tracking usage, archiving Chatbot responses and so on.
>
> It doesn't aim at a perfect implementation of a Google Crawler or the correct way to wrap around Langchain.
---
As such, please bear in mind:
* ***This project has no support***
* ***No new features are in the works***
* ***Most bugs will go unfixed***
* ***Help requests on github will be ignored***
# Project set-up / pre-reqs
We've outlined some prep steps [in this gist](https://gist.github.com/mybyte/28af72af02e97febeec8c60b0a5e651f), such as necessary downloads.
## Used APIs and services
We're going to focus on User Sign on via Google Oauth and access the user's drive/docs in the Google Suite. For those who would like to follow along - you'll have to sign up on Google Cloud and configure Oauth consent screen & API access in the [Google API dashboard](https://console.cloud.google.com/apis/dashboard).
We're going to run a minimalistic, subjective/empirical model shootout using various model providers. For this portion, we are going to use [OpenAI](https://platform.openai.com/), [Anthropic](https://console.anthropic.com/), [Cohere](https://dashboard.cohere.com/), [Mistral](https://console.mistral.ai/) and finally [Fireworks.AI](https://fireworks.ai/)
The latter will be used for the majority of this workshop and serve as the primary endpoint for generating embeddings, doing chatcompletions or calling functions. If you wish to code along, [Fireworks](https://fireworks.ai/) is advisable. Given the nature of Langchain you could use other endpoints available to you, but experience and results might deviate from what we're showing.
## .env file
For our project to work correctly, the root folder should contain a `.env` file with a number of variables.
```
cp .env_example .env
```
```
# MongoDB related
mongo_uri=
mongo_db=
mongo_crypt_shared_path=
# Google auth related -
google_client_id=
google_client_secret=
# api keys
fireworks_api_key=
openai_api_key=
anthropic_api_key=
cohere_api_key=
mistral_api_key=
PYTHONPATH=/meeting-mate
```
Make sure you have PYTHONPATH in your `.env` file, otherwise python modules might not work as expected.
Further, if you want the jupyter notebooks to run in any other directory than root:
* Open VSCode settings
* Search for "notebook file root"
* Set "Jupyter: Notebook File Root" to `${workspaceFolder}`
This will allow you to load .env files, keys and so on from the root folder
---
# Getting started with the project
Links to individual set-up steps and their corresponding guides:
1. [Set up Google for OAuth](./docs/google.md) - there are a few prerequisites for your app to authenticate users. We walk over the basics in this document.
2. [Bootstrapping CSFLE](./docs/csfle.md) - This is where we set up client-side field level encryption to ensure sensitive user access tokens can't be stolen from your database.
3. [Obtaining the user token](./docs/auth.md) - We make use of the Google APIs to implement an authentication flow, retrieve user information and store access tokens.
4. [Retrieving data](./docs/crawling.md) - Making use of Google SDK, we crawl owned & shared documents for every user (including update crawls) and retrieve his documents
5. [Fact extraction](./docs/conversion.md) - We pre-process documents, chunk, extract facts & entities, apply clustering, create embeddings and more.
6. [RAG](./docs/rag.md) - We configure Atlas Search and run the demo app.
During the workshop, we will be able to import Json data allowing you to follow along even if the previous steps didn't work for you, you don't have access to LLMs/inference APIs and so on.