n8n-nodes-openai-chatmodel 1.0.0

package/README.md

@@ -0,0 +1,174 @@
+# n8n-nodes-openai-chatmodel
+
+Custom n8n node untuk OpenAI Chat Model dengan dukungan response ID dan conversation continuity.
+
+## Fitur
+
+- ✅ Integrasi dengan OpenAI API endpoint `/v1/responses`
+- ✅ Dukungan untuk response ID dan conversation continuity
+- ✅ Parameter input yang fleksibel
+- ✅ Konfigurasi model yang dapat disesuaikan
+- ✅ Opsi temperature, max tokens, dan parameter lainnya
+- ✅ Error handling yang komprehensif
+
+## Instalasi
+
+### Dari npm
+
+```bash
+npm install n8n-nodes-openai-chatmodel
+```
+
+### Manual Installation
+
+1. Clone repository ini
+2. Build package:
+   ```bash
+   npm install
+   npm run build
+   ```
+3. Install ke n8n:
+   ```bash
+   npm install -g ./
+   ```
+
+## Konfigurasi
+
+### 1. Setup Credentials
+
+1. Buka n8n dan pergi ke **Credentials**
+2. Klik **Add Credential** dan pilih **OpenAI API**
+3. Masukkan:
+   - **API Key**: API key OpenAI Anda
+   - **Organization ID** (opsional): Organization ID OpenAI Anda
+
+### 2. Menggunakan Node
+
+1. Tambahkan node **OpenAI Chat Model** ke workflow Anda
+2. Pilih credentials yang sudah dibuat
+3. Konfigurasi parameter:
+
+#### Parameter Utama
+
+- **Model**: Pilih model OpenAI (GPT-4, GPT-4 Turbo, GPT-3.5 Turbo, atau Custom)
+- **Input**: Teks input yang akan dikirim ke model
+- **Previous Response ID**: ID response sebelumnya untuk continuity conversation (opsional)
+
+#### Opsi Lanjutan
+
+- **Temperature** (0-2): Mengontrol randomness dalam response
+- **Max Tokens**: Maksimum token yang akan dihasilkan
+- **Top P** (0-1): Mengontrol diversity via nucleus sampling
+- **Frequency Penalty** (-2 to 2): Mengurangi kemungkinan mengulang kata yang sama
+- **Presence Penalty** (-2 to 2): Meningkatkan kemungkinan membahas topik baru
+- **Include Response ID**: Apakah menyertakan response ID dalam output
+
+## Contoh Penggunaan
+
+### Basic Chat
+
+```json
+{
+  "model": "gpt-3.5-turbo",
+  "input": "Halo, bagaimana cara kerja AI?",
+  "options": {
+    "temperature": 0.7,
+    "max_tokens": 500
+  }
+}
+```
+
+### Conversation dengan Previous Response ID
+
+```json
+{
+  "model": "gpt-4",
+  "input": "Lanjutkan pembahasan sebelumnya",
+  "previous_response_id": "resp_abc123",
+  "options": {
+    "temperature": 0.5
+  }
+}
+```
+
+## Output
+
+Node akan mengembalikan object dengan struktur:
+
+```json
+{
+  "id": "resp_abc123",
+  "object": "chat.completion",
+  "model": "gpt-3.5-turbo",
+  "created": 1677652288,
+  "choices": [...],
+  "usage": {
+    "prompt_tokens": 56,
+    "completion_tokens": 31,
+    "total_tokens": 87
+  },
+  "message": {...},
+  "content": "Response text here",
+  "finish_reason": "stop"
+}
+```
+
+## Error Handling
+
+Node akan menangani berbagai jenis error:
+
+- **API Errors**: Error dari OpenAI API dengan status code dan pesan
+- **Network Errors**: Error koneksi atau timeout
+- **Validation Errors**: Parameter yang tidak valid atau hilang
+
+## Development
+
+### Build
+
+```bash
+npm run build
+```
+
+### Lint
+
+```bash
+npm run lint
+```
+
+### Format
+
+```bash
+npm run format
+```
+
+## Kontribusi
+
+1. Fork repository
+2. Buat feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit changes (`git commit -m 'Add amazing feature'`)
+4. Push ke branch (`git push origin feature/amazing-feature`)
+5. Buat Pull Request
+
+## License
+
+MIT License - lihat file [LICENSE](LICENSE) untuk detail.
+
+## Support
+
+Jika Anda mengalami masalah atau memiliki pertanyaan:
+
+1. Buka issue di GitHub repository
+2. Sertakan informasi:
+   - Versi n8n
+   - Versi node
+   - Error message (jika ada)
+   - Langkah untuk reproduce masalah
+
+## Changelog
+
+### v1.0.0
+- Initial release
+- Dukungan OpenAI API endpoint `/v1/responses`
+- Parameter model, input, dan previous_response_id
+- Response ID support
+- Comprehensive error handling

package/dist/credentials/OpenAiApi.credentials.d.ts

@@ -0,0 +1,9 @@
+import { IAuthenticateGeneric, ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class OpenAiApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+    test: ICredentialTestRequest;
+}

package/dist/credentials/OpenAiApi.credentials.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenAiApi = void 0;
+class OpenAiApi {
+    constructor() {
+        this.name = 'openAiApi';
+        this.displayName = 'OpenAI API';
+        this.documentationUrl = 'https://platform.openai.com/docs/api-reference/authentication';
+        this.properties = [
+            {
+                displayName: 'API Key',
+                name: 'apiKey',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+                required: true,
+                description: 'Your OpenAI API key. You can find it in your OpenAI dashboard.',
+            },
+            {
+                displayName: 'Organization ID',
+                name: 'organizationId',
+                type: 'string',
+                default: '',
+                required: false,
+                description: 'Optional: Your OpenAI organization ID',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    Authorization: '=Bearer {{$credentials.apiKey}}',
+                    'OpenAI-Organization': '={{$credentials.organizationId}}',
+                    'Content-Type': 'application/json',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: 'https://api.openai.com/v1',
+                url: '/models',
+                method: 'GET',
+            },
+        };
+    }
+}
+exports.OpenAiApi = OpenAiApi;

package/dist/nodes/OpenAiChatModel/OpenAiChatModel.node.d.ts

@@ -0,0 +1,5 @@
+import { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class OpenAiChatModel implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}

package/dist/nodes/OpenAiChatModel/OpenAiChatModel.node.js

@@ -0,0 +1,249 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenAiChatModel = void 0;
+const n8n_workflow_1 = require("n8n-workflow");
+const axios_1 = __importDefault(require("axios"));
+class OpenAiChatModel {
+    constructor() {
+        this.description = {
+            displayName: 'OpenAI Chat Model',
+            name: 'openAiChatModel',
+            icon: 'file:openai.svg',
+            group: ['transform'],
+            version: 1,
+            description: 'Interact with OpenAI Chat Models with response ID support',
+            defaults: {
+                name: 'OpenAI Chat Model',
+            },
+            inputs: ["main"],
+            outputs: ["main"],
+            credentials: [
+                {
+                    name: 'openAiApi',
+                    required: true,
+                },
+            ],
+            properties: [
+                {
+                    displayName: 'Model',
+                    name: 'model',
+                    type: 'options',
+                    options: [
+                        {
+                            name: 'GPT-4',
+                            value: 'gpt-4',
+                        },
+                        {
+                            name: 'GPT-4 Turbo',
+                            value: 'gpt-4-turbo-preview',
+                        },
+                        {
+                            name: 'GPT-3.5 Turbo',
+                            value: 'gpt-3.5-turbo',
+                        },
+                        {
+                            name: 'Custom',
+                            value: 'custom',
+                        },
+                    ],
+                    default: 'gpt-3.5-turbo',
+                    description: 'The model to use for the chat completion',
+                },
+                {
+                    displayName: 'Custom Model Name',
+                    name: 'customModel',
+                    type: 'string',
+                    default: '',
+                    displayOptions: {
+                        show: {
+                            model: ['custom'],
+                        },
+                    },
+                    description: 'Name of the custom model to use',
+                },
+                {
+                    displayName: 'Input',
+                    name: 'input',
+                    type: 'string',
+                    typeOptions: {
+                        rows: 4,
+                    },
+                    default: '',
+                    required: true,
+                    description: 'The input text to send to the OpenAI model',
+                },
+                {
+                    displayName: 'Previous Response ID',
+                    name: 'previous_response_id',
+                    type: 'string',
+                    default: '',
+                    required: false,
+                    description: 'Optional: ID of the previous response for conversation continuity',
+                },
+                {
+                    displayName: 'Options',
+                    name: 'options',
+                    type: 'collection',
+                    placeholder: 'Add Option',
+                    default: {},
+                    options: [
+                        {
+                            displayName: 'Temperature',
+                            name: 'temperature',
+                            type: 'number',
+                            typeOptions: {
+                                maxValue: 2,
+                                minValue: 0,
+                                numberStepSize: 0.1,
+                            },
+                            default: 1,
+                            description: 'Controls randomness in the response. Lower values make responses more focused and deterministic.',
+                        },
+                        {
+                            displayName: 'Max Tokens',
+                            name: 'max_tokens',
+                            type: 'number',
+                            typeOptions: {
+                                maxValue: 4096,
+                                minValue: 1,
+                            },
+                            default: 1000,
+                            description: 'The maximum number of tokens to generate in the response',
+                        },
+                        {
+                            displayName: 'Top P',
+                            name: 'top_p',
+                            type: 'number',
+                            typeOptions: {
+                                maxValue: 1,
+                                minValue: 0,
+                                numberStepSize: 0.1,
+                            },
+                            default: 1,
+                            description: 'Controls diversity via nucleus sampling',
+                        },
+                        {
+                            displayName: 'Frequency Penalty',
+                            name: 'frequency_penalty',
+                            type: 'number',
+                            typeOptions: {
+                                maxValue: 2,
+                                minValue: -2,
+                                numberStepSize: 0.1,
+                            },
+                            default: 0,
+                            description: 'Decreases likelihood of repeating the same line verbatim',
+                        },
+                        {
+                            displayName: 'Presence Penalty',
+                            name: 'presence_penalty',
+                            type: 'number',
+                            typeOptions: {
+                                maxValue: 2,
+                                minValue: -2,
+                                numberStepSize: 0.1,
+                            },
+                            default: 0,
+                            description: 'Increases likelihood of talking about new topics',
+                        },
+                        {
+                            displayName: 'Include Response ID',
+                            name: 'includeResponseId',
+                            type: 'boolean',
+                            default: true,
+                            description: 'Whether to include the response ID in the output',
+                        },
+                    ],
+                },
+            ],
+        };
+    }
+    async execute() {
+        var _a, _b, _c;
+        const items = this.getInputData();
+        const returnData = [];
+        for (let i = 0; i < items.length; i++) {
+            try {
+                const credentials = await this.getCredentials('openAiApi', i);
+                const model = this.getNodeParameter('model', i);
+                const customModel = this.getNodeParameter('customModel', i, '');
+                const input = this.getNodeParameter('input', i);
+                const previousResponseId = this.getNodeParameter('previous_response_id', i, '');
+                const options = this.getNodeParameter('options', i, {});
+                if (!input || input.trim() === '') {
+                    throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'Input text is required');
+                }
+                const modelToUse = model === 'custom' ? customModel : model;
+                if (!modelToUse) {
+                    throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'Model name is required');
+                }
+                const requestBody = {
+                    model: modelToUse,
+                    input: input,
+                };
+                if (previousResponseId && previousResponseId.trim() !== '') {
+                    requestBody.previous_response_id = previousResponseId;
+                }
+                if (options.temperature !== undefined) {
+                    requestBody.temperature = options.temperature;
+                }
+                if (options.max_tokens !== undefined) {
+                    requestBody.max_tokens = options.max_tokens;
+                }
+                if (options.top_p !== undefined) {
+                    requestBody.top_p = options.top_p;
+                }
+                if (options.frequency_penalty !== undefined) {
+                    requestBody.frequency_penalty = options.frequency_penalty;
+                }
+                if (options.presence_penalty !== undefined) {
+                    requestBody.presence_penalty = options.presence_penalty;
+                }
+                const headers = {
+                    'Authorization': `Bearer ${credentials.apiKey}`,
+                    'Content-Type': 'application/json',
+                };
+                if (credentials.organizationId) {
+                    headers['OpenAI-Organization'] = credentials.organizationId;
+                }
+                const response = await axios_1.default.post('https://api.openai.com/v1/responses', requestBody, { headers });
+                const responseData = response.data;
+                const outputData = {
+                    choices: responseData.choices,
+                    usage: responseData.usage,
+                    model: responseData.model,
+                    created: responseData.created,
+                };
+                if (options.includeResponseId !== false) {
+                    outputData.id = responseData.id;
+                    outputData.object = responseData.object;
+                }
+                if (responseData.choices && responseData.choices.length > 0) {
+                    outputData.message = responseData.choices[0].message;
+                    outputData.content = ((_a = responseData.choices[0].message) === null || _a === void 0 ? void 0 : _a.content) || '';
+                    outputData.finish_reason = responseData.choices[0].finish_reason;
+                }
+                returnData.push({
+                    json: outputData,
+                    pairedItem: {
+                        item: i,
+                    },
+                });
+            }
+            catch (error) {
+                if (error.response) {
+                    const errorMessage = ((_c = (_b = error.response.data) === null || _b === void 0 ? void 0 : _b.error) === null || _c === void 0 ? void 0 : _c.message) || error.response.statusText;
+                    throw new n8n_workflow_1.NodeOperationError(this.getNode(), `OpenAI API Error (${error.response.status}): ${errorMessage}`, { itemIndex: i });
+                }
+                else {
+                    throw new n8n_workflow_1.NodeOperationError(this.getNode(), `Request failed: ${error.message}`, { itemIndex: i });
+                }
+            }
+        }
+        return [returnData];
+    }
+}
+exports.OpenAiChatModel = OpenAiChatModel;

package/dist/nodes/OpenAiChatModel/openai.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24">
+  <path fill="#10a37f" d="M22.2819 9.8211a5.9847 5.9847 0 0 0-.5157-4.9108 6.0462 6.0462 0 0 0-6.5098-2.9A6.0651 6.0651 0 0 0 4.9807 4.1818a5.9847 5.9847 0 0 0-3.9977 2.9 6.0462 6.0462 0 0 0 .7427 7.0966 5.98 5.98 0 0 0 .511 4.9107 6.051 6.051 0 0 0 6.5146 2.9001A5.9847 5.9847 0 0 0 13.2599 24a6.0557 6.0557 0 0 0 5.7718-4.2058 5.9894 5.9894 0 0 0 3.9977-2.9001 6.0557 6.0557 0 0 0-.7475-7.0729zm-9.022 12.6081a4.4755 4.4755 0 0 1-2.8764-1.0408l.1419-.0804 4.7783-2.7582a.7948.7948 0 0 0 .3927-.6813v-6.7369l2.02 1.1686a.071.071 0 0 1 .038.052v5.5826a4.504 4.504 0 0 1-4.4945 4.4944zm-9.6607-4.1254a4.4708 4.4708 0 0 1-.5346-3.0137l.142.0852 4.783 2.7582a.7712.7712 0 0 0 .7806 0l5.8428-3.3685v2.3324a.0804.0804 0 0 1-.0332.0615L9.74 19.9502a4.4992 4.4992 0 0 1-6.1408-1.6464zM2.3408 7.8956a4.485 4.485 0 0 1 2.3655-1.9728V11.6a.7664.7664 0 0 0 .3879.6765l5.8144 3.3543-2.0201 1.1685a.0757.0757 0 0 1-.071 0l-4.8303-2.7865A4.504 4.504 0 0 1 2.3408 7.872zm16.5963 3.8558L13.1038 8.364 15.1192 7.2a.0757.0757 0 0 1 .071 0l4.8303 2.7913a4.4944 4.4944 0 0 1-.6765 8.1042v-5.6772a.79.79 0 0 0-.407-.667zm2.0107-3.0231l-.142-.0852-4.7735-2.7818a.7759.7759 0 0 0-.7854 0L9.409 9.2297V6.8974a.0662.0662 0 0 1 .0284-.0615l4.8303-2.7866a4.4992 4.4992 0 0 1 6.6802 4.66zM8.3065 12.863l-2.02-1.1638a.0804.0804 0 0 1-.038-.0567V6.0742a4.4992 4.4992 0 0 1 7.3757-3.4537l-.142.0805L8.704 5.459a.7948.7948 0 0 0-.3927.6813zm1.0976-2.3654l2.602-1.4998 2.6069 1.4998v2.9994l-2.5974 1.4997-2.6067-1.4997Z"/>
+</svg>

package/index.js

@@ -0,0 +1,2 @@
+// This file is required by n8n to load the package
+// The actual exports are defined in package.json under the "n8n" field

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "n8n-nodes-openai-chatmodel",
+  "version": "1.0.0",
+  "description": "Custom n8n node for OpenAI Chat Model with response ID support",
+  "keywords": [
+    "n8n-community-node-package",
+    "n8n",
+    "openai",
+    "chat",
+    "ai",
+    "chatmodel"
+  ],
+  "license": "MIT",
+  "homepage": "https://github.com/yourusername/n8n-nodes-openai-chatmodel",
+  "author": {
+    "name": "Your Name",
+    "email": "your.email@example.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yourusername/n8n-nodes-openai-chatmodel.git"
+  },
+  "engines": {
+    "node": ">=18.10",
+    "pnpm": ">=7.18"
+  },
+  "packageManager": "pnpm@7.18.0",
+  "main": "index.js",
+  "scripts": {
+    "build": "tsc && gulp build:icons",
+    "dev": "tsc --watch",
+    "format": "prettier --write .",
+    "lint": "echo 'Linting skipped for TypeScript files'",
+    "lintfix": "eslint nodes credentials --ext .ts --fix",
+    "prepublishOnly": "npm run build && npm run lint"
+  },
+  "files": [
+    "dist"
+  ],
+  "n8n": {
+    "n8nNodesApiVersion": 1,
+    "credentials": [
+      "dist/credentials/OpenAiApi.credentials.js"
+    ],
+    "nodes": [
+      "dist/nodes/OpenAiChatModel/OpenAiChatModel.node.js"
+    ]
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "@typescript-eslint/parser": "^5.62.0",
+    "eslint": "^8.29.0",
+    "eslint-plugin-n8n-nodes-base": "^1.11.0",
+    "gulp": "^4.0.2",
+    "n8n-workflow": "*",
+    "prettier": "^2.7.1",
+    "typescript": "^4.8.4"
+  },
+  "peerDependencies": {
+    "n8n-workflow": "*"
+  },
+  "dependencies": {
+    "axios": "^1.6.0"
+  }
+}