Update README and requirements for samples (daxa-ai#411)

* Update README and requirements for samples * Add LangChain SharePoint & GoogleDrive details to README --------- Co-authored-by: Sridhar Ramaswamy <[email protected]>
Raj725 · Jul 17, 2024 · 53e2848 · 53e2848
1 parent 1e71101
commit 53e2848
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 13 deletions.
diff --git a/pebblo_saferetriever/langchain/identity-rag/googledrive-qdrant/README.md b/pebblo_saferetriever/langchain/identity-rag/googledrive-qdrant/README.md
@@ -1,5 +1,9 @@
 ## Identity Enforcement using Pebblo
 
+This solution uses:
+
+- LangChain GoogleDrive loader. See https://python.langchain.com/v0.2/docs/integrations/document_loaders/google_drive for details on specific steps required to be completed in Google Cloud
+
 ### Instructions
 
 1. Create Python virtual-env

diff --git a/pebblo_saferetriever/langchain/pebblo-saferag/googledrive-qdrant/README.md b/pebblo_saferetriever/langchain/pebblo-saferag/googledrive-qdrant/README.md
@@ -1,11 +1,8 @@
 ## Semantic Enforcement using Pebblo
 
-This solution uses the following two proposed PRs:
+This solution uses:
 
-1. Add semantic info to metadata, classified by pebblo-server
-   https://github.com/daxa-ai/langchain/pull/16
-2. langchain: Add PebbloRetrievalQA chain with Identity & Semantic Enforcement support
-   https://github.com/langchain-ai/langchain/pull/20641
+- LangChain GoogleDrive loader. See https://python.langchain.com/v0.2/docs/integrations/document_loaders/google_drive for details on specific steps required to be completed in Google Cloud
 
 ### Instructions
 

diff --git a/pebblo_saferetriever/langchain/pebblo-saferag/sharepoint-postgres/README.md b/pebblo_saferetriever/langchain/pebblo-saferag/sharepoint-postgres/README.md
@@ -4,6 +4,7 @@ This solution uses:
 
 - PostgreSQL 15.7
 - langchain-community from daxa-ai/langchain branch(https://github.com/daxa-ai/langchain/tree/daxa_3.1)
+- LangChain Microsoft Sharepoint loader. See https://python.langchain.com/v0.2/docs/integrations/document_loaders/microsoft_sharepoint for details on specific steps required to be completed in Microsoft Office 365 and Azure Portal.
 
 ### Instructions
 
@@ -42,15 +43,17 @@ O365_CLIENT_ID=<YOUR APPLICATION (CLIENT) ID>
 O365_CLIENT_SECRET=<YOUR CLIENT SECRET>
 O365_TENANT_ID=<YOUR TENANT ID>
 
-# Pebblo configuration
-PEBBLO_CLOUD_URL=<PEBBLO CLOUD URL>
-PEBBLO_API_KEY=<YOUR PEBBLO API KEY>
-PEBBLO_CLASSIFIER_URL="http://localhost:8000/"
-
 # Postgres configuration
 PG_CONNECTION_STRING = "postgresql://<USERNAME>:<PASSWORD>@<HOST>:<PORT>/<DATABASE-NAME>"
 ```
 
+# Pebblo Cloud configuration (optional)
+PEBBLO_CLOUD_URL=<PEBBLO CLOUD URL>
+PEBBLO_API_KEY=<YOUR PEBBLO API KEY>
+
+# Pebblo Server configuration
+PEBBLO_CLASSIFIER_URL="http://localhost:8000/"
+
 > Note: You need to set `PEBBLO_CLASSIFIER_URL` only if your `Pebblo Server` is running somewhere other than the default URL
 > of `http://localhost:8000`.
 

diff --git a/pebblo_saferetriever/langchain/pebblo-saferag/sharepoint-postgres/requirements.txt b/pebblo_saferetriever/langchain/pebblo-saferag/sharepoint-postgres/requirements.txt
@@ -1,5 +1,5 @@
 python-dotenv==1.0.0
-unstructured # For Docx loading
+unstructured[all-docs] # For Docx, PDF loading
 pymupdf # For PDF loading
 tiktoken # OpenAI tokenizer
 

diff --git a/pebblo_saferetriever/langchain/pebblo-saferag/sharepoint-qdrant/README.md b/pebblo_saferetriever/langchain/pebblo-saferag/sharepoint-qdrant/README.md
@@ -4,6 +4,7 @@ This solution uses:
 
 - PostgreSQL 15.7
 - langchain-community 0.2.6
+- LangChain Microsoft Sharepoint loader. See https://python.langchain.com/v0.2/docs/integrations/document_loaders/microsoft_sharepoint for details on specific steps required to be completed in Microsoft Office 365 and Azure Portal.
 
 ### Instructions
 
@@ -32,9 +33,11 @@ O365_CLIENT_ID=<YOUR APPLICATION (CLIENT) ID>
 O365_CLIENT_SECRET=<YOUR CLIENT SECRET>
 O365_TENANT_ID=<YOUR TENANT ID>
 
-# Pebblo configuration
+# Pebblo Cloud configuration (optional)
 PEBBLO_CLOUD_URL=<PEBBLO CLOUD URL>
 PEBBLO_API_KEY=<YOUR PEBBLO API KEY>
+
+# Pebblo Server configuration
 PEBBLO_CLASSIFIER_URL="http://localhost:8000/"
 ```
 

diff --git a/pebblo_saferetriever/langchain/pebblo-saferag/sharepoint-qdrant/requirements.txt b/pebblo_saferetriever/langchain/pebblo-saferag/sharepoint-qdrant/requirements.txt
@@ -1,5 +1,5 @@
 python-dotenv==1.0.0
-unstructured # For Docx loading
+unstructured[all-docs] # For Docx, PDF loading
 pymupdf # For PDF loading
 tiktoken # OpenAI tokenizer
 

diff --git a/pebblo_saferetriever/langchain/semantic-rag/googledrive-qdrant/README.md b/pebblo_saferetriever/langchain/semantic-rag/googledrive-qdrant/README.md
@@ -1,5 +1,9 @@
 ## Semantic Enforcement using Pebblo
 
+This solution uses:
+
+- LangChain GoogleDrive loader. See https://python.langchain.com/v0.2/docs/integrations/document_loaders/google_drive for details on specific steps required to be completed in Google Cloud
+
 ### Instructions
 
 1. Create Python virtual-env