Merge pull request #2 from WillACosta/feature/implement-rag

[AUTOMATED-PR] - main <- feature/implement-rag

Author: WillACosta

.dockerignore

@@ -0,0 +1,107 @@
+# Dependency directories
+node_modules
+pnpm-store
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# IDE / Editor directories
+.idea
+.vscode
+*.swp
+*.swo
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Docker files
+Dockerfile
+docker-compose.yaml
+
+# App
+*.pdf
+docs
+.gitignore

.env-example

@@ -1,4 +1,8 @@
 LANGCHAIN_API_KEY=
 LANGCHAIN_TRACING_V2=true
 LANGCHAIN_CALLBACKS_BACKGROUND=true
-GEMINI_API_KEY=
+
+GOOGLE_GENAI_API_KEY=
+
+REDIS_ENDPOINT_URI=localhost:6379
+REDIS_PASSWORD=redis@dev

.vscode/settings.json

@@ -1,5 +1,6 @@
 {
   "cSpell.words": [
+    "dataproviders",
     "gemini",
     "nodenext",
     "usecases"

README.md

@@ -1,6 +1,6 @@
 ## Gen-AI API with Langchain and NodeJS
 
-This is an Express service written in [TypeScript](https://www.typescriptlang.org/) that provides authorization functionality and includes gen-AI features.
+This is an Express service written in [TypeScript](https://www.typescriptlang.org/) that provides authorization functionality and includes gen-AI features, using RAG concepts, vector database and implements AI memory history with Redis DB.
 
 > 🌱 This project is under development.
 
@@ -12,3 +12,29 @@ This is an Express service written in [TypeScript](https://www.typescriptlang.or
 - [JWT](https://jwt.io/) for handling authentication
 - [GoogleGenAI](https://v02.api.js.langchain.com/modules/_langchain_google_genai.html) langchain plugin.
 - [Google Gemini - API](https://ai.google.dev/)
+- [Docker](https://docs.docker.com/) Containers for setting up environment.
+- [Redis](https://redis.io/) database for storing AI messages.
+
+## Running the application
+
+1. Clone this repository
+
+```shell
+git clone https://github.com/WillACosta/genai-langchain-api
+```
+
+> Copy the `.env.example` file to `.env` and fill it with your own credentials
+
+```shell
+cp .env.example .env
+```
+
+2. You'll need [Docker](https://docs.docker.com/) to setup and running the application services
+
+> From the app's root directory, run the following command to build and running docker containers:
+
+```shell
+docker compose up --build
+```
+
+> The application will be available at `http://localhost:3000`.

docker-compose.yaml

@@ -0,0 +1,40 @@
+version: '3.8'
+
+services:
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    ports:
+      - '3000:3000'
+    env_file:
+      - .env
+    volumes:
+      - ./src:/usr/workspace/app/src
+      - pnpm_store:/pnpm/.pnpm-store
+    command: sh -c "pnpm install && pnpm dev"
+
+  postgres:
+    image: bitnami/postgresql:latest
+    ports:
+      - '5432:5432'
+    environment:
+      - POSTGRES_USER=docker
+      - POSTGRES_PASSWORD=docker
+      - POSTGRES_DB=rag_app
+    volumes:
+      - 'rag_app_postgres_data:/bitnami/postgresql'
+
+  redis:
+    image: bitnami/redis:latest
+    ports:
+      - '6379:6379'
+    environment:
+      - ALLOW_EMPTY_PASSWORD=yes
+    volumes:
+      - 'rag_app_redis_data:/bitnami/redis/data'
+
+volumes:
+  pnpm_store:
+  rag_app_redis_data:
+  rag_app_postgres_data:

dockerfile

@@ -0,0 +1,17 @@
+FROM node:20-alpine
+
+RUN npm install -g [email protected]
+WORKDIR /usr/workspace/app
+
+ENV PNPM_HOME="/pnpm"
+ENV PATH="$PNPM_HOME:$PATH"
+RUN mkdir -p $PNPM_HOME
+
+RUN pnpm config set store-dir "$PNPM_HOME/.pnpm-store" --global
+
+COPY package.json pnpm-lock.yaml* ./
+RUN pnpm install --frozen-lockfile
+COPY . .
+
+EXPOSE 3000
+CMD [ "pnpm", "start" ]

docs/prompts/ai-prompts.md

@@ -0,0 +1,7 @@
+What is this document about?
+
+This document is about AI and chatbot, can you summarize it for me?
+
+Can you list it in a bullet list form?
+
+What was my first question to you?