253 lines
10 KiB
TypeScript
253 lines
10 KiB
TypeScript
import { flatten } from 'lodash'
|
|
import { Chroma } from '@langchain/community/vectorstores/chroma'
|
|
import { Embeddings } from '@langchain/core/embeddings'
|
|
import { Document } from '@langchain/core/documents'
|
|
import { ICommonObject, INode, INodeData, INodeOutputsValue, INodeParams, IndexingResult } from '../../../src/Interface'
|
|
import { getBaseClasses, getCredentialData, getCredentialParam } from '../../../src/utils'
|
|
import { ChromaExtended } from './core'
|
|
import { index } from '../../../src/indexing'
|
|
|
|
class Chroma_VectorStores implements INode {
|
|
label: string
|
|
name: string
|
|
version: number
|
|
description: string
|
|
type: string
|
|
icon: string
|
|
category: string
|
|
badge: string
|
|
baseClasses: string[]
|
|
inputs: INodeParams[]
|
|
credential: INodeParams
|
|
outputs: INodeOutputsValue[]
|
|
|
|
constructor() {
|
|
this.label = 'Chroma'
|
|
this.name = 'chroma'
|
|
this.version = 2.0
|
|
this.type = 'Chroma'
|
|
this.icon = 'chroma.svg'
|
|
this.category = 'Vector Stores'
|
|
this.description = 'Upsert embedded data and perform similarity search upon query using Chroma, an open-source embedding database'
|
|
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,
|
|
optional: true
|
|
},
|
|
{
|
|
label: 'Embeddings',
|
|
name: 'embeddings',
|
|
type: 'Embeddings'
|
|
},
|
|
{
|
|
label: 'Record Manager',
|
|
name: 'recordManager',
|
|
type: 'RecordManager',
|
|
description: 'Keep track of the record to prevent duplication',
|
|
optional: true
|
|
},
|
|
{
|
|
label: 'Collection Name',
|
|
name: 'collectionName',
|
|
type: 'string'
|
|
},
|
|
{
|
|
label: 'Chroma URL',
|
|
name: 'chromaURL',
|
|
type: 'string',
|
|
optional: true
|
|
},
|
|
{
|
|
label: 'Chroma Metadata Filter',
|
|
name: 'chromaMetadataFilter',
|
|
type: 'json',
|
|
optional: true,
|
|
additionalParams: true,
|
|
acceptVariable: 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)]
|
|
}
|
|
]
|
|
}
|
|
|
|
//@ts-ignore
|
|
vectorStoreMethods = {
|
|
async upsert(nodeData: INodeData, options: ICommonObject): Promise<Partial<IndexingResult>> {
|
|
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 recordManager = nodeData.inputs?.recordManager
|
|
|
|
const credentialData = await getCredentialData(nodeData.credential ?? '', options)
|
|
const chromaApiKey = getCredentialParam('chromaApiKey', credentialData, nodeData)
|
|
const chromaTenant = getCredentialParam('chromaTenant', credentialData, nodeData)
|
|
const chromaDatabase = getCredentialParam('chromaDatabase', credentialData, nodeData)
|
|
|
|
const flattenDocs = docs && docs.length ? flatten(docs) : []
|
|
const finalDocs = []
|
|
for (let i = 0; i < flattenDocs.length; i += 1) {
|
|
if (flattenDocs[i] && flattenDocs[i].pageContent) {
|
|
finalDocs.push(new Document(flattenDocs[i]))
|
|
}
|
|
}
|
|
|
|
const obj: {
|
|
collectionName: string
|
|
url?: string
|
|
chromaApiKey?: string
|
|
chromaTenant?: string
|
|
chromaDatabase?: string
|
|
} = { collectionName }
|
|
if (chromaURL) obj.url = chromaURL
|
|
if (chromaApiKey) obj.chromaApiKey = chromaApiKey
|
|
if (chromaTenant) obj.chromaTenant = chromaTenant
|
|
if (chromaDatabase) obj.chromaDatabase = chromaDatabase
|
|
|
|
try {
|
|
if (recordManager) {
|
|
const vectorStore = await ChromaExtended.fromExistingCollection(embeddings, obj)
|
|
await recordManager.createSchema()
|
|
const res = await index({
|
|
docsSource: finalDocs,
|
|
recordManager,
|
|
vectorStore,
|
|
options: {
|
|
cleanup: recordManager?.cleanup,
|
|
sourceIdKey: recordManager?.sourceIdKey ?? 'source',
|
|
vectorStoreName: collectionName
|
|
}
|
|
})
|
|
return res
|
|
} else {
|
|
await ChromaExtended.fromDocuments(finalDocs, embeddings, obj)
|
|
return { numAdded: finalDocs.length, addedDocs: finalDocs }
|
|
}
|
|
} catch (e) {
|
|
throw new Error(e)
|
|
}
|
|
},
|
|
async delete(nodeData: INodeData, ids: string[], options: ICommonObject): Promise<void> {
|
|
const collectionName = nodeData.inputs?.collectionName as string
|
|
const embeddings = nodeData.inputs?.embeddings as Embeddings
|
|
const chromaURL = nodeData.inputs?.chromaURL as string
|
|
const recordManager = nodeData.inputs?.recordManager
|
|
|
|
const credentialData = await getCredentialData(nodeData.credential ?? '', options)
|
|
const chromaApiKey = getCredentialParam('chromaApiKey', credentialData, nodeData)
|
|
const chromaTenant = getCredentialParam('chromaTenant', credentialData, nodeData)
|
|
const chromaDatabase = getCredentialParam('chromaDatabase', credentialData, nodeData)
|
|
|
|
const obj: {
|
|
collectionName: string
|
|
url?: string
|
|
chromaApiKey?: string
|
|
chromaTenant?: string
|
|
chromaDatabase?: string
|
|
} = { collectionName }
|
|
if (chromaURL) obj.url = chromaURL
|
|
if (chromaApiKey) obj.chromaApiKey = chromaApiKey
|
|
if (chromaTenant) obj.chromaTenant = chromaTenant
|
|
if (chromaDatabase) obj.chromaDatabase = chromaDatabase
|
|
|
|
try {
|
|
if (recordManager) {
|
|
const vectorStoreName = collectionName
|
|
await recordManager.createSchema()
|
|
;(recordManager as any).namespace = (recordManager as any).namespace + '_' + vectorStoreName
|
|
const keys: string[] = await recordManager.listKeys({})
|
|
|
|
const chromaStore = new ChromaExtended(embeddings, obj)
|
|
|
|
await chromaStore.delete({ ids: keys })
|
|
await recordManager.deleteKeys(keys)
|
|
} else {
|
|
const chromaStore = new ChromaExtended(embeddings, obj)
|
|
await chromaStore.delete({ ids })
|
|
}
|
|
} catch (e) {
|
|
throw new Error(e)
|
|
}
|
|
}
|
|
}
|
|
|
|
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 chromaTenant = getCredentialParam('chromaTenant', credentialData, nodeData)
|
|
const chromaDatabase = getCredentialParam('chromaDatabase', credentialData, nodeData)
|
|
const chromaMetadataFilter = nodeData.inputs?.chromaMetadataFilter
|
|
|
|
const obj: {
|
|
collectionName: string
|
|
url?: string
|
|
chromaApiKey?: string
|
|
chromaTenant?: string
|
|
chromaDatabase?: string
|
|
filter?: object | undefined
|
|
} = { collectionName }
|
|
if (chromaURL) obj.url = chromaURL
|
|
if (chromaApiKey) obj.chromaApiKey = chromaApiKey
|
|
if (chromaTenant) obj.chromaTenant = chromaTenant
|
|
if (chromaDatabase) obj.chromaDatabase = chromaDatabase
|
|
if (chromaMetadataFilter) {
|
|
const metadatafilter = typeof chromaMetadataFilter === 'object' ? chromaMetadataFilter : JSON.parse(chromaMetadataFilter)
|
|
obj.filter = metadatafilter
|
|
}
|
|
|
|
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
|
|
if (chromaMetadataFilter) {
|
|
;(vectorStore as any).filter = obj.filter
|
|
}
|
|
return vectorStore
|
|
}
|
|
return vectorStore
|
|
}
|
|
}
|
|
|
|
module.exports = { nodeClass: Chroma_VectorStores }
|