first commit

packages/nodes-base/nodes/Aws/Comprehend/AwsComprehend.node.ts

@@ -0,0 +1,291 @@
+import type {
+	IExecuteFunctions,
+	IDataObject,
+	INodeExecutionData,
+	INodeType,
+	INodeTypeDescription,
+} from 'n8n-workflow';
+import { NodeConnectionTypes } from 'n8n-workflow';
+
+import { awsApiRequestREST } from './GenericFunctions';
+import { awsNodeAuthOptions, awsNodeCredentials } from '../utils';
+
+export class AwsComprehend implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'AWS Comprehend',
+		name: 'awsComprehend',
+		icon: 'file:comprehend.svg',
+		group: ['output'],
+		version: 1,
+		subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+		description: 'Sends data to Amazon Comprehend',
+		schemaPath: 'Aws/Comprehend',
+		defaults: {
+			name: 'AWS Comprehend',
+		},
+		inputs: [NodeConnectionTypes.Main],
+		outputs: [NodeConnectionTypes.Main],
+		credentials: awsNodeCredentials,
+		properties: [
+			awsNodeAuthOptions,
+			{
+				displayName: 'Resource',
+				name: 'resource',
+				type: 'options',
+				noDataExpression: true,
+				options: [
+					{
+						name: 'Text',
+						value: 'text',
+					},
+				],
+				default: 'text',
+				description: 'The resource to perform',
+			},
+			{
+				displayName: 'Operation',
+				name: 'operation',
+				type: 'options',
+				noDataExpression: true,
+				options: [
+					{
+						name: 'Detect Dominant Language',
+						value: 'detectDominantLanguage',
+						description: 'Identify the dominant language',
+						action: 'Identify the dominant language',
+					},
+					{
+						name: 'Detect Entities',
+						value: 'detectEntities',
+						description: 'Inspects text for named entities, and returns information about them',
+						action: 'Inspect text for named entities, and returns information about them',
+					},
+					{
+						name: 'Detect Sentiment',
+						value: 'detectSentiment',
+						description: 'Analyse the sentiment of the text',
+						action: 'Analyze the sentiment of the text',
+					},
+				],
+				default: 'detectDominantLanguage',
+			},
+			{
+				displayName: 'Language Code',
+				name: 'languageCode',
+				type: 'options',
+				options: [
+					{
+						name: 'Arabic',
+						value: 'ar',
+					},
+					{
+						name: 'Chinese',
+						value: 'zh',
+					},
+					{
+						name: 'Chinese (T)',
+						value: 'zh-TW',
+					},
+					{
+						name: 'English',
+						value: 'en',
+					},
+					{
+						name: 'French',
+						value: 'fr',
+					},
+					{
+						name: 'German',
+						value: 'de',
+					},
+					{
+						name: 'Hindi',
+						value: 'hi',
+					},
+					{
+						name: 'Italian',
+						value: 'it',
+					},
+					{
+						name: 'Japanese',
+						value: 'ja',
+					},
+					{
+						name: 'Korean',
+						value: 'ko',
+					},
+					{
+						name: 'Portuguese',
+						value: 'pt',
+					},
+					{
+						name: 'Spanish',
+						value: 'es',
+					},
+				],
+				default: 'en',
+				displayOptions: {
+					show: {
+						resource: ['text'],
+						operation: ['detectSentiment', 'detectEntities'],
+					},
+				},
+				description: 'The language code for text',
+			},
+			{
+				displayName: 'Text',
+				name: 'text',
+				type: 'string',
+				default: '',
+				displayOptions: {
+					show: {
+						resource: ['text'],
+					},
+				},
+				description: 'The text to send',
+			},
+			{
+				displayName: 'Simplify',
+				name: 'simple',
+				type: 'boolean',
+				displayOptions: {
+					show: {
+						resource: ['text'],
+						operation: ['detectDominantLanguage'],
+					},
+				},
+				default: true,
+				description:
+					'Whether to return a simplified version of the response instead of the raw data',
+			},
+			{
+				displayName: 'Additional Fields',
+				name: 'additionalFields',
+				type: 'collection',
+				placeholder: 'Add Field',
+				displayOptions: {
+					show: {
+						resource: ['text'],
+						operation: ['detectEntities'],
+					},
+				},
+				default: {},
+				options: [
+					{
+						displayName: 'Endpoint Arn',
+						name: 'endpointArn',
+						type: 'string',
+						default: '',
+						description:
+							'The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model',
+					},
+				],
+			},
+		],
+	};
+
+	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
+		const items = this.getInputData();
+		const returnData: INodeExecutionData[] = [];
+		let responseData;
+		const resource = this.getNodeParameter('resource', 0);
+		const operation = this.getNodeParameter('operation', 0);
+		for (let i = 0; i < items.length; i++) {
+			try {
+				if (resource === 'text') {
+					//https://docs.aws.amazon.com/comprehend/latest/dg/API_DetectDominantLanguage.html
+					if (operation === 'detectDominantLanguage') {
+						const text = this.getNodeParameter('text', i) as string;
+						const simple = this.getNodeParameter('simple', i) as boolean;
+
+						const body: IDataObject = {
+							Text: text,
+						};
+						const action = 'Comprehend_20171127.DetectDominantLanguage';
+						responseData = await awsApiRequestREST.call(
+							this,
+							'comprehend',
+							'POST',
+							'',
+							JSON.stringify(body),
+							{ 'x-amz-target': action, 'Content-Type': 'application/x-amz-json-1.1' },
+						);
+
+						if (simple) {
+							responseData = responseData.Languages.reduce(
+								(accumulator: { [key: string]: number }, currentValue: IDataObject) => {
+									accumulator[currentValue.LanguageCode as string] = currentValue.Score as number;
+									return accumulator;
+								},
+								{},
+							);
+						}
+					}
+
+					//https://docs.aws.amazon.com/comprehend/latest/dg/API_DetectSentiment.html
+					if (operation === 'detectSentiment') {
+						const action = 'Comprehend_20171127.DetectSentiment';
+						const text = this.getNodeParameter('text', i) as string;
+						const languageCode = this.getNodeParameter('languageCode', i) as string;
+						const body: IDataObject = {
+							Text: text,
+							LanguageCode: languageCode,
+						};
+						responseData = await awsApiRequestREST.call(
+							this,
+							'comprehend',
+							'POST',
+							'',
+							JSON.stringify(body),
+							{ 'x-amz-target': action, 'Content-Type': 'application/x-amz-json-1.1' },
+						);
+					}
+
+					//https://docs.aws.amazon.com/comprehend/latest/dg/API_DetectEntities.html
+					if (operation === 'detectEntities') {
+						const action = 'Comprehend_20171127.DetectEntities';
+						const text = this.getNodeParameter('text', i) as string;
+						const languageCode = this.getNodeParameter('languageCode', i) as string;
+						const additionalFields = this.getNodeParameter('additionalFields', i);
+
+						const body: IDataObject = {
+							Text: text,
+							LanguageCode: languageCode,
+						};
+
+						if (additionalFields.endpointArn) {
+							body.EndpointArn = additionalFields.endpointArn;
+						}
+
+						responseData = await awsApiRequestREST.call(
+							this,
+							'comprehend',
+							'POST',
+							'',
+							JSON.stringify(body),
+							{ 'x-amz-target': action, 'Content-Type': 'application/x-amz-json-1.1' },
+						);
+						responseData = responseData.Entities;
+					}
+				}
+
+				const executionData = this.helpers.constructExecutionMetaData(
+					this.helpers.returnJsonArray(responseData),
+					{ itemData: { item: i } },
+				);
+				returnData.push(...executionData);
+			} catch (error) {
+				if (this.continueOnFail()) {
+					const executionData = this.helpers.constructExecutionMetaData(
+						this.helpers.returnJsonArray({ error: error.message }),
+						{ itemData: { item: i } },
+					);
+					returnData.push(...executionData);
+					continue;
+				}
+				throw error;
+			}
+		}
+		return [returnData];
+	}
+}