custom header to azure open ai model

Author: mgosal

packages/@n8n/nodes-langchain/credentials/AzureOpenAiApi.credentials.ts

@@ -1,4 +1,10 @@
-import type { IAuthenticateGeneric, ICredentialType, INodeProperties } from 'n8n-workflow';
+import type {
+	ICredentialDataDecryptedObject,
+	ICredentialType,
+	IDisplayOptions,
+	IHttpRequestOptions,
+	INodeProperties,
+} from 'n8n-workflow';
 
 export class AzureOpenAiApi implements ICredentialType {
 	name = 'azureOpenAiApi';
@@ -37,14 +43,50 @@ export class AzureOpenAiApi implements ICredentialType {
 			default: undefined,
 			placeholder: 'https://westeurope.api.cognitive.microsoft.com',
 		},
-	];
-
-	authenticate: IAuthenticateGeneric = {
-		type: 'generic',
-		properties: {
-			headers: {
-				'api-key': '={{$credentials.apiKey}}',
+		{
+			displayName: 'Add Custom Header',
+			name: 'header',
+			type: 'boolean',
+			default: false,
+		},
+		{
+			displayName: 'Header Name',
+			name: 'headerName',
+			type: 'string',
+			displayOptions: {
+				show: {
+					header: [true],
+				},
+			} as IDisplayOptions,
+			default: '',
+		},
+		{
+			displayName: 'Header Value',
+			name: 'headerValue',
+			type: 'string',
+			typeOptions: {
+				password: true,
 			},
+			displayOptions: {
+				show: {
+					header: [true],
+				},
+			} as IDisplayOptions,
+			default: '',
 		},
-	};
+	];
+
+	async authenticate(
+		credentials: ICredentialDataDecryptedObject,
+		requestOptions: IHttpRequestOptions,
+	): Promise<IHttpRequestOptions> {
+		requestOptions.headers = { 'api-key': credentials.apiKey };
+		if (credentials.header) {
+			requestOptions.headers = {
+				'api-key': credentials.apiKey,
+				[credentials.headerName as string]: credentials.headerValue,
+			};
+		}
+		return requestOptions;
+	}
 }

packages/@n8n/nodes-langchain/nodes/llms/LMChatOpenAi/LmChatOpenAi.node.ts

@@ -358,6 +358,11 @@ export class LmChatOpenAi implements INodeType {
 				dispatcher: getProxyAgent(configuration.baseURL ?? 'https://api.openai.com/v1'),
 			};
 		}
+		if (credentials.header) {
+			configuration.defaultHeaders = {
+				[credentials.headerName as string]: credentials.headerValue as string,
+			};
+		}
 
 		// Extra options to send to OpenAI, that are not directly supported by LangChain
 		const modelKwargs: {

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

@@ -103,6 +103,18 @@ export class LmChatAzureOpenAi implements INodeType {
 
 			this.logger.info(`Instantiating AzureChatOpenAI model with deployment: ${modelName}`);
 
+			const credentials = await this.getCredentials('azureOpenAiApi');
+			const configuration = {
+				fetchOptions: {
+					dispatcher: getProxyAgent(),
+				},
+				defaultHeaders: {},
+			};
+			if (credentials.header) {
+				configuration.defaultHeaders = {
+					[credentials.headerName as string]: credentials.headerValue as string,
+				};
+			}
 			// Create and return the model
 			const model = new AzureChatOpenAI({
 				azureOpenAIApiDeploymentName: modelName,
@@ -111,11 +123,7 @@ export class LmChatAzureOpenAi implements INodeType {
 				timeout: options.timeout ?? 60000,
 				maxRetries: options.maxRetries ?? 2,
 				callbacks: [new N8nLlmTracing(this)],
-				configuration: {
-					fetchOptions: {
-						dispatcher: getProxyAgent(),
-					},
-				},
+				configuration,
 				modelKwargs: options.responseFormat
 					? {
 							response_format: { type: options.responseFormat },