Merge pull request #691 from FlowiseAI/feature/ChromaAuth

Feature/chroma auth

Author: HenryHengZJ

packages/components/credentials/ChromaApi.credential.ts

@@ -0,0 +1,24 @@
+import { INodeParams, INodeCredential } from '../src/Interface'
+
+class ChromaApi implements INodeCredential {
+    label: string
+    name: string
+    description: string
+    version: number
+    inputs: INodeParams[]
+
+    constructor() {
+        this.label = 'Chroma API'
+        this.name = 'chromaApi'
+        this.version = 1.0
+        this.inputs = [
+            {
+                label: 'Chroma Api Key',
+                name: 'chromaApiKey',
+                type: 'password'
+            }
+        ]
+    }
+}
+
+module.exports = { credClass: ChromaApi }

packages/components/nodes/vectorstores/Chroma_Existing/Chroma_Existing.ts packages/components/nodes/vectorstores/Chroma/Chroma_Existing.ts

@@ -1,7 +1,8 @@
-import { INode, INodeData, INodeOutputsValue, INodeParams } from '../../../src/Interface'
+import { ICommonObject, INode, INodeData, INodeOutputsValue, INodeParams } from '../../../src/Interface'
 import { Chroma } from 'langchain/vectorstores/chroma'
 import { Embeddings } from 'langchain/embeddings/base'
-import { getBaseClasses } from '../../../src/utils'
+import { getBaseClasses, getCredentialData, getCredentialParam } from '../../../src/utils'
+import { ChromaExtended } from './core'
 
 class Chroma_Existing_VectorStores implements INode {
     label: string
@@ -13,6 +14,7 @@ class Chroma_Existing_VectorStores implements INode {
     category: string
     baseClasses: string[]
     inputs: INodeParams[]
+    credential: INodeParams
     outputs: INodeOutputsValue[]
 
     constructor() {
@@ -24,6 +26,14 @@ class Chroma_Existing_VectorStores implements INode {
         this.category = 'Vector Stores'
         this.description = 'Load existing index from Chroma (i.e: Document has been upserted)'
         this.baseClasses = [this.type, 'VectorStoreRetriever', 'BaseRetriever']
+        this.credential = {
+            label: 'Connect Credential',
+            name: 'credential',
+            type: 'credential',
+            description: 'Only needed if you have chroma on cloud services with X-Api-key',
+            optional: true,
+            credentialNames: ['chromaApi']
+        }
         this.inputs = [
             {
                 label: 'Embeddings',
@@ -65,21 +75,26 @@ class Chroma_Existing_VectorStores implements INode {
         ]
     }
 
-    async init(nodeData: INodeData): Promise<any> {
+    async init(nodeData: INodeData, _: string, options: ICommonObject): Promise<any> {
         const collectionName = nodeData.inputs?.collectionName as string
         const embeddings = nodeData.inputs?.embeddings as Embeddings
         const chromaURL = nodeData.inputs?.chromaURL as string
         const output = nodeData.outputs?.output as string
         const topK = nodeData.inputs?.topK as string
         const k = topK ? parseFloat(topK) : 4
 
+        const credentialData = await getCredentialData(nodeData.credential ?? '', options)
+        const chromaApiKey = getCredentialParam('chromaApiKey', credentialData, nodeData)
+
         const obj: {
             collectionName: string
             url?: string
+            chromaApiKey?: string
         } = { collectionName }
         if (chromaURL) obj.url = chromaURL
+        if (chromaApiKey) obj.chromaApiKey = chromaApiKey
 
-        const vectorStore = await Chroma.fromExistingCollection(embeddings, obj)
+        const vectorStore = await ChromaExtended.fromExistingCollection(embeddings, obj)
 
         if (output === 'retriever') {
             const retriever = vectorStore.asRetriever(k)

packages/components/nodes/vectorstores/Chroma_Upsert/Chroma_Upsert.ts packages/components/nodes/vectorstores/Chroma/Chroma_Upsert.ts

@@ -1,9 +1,10 @@
-import { INode, INodeData, INodeOutputsValue, INodeParams } from '../../../src/Interface'
+import { ICommonObject, INode, INodeData, INodeOutputsValue, INodeParams } from '../../../src/Interface'
 import { Chroma } from 'langchain/vectorstores/chroma'
 import { Embeddings } from 'langchain/embeddings/base'
 import { Document } from 'langchain/document'
-import { getBaseClasses } from '../../../src/utils'
+import { getBaseClasses, getCredentialData, getCredentialParam } from '../../../src/utils'
 import { flatten } from 'lodash'
+import { ChromaExtended } from './core'
 
 class ChromaUpsert_VectorStores implements INode {
     label: string
@@ -15,6 +16,7 @@ class ChromaUpsert_VectorStores implements INode {
     category: string
     baseClasses: string[]
     inputs: INodeParams[]
+    credential: INodeParams
     outputs: INodeOutputsValue[]
 
     constructor() {
@@ -26,6 +28,14 @@ class ChromaUpsert_VectorStores implements INode {
         this.category = 'Vector Stores'
         this.description = 'Upsert documents to Chroma'
         this.baseClasses = [this.type, 'VectorStoreRetriever', 'BaseRetriever']
+        this.credential = {
+            label: 'Connect Credential',
+            name: 'credential',
+            type: 'credential',
+            description: 'Only needed if you have chroma on cloud services with X-Api-key',
+            optional: true,
+            credentialNames: ['chromaApi']
+        }
         this.inputs = [
             {
                 label: 'Document',
@@ -73,7 +83,7 @@ class ChromaUpsert_VectorStores implements INode {
         ]
     }
 
-    async init(nodeData: INodeData): Promise<any> {
+    async init(nodeData: INodeData, _: string, options: ICommonObject): Promise<any> {
         const collectionName = nodeData.inputs?.collectionName as string
         const docs = nodeData.inputs?.document as Document[]
         const embeddings = nodeData.inputs?.embeddings as Embeddings
@@ -82,6 +92,9 @@ class ChromaUpsert_VectorStores implements INode {
         const topK = nodeData.inputs?.topK as string
         const k = topK ? parseFloat(topK) : 4
 
+        const credentialData = await getCredentialData(nodeData.credential ?? '', options)
+        const chromaApiKey = getCredentialParam('chromaApiKey', credentialData, nodeData)
+
         const flattenDocs = docs && docs.length ? flatten(docs) : []
         const finalDocs = []
         for (let i = 0; i < flattenDocs.length; i += 1) {
@@ -91,10 +104,12 @@ class ChromaUpsert_VectorStores implements INode {
         const obj: {
             collectionName: string
             url?: string
+            chromaApiKey?: string
         } = { collectionName }
         if (chromaURL) obj.url = chromaURL
+        if (chromaApiKey) obj.chromaApiKey = chromaApiKey
 
-        const vectorStore = await Chroma.fromDocuments(finalDocs, embeddings, obj)
+        const vectorStore = await ChromaExtended.fromDocuments(finalDocs, embeddings, obj)
 
         if (output === 'retriever') {
             const retriever = vectorStore.asRetriever(k)

packages/components/nodes/vectorstores/Chroma_Existing/chroma.svg packages/components/nodes/vectorstores/Chroma/chroma.svg

@@ -0,0 +1,49 @@
+import { Chroma, ChromaLibArgs } from 'langchain/vectorstores/chroma'
+import { Embeddings } from 'langchain/embeddings/base'
+import type { Collection } from 'chromadb'
+
+interface ChromaAuth {
+    chromaApiKey?: string
+}
+
+export class ChromaExtended extends Chroma {
+    chromaApiKey?: string
+
+    constructor(embeddings: Embeddings, args: ChromaLibArgs & Partial<ChromaAuth>) {
+        super(embeddings, args)
+        this.chromaApiKey = args.chromaApiKey
+    }
+
+    static async fromExistingCollection(embeddings: Embeddings, dbConfig: ChromaLibArgs & Partial<ChromaAuth>): Promise<Chroma> {
+        const instance = new this(embeddings, dbConfig)
+        await instance.ensureCollection()
+        return instance
+    }
+
+    async ensureCollection(): Promise<Collection> {
+        if (!this.collection) {
+            if (!this.index) {
+                const { ChromaClient } = await Chroma.imports()
+                const obj: any = {
+                    path: this.url
+                }
+                if (this.chromaApiKey) {
+                    obj.fetchOptions = {
+                        headers: {
+                            'X-Api-Key': this.chromaApiKey
+                        }
+                    }
+                }
+                this.index = new ChromaClient(obj)
+            }
+            try {
+                this.collection = await this.index.getOrCreateCollection({
+                    name: this.collectionName
+                })
+            } catch (err) {
+                throw new Error(`Chroma getOrCreateCollection error: ${err}`)
+            }
+        }
+        return this.collection
+    }
+}

packages/components/nodes/vectorstores/Chroma/core.ts

@@ -29,7 +29,7 @@
         "@types/jsdom": "^21.1.1",
         "axios": "^0.27.2",
         "cheerio": "^1.0.0-rc.12",
-        "chromadb": "^1.4.2",
+        "chromadb": "^1.5.3",
         "cohere-ai": "^6.2.0",
         "d3-dsv": "2",
         "dotenv": "^16.0.0",