feat(Postgres PGVector Store Node): Add PGVector vector store node (#…

…10517)

packages/@n8n/nodes-langchain/nodes/vector_store/VectorStorePGVector/VectorStorePGVector.node.ts

@@ -0,0 +1,276 @@
+import { type INodeProperties } from 'n8n-workflow';
+import {
+	PGVectorStore,
+	type DistanceStrategy,
+	type PGVectorStoreArgs,
+} from '@langchain/community/vectorstores/pgvector';
+import { configurePostgres } from 'n8n-nodes-base/dist/nodes/Postgres/v2/transport';
+import type { PostgresNodeCredentials } from 'n8n-nodes-base/dist/nodes/Postgres/v2/helpers/interfaces';
+import type pg from 'pg';
+import { createVectorStoreNode } from '../shared/createVectorStoreNode';
+import { metadataFilterField } from '../../../utils/sharedFields';
+
+type CollectionOptions = {
+	useCollection?: boolean;
+	collectionName?: string;
+	collectionTableName?: string;
+};
+
+type ColumnOptions = {
+	idColumnName: string;
+	vectorColumnName: string;
+	contentColumnName: string;
+	metadataColumnName: string;
+};
+
+const sharedFields: INodeProperties[] = [
+	{
+		displayName: 'Table Name',
+		name: 'tableName',
+		type: 'string',
+		default: 'n8n_vectors',
+		description:
+			'The table name to store the vectors in. If table does not exist, it will be created.',
+	},
+];
+
+const collectionField: INodeProperties = {
+	displayName: 'Collection',
+	name: 'collection',
+	type: 'fixedCollection',
+	description: 'Collection of vectors',
+	default: {
+		values: {
+			useCollection: false,
+			collectionName: 'n8n',
+			collectionTable: 'n8n_vector_collections',
+		},
+	},
+	typeOptions: {},
+	placeholder: 'Add Collection Settings',
+	options: [
+		{
+			name: 'values',
+			displayName: 'Collection Settings',
+			values: [
+				{
+					displayName: 'Use Collection',
+					name: 'useCollection',
+					type: 'boolean',
+					default: false,
+				},
+				{
+					displayName: 'Collection Name',
+					name: 'collectionName',
+					type: 'string',
+					default: 'n8n',
+					required: true,
+					displayOptions: { show: { useCollection: [true] } },
+				},
+				{
+					displayName: 'Collection Table Name',
+					name: 'collectionTableName',
+					type: 'string',
+					default: 'n8n_vector_collections',
+					required: true,
+					displayOptions: { show: { useCollection: [true] } },
+				},
+			],
+		},
+	],
+};
+
+const columnNamesField: INodeProperties = {
+	displayName: 'Column Names',
+	name: 'columnNames',
+	type: 'fixedCollection',
+	description: 'The names of the columns in the PGVector table',
+	default: {
+		values: {
+			idColumnName: 'id',
+			vectorColumnName: 'embedding',
+			contentColumnName: 'text',
+			metadataColumnName: 'metadata',
+		},
+	},
+	typeOptions: {},
+	placeholder: 'Set Column Names',
+	options: [
+		{
+			name: 'values',
+			displayName: 'Column Name Settings',
+			values: [
+				{
+					displayName: 'ID Column Name',
+					name: 'idColumnName',
+					type: 'string',
+					default: 'id',
+					required: true,
+				},
+				{
+					displayName: 'Vector Column Name',
+					name: 'vectorColumnName',
+					type: 'string',
+					default: 'embedding',
+					required: true,
+				},
+				{
+					displayName: 'Content Column Name',
+					name: 'contentColumnName',
+					type: 'string',
+					default: 'text',
+					required: true,
+				},
+				{
+					displayName: 'Metadata Column Name',
+					name: 'metadataColumnName',
+					type: 'string',
+					default: 'metadata',
+					required: true,
+				},
+			],
+		},
+	],
+};
+
+const distanceStrategyField: INodeProperties = {
+	displayName: 'Distance Strategy',
+	name: 'distanceStrategy',
+	type: 'options',
+	default: 'cosine',
+	description: 'The method to calculate the distance between two vectors',
+	options: [
+		{
+			name: 'Cosine',
+			value: 'cosine',
+		},
+		{
+			name: 'Inner Product',
+			value: 'innerProduct',
+		},
+		{
+			name: 'Euclidean',
+			value: 'euclidean',
+		},
+	],
+};
+
+const insertFields: INodeProperties[] = [
+	{
+		displayName: 'Options',
+		name: 'options',
+		type: 'collection',
+		placeholder: 'Add Option',
+		default: {},
+		options: [collectionField, columnNamesField],
+	},
+];
+
+const retrieveFields: INodeProperties[] = [
+	{
+		displayName: 'Options',
+		name: 'options',
+		type: 'collection',
+		placeholder: 'Add Option',
+		default: {},
+		options: [distanceStrategyField, collectionField, columnNamesField, metadataFilterField],
+	},
+];
+
+export const VectorStorePGVector = createVectorStoreNode({
+	meta: {
+		description: 'Work with your data in Postgresql with the PGVector extension',
+		icon: 'file:postgres.svg',
+		displayName: 'Postgres PGVector Store',
+		docsUrl:
+			'https://docs.n8n.io/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoresupabase/',
+		name: 'vectorStorePGVector',
+		credentials: [
+			{
+				name: 'postgres',
+				required: true,
+				testedBy: 'postgresConnectionTest',
+			},
+		],
+		operationModes: ['load', 'insert', 'retrieve'],
+	},
+	sharedFields,
+	insertFields,
+	loadFields: retrieveFields,
+	retrieveFields,
+	async getVectorStoreClient(context, filter, embeddings, itemIndex) {
+		const tableName = context.getNodeParameter('tableName', itemIndex, '', {
+			extractValue: true,
+		}) as string;
+		const credentials = await context.getCredentials('postgres');
+		const pgConf = await configurePostgres.call(context, credentials as PostgresNodeCredentials);
+		const pool = pgConf.db.$pool as unknown as pg.Pool;
+
+		const config: PGVectorStoreArgs = {
+			pool,
+			tableName,
+			filter,
+		};
+
+		const collectionOptions = context.getNodeParameter(
+			'options.collection.values',
+			0,
+			{},
+		) as CollectionOptions;
+
+		if (collectionOptions && collectionOptions.useCollection) {
+			config.collectionName = collectionOptions.collectionName;
+			config.collectionTableName = collectionOptions.collectionTableName;
+		}
+
+		config.columns = context.getNodeParameter('options.columnNames.values', 0, {
+			idColumnName: 'id',
+			vectorColumnName: 'embedding',
+			contentColumnName: 'text',
+			metadataColumnName: 'metadata',
+		}) as ColumnOptions;
+
+		config.distanceStrategy = context.getNodeParameter(
+			'options.distanceStrategy',
+			0,
+			'cosine',
+		) as DistanceStrategy;
+
+		return await PGVectorStore.initialize(embeddings, config);
+	},
+	async populateVectorStore(context, embeddings, documents, itemIndex) {
+		// NOTE: if you are to create the HNSW index before use, you need to consider moving the distanceStrategy field to
+		// shared fields, because you need that strategy when creating the index.
+		const tableName = context.getNodeParameter('tableName', itemIndex, '', {
+			extractValue: true,
+		}) as string;
+		const credentials = await context.getCredentials('postgres');
+		const pgConf = await configurePostgres.call(context, credentials as PostgresNodeCredentials);
+		const pool = pgConf.db.$pool as unknown as pg.Pool;
+
+		const config: PGVectorStoreArgs = {
+			pool,
+			tableName,
+		};
+
+		const collectionOptions = context.getNodeParameter(
+			'options.collection.values',
+			0,
+			{},
+		) as CollectionOptions;
+
+		if (collectionOptions && collectionOptions.useCollection) {
+			config.collectionName = collectionOptions.collectionName;
+			config.collectionTableName = collectionOptions.collectionTableName;
+		}
+
+		config.columns = context.getNodeParameter('options.columnNames.values', 0, {
+			idColumnName: 'id',
+			vectorColumnName: 'embedding',
+			contentColumnName: 'text',
+			metadataColumnName: 'metadata',
+		}) as ColumnOptions;
+
+		await PGVectorStore.fromDocuments(documents, embeddings, config);
+	},
+});

packages/@n8n/nodes-langchain/package.json

@@ -108,6 +108,7 @@
       "dist/nodes/vector_store/VectorStoreInMemory/VectorStoreInMemory.node.js",
       "dist/nodes/vector_store/VectorStoreInMemoryInsert/VectorStoreInMemoryInsert.node.js",
       "dist/nodes/vector_store/VectorStoreInMemoryLoad/VectorStoreInMemoryLoad.node.js",
+      "dist/nodes/vector_store/VectorStorePGVector/VectorStorePGVector.node.js",
       "dist/nodes/vector_store/VectorStorePinecone/VectorStorePinecone.node.js",
       "dist/nodes/vector_store/VectorStorePineconeInsert/VectorStorePineconeInsert.node.js",
       "dist/nodes/vector_store/VectorStorePineconeLoad/VectorStorePineconeLoad.node.js",