From f2f8ed6a9ce1ab41bd69193ce283757cd28cb16e Mon Sep 17 00:00:00 2001
From: vinodkiran <vinodkiran@usa.net>
Date: Fri, 22 Dec 2023 12:12:25 +0530
Subject: [PATCH] Compression Retriever - LLM filter

---
 .../LLMFilterCompressionRetriever.ts          | 60 +++++++++++++++++++
 .../compressionRetriever.svg                  |  7 +++
 2 files changed, 67 insertions(+)
 create mode 100644 packages/components/nodes/retrievers/LLMFilterRetriever/LLMFilterCompressionRetriever.ts
 create mode 100644 packages/components/nodes/retrievers/LLMFilterRetriever/compressionRetriever.svg

diff --git a/packages/components/nodes/retrievers/LLMFilterRetriever/LLMFilterCompressionRetriever.ts b/packages/components/nodes/retrievers/LLMFilterRetriever/LLMFilterCompressionRetriever.ts
new file mode 100644
index 000000000..c421c7ce1
--- /dev/null
+++ b/packages/components/nodes/retrievers/LLMFilterRetriever/LLMFilterCompressionRetriever.ts
@@ -0,0 +1,60 @@
+import { INode, INodeData, INodeOutputsValue, INodeParams } from '../../../src/Interface'
+import { BaseRetriever } from 'langchain/schema/retriever'
+import { ContextualCompressionRetriever } from 'langchain/retrievers/contextual_compression'
+import { BaseLanguageModel } from 'langchain/base_language'
+import { LLMChainExtractor } from 'langchain/retrievers/document_compressors/chain_extract'
+
+class LLMFilterCompressionRetriever_Retrievers implements INode {
+    label: string
+    name: string
+    version: number
+    description: string
+    type: string
+    icon: string
+    category: string
+    baseClasses: string[]
+    inputs: INodeParams[]
+    outputs: INodeOutputsValue[]
+    badge: string
+
+    constructor() {
+        this.label = 'LLM Filter Retriever'
+        this.name = 'llmFilterRetriever'
+        this.version = 1.0
+        this.type = 'LLMFilterRetriever'
+        this.icon = 'compressionRetriever.svg'
+        this.category = 'Retrievers'
+        this.badge = 'NEW'
+        this.description =
+            'Iterate over the initially returned documents and extract, from each, only the content that is relevant to the query'
+        this.baseClasses = [this.type, 'BaseRetriever']
+        this.inputs = [
+            {
+                label: 'Base Retriever',
+                name: 'baseRetriever',
+                type: 'VectorStoreRetriever'
+            },
+            {
+                label: 'Language Model',
+                name: 'model',
+                type: 'BaseLanguageModel',
+                optional: true
+            },
+        ]
+    }
+
+    async init(nodeData: INodeData): Promise<any> {
+        const baseRetriever = nodeData.inputs?.baseRetriever as BaseRetriever
+        const model = nodeData.inputs?.model as BaseLanguageModel
+
+        if (model) {
+            return new ContextualCompressionRetriever({
+                baseCompressor: LLMChainExtractor.fromLLM(model),
+                baseRetriever: baseRetriever
+            })
+        }
+        return {}
+    }
+}
+
+module.exports = { nodeClass: LLMFilterCompressionRetriever_Retrievers }
diff --git a/packages/components/nodes/retrievers/LLMFilterRetriever/compressionRetriever.svg b/packages/components/nodes/retrievers/LLMFilterRetriever/compressionRetriever.svg
new file mode 100644
index 000000000..23c52d25e
--- /dev/null
+++ b/packages/components/nodes/retrievers/LLMFilterRetriever/compressionRetriever.svg
@@ -0,0 +1,7 @@
+<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-chart-bar" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round">
+   <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
+   <path d="M3 12m0 1a1 1 0 0 1 1 -1h4a1 1 0 0 1 1 1v6a1 1 0 0 1 -1 1h-4a1 1 0 0 1 -1 -1z" />
+   <path d="M9 8m0 1a1 1 0 0 1 1 -1h4a1 1 0 0 1 1 1v10a1 1 0 0 1 -1 1h-4a1 1 0 0 1 -1 -1z" />
+   <path d="M15 4m0 1a1 1 0 0 1 1 -1h4a1 1 0 0 1 1 1v14a1 1 0 0 1 -1 1h-4a1 1 0 0 1 -1 -1z" />
+   <path d="M4 20l14 0" />
+</svg>
\ No newline at end of file