update readme.md

.gitignore

@@ -40,7 +40,6 @@ apps/docs/public/registry/
 
 # env
 .env
-.env.example
 
 # cursor
 .cursor

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 [Your Name or Organization Name]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

README.md

@@ -0,0 +1,250 @@
+# AI PDF Chatbot & Agent Powered by LangChain and LangGraph
+
+This monorepo is a customizable template example of an AI agent chatbot that ingests PDF documents, stores embeddings in a vector database (Supabase), and then answers user queries using OpenAI (or another LLM provider) utilising LangChain and LangGraph as orchestration frameworks.
+
+This template is also an accompanying example to the book [Learning LangChain (O'Reilly)](https://tinyurl.com/learning-langchain): Building AI and LLM applications with LangChain and LangGraph.
+
+
+## Table of Contents
+
+1. [Features](#features)
+2. [Architecture Overview](#architecture-overview)
+3. [Prerequisites](#prerequisites)
+4. [Installation](#installation)
+5. [Environment Variables](#environment-variables)
+   - [Frontend Variables](#frontend-variables)
+   - [Backend Variables](#backend-variables)
+6. [Local Development](#local-development)
+   - [Running the Backend](#running-the-backend)
+   - [Running the Frontend](#running-the-frontend)
+7. [Usage](#usage)
+   - [Uploading/Ingesting PDFs](#uploadingingesting-pdfs)
+   - [Asking Questions](#asking-questions)
+   - [Viewing Chat History](#viewing-chat-history)
+8. [Production Build & Deployment](#production-build--deployment)
+9. [Customizing the Agent](#customizing-the-agent)
+10. [Troubleshooting](#troubleshooting)
+11. [Next Steps](#next-steps)
+
+---
+
+## Features
+
+- **Document Ingestion Graph**: Upload and parse PDFs into `Document` objects, then store vector embeddings into a vector database (we use Supabase in this example).
+- **Retrieval Graph**: Handle user questions, decide whether to retrieve documents or give a direct answer, then generate concise responses with references to the retrieved documents.
+- **Streaming Responses**: Real-time streaming of partial responses from the server to the client UI.
+- **LangGraph Integration**: Built using LangGraph’s state machine approach to orchestrate ingestion and retrieval, visualise your agentic workflow, and debug each step of the graph.  
+- **Next.js Frontend**: Allows file uploads, real-time chat, and easy extension with React components and Tailwind.
+
+---
+
+## Architecture Overview
+
+┌─────────────────────┐    1. Upload PDFs    ┌───────────────────────────┐
+│Frontend (Next.js)   │ ────────────────────> │Backend (LangGraph)       │
+│ - React UI w/ chat  │                      │ - Ingestion Graph         │
+│ - Upload .pdf files │ <────────────────────┤   + Vector embedding via  │
+└─────────────────────┘    2. Confirmation   │     SupabaseVectorStore   │
+(storing embeddings in DB)
+
+┌─────────────────────┐    3. Ask questions  ┌───────────────────────────┐
+│Frontend (Next.js)   │ ────────────────────> │Backend (LangGraph)       │
+│ - Chat + SSE stream │                      │ - Retrieval Graph         │
+│ - Display sources   │ <────────────────────┤   + Chat model (OpenAI)   │
+└─────────────────────┘ 4. Streamed answers  └───────────────────────────┘
+
+- **Supabase** is used as the vector store to store and retrieve relevant documents at query time.  
+- **OpenAI** (or other LLM providers) is used for language modeling.  
+- **LangGraph** orchestrates the "graph" steps for ingestion, routing, and generating responses.  
+- **Next.js** (React) powers the user interface for uploading PDFs and real-time chat.
+
+The system consists of:
+- **Backend**: A Node.js/TypeScript service that contains LangGraph agent "graphs" for:
+  - **Ingestion** (`src/ingestion_graph.ts`) - handles indexing/ingesting documents
+  - **Retrieval** (`src/retrieval_graph.ts`) - question-answering over the ingested documents
+  - **Configuration** (`src/shared/configuration.ts`) - handles configuration for the backend api including model providers and vector stores
+- **Frontend**: A Next.js/React app that provides a web UI for users to upload PDFs and chat with the AI.
+---
+
+## Prerequisites
+
+1. **Node.js v18+** (we recommend Node v20).
+2. **Yarn** (or npm, but this monorepo is pre-configured with Yarn).
+3. **Supabase project** (if you plan to store embeddings in Supabase; see [Setting up Supabase](https://supabase.com/docs/guides/getting-started)).
+   - You will need:
+     - `SUPABASE_URL`
+     - `SUPABASE_SERVICE_ROLE_KEY`
+     - A table named `documents` and a function named `match_documents` for vector similarity search (see [LangChain documentation for guidance on setting up the tables](https://js.langchain.com/docs/integrations/vectorstores/supabase/)).
+4. **OpenAI API Key** (or another LLM provider’s key, supported by LangChain).
+5. **LangChain API Key** (free and optional, but highly recommended for debugging and tracing your LangChain and LangGraph applications). Learn more [here](https://docs.smith.langchain.com/administration/how_to_guides/organization_management/create_account_api_key)
+
+---
+
+## Installation
+
+1. **Clone** the repository:
+
+   ```bash
+   git clone https://github.com/mayooear/ai-pdf-chatbot-langchain.git
+   cd ai-pdf-chatbot-langchain
+
+	2.	Install dependencies (from the monorepo root):
+
+yarn install
+
+	3.	Configure environment variables in both backend and frontend. See .`env.example` files for details.
+
+## Environment Variables
+
+The project relies on environment variables to configure keys and endpoints. Each sub-project (backend and frontend) has its own .env.example. Copy these to .env and fill in your details.
+
+### Frontend Variables
+
+Create a .env file in frontend:
+
+`cp frontend/.env.example frontend/.env`
+
+```
+    NEXT_PUBLIC_LANGGRAPH_API_URL=http://localhost:2024
+    LANGCHAIN_API_KEY=your-langsmith-api-key-here # Optional: LangSmith API key
+    LANGGRAPH_INGESTION_ASSISTANT_ID=ingestion_graph
+    LANGGRAPH_RETRIEVAL_ASSISTANT_ID=retrieval_graph
+
+    LANGCHAIN_TRACING_V2=true # Optional: Enable LangSmith tracing
+
+    LANGCHAIN_PROJECT="pdf-chatbot" # Optional: LangSmith project name
+```
+
+### Backend Variables
+
+Create a .env file in backend:
+
+`cp backend/.env.example backend/.env`
+
+```
+    OPENAI_API_KEY=your-openai-api-key-here
+    SUPABASE_URL=your-supabase-url-here
+    SUPABASE_SERVICE_ROLE_KEY=your-supabase-service-role-key-here
+
+    LANGCHAIN_TRACING_V2=true # Optional: Enable LangSmith tracing
+
+    LANGCHAIN_PROJECT="pdf-chatbot" # Optional: LangSmith project name
+```
+
+**Explanation of Environment Variables:**
+
+-   `NEXT_PUBLIC_LANGGRAPH_API_URL`: The URL where your LangGraph backend server is running.  Defaults to `http://localhost:2024` for local development. 
+-   `LANGCHAIN_API_KEY`: Your LangSmith API key.  This is optional, but highly recommended for debugging and tracing your LangChain and LangGraph applications.
+-   `LANGGRAPH_INGESTION_ASSISTANT_ID`: The ID of the LangGraph assistant for document ingestion. Default is `ingestion_graph`.
+-   `LANGGRAPH_RETRIEVAL_ASSISTANT_ID`: The ID of the LangGraph assistant for question answering. Default is `retrieval_graph`.
+-   `LANGCHAIN_TRACING_V2`:  Enable tracing to debug your application on the LangSmith platform.  Set to `true` to enable.
+-   `LANGCHAIN_PROJECT`:  The name of your LangSmith project.
+-   `OPENAI_API_KEY`: Your OpenAI API key.
+-   `SUPABASE_URL`: Your Supabase URL.
+-   `SUPABASE_SERVICE_ROLE_KEY`: Your Supabase service role key.
+
+
+
+## Local Development
+
+This monorepo uses Turborepo to manage both backend and frontend projects. You can run them separately for development.
+
+### Running the Backend
+
+1.	Navigate to backend:
+
+`cd backend`
+
+	2.	Install dependencies (already done if you ran yarn install at the root).
+	3.	Start LangGraph in dev mode:
+
+`yarn langgraph:dev`
+
+This will launch a local LangGraph server on port 2024 by default. It should redirect you to a UI for interacting with the LangGraph server. [Langgraph studio guide](https://langchain-ai.github.io/langgraph/concepts/langgraph_studio/)
+
+### Running the Frontend
+
+Open a new terminal window/tab:
+
+`cd frontend`
+
+`yarn dev`
+
+This will start a local Next.js development server (by default on port 3000).
+Access the UI in your browser at http://localhost:3000.
+
+## Usage
+
+Once both services are running:
+	1. Use langgraph studio UI to interact with the LangGraph server and ensure the workflow is working as expected.
+    2. Navigate to http://localhost:3000 to use the chatbot UI.
+	3. Upload a small PDF document via the file upload button at the bottom of the page. This will trigger the ingestion graph to extract the text and store the embeddings in Supabase via the frontend `app/api/ingest` route.
+	4.	After the ingestion is complete, ask questions in the chat input.
+	5.	The chatbot will trigger the retrieval graph via the `app/api/chat` route to retrieve the most relevant documents from the vector database and use the relevant PDF context (if needed) to answer.
+
+### Uploading/Ingesting PDFs
+
+Click on the paperclip icon in the chat input area.
+
+Select one or more PDF files to upload ensuring a total of max 5, each under 10MB (you can change these threshold values in the `app/api/ingest` route).
+
+The backend processes the PDFs, extracts text, and stores embeddings in Supabase (or your chosen vector store).
+
+### Asking Questions
+	•	Type your question in the chat input field.
+	•	Responses stream in real time. If the system retrieved documents, you’ll see a link to “View Sources” for each chunk of text used in the answer.
+
+Viewing Chat History
+	•	The system creates a unique thread per user session (frontend). All messages are kept in the state for the session.
+	•	For demonstration purposes, the current example UI does not store the entire conversation beyond the local thread state and is not persistent across sessions. You can extend it to persist threads in a database. However, the "ingested documents" are persistent across sessions as they are stored in a vector database.
+
+
+## Deploying the Backend
+
+To deploy your backend ai agent to a cloud service, you can either use LangGraph's cloud as per this [guide](https://langchain-ai.github.io/langgraph/cloud/quick_start/?h=studio#deploy-to-langgraph-cloud) or self-host it as per this [guide](https://langchain-ai.github.io/langgraph/how-tos/deploy-self-hosted/).
+
+## Deploying the Frontend
+The frontend can be deployed to any hosting that supports Next.js (Vercel, Netlify, etc.).
+Make sure NEXT_PUBLIC_LANGGRAPH_API_URL is pointing to your deployed backend URL.
+
+## Customizing the Agent
+
+You can customize the agent on the backend and frontend.
+
+### Backend
+
+- In the configuration file `src/shared/configuration.ts`, you can change the default configs i.e. the vector store, k-value, and filter kwargs, shared between the ingestion and retrieval graphs. Configs can be used in each node of the graph or passed into the graph as a config object via a client.
+- You can adjust the prompts in the `src/retrieval_graph/prompts.ts` file.
+- If you'd like to change the retrieval model, you can do so in the `src/shared/retrieval.ts` file by adding another makeRetriever function that encapsulates the desired client for the vector store.
+
+
+
+### Frontend
+
+- You can modify the file upload restrictions in the `app/api/ingest` route.
+- In `constants/graphConfigs.ts`, you can change the default configs for the ingestion and retrieval graphs. These include the model, k value, and retriever provider.
+
+
+## Troubleshooting
+1. .env Not Loaded
+   - Make sure you copied .env.example to .env in both backend and frontend.
+   - Check your environment variables are correct and restart the dev server.
+
+2. Supabase Vector Store
+   - Ensure you have configured your Supabase instance with the documents table and match_documents function. Check the official LangChain docs on Supabase integration.
+
+3. OpenAI Errors
+   - Double-check your OPENAI_API_KEY. Make sure you have enough credits/quota.
+
+4. LangGraph Not Running
+   - If yarn langgraph:dev fails, confirm your Node version is >= 18 and that you have all dependencies installed.
+
+5. Network Errors
+   - Frontend must point to the correct NEXT_PUBLIC_LANGGRAPH_API_URL. By default, it is http://localhost:2024.
+
+## Next Steps
+
+If you'd like to contribute to this project, feel free to open a pull request. Ensure it is well documented and tested.
+
+If you'd like to learn more about building AI agents with LangChain and LangGraph, check out the book [Learning LangChain (O'Reilly)](https://tinyurl.com/learning-langchain).
+

backend/.env.example

@@ -0,0 +1,11 @@
+OPENAI_API_KEY=
+
+
+SUPABASE_URL=
+SUPABASE_SERVICE_ROLE_KEY=
+
+# Optional: LangSmith for tracing (recommended for development)
+LANGCHAIN_TRACING_V2=true
+# Optional: LangSmith API key to access deployed graph
+LANGCHAIN_API_KEY=your-langsmith-api-key-here
+LANGCHAIN_PROJECT=ai-agent-pdf-chatbot

frontend/.env.example

@@ -0,0 +1,8 @@
+NEXT_PUBLIC_LANGGRAPH_API_URL=http://localhost:2024
+LANGCHAIN_API_KEY=
+LANGGRAPH_INGESTION_ASSISTANT_ID=ingestion_graph
+LANGGRAPH_RETRIEVAL_ASSISTANT_ID=retrieval_graph
+
+LANGCHAIN_TRACING_V2=true
+
+LANGCHAIN_PROJECT="pdf-chatbot"

frontend/.gitignore

@@ -17,7 +17,8 @@ yarn-error.log*
 .pnpm-debug.log*
 
 # env files
-.env*
+.env
+.env.local
 
 # vercel
 .vercel

frontend/package.json

@@ -1,6 +1,7 @@
 {
-  "name": "my-v0-project",
+  "name": "frontend",
   "version": "0.1.0",
+  "description": "Frontend for the AI chatbot based on the book Learning LangChain",
   "private": true,
   "scripts": {
     "dev": "next dev",
@@ -89,5 +90,6 @@
     "tailwindcss": "^3.4.17",
     "ts-jest": "^29.2.5",
     "typescript": "^5"
-  }
+  },
+  "license": "MIT"
 }

package.json

@@ -1,5 +1,6 @@
 {
-    "name": "ai-agent-pdf-chatbot",
+    "name": "ai-pdf-chatbot-langchain",
+    "description": "AI PDF chatbot template based on the book Learning LangChain (O'Reilly)",
     "private": true,
     "version": "0.0.1",
     "author": "Mayo Oshin",