Dev

README.md

@@ -1,118 +1,206 @@
-# Knowledge Graph Builder App
-
-Creating knowledge graphs from unstructured data
-
-
-# LLM Graph Builder
 
+# Knowledge Graph Builder
 ![Python](https://img.shields.io/badge/Python-yellow)
 ![FastAPI](https://img.shields.io/badge/FastAPI-green)
 ![React](https://img.shields.io/badge/React-blue)
 
-## Overview
-This application is designed to turn Unstructured data (pdfs,docs,txt,youtube video,web pages,etc.) into a knowledge graph stored in Neo4j. It utilizes the power of Large language models (OpenAI,Gemini,etc.) to extract nodes, relationships and their properties from the text and create a structured knowledge graph using Langchain framework. 
+Transform unstructured data (PDFs, DOCs, TXT, YouTube videos, web pages, etc.) into a structured Knowledge Graph stored in Neo4j using the power of Large Language Models (LLMs) and the LangChain framework.
+
+This application allows you to upload files from various sources (local machine, GCS, S3 bucket, or web sources), choose your preferred LLM model, and generate a Knowledge Graph. 
 
-Upload your files from local machine, GCS or S3 bucket or from web sources, choose your LLM model and generate knowledge graph.
+---
 
 ## Key Features
-- **Knowledge Graph Creation**: Transform unstructured data into structured knowledge graphs using LLMs.
-- **Providing Schema**: Provide your own custom schema or use existing schema in settings to generate graph.
-- **View Graph**: View graph for a particular source or multiple sources at a time in Bloom.
-- **Chat with Data**: Interact with your data in a Neo4j database through conversational queries, also retrieve metadata about the source of response to your queries.For a dedicated chat interface, access the standalone chat application at: [Chat-Only](https://dev-frontend-dcavk67s4a-uc.a.run.app/chat-only). This link provides a focused chat experience for querying your data.
 
-## Getting started
+### **Knowledge Graph Creation**
+- Seamlessly transform unstructured data into structured Knowledge Graphs using advanced LLMs.
+- Extract nodes, relationships, and their properties to create structured graphs.
 
-:warning: You will need to have a Neo4j Database V5.15 or later with [APOC installed](https://neo4j.com/docs/apoc/current/installation/) to use this Knowledge Graph Builder.
-You can use any [Neo4j Aura database](https://neo4j.com/aura/) (including the free database)
-If you are using Neo4j Desktop, you will not be able to use the docker-compose but will have to follow the [separate deployment of backend and frontend section](#running-backend-and-frontend-separately-dev-environment). :warning:
+### **Schema Support**
+- Use a custom schema or existing schemas configured in the settings to generate graphs.
 
+### **Graph Visualization**
+- View graphs for specific or multiple data sources simultaneously in **Neo4j Bloom**.
 
-## Deployment
-### Local deployment
-#### Running through docker-compose
-By default only OpenAI and Diffbot are enabled since Gemini requires extra GCP configurations.
-According to enviornment we are configuring the models which is indicated by VITE_LLM_MODELS_PROD variable we can configure model based on our need.
+### **Chat with Data**
+- Interact with your data in the Neo4j database through conversational queries.
+- Retrieve metadata about the source of responses to your queries.
+- For a dedicated chat interface, use the standalone chat application with **[/chat-only](/chat-only) route.** 
 
-EX:
-```env
-VITE_LLM_MODELS_PROD="openai_gpt_4o,openai_gpt_4o_mini,diffbot,gemini_1.5_flash"
+### **LLMs Supported**
+1. OpenAI
+2. Gemini
+3. Diffbot
+4. Azure OpenAI(dev deployed version)
+5. Anthropic(dev deployed version)
+6. Fireworks(dev deployed version)
+7. Groq(dev deployed version)
+8. Amazon Bedrock(dev deployed version)
+9. Ollama(dev deployed version)
+10. Deepseek(dev deployed version)
+11. Other OpenAI Compatible baseurl models(dev deployed version)
+
+---
+
+## Getting Started
+
+### **Prerequisites**
+- Neo4j Database **5.23 or later** with APOC installed.
+  - **Neo4j Aura** databases (including the free tier) are supported.
+  - If using **Neo4j Desktop**, you will need to deploy the backend and frontend separately (docker-compose is not supported).
+
+---
+
+## Deployment Options
+
+### **Local Deployment**
+
+#### Using Docker-Compose
+Run the application using the default `docker-compose` configuration.
+
+1. **Supported LLM Models**: 
+   - By default, only OpenAI and Diffbot are enabled. Gemini requires additional GCP configurations. 
+   - Use the `VITE_LLM_MODELS_PROD` variable to configure the models you need. Example:
+     ```bash
+     VITE_LLM_MODELS_PROD="openai_gpt_4o,openai_gpt_4o_mini,diffbot,gemini_1.5_flash"
+     ```
+
+2. **Input Sources**: 
+   - By default, the following sources are enabled: `local`, `YouTube`, `Wikipedia`, `AWS S3`, and `web`. 
+   - To add Google Cloud Storage (GCS) integration, include `gcs` and your Google client ID:
+     ```bash
+     VITE_REACT_APP_SOURCES="local,youtube,wiki,s3,gcs,web"
+     VITE_GOOGLE_CLIENT_ID="your-google-client-id"
+     ```
+
+#### Chat Modes
+Configure chat modes using the `VITE_CHAT_MODES` variable:
+- By default, all modes are enabled: `vector`, `graph_vector`, `graph`, `fulltext`, `graph_vector_fulltext`, `entity_vector`, and `global_vector`. 
+- To specify specific modes, update the variable. For example:
+  ```bash
+  VITE_CHAT_MODES="vector,graph"
+  ```
+
+---
+
+### **Running Backend and Frontend Separately**
+
+For development, you can run the backend and frontend independently.
+
+#### **Frontend Setup**
+1. Create the `.env` file in the `frontend` folder by copying `frontend/example.env`.
+2. Update environment variables as needed.
+3. Run:
+   ```bash
+   cd frontend
+   yarn
+   yarn run dev
+   ```
+
+#### **Backend Setup**
+1. Create the `.env` file in the `backend` folder by copying `backend/example.env`.
+2. Preconfigure user credentials in the `.env` file to bypass the login dialog:
+   ```bash
+   NEO4J_URI=<your-neo4j-uri>
+   NEO4J_USERNAME=<your-username>
+   NEO4J_PASSWORD=<your-password>
+   NEO4J_DATABASE=<your-database-name>
+   ```
+3. Run:
+   ```bash
+   cd backend
+   python -m venv envName
+   source envName/bin/activate
+   pip install -r requirements.txt
+   uvicorn score:app --reload
+   ```
+
+---
+
+### **Cloud Deployment**
+
+Deploy the application on **Google Cloud Platform** using the following commands:
+
+#### **Frontend Deployment**
+```bash
+gcloud run deploy dev-frontend \
+  --source . \
+  --region us-central1 \
+  --allow-unauthenticated
 ```
 
-#### Additional configs
-
-By default, the input sources will be: Local files, Youtube, Wikipedia ,AWS S3 and Webpages. As this default config is applied:
-```env
-VITE_REACT_APP_SOURCES="local,youtube,wiki,s3,web"
+#### **Backend Deployment**
+```bash
+gcloud run deploy dev-backend \
+  --set-env-vars "OPENAI_API_KEY=<your-openai-api-key>" \
+  --set-env-vars "DIFFBOT_API_KEY=<your-diffbot-api-key>" \
+  --set-env-vars "NEO4J_URI=<your-neo4j-uri>" \
+  --set-env-vars "NEO4J_USERNAME=<your-username>" \
+  --set-env-vars "NEO4J_PASSWORD=<your-password>" \
+  --source . \
+  --region us-central1 \
+  --allow-unauthenticated
 ```
 
-If however you want the Google GCS integration, add `gcs` and your Google client ID:
-```env
-VITE_REACT_APP_SOURCES="local,youtube,wiki,s3,gcs,web"
-VITE_GOOGLE_CLIENT_ID="xxxx"
+---
+## For local llms (Ollama)
+1. Pull the docker imgage of ollama
+```bash
+docker pull ollama/ollama
 ```
-
-You can of course combine all (local, youtube, wikipedia, s3 and gcs) or remove any you don't want/need.
-
-### Chat Modes
-
-By default,all of the chat modes will be available: vector, graph_vector, graph, fulltext, graph_vector_fulltext , entity_vector and global_vector.
-
-If none of the mode is mentioned in the chat modes variable all modes will be available:
+2. Run the ollama docker image
+```bash
+docker run -d -v ollama:/root/.ollama -p 11434:11434 --name ollama ollama/ollama
+```
+3. Execute any llm model ex llama3
+```bash
+docker exec -it ollama ollama run llama3
+```
+4. Configure  env variable in docker compose.
 ```env
-VITE_CHAT_MODES=""
+LLM_MODEL_CONFIG_ollama_<model_name>
+#example
+LLM_MODEL_CONFIG_ollama_llama3=${LLM_MODEL_CONFIG_ollama_llama3-llama3,
+http://host.docker.internal:11434}
 ```
-
-If however you want to specify the only vector mode or only graph mode you can do that by specifying the mode in the env:
+5. Configure the backend API url
 ```env
-VITE_CHAT_MODES="vector,graph"
-VITE_CHAT_MODES="vector,graph"
+VITE_BACKEND_API_URL=${VITE_BACKEND_API_URL-backendurl}
 ```
+6. Open the application in browser and select the ollama model for the extraction.
+7. Enjoy Graph Building.
+---
+
+## Additional Configuration
 
-#### Running Backend and Frontend separately (dev environment)
-Alternatively, you can run the backend and frontend separately:
-
-- For the frontend:
-1. Create the frontend/.env file by copy/pasting the frontend/example.env.
-2. Change values as needed
-3.
-    ```bash
-    cd frontend
-    yarn
-    yarn run dev
-    ```
-
-- For the backend:
-1. Create the backend/.env file by copy/pasting the backend/example.env. To streamline the initial setup and testing of the application, you can preconfigure user credentials directly within the backend .env file. This bypasses the login dialog and allows you to immediately connect with a predefined user.
-   - **NEO4J_URI**:
-   - **NEO4J_USERNAME**:
-   - **NEO4J_PASSWORD**:
-   - **NEO4J_DATABASE**:
-3. Change values as needed
-4.
-    ```bash
-    cd backend
-    python -m venv envName
-    source envName/bin/activate 
-    pip install -r requirements.txt
-    uvicorn score:app --reload
-    ```
-### Deploy in Cloud
-To deploy the app and packages on Google Cloud Platform, run the following command on google cloud run:
+### **LLM Models**
+Configure LLM models using the `VITE_LLM_MODELS_PROD` variable. Example:
 ```bash
-# Frontend deploy 
-gcloud run deploy dev-frontend 
-source location current directory > Frontend
-region : 32 [us-central 1]
-Allow unauthenticated request : Yes
+VITE_LLM_MODELS_PROD="openai_gpt_4o,openai_gpt_4o_mini,diffbot,gemini_1.5_flash"
 ```
+
+### **Input Sources**
+The default input sources are: `local`, `YouTube`, `Wikipedia`, `AWS S3`, and `web`. 
+
+To enable GCS integration, include `gcs` and your Google client ID:
 ```bash
-# Backend deploy 
-gcloud run deploy --set-env-vars "OPENAI_API_KEY = " --set-env-vars "DIFFBOT_API_KEY = " --set-env-vars "NEO4J_URI = " --set-env-vars "NEO4J_PASSWORD = " --set-env-vars "NEO4J_USERNAME = "
-source location current directory > Backend
-region : 32 [us-central 1]
-Allow unauthenticated request : Yes
+VITE_REACT_APP_SOURCES="local,youtube,wiki,s3,gcs,web"
+VITE_GOOGLE_CLIENT_ID="your-google-client-id"
 ```
 
+## Usage
+1. Connect to Neo4j Aura Instance which can be both AURA DS or AURA DB by passing URI and password through Backend env, fill using login dialog or drag and drop the Neo4j credentials file.
+2. To differntiate we have added different icons. For AURA DB we have a database icon and for AURA DS we have scientific molecule icon right under Neo4j Connection details label.
+3. Choose your source from a list of Unstructured sources to create graph.
+4. Change the LLM (if required) from drop down, which will be used to generate graph.
+5. Optionally, define schema(nodes and relationship labels) in entity graph extraction settings.
+6. Either select multiple files to 'Generate Graph' or all the files in 'New' status will be processed for graph creation.
+7. Have a look at the graph for individual files using 'View' in grid or select one or more files and 'Preview Graph'
+8. Ask questions related to the processed/completed sources to chat-bot, Also get detailed information about your answers generated by LLM.
+
+---
+
+
 ## ENV
 | Env Variable Name       | Mandatory/Optional | Default Value | Description                                                                                      |
 |-------------------------|--------------------|---------------|--------------------------------------------------------------------------------------------------|
@@ -166,60 +254,6 @@ Allow unauthenticated request : Yes
 | VITE_TOKENS_PER_CHUNK | Optional |  100  | variable to configure tokens count per chunk.This gives flexibility for users who may require different chunk sizes for various tokenization tasks, especially when working with large datasets or specific language models.
 | VITE_CHUNK_TO_COMBINE | Optional |   1  | variable to configure number of chunks to combine for parllel processing. 
 
-## LLMs Supported 
-1. OpenAI
-2. Gemini
-3. Diffbot
-4. Azure OpenAI(dev deployed version)
-5. Anthropic(dev deployed version)
-6. Fireworks(dev deployed version)
-7. Groq(dev deployed version)
-8. Amazon Bedrock(dev deployed version)
-9. Ollama(dev deployed version)
-10. Deepseek(dev deployed version)
-11. Other OpenAI compabtile baseurl models(dev deployed version)
-
-## For local llms (Ollama)
-1. Pull the docker imgage of ollama
-```bash
-docker pull ollama/ollama
-```
-2. Run the ollama docker image
-```bash
-docker run -d -v ollama:/root/.ollama -p 11434:11434 --name ollama ollama/ollama
-```
-3. Pull specific ollama model.
-```bash
-ollama pull llama3
-```
-4. Execute any llm model ex🦙3
-```bash
-docker exec -it ollama ollama run llama3
-```
-5. Configure  env variable in docker compose.
-```env
-LLM_MODEL_CONFIG_ollama_<model_name>
-#example
-LLM_MODEL_CONFIG_ollama_llama3=${LLM_MODEL_CONFIG_ollama_llama3-llama3,
-http://host.docker.internal:11434}
-```
-6. Configure the backend API url
-```env
-VITE_BACKEND_API_URL=${VITE_BACKEND_API_URL-backendurl}
-```
-7. Open the application in browser and select the ollama model for the extraction.
-8. Enjoy Graph Building.
-
-
-## Usage
-1. Connect to Neo4j Aura Instance which can be both AURA DS or AURA DB by passing URI and password through Backend env, fill using login dialog or drag and drop the Neo4j credentials file.
-2. To differntiate we have added different icons. For AURA DB we have a database icon and for AURA DS we have scientific molecule icon right under Neo4j Connection details label.
-3. Choose your source from a list of Unstructured sources to create graph.
-4. Change the LLM (if required) from drop down, which will be used to generate graph.
-5. Optionally, define schema(nodes and relationship labels) in entity graph extraction settings.
-6. Either select multiple files to 'Generate Graph' or all the files in 'New' status will be processed for graph creation.
-7. Have a look at the graph for individual files using 'View' in grid or select one or more files and 'Preview Graph'
-8. Ask questions related to the processed/completed sources to chat-bot, Also get detailed information about your answers generated by LLM.
 
 ## Links
 

backend/example.env

@@ -31,16 +31,19 @@ DEFAULT_DIFFBOT_CHAT_MODEL="openai_gpt_4o"  #whichever model specified here , ne
 LLM_MODEL_CONFIG_openai_gpt_3.5="gpt-3.5-turbo-0125,openai_api_key"
 LLM_MODEL_CONFIG_openai_gpt_4o_mini="gpt-4o-mini-2024-07-18,openai_api_key"
 LLM_MODEL_CONFIG_openai_gpt_4o="gpt-4o-2024-11-20,openai_api_key"
-LLM_MODEL_CONFIG_openai-gpt-o3-mini="o3-mini-2025-01-31,openai_api_key"
+LLM_MODEL_CONFIG_openai_gpt_4.1_mini="gpt-4.1-mini,openai_api_key"
+LLM_MODEL_CONFIG_openai_gpt_4.1="gpt-4.1,openai_api_key"
+LLM_MODEL_CONFIG_openai_gpt_o3_mini="o3-mini-2025-01-31,openai_api_key"
 LLM_MODEL_CONFIG_gemini_1.5_pro="gemini-1.5-pro-002"
 LLM_MODEL_CONFIG_gemini_1.5_flash="gemini-1.5-flash-002"
 LLM_MODEL_CONFIG_gemini_2.0_flash="gemini-2.0-flash-001"
+LLM_MODEL_CONFIG_gemini_2.5_pro="gemini-2.5-pro-exp-03-25"
 LLM_MODEL_CONFIG_diffbot="diffbot,diffbot_api_key"
 LLM_MODEL_CONFIG_azure_ai_gpt_35="azure_deployment_name,azure_endpoint or base_url,azure_api_key,api_version"
 LLM_MODEL_CONFIG_azure_ai_gpt_4o="gpt-4o,https://YOUR-ENDPOINT.openai.azure.com/,azure_api_key,api_version"
 LLM_MODEL_CONFIG_groq_llama3_70b="model_name,base_url,groq_api_key"
 LLM_MODEL_CONFIG_anthropic_claude_3_5_sonnet="model_name,anthropic_api_key"
-LLM_MODEL_CONFIG_fireworks_llama_v3_70b="model_name,fireworks_api_key"
+LLM_MODEL_CONFIG_fireworks_llama4_maverick="model_name,fireworks_api_key"
 LLM_MODEL_CONFIG_bedrock_claude_3_5_sonnet="model_name,aws_access_key_id,aws_secret__access_key,region_name"
 LLM_MODEL_CONFIG_ollama_llama3="model_name,model_local_url"
 YOUTUBE_TRANSCRIPT_PROXY="https://user:pass@domain:port"