feat(Google Vertex Chat Model Node): Add support for Google Vertex AI Chat models (#9970)

Co-authored-by: oleg <oleg@n8n.io>

packages/@n8n/nodes-langchain/nodes/llms/LmChatGoogleVertex/LmChatGoogleVertex.node.ts

@@ -0,0 +1,200 @@
+/* eslint-disable n8n-nodes-base/node-dirname-against-convention */
+import {
+	NodeConnectionType,
+	type IExecuteFunctions,
+	type INodeType,
+	type INodeTypeDescription,
+	type SupplyData,
+	type ILoadOptionsFunctions,
+	type JsonObject,
+	NodeOperationError,
+} from 'n8n-workflow';
+import { ChatVertexAI } from '@langchain/google-vertexai';
+import type { SafetySetting } from '@google/generative-ai';
+import { ProjectsClient } from '@google-cloud/resource-manager';
+import { getConnectionHintNoticeField } from '../../../utils/sharedFields';
+import { N8nLlmTracing } from '../N8nLlmTracing';
+import { makeErrorFromStatus } from './error-handling';
+import { additionalOptions } from '../gemini-common/additional-options';
+
+export class LmChatGoogleVertex implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Google Vertex Chat Model',
+		// eslint-disable-next-line n8n-nodes-base/node-class-description-name-miscased
+		name: 'lmChatGoogleVertex',
+		icon: 'file:google.svg',
+		group: ['transform'],
+		version: 1,
+		description: 'Chat Model Google Vertex',
+		defaults: {
+			name: 'Google Vertex Chat Model',
+		},
+		codex: {
+			categories: ['AI'],
+			subcategories: {
+				AI: ['Language Models'],
+			},
+			resources: {
+				primaryDocumentation: [
+					{
+						url: 'https://docs.n8n.io/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatgooglevertex/',
+					},
+				],
+			},
+		},
+		// eslint-disable-next-line n8n-nodes-base/node-class-description-inputs-wrong-regular-node
+		inputs: [],
+		// eslint-disable-next-line n8n-nodes-base/node-class-description-outputs-wrong
+		outputs: [NodeConnectionType.AiLanguageModel],
+		outputNames: ['Model'],
+		credentials: [
+			{
+				name: 'googleApi',
+				required: true,
+			},
+		],
+		properties: [
+			getConnectionHintNoticeField([NodeConnectionType.AiChain, NodeConnectionType.AiAgent]),
+			{
+				displayName: 'Project ID',
+				name: 'projectId',
+				type: 'resourceLocator',
+				default: { mode: 'list', value: '' },
+				required: true,
+				description: 'Select or enter your Google Cloud project ID',
+				modes: [
+					{
+						displayName: 'From List',
+						name: 'list',
+						type: 'list',
+						typeOptions: {
+							searchListMethod: 'gcpProjectsList',
+						},
+					},
+					{
+						displayName: 'ID',
+						name: 'id',
+						type: 'string',
+					},
+				],
+			},
+			{
+				displayName: 'Model Name',
+				name: 'modelName',
+				type: 'string',
+				description:
+					'The model which will generate the completion. <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models">Learn more</a>.',
+				default: 'gemini-1.5-flash',
+			},
+			additionalOptions,
+		],
+	};
+
+	methods = {
+		listSearch: {
+			async gcpProjectsList(this: ILoadOptionsFunctions) {
+				const results: Array<{ name: string; value: string }> = [];
+
+				const credentials = await this.getCredentials('googleApi');
+
+				const client = new ProjectsClient({
+					credentials: {
+						client_email: credentials.email as string,
+						private_key: credentials.privateKey as string,
+					},
+				});
+
+				const [projects] = await client.searchProjects();
+
+				for (const project of projects) {
+					if (project.projectId) {
+						results.push({
+							name: project.displayName ?? project.projectId,
+							value: project.projectId,
+						});
+					}
+				}
+
+				return { results };
+			},
+		},
+	};
+
+	async supplyData(this: IExecuteFunctions, itemIndex: number): Promise<SupplyData> {
+		const credentials = await this.getCredentials('googleApi');
+
+		const modelName = this.getNodeParameter('modelName', itemIndex) as string;
+
+		const projectId = this.getNodeParameter('projectId', itemIndex, '', {
+			extractValue: true,
+		}) as string;
+
+		const options = this.getNodeParameter('options', itemIndex, {
+			maxOutputTokens: 2048,
+			temperature: 0.4,
+			topK: 40,
+			topP: 0.9,
+		}) as {
+			maxOutputTokens: number;
+			temperature: number;
+			topK: number;
+			topP: number;
+		};
+
+		const safetySettings = this.getNodeParameter(
+			'options.safetySettings.values',
+			itemIndex,
+			null,
+		) as SafetySetting[];
+
+		try {
+			const model = new ChatVertexAI({
+				authOptions: {
+					projectId,
+					credentials: {
+						client_email: credentials.email as string,
+						private_key: credentials.privateKey as string,
+					},
+				},
+				model: modelName,
+				topK: options.topK,
+				topP: options.topP,
+				temperature: options.temperature,
+				maxOutputTokens: options.maxOutputTokens,
+				safetySettings,
+				callbacks: [new N8nLlmTracing(this)],
+				// Handle ChatVertexAI invocation errors to provide better error messages
+				onFailedAttempt: (error: any) => {
+					const customError = makeErrorFromStatus(Number(error?.response?.status), {
+						modelName,
+					});
+
+					if (customError) {
+						throw new NodeOperationError(this.getNode(), error as JsonObject, customError);
+					}
+
+					throw error;
+				},
+			});
+
+			return {
+				response: model,
+			};
+		} catch (e) {
+			// Catch model name validation error from LangChain (https://github.com/langchain-ai/langchainjs/blob/ef201d0ee85ee4049078270a0cfd7a1767e624f8/libs/langchain-google-common/src/utils/common.ts#L124)
+			// to show more helpful error message
+			if (e?.message?.startsWith('Unable to verify model params')) {
+				throw new NodeOperationError(this.getNode(), e as JsonObject, {
+					message: 'Unsupported model',
+					description: "Only models starting with 'gemini' are supported.",
+				});
+			}
+
+			// Assume all other exceptions while creating a new ChatVertexAI instance are parameter validation errors
+			throw new NodeOperationError(this.getNode(), e as JsonObject, {
+				message: 'Invalid options',
+				description: e.message,
+			});
+		}
+	}
+}

packages/@n8n/nodes-langchain/nodes/llms/LmChatGoogleVertex/error-handling.ts

@@ -0,0 +1,25 @@
+export interface ErrorLike {
+	message?: string;
+	description?: string;
+}
+
+export interface ErrorContext {
+	modelName?: string;
+}
+
+export function makeErrorFromStatus(statusCode: number, context?: ErrorContext): ErrorLike {
+	const errorMessages: Record<number, ErrorLike> = {
+		403: {
+			message: 'Unauthorized for this project',
+			description:
+				'Check your Google Cloud project ID, and that your credential has access to that project',
+		},
+		404: {
+			message: context?.modelName
+				? `No model found called '${context.modelName}'`
+				: 'No model found',
+		},
+	};
+
+	return errorMessages[statusCode];
+}

packages/@n8n/nodes-langchain/nodes/llms/LmChatGoogleVertex/google.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 48 48"><defs><path id="a" d="M44.5 20H24v8.5h11.8C34.7 33.9 30.1 37 24 37c-7.2 0-13-5.8-13-13s5.8-13 13-13c3.1 0 5.9 1.1 8.1 2.9l6.4-6.4C34.6 4.1 29.6 2 24 2 11.8 2 2 11.8 2 24s9.8 22 22 22c11 0 21-8 21-22 0-1.3-.2-2.7-.5-4"/></defs><clipPath id="b"><use xlink:href="#a" overflow="visible"/></clipPath><path fill="#FBBC05" d="M0 37V11l17 13z" clip-path="url(#b)"/><path fill="#EA4335" d="m0 11 17 13 7-6.1L48 14V0H0z" clip-path="url(#b)"/><path fill="#34A853" d="m0 37 30-23 7.9 1L48 0v48H0z" clip-path="url(#b)"/><path fill="#4285F4" d="M48 48 17 24l-4-3 35-10z" clip-path="url(#b)"/></svg>