UNPKG

@n8n/n8n-nodes-langchain

Version:
251 lines • 11 kB
"use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.EmbeddingsAzureOpenAi = void 0; const identity_1 = require("@azure/identity"); const openai_1 = require("@langchain/openai"); const ai_utilities_1 = require("@n8n/ai-utilities"); const n8n_workflow_1 = require("n8n-workflow"); const N8nOAuth2TokenCredential_1 = require("../../llms/LmChatAzureOpenAi/credentials/N8nOAuth2TokenCredential"); const types_1 = require("../../llms/LmChatAzureOpenAi/types"); const API_KEY_AUTH = "azureOpenAiApi"; const ENTRA_AUTH = "azureEntraCognitiveServicesOAuth2Api"; function assertCredentialAllowsHost(node, credentialData, url) { const allowedDomains = (0, n8n_workflow_1.getCredentialAllowedDomains)({ node, credentialData, credentialOwnedSurface: true, }); (0, n8n_workflow_1.assertUrlAllowed)({ url, allowedDomains, node }); } class EmbeddingsAzureOpenAi { constructor() { this.description = { displayName: 'Microsoft Foundry Embeddings', name: 'embeddingsAzureOpenAi', icon: 'file:foundry.svg', credentials: [ { name: API_KEY_AUTH, required: true, displayOptions: { show: { authentication: [API_KEY_AUTH], }, }, }, { name: ENTRA_AUTH, required: true, displayOptions: { show: { authentication: [ENTRA_AUTH], }, }, }, ], group: ['transform'], version: 1, description: 'Use Microsoft Foundry Embeddings', defaults: { name: 'Microsoft Foundry Embeddings', }, codex: { categories: ['AI'], subcategories: { AI: ['Embeddings'], }, resources: { primaryDocumentation: [ { url: 'https://docs.n8n.io/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingsazureopenai/', }, ], }, alias: [ 'Azure', 'Azure OpenAI', 'Embeddings Azure OpenAI', 'Azure AI Foundry', 'Foundry', 'AOAI', ], }, inputs: [], outputs: [n8n_workflow_1.NodeConnectionTypes.AiEmbedding], outputNames: ['Embeddings'], properties: [ { displayName: 'Authentication', name: 'authentication', type: 'options', default: API_KEY_AUTH, options: [ { name: 'API Key', value: API_KEY_AUTH, }, { name: 'Azure Entra ID (OAuth2)', value: ENTRA_AUTH, }, ], }, (0, ai_utilities_1.getConnectionHintNoticeField)([n8n_workflow_1.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(itemIndex) { this.logger.debug('Supply data for embeddings'); const authentication = this.getNodeParameter('authentication', itemIndex, API_KEY_AUTH); let target; let credentialData; let apiKey; let tokenProvider; if (authentication === ENTRA_AUTH) { const credential = await this.getCredentials(ENTRA_AUTH); const entraCredential = new N8nOAuth2TokenCredential_1.N8nOAuth2TokenCredential(this.getNode(), credential, undefined, this.helpers.getSecureEgressFilter()); const deployment = await entraCredential.getDeploymentDetails(); target = { resourceName: deployment.resourceName, apiVersion: deployment.apiVersion, endpoint: deployment.endpoint, endpointType: credential.endpointType, foundryEndpoint: credential.foundryEndpoint, }; tokenProvider = (0, identity_1.getBearerTokenProvider)(entraCredential, types_1.AZURE_OPENAI_INFERENCE_SCOPE); credentialData = credential; } else { const credential = await this.getCredentials(API_KEY_AUTH); target = credential; apiKey = credential.apiKey; credentialData = credential; } const credentialLabel = authentication === ENTRA_AUTH ? 'Microsoft Foundry (Entra ID)' : 'Microsoft Foundry (API Key)'; const modelName = this.getNodeParameter('model', itemIndex); const options = this.getNodeParameter('options', itemIndex, {}); if (options.timeout === -1) { options.timeout = undefined; } if (target.endpointType === 'foundry') { const foundryURL = target.foundryEndpoint?.trim(); if (!foundryURL) { throw new n8n_workflow_1.NodeOperationError(this.getNode(), `Foundry endpoint is missing in the selected ${credentialLabel} credential.`); } assertCredentialAllowsHost(this.getNode(), credentialData, foundryURL); const embeddings = new openai_1.OpenAIEmbeddings({ apiKey: tokenProvider ?? apiKey, model: modelName, configuration: { baseURL: foundryURL, fetch: ai_utilities_1.aiClientFetch, fetchOptions: { dispatcher: (0, ai_utilities_1.getProxyAgent)(foundryURL, {}, this.helpers.getSecureEgressFilter()), }, }, ...options, }); return { response: (0, ai_utilities_1.logWrapper)(embeddings, this), }; } if (!target.endpoint?.trim() && !target.resourceName?.trim()) { throw new n8n_workflow_1.NodeOperationError(this.getNode(), `Resource Name is missing in the selected ${credentialLabel} credential.`); } if (!target.apiVersion?.trim()) { throw new n8n_workflow_1.NodeOperationError(this.getNode(), `API Version is missing in the selected ${credentialLabel} credential.`); } const dialledHost = target.endpoint || `https://${target.resourceName}.openai.azure.com`; assertCredentialAllowsHost(this.getNode(), credentialData, dialledHost); const embeddings = new openai_1.AzureOpenAIEmbeddings({ azureOpenAIApiDeploymentName: modelName, azureOpenAIApiInstanceName: !target.endpoint ? target.resourceName : undefined, azureOpenAIApiKey: apiKey, azureADTokenProvider: tokenProvider, azureOpenAIApiVersion: target.apiVersion, azureOpenAIBasePath: target.endpoint ? `${target.endpoint}/openai/deployments` : undefined, configuration: { fetch: ai_utilities_1.aiClientFetch, fetchOptions: { dispatcher: (0, ai_utilities_1.getProxyAgent)(dialledHost, {}, this.helpers.getSecureEgressFilter()), }, }, ...options, }); return { response: (0, ai_utilities_1.logWrapper)(embeddings, this), }; } } exports.EmbeddingsAzureOpenAi = EmbeddingsAzureOpenAi; //# sourceMappingURL=EmbeddingsAzureOpenAi.node.js.map