first commit

packages/@n8n/nodes-langchain/nodes/embeddings/EmbeddingsAzureOpenAi/EmbeddingsAzureOpenAi.node.ts

@@ -0,0 +1,169 @@
+import { AzureOpenAIEmbeddings } from '@langchain/openai';
+import { getProxyAgent, logWrapper, getConnectionHintNoticeField } from '@n8n/ai-utilities';
+import {
+	NodeConnectionTypes,
+	type INodeType,
+	type INodeTypeDescription,
+	type ISupplyDataFunctions,
+	type SupplyData,
+} from 'n8n-workflow';
+
+export class EmbeddingsAzureOpenAi implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Embeddings Azure OpenAI',
+		name: 'embeddingsAzureOpenAi',
+		icon: 'file:azure.svg',
+		credentials: [
+			{
+				name: 'azureOpenAiApi',
+				required: true,
+			},
+		],
+		group: ['transform'],
+		version: 1,
+		description: 'Use Embeddings Azure OpenAI',
+		defaults: {
+			name: 'Embeddings Azure OpenAI',
+		},
+
+		codex: {
+			categories: ['AI'],
+			subcategories: {
+				AI: ['Embeddings'],
+			},
+			resources: {
+				primaryDocumentation: [
+					{
+						url: 'https://docs.n8n.io/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingsazureopenai/',
+					},
+				],
+			},
+		},
+
+		inputs: [],
+
+		outputs: [NodeConnectionTypes.AiEmbedding],
+		outputNames: ['Embeddings'],
+		properties: [
+			getConnectionHintNoticeField([NodeConnectionTypes.AiVectorStore]),
+			{
+				displayName: 'Model (Deployment) Name',
+				name: 'model',
+				type: 'string',
+				description: 'The name of the model(deployment) to use',
+				default: '',
+			},
+			{
+				displayName: 'Options',
+				name: 'options',
+				placeholder: 'Add Option',
+				description: 'Additional options to add',
+				type: 'collection',
+				default: {},
+				options: [
+					{
+						displayName: 'Batch Size',
+						name: 'batchSize',
+						default: 512,
+						typeOptions: { maxValue: 2048 },
+						description: 'Maximum number of documents to send in each request',
+						type: 'number',
+					},
+					{
+						displayName: 'Strip New Lines',
+						name: 'stripNewLines',
+						default: true,
+						description: 'Whether to strip new lines from the input text',
+						type: 'boolean',
+					},
+					{
+						displayName: 'Timeout',
+						name: 'timeout',
+						default: -1,
+						description:
+							'Maximum amount of time a request is allowed to take in seconds. Set to -1 for no timeout.',
+						type: 'number',
+					},
+					{
+						displayName: 'Dimensions',
+						name: 'dimensions',
+						default: 1536,
+						description:
+							'The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.',
+						type: 'options',
+						options: [
+							{
+								name: '256',
+								value: 256,
+							},
+							{
+								name: '512',
+								value: 512,
+							},
+							{
+								name: '1024',
+								value: 1024,
+							},
+							{
+								name: '1536',
+								value: 1536,
+							},
+							{
+								name: '3072',
+								value: 3072,
+							},
+						],
+					},
+				],
+			},
+		],
+	};
+
+	async supplyData(this: ISupplyDataFunctions, itemIndex: number): Promise<SupplyData> {
+		this.logger.debug('Supply data for embeddings');
+		const credentials = await this.getCredentials<{
+			apiKey: string;
+			resourceName: string;
+			apiVersion: string;
+			endpoint?: string;
+		}>('azureOpenAiApi');
+		const modelName = this.getNodeParameter('model', itemIndex) as string;
+
+		const options = this.getNodeParameter('options', itemIndex, {}) as {
+			batchSize?: number;
+			stripNewLines?: boolean;
+			timeout?: number;
+			dimensions?: number | undefined;
+		};
+
+		if (options.timeout === -1) {
+			options.timeout = undefined;
+		}
+
+		const embeddings = new AzureOpenAIEmbeddings({
+			azureOpenAIApiDeploymentName: modelName,
+			// instance name only needed to set base url
+			azureOpenAIApiInstanceName: !credentials.endpoint ? credentials.resourceName : undefined,
+			azureOpenAIApiKey: credentials.apiKey,
+			azureOpenAIApiVersion: credentials.apiVersion,
+			// azureOpenAIEndpoint and configuration.baseURL are both ignored here
+			// only setting azureOpenAIBasePath worked
+			azureOpenAIBasePath: credentials.endpoint
+				? `${credentials.endpoint}/openai/deployments`
+				: undefined,
+			configuration: {
+				fetchOptions: {
+					dispatcher: getProxyAgent(
+						credentials.endpoint ?? `https://${credentials.resourceName}.openai.azure.com`,
+						{},
+					),
+				},
+			},
+			...options,
+		});
+
+		return {
+			response: logWrapper(embeddings, this),
+		};
+	}
+}