From 4a8a17f7d9b2292bc07117b54b6f719641a6e4a6 Mon Sep 17 00:00:00 2001 From: Ria <123465523+riascho@users.noreply.github.com> Date: Tue, 4 Mar 2025 11:14:27 +0100 Subject: [PATCH 1/2] adds xAi Grok Chat Model node and credentials --- .../credentials/XAiApi.credentials.ts | 47 ++++ .../nodes/agents/Agent/Agent.node.ts | 2 + .../llms/LmChatXAiGrok/LmChatXAiGrok.node.ts | 253 ++++++++++++++++++ .../nodes/llms/LmChatXAiGrok/logo.svg | 1 + packages/@n8n/nodes-langchain/package.json | 2 + 5 files changed, 305 insertions(+) create mode 100644 packages/@n8n/nodes-langchain/credentials/XAiApi.credentials.ts create mode 100644 packages/@n8n/nodes-langchain/nodes/llms/LmChatXAiGrok/LmChatXAiGrok.node.ts create mode 100644 packages/@n8n/nodes-langchain/nodes/llms/LmChatXAiGrok/logo.svg diff --git a/packages/@n8n/nodes-langchain/credentials/XAiApi.credentials.ts b/packages/@n8n/nodes-langchain/credentials/XAiApi.credentials.ts new file mode 100644 index 0000000000..7487890184 --- /dev/null +++ b/packages/@n8n/nodes-langchain/credentials/XAiApi.credentials.ts @@ -0,0 +1,47 @@ +import type { + IAuthenticateGeneric, + ICredentialTestRequest, + ICredentialType, + INodeProperties, +} from 'n8n-workflow'; + +export class XAiApi implements ICredentialType { + name = 'xAiApi'; + + displayName = 'xAi'; + + documentationUrl = 'xAi'; + + properties: INodeProperties[] = [ + { + displayName: 'API Key', + name: 'apiKey', + type: 'string', + typeOptions: { password: true }, + required: true, + default: '', + }, + { + displayName: 'Base URL', + name: 'url', + type: 'hidden', + default: 'https://api.x.ai/v1', + }, + ]; + + authenticate: IAuthenticateGeneric = { + type: 'generic', + properties: { + headers: { + Authorization: '=Bearer {{$credentials.apiKey}}', + }, + }, + }; + + test: ICredentialTestRequest = { + request: { + baseURL: '={{ $credentials.url }}', + url: '/models', + }, + }; +} diff --git a/packages/@n8n/nodes-langchain/nodes/agents/Agent/Agent.node.ts b/packages/@n8n/nodes-langchain/nodes/agents/Agent/Agent.node.ts index 45c9d10e8c..3a0d812967 100644 --- a/packages/@n8n/nodes-langchain/nodes/agents/Agent/Agent.node.ts +++ b/packages/@n8n/nodes-langchain/nodes/agents/Agent/Agent.node.ts @@ -99,6 +99,7 @@ function getInputs( '@n8n/n8n-nodes-langchain.lmChatAzureOpenAi', '@n8n/n8n-nodes-langchain.lmChatDeepSeek', '@n8n/n8n-nodes-langchain.lmChatOpenRouter', + '@n8n/n8n-nodes-langchain.lmChatXAiGrok', ], }, }, @@ -129,6 +130,7 @@ function getInputs( '@n8n/n8n-nodes-langchain.lmChatGoogleGemini', '@n8n/n8n-nodes-langchain.lmChatDeepSeek', '@n8n/n8n-nodes-langchain.lmChatOpenRouter', + '@n8n/n8n-nodes-langchain.lmChatXAiGrok', ], }, }, diff --git a/packages/@n8n/nodes-langchain/nodes/llms/LmChatXAiGrok/LmChatXAiGrok.node.ts b/packages/@n8n/nodes-langchain/nodes/llms/LmChatXAiGrok/LmChatXAiGrok.node.ts new file mode 100644 index 0000000000..f2b7e5c180 --- /dev/null +++ b/packages/@n8n/nodes-langchain/nodes/llms/LmChatXAiGrok/LmChatXAiGrok.node.ts @@ -0,0 +1,253 @@ +/* eslint-disable n8n-nodes-base/node-dirname-against-convention */ + +import { ChatOpenAI, type ClientOptions } from '@langchain/openai'; +import { + NodeConnectionType, + type INodeType, + type INodeTypeDescription, + type ISupplyDataFunctions, + type SupplyData, +} from 'n8n-workflow'; + +import { getConnectionHintNoticeField } from '@utils/sharedFields'; + +import { openAiFailedAttemptHandler } from '../../vendors/OpenAi/helpers/error-handling'; +import { makeN8nLlmFailedAttemptHandler } from '../n8nLlmFailedAttemptHandler'; +import { N8nLlmTracing } from '../N8nLlmTracing'; + +export class LmChatXAiGrok implements INodeType { + description: INodeTypeDescription = { + displayName: 'xAI Grok Chat Model', + // eslint-disable-next-line n8n-nodes-base/node-class-description-name-miscased + name: 'lmChatXAiGrok', + icon: 'file:logo.svg', + group: ['transform'], + version: [1], + description: 'For advanced usage with an AI chain', + defaults: { + name: 'xAI Grok Chat Model', + }, + codex: { + categories: ['AI'], + subcategories: { + AI: ['Language Models', 'Root Nodes'], + 'Language Models': ['Chat Models (Recommended)'], + }, + resources: { + primaryDocumentation: [ + { + url: 'https://docs.n8n.io/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.xxxxxxxx/', + }, + ], + }, + }, + // 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: 'xAiApi', + required: true, + }, + ], + requestDefaults: { + ignoreHttpStatusErrors: true, + baseURL: '={{ $credentials?.url }}', + }, + properties: [ + getConnectionHintNoticeField([NodeConnectionType.AiChain, NodeConnectionType.AiAgent]), + { + displayName: + 'If using JSON response format, you must include word "json" in the prompt in your chain or agent. Also, make sure to select latest models released post November 2023.', + name: 'notice', + type: 'notice', + default: '', + displayOptions: { + show: { + '/options.responseFormat': ['json_object'], + }, + }, + }, + { + displayName: 'Model', + name: 'model', + type: 'options', + description: + 'The model which will generate the completion. Learn more.', + typeOptions: { + loadOptions: { + routing: { + request: { + method: 'GET', + url: '/models', + }, + output: { + postReceive: [ + { + type: 'rootProperty', + properties: { + property: 'data', + }, + }, + { + type: 'setKeyValue', + properties: { + name: '={{$responseItem.id}}', + value: '={{$responseItem.id}}', + }, + }, + { + type: 'sort', + properties: { + key: 'name', + }, + }, + ], + }, + }, + }, + }, + routing: { + send: { + type: 'body', + property: 'model', + }, + }, + default: 'grok-2-vision-1212', + }, + { + displayName: 'Options', + name: 'options', + placeholder: 'Add Option', + description: 'Additional options to add', + type: 'collection', + default: {}, + options: [ + { + displayName: 'Frequency Penalty', + name: 'frequencyPenalty', + default: 0, + typeOptions: { maxValue: 2, minValue: -2, numberPrecision: 1 }, + description: + "Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim", + type: 'number', + }, + { + displayName: 'Maximum Number of Tokens', + name: 'maxTokens', + default: -1, + description: + 'The maximum number of tokens to generate in the completion. Most models have a context length of 2048 tokens (except for the newest models, which support 32,768).', + type: 'number', + typeOptions: { + maxValue: 32768, + }, + }, + { + displayName: 'Response Format', + name: 'responseFormat', + default: 'text', + type: 'options', + options: [ + { + name: 'Text', + value: 'text', + description: 'Regular text response', + }, + { + name: 'JSON', + value: 'json_object', + description: + 'Enables JSON mode, which should guarantee the message the model generates is valid JSON', + }, + ], + }, + { + displayName: 'Presence Penalty', + name: 'presencePenalty', + default: 0, + typeOptions: { maxValue: 2, minValue: -2, numberPrecision: 1 }, + description: + "Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics", + type: 'number', + }, + { + displayName: 'Sampling Temperature', + name: 'temperature', + default: 0.7, + typeOptions: { maxValue: 2, minValue: 0, numberPrecision: 1 }, + description: + 'Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.', + type: 'number', + }, + { + displayName: 'Timeout', + name: 'timeout', + default: 360000, + description: 'Maximum amount of time a request is allowed to take in milliseconds', + type: 'number', + }, + { + displayName: 'Max Retries', + name: 'maxRetries', + default: 2, + description: 'Maximum number of retries to attempt', + type: 'number', + }, + { + displayName: 'Top P', + name: 'topP', + default: 1, + typeOptions: { maxValue: 1, minValue: 0, numberPrecision: 1 }, + description: + 'Controls diversity via nucleus sampling: 0.5 means half of all likelihood-weighted options are considered. We generally recommend altering this or temperature but not both.', + type: 'number', + }, + ], + }, + ], + }; + + async supplyData(this: ISupplyDataFunctions, itemIndex: number): Promise { + const credentials = await this.getCredentials('xAiApi'); + + const modelName = this.getNodeParameter('model', itemIndex) as string; + + const options = this.getNodeParameter('options', itemIndex, {}) as { + frequencyPenalty?: number; + maxTokens?: number; + maxRetries: number; + timeout: number; + presencePenalty?: number; + temperature?: number; + topP?: number; + responseFormat?: 'text' | 'json_object'; + }; + + const configuration: ClientOptions = { + baseURL: credentials.url, + }; + + const model = new ChatOpenAI({ + openAIApiKey: credentials.apiKey, + modelName, + ...options, + timeout: options.timeout ?? 60000, + maxRetries: options.maxRetries ?? 2, + configuration, + callbacks: [new N8nLlmTracing(this)], + modelKwargs: options.responseFormat + ? { + response_format: { type: options.responseFormat }, + } + : undefined, + onFailedAttempt: makeN8nLlmFailedAttemptHandler(this, openAiFailedAttemptHandler), + }); + + return { + response: model, + }; + } +} diff --git a/packages/@n8n/nodes-langchain/nodes/llms/LmChatXAiGrok/logo.svg b/packages/@n8n/nodes-langchain/nodes/llms/LmChatXAiGrok/logo.svg new file mode 100644 index 0000000000..58bdc2cbb3 --- /dev/null +++ b/packages/@n8n/nodes-langchain/nodes/llms/LmChatXAiGrok/logo.svg @@ -0,0 +1 @@ + diff --git a/packages/@n8n/nodes-langchain/package.json b/packages/@n8n/nodes-langchain/package.json index ffdd31a7b9..92b37072b8 100644 --- a/packages/@n8n/nodes-langchain/package.json +++ b/packages/@n8n/nodes-langchain/package.json @@ -37,6 +37,7 @@ "dist/credentials/QdrantApi.credentials.js", "dist/credentials/SerpApi.credentials.js", "dist/credentials/WolframAlphaApi.credentials.js", + "dist/credentials/XAiApi.credentials.js", "dist/credentials/XataApi.credentials.js", "dist/credentials/ZepApi.credentials.js" ], @@ -73,6 +74,7 @@ "dist/nodes/llms/LmChatMistralCloud/LmChatMistralCloud.node.js", "dist/nodes/llms/LMChatOllama/LmChatOllama.node.js", "dist/nodes/llms/LmChatOpenRouter/LmChatOpenRouter.node.js", + "dist/nodes/llms/LmChatXAiGrok/LmChatXAiGrok.node.js", "dist/nodes/llms/LMChatOpenAi/LmChatOpenAi.node.js", "dist/nodes/llms/LMOpenAi/LmOpenAi.node.js", "dist/nodes/llms/LMCohere/LmCohere.node.js", From cc52783bc82ac0461839b4d42ab3bc806a9ef0d7 Mon Sep 17 00:00:00 2001 From: Ria <123465523+riascho@users.noreply.github.com> Date: Tue, 4 Mar 2025 11:25:05 +0100 Subject: [PATCH 2/2] adds svg for light theme --- .../nodes/llms/LmChatXAiGrok/LmChatXAiGrok.node.ts | 2 +- .../@n8n/nodes-langchain/nodes/llms/LmChatXAiGrok/logo.dark.svg | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 packages/@n8n/nodes-langchain/nodes/llms/LmChatXAiGrok/logo.dark.svg diff --git a/packages/@n8n/nodes-langchain/nodes/llms/LmChatXAiGrok/LmChatXAiGrok.node.ts b/packages/@n8n/nodes-langchain/nodes/llms/LmChatXAiGrok/LmChatXAiGrok.node.ts index f2b7e5c180..345300adc8 100644 --- a/packages/@n8n/nodes-langchain/nodes/llms/LmChatXAiGrok/LmChatXAiGrok.node.ts +++ b/packages/@n8n/nodes-langchain/nodes/llms/LmChatXAiGrok/LmChatXAiGrok.node.ts @@ -20,7 +20,7 @@ export class LmChatXAiGrok implements INodeType { displayName: 'xAI Grok Chat Model', // eslint-disable-next-line n8n-nodes-base/node-class-description-name-miscased name: 'lmChatXAiGrok', - icon: 'file:logo.svg', + icon: { light: 'file:logo.dark.svg', dark: 'file:logo.svg' }, group: ['transform'], version: [1], description: 'For advanced usage with an AI chain', diff --git a/packages/@n8n/nodes-langchain/nodes/llms/LmChatXAiGrok/logo.dark.svg b/packages/@n8n/nodes-langchain/nodes/llms/LmChatXAiGrok/logo.dark.svg new file mode 100644 index 0000000000..53f973030f --- /dev/null +++ b/packages/@n8n/nodes-langchain/nodes/llms/LmChatXAiGrok/logo.dark.svg @@ -0,0 +1 @@ +