Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add couchbase vectore store support #2303

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions packages/components/credentials/CouchbaseApi.credential.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import { INodeParams, INodeCredential } from '../src/Interface'

class CouchbaseApi implements INodeCredential {
label: string
name: string
version: number
description: string
inputs: INodeParams[]

constructor() {
this.label = 'Couchbase API'
this.name = 'couchbaseApi'
this.version = 1.0
this.inputs = [
{
label: 'Couchbase Connection String',
name: 'connectionString',
type: 'string'
},
{
label: 'Couchbase Username',
name: 'username',
type: 'string'
},
{
label: 'Couchbase Password',
name: 'password',
type: 'password'
}
]
}
}

module.exports = { credClass: CouchbaseApi }
229 changes: 229 additions & 0 deletions packages/components/nodes/vectorstores/Couchbase/Couchbase.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,229 @@
import { flatten } from 'lodash'
import { Embeddings } from '@langchain/core/embeddings'
import { Document } from '@langchain/core/documents'
import { CouchbaseVectorStore, CouchbaseVectorStoreArgs } from '@langchain/community/vectorstores/couchbase'
import { Cluster } from 'couchbase'
import { ICommonObject, INode, INodeData, INodeOutputsValue, INodeParams, IndexingResult } from '../../../src/Interface'
import { getBaseClasses, getCredentialData, getCredentialParam } from '../../../src/utils'
import { resolveVectorStoreOrRetriever } from '../VectorStoreUtils'

class Couchbase_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 = 'Couchbase'
this.name = 'couchbase'
this.version = 1.0
this.type = 'Couchbase'
this.icon = 'couchbase.svg'
this.category = 'Vector Stores'
this.description = `Upsert embedded data and load existing index using Couchbase, a award-winning distributed NoSQL database`
this.baseClasses = [this.type, 'VectorStoreRetriever', 'BaseRetriever']
this.credential = {
label: 'Connect Credential',
name: 'credential',
type: 'credential',
credentialNames: ['couchbaseApi']
}
this.inputs = [
{
label: 'Document',
name: 'document',
type: 'Document',
list: true,
optional: true
},
{
label: 'Embeddings',
name: 'embeddings',
type: 'Embeddings'
},
{
label: 'Bucket Name',
name: 'bucketName',
placeholder: '<DB_BUCKET_NAME>',
type: 'string'
},
{
label: 'Scope Name',
name: 'scopeName',
placeholder: '<SCOPE_NAME>',
type: 'string'
},
{
label: 'Collection Name',
name: 'collectionName',
placeholder: '<COLLECTION_NAME>',
type: 'string'
},
{
label: 'Index Name',
name: 'indexName',
placeholder: '<VECTOR_INDEX_NAME>',
type: 'string'
},
{
label: 'Content Field',
name: 'textKey',
description: 'Name of the field (column) that contains the actual content',
type: 'string',
default: 'text',
additionalParams: true,
optional: true
},
{
label: 'Embedded Field',
name: 'embeddingKey',
description: 'Name of the field (column) that contains the Embedding',
type: 'string',
default: 'embedding',
additionalParams: true,
optional: true
},
prajwal-pai77 marked this conversation as resolved.
Show resolved Hide resolved
{
label: 'Couchbase Metadata Filter',
name: 'couchbaseMetadataFilter',
type: 'json',
optional: true,
additionalParams: 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: 'Couchbase Retriever',
name: 'retriever',
baseClasses: this.baseClasses
},
{
label: 'Couchbase Vector Store',
name: 'vectorStore',
baseClasses: [this.type, ...getBaseClasses(CouchbaseVectorStore)]
}
]
}

//@ts-ignore
vectorStoreMethods = {
async upsert(nodeData: INodeData, options: ICommonObject): Promise<Partial<IndexingResult>> {
const credentialData = await getCredentialData(nodeData.credential ?? '', options)
const bucketName = nodeData.inputs?.bucketName as string
const scopeName = nodeData.inputs?.scopeName as string
const collectionName = nodeData.inputs?.collectionName as string
const indexName = nodeData.inputs?.indexName as string
let textKey = nodeData.inputs?.textKey as string
let embeddingKey = nodeData.inputs?.embeddingKey as string
const embeddings = nodeData.inputs?.embeddings as Embeddings

let connectionString = getCredentialParam('connectionString', credentialData, nodeData)
let databaseUsername = getCredentialParam('username', credentialData, nodeData)
let databasePassword = getCredentialParam('password', credentialData, nodeData)

const docs = nodeData.inputs?.document as Document[]

const flattenDocs = docs && docs.length ? flatten(docs) : []
const finalDocs = []
for (let i = 0; i < flattenDocs.length; i += 1) {
if (flattenDocs[i] && flattenDocs[i].pageContent) {
const document = new Document(flattenDocs[i])
finalDocs.push(document)
}
}

const couchbaseClient = await Cluster.connect(connectionString, {
username: databaseUsername,
password: databasePassword,
configProfile: 'wanDevelopment'
HenryHengZJ marked this conversation as resolved.
Show resolved Hide resolved
})

const couchbaseConfig: CouchbaseVectorStoreArgs = {
cluster: couchbaseClient,
bucketName: bucketName,
scopeName: scopeName,
collectionName: collectionName,
indexName: indexName,
textKey: textKey,
embeddingKey: embeddingKey
}

try {
if (!textKey || textKey === '') couchbaseConfig.textKey = 'text'
if (!embeddingKey || embeddingKey === '') couchbaseConfig.embeddingKey = 'embedding'

await CouchbaseVectorStore.fromDocuments(finalDocs, embeddings, couchbaseConfig)
return { numAdded: finalDocs.length, addedDocs: finalDocs }
} catch (e) {
throw new Error(e)
}
}
}

async init(nodeData: INodeData, _: string, options: ICommonObject): Promise<any> {
const credentialData = await getCredentialData(nodeData.credential ?? '', options)
const bucketName = nodeData.inputs?.bucketName as string
const scopeName = nodeData.inputs?.scopeName as string
const collectionName = nodeData.inputs?.collectionName as string
const indexName = nodeData.inputs?.indexName as string
let textKey = nodeData.inputs?.textKey as string
let embeddingKey = nodeData.inputs?.embeddingKey as string
const embeddings = nodeData.inputs?.embeddings as Embeddings
const couchbaseMetadataFilter = nodeData.inputs?.couchbaseMetadataFilter

let connectionString = getCredentialParam('connectionString', credentialData, nodeData)
let databaseUsername = getCredentialParam('username', credentialData, nodeData)
let databasePassword = getCredentialParam('password', credentialData, nodeData)
let metadatafilter

const couchbaseClient = await Cluster.connect(connectionString, {
username: databaseUsername,
password: databasePassword,
configProfile: 'wanDevelopment'
})

const couchbaseConfig: CouchbaseVectorStoreArgs = {
cluster: couchbaseClient,
bucketName: bucketName,
scopeName: scopeName,
collectionName: collectionName,
indexName: indexName,
textKey: textKey,
embeddingKey: embeddingKey
}

try {
if (!textKey || textKey === '') couchbaseConfig.textKey = 'text'
if (!embeddingKey || embeddingKey === '') couchbaseConfig.embeddingKey = 'embedding'

if (couchbaseMetadataFilter) {
metadatafilter = typeof couchbaseMetadataFilter === 'object' ? couchbaseMetadataFilter : JSON.parse(couchbaseMetadataFilter)
}

const vectorStore = await CouchbaseVectorStore.initialize(embeddings, couchbaseConfig)

return resolveVectorStoreOrRetriever(nodeData, vectorStore, metadatafilter)
} catch (e) {
throw new Error(e)
}
}
}

module.exports = { nodeClass: Couchbase_VectorStores }
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion packages/components/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"@huggingface/inference": "^2.6.1",
"@langchain/anthropic": "^0.1.14",
"@langchain/cohere": "^0.0.7",
"@langchain/community": "^0.0.39",
"@langchain/community": "^0.0.43",
"@langchain/core": "^0.1.57",
"@langchain/google-genai": "^0.0.10",
"@langchain/google-vertexai": "^0.0.5",
Expand All @@ -59,6 +59,7 @@
"assemblyai": "^4.2.2",
"axios": "1.6.2",
"cheerio": "^1.0.0-rc.12",
"couchbase": "4.3.1",
"chromadb": "^1.5.11",
"cohere-ai": "^6.2.0",
"crypto-js": "^4.1.1",
Expand Down
Loading
Loading