From 6e6bb3972f79b304f030e28283e7ea96e4fe89f3 Mon Sep 17 00:00:00 2001 From: mpawank Date: Tue, 13 May 2025 15:19:00 +0530 Subject: [PATCH 1/5] mpawanl --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index e8979cf50..98005b35c 100644 --- a/README.md +++ b/README.md @@ -237,3 +237,11 @@ Fine-tuning the Backend is always desired. +--- + +## 📘 Documentation (Coming Soon) + +We're working on docs via: + +- [Mintlify](https://mintlify.com/) +- [Fumadocs](https://fumadocs.com/) From 9ccbf848e8ea6f1c0d3240292212ee575f9a9b75 Mon Sep 17 00:00:00 2001 From: mpawank Date: Wed, 14 May 2025 00:55:22 +0530 Subject: [PATCH 2/5] updated layout.tsx for better seo --- surfsense_web/app/layout.tsx | 106 +++++++++++++++++++++++++---------- 1 file changed, 77 insertions(+), 29 deletions(-) diff --git a/surfsense_web/app/layout.tsx b/surfsense_web/app/layout.tsx index 6b60891a4..30903a608 100644 --- a/surfsense_web/app/layout.tsx +++ b/surfsense_web/app/layout.tsx @@ -15,35 +15,83 @@ const roboto = Roboto({ }); export const metadata: Metadata = { - title: "SurfSense - A Personal NotebookLM and Perplexity-like AI Assistant for Everyone.", - description: - "Have your own private NotebookLM and Perplexity with better integrations.", - openGraph: { - images: [ - { - url: "https://surfsense.net/og-image.png", - width: 1200, - height: 630, - alt: "SurfSense - A Personal NotebookLM and Perplexity-like AI Assistant for Everyone.", - }, - ], - }, - twitter: { - card: "summary_large_image", - site: "https://surfsense.net", - creator: "https://surfsense.net", - title: "SurfSense - A Personal NotebookLM and Perplexity-like AI Assistant for Everyone.", - description: - "Have your own private NotebookLM and Perplexity with better integrations.", - images: [ - { - url: "https://surfsense.net/og-image.png", - width: 1200, - height: 630, - alt: "SurfSense - A Personal NotebookLM and Perplexity-like AI Assistant for Everyone.", - }, - ], - }, + title: "SurfSense – Customizable AI Research & Knowledge Management Assistant", + description: + "SurfSense is an AI-powered research assistant that integrates with tools like Notion, GitHub, Slack, and more to help you efficiently manage, search, and chat with your documents. Generate podcasts, perform hybrid search, and unlock insights from your knowledge base.", + keywords: [ + "SurfSense", + "AI research assistant", + "AI knowledge management", + "AI document assistant", + "customizable AI assistant", + "notion integration", + "slack integration", + "github integration", + "hybrid search", + "vector search", + "RAG", + "LangChain", + "FastAPI", + "LLM apps", + "AI document chat", + "knowledge management AI", + "AI-powered document search", + "personal AI assistant", + "AI research tools", + "AI podcast generator", + "AI knowledge base", + "AI document assistant tools", + "AI-powered search assistant", + ], + openGraph: { + title: "SurfSense – AI Research & Knowledge Management Assistant", + description: + "Connect your documents and tools like Notion, Slack, GitHub, and more to your private AI assistant. SurfSense offers powerful search, document chat, podcast generation, and RAG APIs to enhance your workflow.", + url: "https://surfsense.net", + siteName: "SurfSense", + type: "website", + images: [ + { + url: "https://surfsense.net/og-image.png", + width: 1200, + height: 630, + alt: "SurfSense AI Research Assistant", + }, + ], + locale: "en_US", + }, + twitter: { + card: "summary_large_image", + title: "SurfSense – AI Assistant for Research & Knowledge Management", + description: + "Have your own NotebookLM or Perplexity, but better. SurfSense connects external tools, allows chat with your documents, and generates fast, high-quality podcasts.", + creator: "@surfsenseapp", // Replace with actual handle + images: [ + { + url: "https://surfsense.net/og-image-twitter.png", // Consider a different image for Twitter + width: 1200, + height: 630, + alt: "SurfSense AI Assistant Preview", + }, + ], + }, + // Adding structured data (JSON-LD) for rich search results + structuredData: { + "@context": "https://schema.org", + "@type": "WebSite", + name: "SurfSense", + description: "AI-powered research assistant that integrates with tools like Notion, GitHub, and Slack. Offers powerful search and knowledge management capabilities.", + url: "https://surfsense.net", + sameAs: [ + "https://twitter.com/surfsenseapp", // Replace with actual social links + "https://www.linkedin.com/company/surfsense", // Replace with actual social links + ], + potentialAction: { + "@type": "SearchAction", + target: "https://surfsense.net/search?q={search_term_string}", + query: "{search_term_string}", + }, + }, }; export default async function RootLayout({ From 288798ade4664cbd73c01f331f7e5bbf30813423 Mon Sep 17 00:00:00 2001 From: mpawank Date: Wed, 14 May 2025 01:22:25 +0530 Subject: [PATCH 3/5] updated seo --- surfsense_web/app/layout.tsx | 24 ++++-------------------- 1 file changed, 4 insertions(+), 20 deletions(-) diff --git a/surfsense_web/app/layout.tsx b/surfsense_web/app/layout.tsx index 30903a608..33bf10bb4 100644 --- a/surfsense_web/app/layout.tsx +++ b/surfsense_web/app/layout.tsx @@ -65,33 +65,17 @@ export const metadata: Metadata = { title: "SurfSense – AI Assistant for Research & Knowledge Management", description: "Have your own NotebookLM or Perplexity, but better. SurfSense connects external tools, allows chat with your documents, and generates fast, high-quality podcasts.", - creator: "@surfsenseapp", // Replace with actual handle + creator: "https://surfsense.net", + site: "https://surfsense.net", images: [ { - url: "https://surfsense.net/og-image-twitter.png", // Consider a different image for Twitter + url: "https://surfsense.net/og-image-twitter.png", width: 1200, height: 630, alt: "SurfSense AI Assistant Preview", }, ], - }, - // Adding structured data (JSON-LD) for rich search results - structuredData: { - "@context": "https://schema.org", - "@type": "WebSite", - name: "SurfSense", - description: "AI-powered research assistant that integrates with tools like Notion, GitHub, and Slack. Offers powerful search and knowledge management capabilities.", - url: "https://surfsense.net", - sameAs: [ - "https://twitter.com/surfsenseapp", // Replace with actual social links - "https://www.linkedin.com/company/surfsense", // Replace with actual social links - ], - potentialAction: { - "@type": "SearchAction", - target: "https://surfsense.net/search?q={search_term_string}", - query: "{search_term_string}", - }, - }, + } }; export default async function RootLayout({ From 9d5dd56306e914b4cdef54e6b83b2c32d0954a70 Mon Sep 17 00:00:00 2001 From: mpawank Date: Wed, 14 May 2025 08:49:52 +0530 Subject: [PATCH 4/5] removed change from r --- README.md | 146 ++++++++++++++++++++++++++---------------------------- 1 file changed, 71 insertions(+), 75 deletions(-) diff --git a/README.md b/README.md index 98005b35c..cfcf0c55f 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,13 @@ - ![new_header](https://github.com/user-attachments/assets/e236b764-0ddc-42ff-a1f1-8fbb3d2e0e65) - - - # SurfSense + While tools like NotebookLM and Perplexity are impressive and highly effective for conducting research on any topic/query, SurfSense elevates this capability by integrating with your personal knowledge base. It is a highly customizable AI research agent, connected to external sources such as search engines (Tavily, LinkUp), Slack, Linear, Notion, YouTube, GitHub and more to come.
MODSetter%2FSurfSense | Trendshift
- # Video https://github.com/user-attachments/assets/48142909-6391-4084-b7e8-81da388bb1fc @@ -24,31 +20,46 @@ https://github.com/user-attachments/assets/d516982f-de00-4c41-9e4c-632a7d942f41 https://github.com/user-attachments/assets/bf64a6ca-934b-47ac-9e1b-edac5fe972ec - - ## Key Features + ### 1. Latest -#### 💡 **Idea**: +#### 💡 **Idea**: + Have your own highly customizable private NotebookLM and Perplexity integrated with external sources. + #### 📁 **Multiple File Format Uploading Support** -Save content from your own personal files *(Documents, images and supports **27 file extensions**)* to your own personal knowledge base . + +Save content from your own personal files _(Documents, images and supports **27 file extensions**)_ to your own personal knowledge base . + #### 🔍 **Powerful Search** + Quickly research or find anything in your saved content . + #### đŸ’Ŧ **Chat with your Saved Content** - Interact in Natural Language and get cited answers. + +Interact in Natural Language and get cited answers. + #### 📄 **Cited Answers** + Get Cited answers just like Perplexity. + #### 🔔 **Privacy & Local LLM Support** + Works Flawlessly with Ollama local LLMs. + #### 🏠 **Self Hostable** + Open source and easy to deploy locally. -#### 🎙ī¸ Podcasts + +#### 🎙ī¸ Podcasts + - Blazingly fast podcast generation agent. (Creates a 3-minute podcast in under 20 seconds.) - Convert your chat conversations into engaging audio content - Support for multiple TTS providers (OpenAI, Azure, Google Vertex AI) #### 📊 **Advanced RAG Techniques** + - Supports 150+ LLM's - Supports 6000+ Embedding Models. - Supports all major Rerankers (Pinecode, Cohere, Flashrank etc) @@ -57,6 +68,7 @@ Open source and easy to deploy locally. - RAG as a Service API Backend. #### ℹī¸ **External Sources** + - Search Engines (Tavily, LinkUp) - Slack - Linear @@ -66,19 +78,16 @@ Open source and easy to deploy locally. - and more to come..... #### 🔖 Cross Browser Extension + - The SurfSense extension can be used to save any webpage you like. - Its main usecase is to save any webpages protected beyond authentication. - ## FEATURE REQUESTS AND FUTURE - **SurfSense is actively being developed.** While it's not yet production-ready, you can help us speed up the process. Join the [SurfSense Discord](https://discord.gg/ejRNvftDp9) and help shape the future of SurfSense! - - ## How to get started? ### Installation Options @@ -86,6 +95,7 @@ Join the [SurfSense Discord](https://discord.gg/ejRNvftDp9) and help shape the f SurfSense provides two installation methods: 1. **[Docker Installation](https://www.surfsense.net/docs/docker-installation)** - The easiest way to get SurfSense up and running with all dependencies containerized. + - Includes pgAdmin for database management through a web UI - Supports environment variable customization via `.env` file - See [Docker Setup Guide](DOCKER_SETUP.md) for detailed instructions @@ -95,6 +105,7 @@ SurfSense provides two installation methods: Both installation guides include detailed OS-specific instructions for Windows, macOS, and Linux. Before installation, make sure to complete the [prerequisite setup steps](https://www.surfsense.net/docs/) including: + - PGVector setup - Google OAuth configuration - Unstructured.io API key @@ -102,22 +113,21 @@ Before installation, make sure to complete the [prerequisite setup steps](https: ## Screenshots -**Search Spaces** +**Search Spaces** ![search_spaces](https://github.com/user-attachments/assets/e254c38c-f937-44b6-9e9d-770db583d099) -**Manage Documents** +**Manage Documents** ![documents](https://github.com/user-attachments/assets/7001e306-eb06-4009-89c6-8fadfdc3fc4d) -**Research Agent** +**Research Agent** ![researcher](https://github.com/user-attachments/assets/fda3e61f-f936-4b66-b565-d84edde44a67) -**Podcast Agent** +**Podcast Agent** ![podcasts](https://github.com/user-attachments/assets/6cb82ffd-9e14-4172-bc79-67faf34c4c1c) - -**Agent Chat** +**Agent Chat** ![chat](https://github.com/user-attachments/assets/bb352d52-1c6d-4020-926b-722d0b98b491) @@ -127,89 +137,86 @@ Before installation, make sure to complete the [prerequisite setup steps](https: ![ext2](https://github.com/user-attachments/assets/a9b9f1aa-2677-404d-b0a0-c1b2dddf24a7) - ## Tech Stack +### **BackEnd** - ### **BackEnd** +- **FastAPI**: Modern, fast web framework for building APIs with Python -- **FastAPI**: Modern, fast web framework for building APIs with Python - -- **PostgreSQL with pgvector**: Database with vector search capabilities for similarity searches +- **PostgreSQL with pgvector**: Database with vector search capabilities for similarity searches -- **SQLAlchemy**: SQL toolkit and ORM (Object-Relational Mapping) for database interactions +- **SQLAlchemy**: SQL toolkit and ORM (Object-Relational Mapping) for database interactions -- **Alembic**: A database migrations tool for SQLAlchemy. +- **Alembic**: A database migrations tool for SQLAlchemy. -- **FastAPI Users**: Authentication and user management with JWT and OAuth support +- **FastAPI Users**: Authentication and user management with JWT and OAuth support -- **LangGraph**: Framework for developing AI-agents. - -- **LangChain**: Framework for developing AI-powered applications. +- **LangGraph**: Framework for developing AI-agents. -- **LLM Integration**: Integration with LLM models through LiteLLM +- **LangChain**: Framework for developing AI-powered applications. -- **Rerankers**: Advanced result ranking for improved search relevance +- **LLM Integration**: Integration with LLM models through LiteLLM -- **Hybrid Search**: Combines vector similarity and full-text search for optimal results using Reciprocal Rank Fusion (RRF) +- **Rerankers**: Advanced result ranking for improved search relevance -- **Vector Embeddings**: Document and text embeddings for semantic search +- **Hybrid Search**: Combines vector similarity and full-text search for optimal results using Reciprocal Rank Fusion (RRF) -- **pgvector**: PostgreSQL extension for efficient vector similarity operations +- **Vector Embeddings**: Document and text embeddings for semantic search -- **Chonkie**: Advanced document chunking and embedding library - - Uses `AutoEmbeddings` for flexible embedding model selection - - `LateChunker` for optimized document chunking based on embedding model's max sequence length +- **pgvector**: PostgreSQL extension for efficient vector similarity operations +- **Chonkie**: Advanced document chunking and embedding library +- Uses `AutoEmbeddings` for flexible embedding model selection +- `LateChunker` for optimized document chunking based on embedding model's max sequence length - --- - ### **FrontEnd** -- **Next.js 15.2.3**: React framework featuring App Router, server components, automatic code-splitting, and optimized rendering. +### **FrontEnd** -- **React 19.0.0**: JavaScript library for building user interfaces. +- **Next.js 15.2.3**: React framework featuring App Router, server components, automatic code-splitting, and optimized rendering. -- **TypeScript**: Static type-checking for JavaScript, enhancing code quality and developer experience. +- **React 19.0.0**: JavaScript library for building user interfaces. + +- **TypeScript**: Static type-checking for JavaScript, enhancing code quality and developer experience. - **Vercel AI SDK Kit UI Stream Protocol**: To create scalable chat UI. -- **Tailwind CSS 4.x**: Utility-first CSS framework for building custom UI designs. +- **Tailwind CSS 4.x**: Utility-first CSS framework for building custom UI designs. -- **Shadcn**: Headless components library. +- **Shadcn**: Headless components library. -- **Lucide React**: Icon set implemented as React components. +- **Lucide React**: Icon set implemented as React components. -- **Framer Motion**: Animation library for React. +- **Framer Motion**: Animation library for React. -- **Sonner**: Toast notification library. +- **Sonner**: Toast notification library. -- **Geist**: Font family from Vercel. +- **Geist**: Font family from Vercel. -- **React Hook Form**: Form state management and validation. +- **React Hook Form**: Form state management and validation. -- **Zod**: TypeScript-first schema validation with static type inference. +- **Zod**: TypeScript-first schema validation with static type inference. -- **@hookform/resolvers**: Resolvers for using validation libraries with React Hook Form. +- **@hookform/resolvers**: Resolvers for using validation libraries with React Hook Form. -- **@tanstack/react-table**: Headless UI for building powerful tables & datagrids. +- **@tanstack/react-table**: Headless UI for building powerful tables & datagrids. +### **DevOps** - ### **DevOps** +- **Docker**: Container platform for consistent deployment across environments -- **Docker**: Container platform for consistent deployment across environments - -- **Docker Compose**: Tool for defining and running multi-container Docker applications +- **Docker Compose**: Tool for defining and running multi-container Docker applications -- **pgAdmin**: Web-based PostgreSQL administration tool included in Docker setup +- **pgAdmin**: Web-based PostgreSQL administration tool included in Docker setup +### **Extension** -### **Extension** - Manifest v3 on Plasmo +Manifest v3 on Plasmo ## Future Work + - Add More Connectors. - Patch minor bugs. -- Implement Canvas. +- Implement Canvas. - Complete Hybrid Search. **[Done]** - Add support for file uploads QA. **[Done]** - Shift to WebSockets for Streaming responses. **[Deprecated in favor of AI SDK Stream Protocol]** @@ -220,9 +227,7 @@ Before installation, make sure to complete the [prerequisite setup steps](https: - Basic keyword search page for saved sessions **[Done]** - Multi & Single Document Chat **[Done]** - - -## Contribute +## Contribute Contributions are very welcome! A contribution can be as small as a ⭐ or even finding and creating issues. Fine-tuning the Backend is always desired. @@ -236,12 +241,3 @@ Fine-tuning the Backend is always desired. Star History Chart - ---- - -## 📘 Documentation (Coming Soon) - -We're working on docs via: - -- [Mintlify](https://mintlify.com/) -- [Fumadocs](https://fumadocs.com/) From 445e02b71b31d9484d78b1e32835466f45f55e49 Mon Sep 17 00:00:00 2001 From: mpawank Date: Wed, 14 May 2025 08:54:40 +0530 Subject: [PATCH 5/5] removed changes from readme --- README.md | 138 ++++++++++++++++++++++++++---------------------------- 1 file changed, 67 insertions(+), 71 deletions(-) diff --git a/README.md b/README.md index cfcf0c55f..e8979cf50 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,17 @@ + ![new_header](https://github.com/user-attachments/assets/e236b764-0ddc-42ff-a1f1-8fbb3d2e0e65) -# SurfSense + + +# SurfSense While tools like NotebookLM and Perplexity are impressive and highly effective for conducting research on any topic/query, SurfSense elevates this capability by integrating with your personal knowledge base. It is a highly customizable AI research agent, connected to external sources such as search engines (Tavily, LinkUp), Slack, Linear, Notion, YouTube, GitHub and more to come.
MODSetter%2FSurfSense | Trendshift
+ # Video https://github.com/user-attachments/assets/48142909-6391-4084-b7e8-81da388bb1fc @@ -20,46 +24,31 @@ https://github.com/user-attachments/assets/d516982f-de00-4c41-9e4c-632a7d942f41 https://github.com/user-attachments/assets/bf64a6ca-934b-47ac-9e1b-edac5fe972ec -## Key Features + +## Key Features ### 1. Latest -#### 💡 **Idea**: - +#### 💡 **Idea**: Have your own highly customizable private NotebookLM and Perplexity integrated with external sources. - #### 📁 **Multiple File Format Uploading Support** - -Save content from your own personal files _(Documents, images and supports **27 file extensions**)_ to your own personal knowledge base . - +Save content from your own personal files *(Documents, images and supports **27 file extensions**)* to your own personal knowledge base . #### 🔍 **Powerful Search** - Quickly research or find anything in your saved content . - #### đŸ’Ŧ **Chat with your Saved Content** - -Interact in Natural Language and get cited answers. - + Interact in Natural Language and get cited answers. #### 📄 **Cited Answers** - Get Cited answers just like Perplexity. - #### 🔔 **Privacy & Local LLM Support** - Works Flawlessly with Ollama local LLMs. - #### 🏠 **Self Hostable** - Open source and easy to deploy locally. - -#### 🎙ī¸ Podcasts - +#### 🎙ī¸ Podcasts - Blazingly fast podcast generation agent. (Creates a 3-minute podcast in under 20 seconds.) - Convert your chat conversations into engaging audio content - Support for multiple TTS providers (OpenAI, Azure, Google Vertex AI) #### 📊 **Advanced RAG Techniques** - - Supports 150+ LLM's - Supports 6000+ Embedding Models. - Supports all major Rerankers (Pinecode, Cohere, Flashrank etc) @@ -68,7 +57,6 @@ Open source and easy to deploy locally. - RAG as a Service API Backend. #### ℹī¸ **External Sources** - - Search Engines (Tavily, LinkUp) - Slack - Linear @@ -78,16 +66,19 @@ Open source and easy to deploy locally. - and more to come..... #### 🔖 Cross Browser Extension - - The SurfSense extension can be used to save any webpage you like. - Its main usecase is to save any webpages protected beyond authentication. + ## FEATURE REQUESTS AND FUTURE + **SurfSense is actively being developed.** While it's not yet production-ready, you can help us speed up the process. Join the [SurfSense Discord](https://discord.gg/ejRNvftDp9) and help shape the future of SurfSense! + + ## How to get started? ### Installation Options @@ -95,7 +86,6 @@ Join the [SurfSense Discord](https://discord.gg/ejRNvftDp9) and help shape the f SurfSense provides two installation methods: 1. **[Docker Installation](https://www.surfsense.net/docs/docker-installation)** - The easiest way to get SurfSense up and running with all dependencies containerized. - - Includes pgAdmin for database management through a web UI - Supports environment variable customization via `.env` file - See [Docker Setup Guide](DOCKER_SETUP.md) for detailed instructions @@ -105,7 +95,6 @@ SurfSense provides two installation methods: Both installation guides include detailed OS-specific instructions for Windows, macOS, and Linux. Before installation, make sure to complete the [prerequisite setup steps](https://www.surfsense.net/docs/) including: - - PGVector setup - Google OAuth configuration - Unstructured.io API key @@ -113,21 +102,22 @@ Before installation, make sure to complete the [prerequisite setup steps](https: ## Screenshots -**Search Spaces** +**Search Spaces** ![search_spaces](https://github.com/user-attachments/assets/e254c38c-f937-44b6-9e9d-770db583d099) -**Manage Documents** +**Manage Documents** ![documents](https://github.com/user-attachments/assets/7001e306-eb06-4009-89c6-8fadfdc3fc4d) -**Research Agent** +**Research Agent** ![researcher](https://github.com/user-attachments/assets/fda3e61f-f936-4b66-b565-d84edde44a67) -**Podcast Agent** +**Podcast Agent** ![podcasts](https://github.com/user-attachments/assets/6cb82ffd-9e14-4172-bc79-67faf34c4c1c) -**Agent Chat** + +**Agent Chat** ![chat](https://github.com/user-attachments/assets/bb352d52-1c6d-4020-926b-722d0b98b491) @@ -137,86 +127,89 @@ Before installation, make sure to complete the [prerequisite setup steps](https: ![ext2](https://github.com/user-attachments/assets/a9b9f1aa-2677-404d-b0a0-c1b2dddf24a7) + ## Tech Stack -### **BackEnd** -- **FastAPI**: Modern, fast web framework for building APIs with Python + ### **BackEnd** -- **PostgreSQL with pgvector**: Database with vector search capabilities for similarity searches +- **FastAPI**: Modern, fast web framework for building APIs with Python + +- **PostgreSQL with pgvector**: Database with vector search capabilities for similarity searches -- **SQLAlchemy**: SQL toolkit and ORM (Object-Relational Mapping) for database interactions +- **SQLAlchemy**: SQL toolkit and ORM (Object-Relational Mapping) for database interactions -- **Alembic**: A database migrations tool for SQLAlchemy. +- **Alembic**: A database migrations tool for SQLAlchemy. -- **FastAPI Users**: Authentication and user management with JWT and OAuth support +- **FastAPI Users**: Authentication and user management with JWT and OAuth support -- **LangGraph**: Framework for developing AI-agents. +- **LangGraph**: Framework for developing AI-agents. + +- **LangChain**: Framework for developing AI-powered applications. -- **LangChain**: Framework for developing AI-powered applications. +- **LLM Integration**: Integration with LLM models through LiteLLM -- **LLM Integration**: Integration with LLM models through LiteLLM +- **Rerankers**: Advanced result ranking for improved search relevance -- **Rerankers**: Advanced result ranking for improved search relevance +- **Hybrid Search**: Combines vector similarity and full-text search for optimal results using Reciprocal Rank Fusion (RRF) -- **Hybrid Search**: Combines vector similarity and full-text search for optimal results using Reciprocal Rank Fusion (RRF) +- **Vector Embeddings**: Document and text embeddings for semantic search -- **Vector Embeddings**: Document and text embeddings for semantic search +- **pgvector**: PostgreSQL extension for efficient vector similarity operations -- **pgvector**: PostgreSQL extension for efficient vector similarity operations +- **Chonkie**: Advanced document chunking and embedding library + - Uses `AutoEmbeddings` for flexible embedding model selection + - `LateChunker` for optimized document chunking based on embedding model's max sequence length -- **Chonkie**: Advanced document chunking and embedding library -- Uses `AutoEmbeddings` for flexible embedding model selection -- `LateChunker` for optimized document chunking based on embedding model's max sequence length + --- + ### **FrontEnd** -### **FrontEnd** +- **Next.js 15.2.3**: React framework featuring App Router, server components, automatic code-splitting, and optimized rendering. -- **Next.js 15.2.3**: React framework featuring App Router, server components, automatic code-splitting, and optimized rendering. +- **React 19.0.0**: JavaScript library for building user interfaces. -- **React 19.0.0**: JavaScript library for building user interfaces. - -- **TypeScript**: Static type-checking for JavaScript, enhancing code quality and developer experience. +- **TypeScript**: Static type-checking for JavaScript, enhancing code quality and developer experience. - **Vercel AI SDK Kit UI Stream Protocol**: To create scalable chat UI. -- **Tailwind CSS 4.x**: Utility-first CSS framework for building custom UI designs. +- **Tailwind CSS 4.x**: Utility-first CSS framework for building custom UI designs. -- **Shadcn**: Headless components library. +- **Shadcn**: Headless components library. -- **Lucide React**: Icon set implemented as React components. +- **Lucide React**: Icon set implemented as React components. -- **Framer Motion**: Animation library for React. +- **Framer Motion**: Animation library for React. -- **Sonner**: Toast notification library. +- **Sonner**: Toast notification library. -- **Geist**: Font family from Vercel. +- **Geist**: Font family from Vercel. -- **React Hook Form**: Form state management and validation. +- **React Hook Form**: Form state management and validation. -- **Zod**: TypeScript-first schema validation with static type inference. +- **Zod**: TypeScript-first schema validation with static type inference. -- **@hookform/resolvers**: Resolvers for using validation libraries with React Hook Form. +- **@hookform/resolvers**: Resolvers for using validation libraries with React Hook Form. -- **@tanstack/react-table**: Headless UI for building powerful tables & datagrids. +- **@tanstack/react-table**: Headless UI for building powerful tables & datagrids. -### **DevOps** -- **Docker**: Container platform for consistent deployment across environments + ### **DevOps** -- **Docker Compose**: Tool for defining and running multi-container Docker applications +- **Docker**: Container platform for consistent deployment across environments + +- **Docker Compose**: Tool for defining and running multi-container Docker applications -- **pgAdmin**: Web-based PostgreSQL administration tool included in Docker setup +- **pgAdmin**: Web-based PostgreSQL administration tool included in Docker setup -### **Extension** -Manifest v3 on Plasmo +### **Extension** + Manifest v3 on Plasmo ## Future Work - - Add More Connectors. - Patch minor bugs. -- Implement Canvas. +- Implement Canvas. - Complete Hybrid Search. **[Done]** - Add support for file uploads QA. **[Done]** - Shift to WebSockets for Streaming responses. **[Deprecated in favor of AI SDK Stream Protocol]** @@ -227,7 +220,9 @@ Manifest v3 on Plasmo - Basic keyword search page for saved sessions **[Done]** - Multi & Single Document Chat **[Done]** -## Contribute + + +## Contribute Contributions are very welcome! A contribution can be as small as a ⭐ or even finding and creating issues. Fine-tuning the Backend is always desired. @@ -241,3 +236,4 @@ Fine-tuning the Backend is always desired. Star History Chart +