add auth to chroma

2026-06-28 19:00:59 +03:00 · 2023-08-03 11:52:17 +01:00
parent d8749bd495
commit 3669eeee41
5 changed files with 71 additions and 60 deletions
@@ -0,0 +1,110 @@
+import { ICommonObject, INode, INodeData, INodeOutputsValue, INodeParams } from '../../../src/Interface'
+import { Chroma } from 'langchain/vectorstores/chroma'
+import { Embeddings } from 'langchain/embeddings/base'
+import { getBaseClasses, getCredentialData, getCredentialParam } from '../../../src/utils'
+import { ChromaExtended } from './core'
+
+class Chroma_Existing_VectorStores implements INode {
+    label: string
+    name: string
+    version: number
+    description: string
+    type: string
+    icon: string
+    category: string
+    baseClasses: string[]
+    inputs: INodeParams[]
+    credential: INodeParams
+    outputs: INodeOutputsValue[]
+
+    constructor() {
+        this.label = 'Chroma Load Existing Index'
+        this.name = 'chromaExistingIndex'
+        this.version = 1.0
+        this.type = 'Chroma'
+        this.icon = 'chroma.svg'
+        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',
+                name: 'embeddings',
+                type: 'Embeddings'
+            },
+            {
+                label: 'Collection Name',
+                name: 'collectionName',
+                type: 'string'
+            },
+            {
+                label: 'Chroma URL',
+                name: 'chromaURL',
+                type: 'string',
+                optional: true
+            },
+            {
+                label: 'Top K',
+                name: 'topK',
+                description: 'Number of top results to fetch. Default to 4',
+                placeholder: '4',
+                type: 'number',
+                additionalParams: true,
+                optional: true
+            }
+        ]
+        this.outputs = [
+            {
+                label: 'Chroma Retriever',
+                name: 'retriever',
+                baseClasses: this.baseClasses
+            },
+            {
+                label: 'Chroma Vector Store',
+                name: 'vectorStore',
+                baseClasses: [this.type, ...getBaseClasses(Chroma)]
+            }
+        ]
+    }
+
+    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 ChromaExtended.fromExistingCollection(embeddings, obj)
+
+        if (output === 'retriever') {
+            const retriever = vectorStore.asRetriever(k)
+            return retriever
+        } else if (output === 'vectorStore') {
+            ;(vectorStore as any).k = k
+            return vectorStore
+        }
+        return vectorStore
+    }
+}
+
+module.exports = { nodeClass: Chroma_Existing_VectorStores }
@@ -0,0 +1,125 @@
+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, getCredentialData, getCredentialParam } from '../../../src/utils'
+import { flatten } from 'lodash'
+import { ChromaExtended } from './core'
+
+class ChromaUpsert_VectorStores implements INode {
+    label: string
+    name: string
+    version: number
+    description: string
+    type: string
+    icon: string
+    category: string
+    baseClasses: string[]
+    inputs: INodeParams[]
+    credential: INodeParams
+    outputs: INodeOutputsValue[]
+
+    constructor() {
+        this.label = 'Chroma Upsert Document'
+        this.name = 'chromaUpsert'
+        this.version = 1.0
+        this.type = 'Chroma'
+        this.icon = 'chroma.svg'
+        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',
+                name: 'document',
+                type: 'Document',
+                list: true
+            },
+            {
+                label: 'Embeddings',
+                name: 'embeddings',
+                type: 'Embeddings'
+            },
+            {
+                label: 'Collection Name',
+                name: 'collectionName',
+                type: 'string'
+            },
+            {
+                label: 'Chroma URL',
+                name: 'chromaURL',
+                type: 'string',
+                optional: true
+            },
+            {
+                label: 'Top K',
+                name: 'topK',
+                description: 'Number of top results to fetch. Default to 4',
+                placeholder: '4',
+                type: 'number',
+                additionalParams: true,
+                optional: true
+            }
+        ]
+        this.outputs = [
+            {
+                label: 'Chroma Retriever',
+                name: 'retriever',
+                baseClasses: this.baseClasses
+            },
+            {
+                label: 'Chroma Vector Store',
+                name: 'vectorStore',
+                baseClasses: [this.type, ...getBaseClasses(Chroma)]
+            }
+        ]
+    }
+
+    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
+        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 flattenDocs = docs && docs.length ? flatten(docs) : []
+        const finalDocs = []
+        for (let i = 0; i < flattenDocs.length; i += 1) {
+            finalDocs.push(new Document(flattenDocs[i]))
+        }
+
+        const obj: {
+            collectionName: string
+            url?: string
+            chromaApiKey?: string
+        } = { collectionName }
+        if (chromaURL) obj.url = chromaURL
+        if (chromaApiKey) obj.chromaApiKey = chromaApiKey
+
+        const vectorStore = await ChromaExtended.fromDocuments(finalDocs, embeddings, obj)
+
+        if (output === 'retriever') {
+            const retriever = vectorStore.asRetriever(k)
+            return retriever
+        } else if (output === 'vectorStore') {
+            ;(vectorStore as any).k = k
+            return vectorStore
+        }
+        return vectorStore
+    }
+}
+
+module.exports = { nodeClass: ChromaUpsert_VectorStores }
@@ -0,0 +1,7 @@
+<svg width="209" height="135" viewBox="0 0 209 135" fill="none" xmlns="http://www.w3.org/2000/svg">
+<ellipse cx="136.019" cy="67.2304" rx="66.6667" ry="64" fill="#FFDE2D"/>
+<ellipse cx="69.352" cy="67.2304" rx="66.6667" ry="64" fill="#327EFF"/>
+<path d="M2.68528 67.2304C2.68527 31.8842 32.5329 3.23047 69.3519 3.23047L69.3519 67.2304L2.68528 67.2304Z" fill="#327EFF"/>
+<path d="M136.019 67.2305C136.019 102.577 106.171 131.23 69.3519 131.23L69.3519 67.2305L136.019 67.2305Z" fill="#FF6446"/>
+<path d="M69.352 67.2304C69.352 31.8842 99.1997 3.23047 136.019 3.23047L136.019 67.2304L69.352 67.2304Z" fill="#FF6446"/>
+</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
+    }
+}