diff --git a/README.md b/README.md index ce83577..48862a0 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@
-
+
@@ -23,14 +23,15 @@
OCI CIS AI Agent is a self-hosted web application that automates **CIS Oracle Cloud Infrastructure Foundations Benchmark 3.0** compliance checks, powered by **OCI Generative AI** for intelligent analysis and an **MCP (Model Context Protocol)** server architecture for extensible task execution.
-The platform combines security compliance scanning, AI-powered chat, infrastructure exploration, and vector-based knowledge storage into a single, containerized solution with Oracle Cloud's official light theme.
+The platform combines security compliance scanning, AI-powered chat with **RAG (Retrieval-Augmented Generation)**, infrastructure exploration, and vector-based knowledge storage into a single, containerized solution with Oracle Cloud's official light theme.
---
## Features
-### ๐ค AI Chat Agent
+### ๐ค AI Chat Agent with RAG
- **OCI Generative AI** integration via official SDK (`oci.generative_ai_inference`)
+- **RAG (Retrieval-Augmented Generation)**: automatically queries ADB vector store for relevant context before generating responses
- 12 models across 4 providers: **Cohere** (Command A/R/R+), **Meta** (Llama 4/3.3/3.2/3.1), **Google** (Gemini 2.5), **xAI** (Grok 3/4)
- 16 OCI regions supported with auto-generated endpoints
- Full parameter control: temperature, max_tokens, top_p, top_k, frequency/presence penalty
@@ -63,6 +64,15 @@ The platform combines security compliance scanning, AI-powered chat, infrastruct
- Wallet ZIP upload and automatic extraction
- Connection testing
- Configurable embeddings table name (default: `CIS_EMBEDDINGS`)
+- Link to GenAI config for embedding generation via OCI GenAI
+
+### ๐งฌ Embeddings Management
+- Dedicated tab for managing vector embeddings
+- **Embed CIS Reports**: automatically chunk reports by section (IAM, Networking, Compute, etc.) and generate embeddings
+- **Upload text files**: upload `.txt` files, automatically chunked by paragraphs
+- **OCI GenAI Embeddings**: uses Cohere Embed models (v3.0, multilingual, light) via OCI GenAI `embed_text` API
+- Browse, inspect and delete individual embeddings from the ADB vector store
+- 4 embedding models supported: Cohere Embed English/Multilingual v3.0 (1024d), Light variants (384d)
### ๐ Security
- **JWT authentication** with configurable expiry
@@ -92,6 +102,9 @@ The platform combines security compliance scanning, AI-powered chat, infrastruct
โ โ โ MCP Servers โโโโถ Tools โ โ
โ โ โโโโโโโโโโโโโโโค โ โ
โ โ โ oracledb โโโโถ ADB โ โ
+โ โ โโโโโโโโโโโโโโโค โ โ
+โ โ โ RAG Pipeline โโโโถ Embed + โ โ
+โ โ โ โ Search โ โ
โ โ โโโโโโโโโโโโโโโ โ โ
โ โ โ โ
โ โ SQLite (agent.db) โ โ
@@ -208,14 +221,27 @@ Register MCP servers for extended task execution:
MCP servers can be **linked to ADB Vector** databases, enabling them to use the vector store as a tool during report execution.
-### Step 4 โ ADB Vector (Optional)
+### Step 4 โ ADB Vector + RAG (Optional)
-For persistent vector storage of CIS findings and embeddings:
+For persistent vector storage and RAG-powered chat:
1. Add DSN (TNS name from tnsnames.ora, e.g., `myatp_high`)
2. Set credentials (username/password)
-3. Upload Wallet ZIP (for mTLS)
-4. Test the connection
+3. Select a **GenAI Config** (for embedding generation via OCI GenAI)
+4. Select an **Embedding Model** (Cohere Embed v3.0 recommended)
+5. Upload Wallet ZIP (for mTLS)
+6. Test the connection
+7. Click **Create Table** to initialize the embeddings table in ADB
+
+### Step 5 โ Embeddings (Optional)
+
+Navigate to the **Embeddings** tab to populate the vector store:
+
+1. **From CIS Reports**: Select a completed report and generate embeddings (1 per section)
+2. **From text files**: Upload `.txt` files for automatic chunking and embedding
+3. Browse and manage existing embeddings
+
+Once embeddings exist, the **chat automatically uses RAG** โ it queries the ADB vector store for relevant context before generating responses with the selected GenAI model.
---
@@ -241,12 +267,12 @@ Allow group