feat(OpenAI Node): Add a node to work with OpenAI (#4932)

* feat(OpenAI Node): Add a node to work with OpenAI * Added codex file for OpenAi node * Minor tweaks to Operation Image. * Minor tweaks to Resource Text. * Minor copy modification to Image:Create. * Removed "a Text" in Text operations names. * ⚡ Connect Response Format parameter and other improvements * ✨ Add "filter" postReceiveAction * ⚡ Rename operations and add spelling mistake again to example * ⚡ Rename another operation Co-authored-by: Jonathan Bennetts <jonathan.bennetts@gmail.com> Co-authored-by: Giulio Andreini <andreini@netseven.it>
2025-12-18 02:21:13 +00:00 · 2022-12-15 18:05:42 -06:00
parent 3028ad3c61
commit 7a984bb6b7
9 changed files with 821 additions and 2 deletions
--- a/packages/nodes-base/nodes/OpenAi/ImageDescription.ts
+++ b/packages/nodes-base/nodes/OpenAi/ImageDescription.ts
@@ -0,0 +1,186 @@
+import { INodeExecutionData, INodeProperties } from 'n8n-workflow';
+
+export const imageOperations: INodeProperties[] = [
+	{
+		displayName: 'Operation',
+		name: 'operation',
+		type: 'options',
+		noDataExpression: true,
+		displayOptions: {
+			show: {
+				resource: ['image'],
+			},
+		},
+		options: [
+			{
+				name: 'Create',
+				value: 'create',
+				action: 'Create an Image',
+				description: 'Create an image for a given text',
+				routing: {
+					request: {
+						method: 'POST',
+						url: '/v1/images/generations',
+					},
+				},
+			},
+		],
+		routing: {
+			output: {
+				postReceive: [
+					{
+						type: 'rootProperty',
+						properties: {
+							property: 'data',
+						},
+					},
+				],
+			},
+		},
+		default: 'create',
+	},
+];
+
+const createOperations: INodeProperties[] = [
+	{
+		displayName: 'Prompt',
+		name: 'prompt',
+		type: 'string',
+		placeholder: 'e.g. A cute cat eating a dinosaur',
+		description:
+			'A text description of the desired image(s). The maximum length is 1000 characters.',
+		displayOptions: {
+			show: {
+				resource: ['image'],
+				operation: ['create'],
+			},
+		},
+		default: '',
+		routing: {
+			send: {
+				type: 'body',
+				property: 'prompt',
+			},
+		},
+	},
+	{
+		displayName: 'Response Format',
+		name: 'responseFormat',
+		type: 'options',
+		default: 'binaryData',
+		description: 'The format in which to return the image(s)',
+		displayOptions: {
+			show: {
+				resource: ['image'],
+				operation: ['create'],
+			},
+		},
+		options: [
+			{
+				name: 'Binary Data',
+				value: 'binaryData',
+			},
+			{
+				name: 'Image Url',
+				value: 'imageUrl',
+			},
+		],
+		routing: {
+			send: {
+				type: 'body',
+				property: 'response_format',
+				value: '={{ $value === "imageUrl" ? "url" : "b64_json" }}',
+			},
+			output: {
+				postReceive: [
+					async function (items: INodeExecutionData[]): Promise<INodeExecutionData[]> {
+						if (this.getNode().parameters.responseFormat === 'imageUrl') {
+							return items;
+						}
+
+						const result: INodeExecutionData[] = [];
+						for (let i = 0; i < items.length; i++) {
+							result.push({
+								json: {},
+								binary: {
+									data: await this.helpers.prepareBinaryData(
+										Buffer.from(items[i].json.b64_json as string, 'base64'),
+										'data',
+									),
+								},
+							} as INodeExecutionData);
+						}
+
+						return result;
+					},
+				],
+			},
+		},
+	},
+	{
+		displayName: 'Options',
+		name: 'options',
+		placeholder: 'Add Option',
+		description: 'Additional options to add',
+		type: 'collection',
+		default: {},
+		displayOptions: {
+			show: {
+				resource: ['image'],
+				operation: ['create'],
+			},
+		},
+		options: [
+			{
+				displayName: 'Number of Images',
+				name: 'n',
+				default: 1,
+				description: 'Number of images to generate',
+				type: 'number',
+				typeOptions: {
+					minValue: 1,
+					maxValue: 10,
+				},
+				routing: {
+					send: {
+						type: 'body',
+						property: 'n',
+					},
+				},
+			},
+			{
+				displayName: 'Resolution',
+				name: 'size',
+				type: 'options',
+				options: [
+					{
+						name: '256x256',
+						value: '256x256',
+					},
+					{
+						name: '512x512',
+						value: '512x512',
+					},
+					{
+						name: '1024x1024',
+						value: '1024x1024',
+					},
+				],
+				routing: {
+					send: {
+						type: 'body',
+						property: 'size',
+					},
+				},
+				default: '1024x1024',
+			},
+		],
+	},
+];
+
+export const imageFields: INodeProperties[] = [
+	/* -------------------------------------------------------------------------- */
+	/*                                image:create                                */
+	/* -------------------------------------------------------------------------- */
+	...createOperations,
+];