n8n-nodes-qlik-cloud 1.0.1 → 1.0.3

package/src/icons/qlik.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" id="Layer_1" viewBox="0 0 71.39 29.74"><defs><style>.cls-2{stroke-width:0;fill:#54565a}</style></defs><path d="M70.47 27.52c.05-.07.07-.15.07-.24s-.02-.17-.07-.24-.1-.11-.16-.14a.38.38 0 0 0-.17-.04h-.66v1.31h.29v-.44h.29l.23.44h.32l-.27-.51a.47.47 0 0 0 .15-.13Zm-.71-.45h.27s.07.01.12.04c.04.03.07.08.07.16s-.02.14-.07.18c-.05.04-.09.06-.13.06h-.27v-.44Z" class="cls-2"/><path d="M71.28 26.97c-.07-.17-.17-.32-.31-.45-.13-.13-.28-.23-.45-.31s-.36-.11-.55-.11-.38.04-.55.11-.32.18-.45.31-.23.28-.3.45c-.07.17-.11.36-.11.55s.04.38.11.55c.07.17.17.32.3.45.13.13.28.23.45.31s.36.11.55.11.38-.04.55-.11.32-.18.45-.31.23-.28.31-.45c.07-.17.11-.36.11-.55s-.04-.38-.11-.55Zm-.37 1.1c-.1.16-.23.29-.39.39-.16.1-.34.15-.54.15s-.38-.05-.54-.15c-.16-.1-.29-.23-.39-.39-.1-.16-.15-.34-.15-.54s.05-.38.15-.54c.1-.16.23-.29.39-.39.16-.1.34-.15.54-.15s.38.05.54.15c.16.1.29.23.39.39.1.16.15.34.15.54s-.05.38-.15.54ZM34.9.65h2.96v28.32H34.9zM42.95 9.19h2.95v19.78h-2.95z" class="cls-2"/><circle cx="44.45" cy="2.67" r="2.02" class="cls-2"/><path d="M66.62 9.19h-4.11l-8.52 7.46-.02-16h-2.94v28.32h2.94v-9.14l8.75 9.14h4.1L56.39 18.39l10.23-9.2zM14.87 26.69c-6.53 0-11.82-5.29-11.82-11.82 0-2.77.96-5.32 2.55-7.34L3.44 5.34A14.922 14.922 0 0 0 0 14.87c0 8.21 6.66 14.87 14.87 14.87 3.56 0 6.83-1.25 9.39-3.34l-2.16-2.19c-2 1.55-4.5 2.47-7.23 2.47Z" class="cls-2"/><path fill="#009445" stroke-width="0" d="m26.31 24.34.17-.17a14.83 14.83 0 0 0 3.26-9.3C29.74 6.66 23.08 0 14.87 0c-3.54 0-6.79 1.24-9.34 3.3-.74.6-1.41 1.26-2.03 1.98-.02.02-.03.04-.05.06l2.16 2.19s.04-.05.06-.07c.59-.74 1.27-1.4 2.02-1.97a11.74 11.74 0 0 1 7.18-2.44c6.53 0 11.82 5.29 11.82 11.82 0 2.75-.94 5.29-2.52 7.3-.57.73-1.23 1.39-1.95 1.96l-.12.09 2.16 2.19 2.54 2.57h4.1l-4.59-4.64Z"/></svg>

package/src/nodes/QlikCloud/QlikCloud.node.ts

@@ -116,6 +116,15 @@ async function handleAssistantsResource(operation: string, context: IExecuteFunc
 		if (options.limit) {
 			qs.limit = options.limit;
 		}
+		if (options.next) {
+			qs.next = options.next;
+		}
+		if (options.prev) {
+			qs.prev = options.prev;
+		}
+		if (options.sort) {
+			qs.sort = options.sort;
+		}
 
 		return await qlikApiRequest.call(context, 'GET', '/api/v1/assistants', undefined, qs);
 	}
@@ -127,16 +136,44 @@ async function handleAssistantsResource(operation: string, context: IExecuteFunc
 
 	if (operation === 'create') {
 		const name = context.getNodeParameter('name', 0) as string;
+		const title = context.getNodeParameter('title', 0) as string;
+		const description = context.getNodeParameter('description', 0) as string;
+		const spaceId = context.getNodeParameter('spaceId', 0) as string;
 		const options = context.getNodeParameter('options', 0) as any;
 
-		const body: any = { name };
-		if (options.description) {
-			body.description = options.description;
+		const body: any = { name, title, description, spaceId };
+		if (options.tags) {
+			body.tags = options.tags.split(',').map((tag: string) => tag.trim());
+		}
+		if (options.knowledgeBases) {
+			body.knowledgeBases = options.knowledgeBases.split(',').map((kb: string) => kb.trim());
+		}
+		if (options.welcomeMessage) {
+			body.welcomeMessage = options.welcomeMessage;
+		}
+		if (options.customProperties) {
+			body.customProperties = typeof options.customProperties === 'string'
+				? JSON.parse(options.customProperties)
+				: options.customProperties;
 		}
 
 		return await qlikApiRequest.call(context, 'POST', '/api/v1/assistants', body);
 	}
 
+	if (operation === 'update') {
+		const assistantId = context.getNodeParameter('assistantId', 0) as string;
+		const body = context.getNodeParameter('body', 0) as any;
+
+		const patchOps = typeof body === 'string' ? JSON.parse(body) : body;
+
+		return await qlikApiRequest.call(
+			context,
+			'PATCH',
+			`/api/v1/assistants/${assistantId}`,
+			patchOps,
+		);
+	}
+
 	if (operation === 'search') {
 		const assistantId = context.getNodeParameter('assistantId', 0) as string;
 		const query = context.getNodeParameter('query', 0) as string;
@@ -158,6 +195,89 @@ async function handleAssistantsResource(operation: string, context: IExecuteFunc
 		);
 	}
 
+	if (operation === 'getFeedback') {
+		const assistantId = context.getNodeParameter('assistantId', 0) as string;
+		return await qlikApiRequest.call(context, 'GET', `/api/v1/assistants/${assistantId}/feedback`);
+	}
+
+	if (operation === 'bulkSearchSources') {
+		const assistantId = context.getNodeParameter('assistantId', 0) as string;
+		const chunkIds = context.getNodeParameter('chunkIds', 0) as any;
+
+		const body = typeof chunkIds === 'string' ? JSON.parse(chunkIds) : chunkIds;
+
+		return await qlikApiRequest.call(
+			context,
+			'POST',
+			`/api/v1/assistants/${assistantId}/sources/plaintexts`,
+			{ chunkIds: body },
+		);
+	}
+
+	if (operation === 'listStarters') {
+		const assistantId = context.getNodeParameter('assistantId', 0) as string;
+		const options = context.getNodeParameter('options', 0) as any;
+
+		const qs: any = {};
+		if (options.limit) {
+			qs.limit = options.limit;
+		}
+
+		return await qlikApiRequest.call(context, 'GET', `/api/v1/assistants/${assistantId}/starters`, undefined, qs);
+	}
+
+	if (operation === 'createStarter') {
+		const assistantId = context.getNodeParameter('assistantId', 0) as string;
+		const question = context.getNodeParameter('question', 0) as string;
+		const options = context.getNodeParameter('options', 0) as any;
+
+		const body: any = { question };
+		if (options.followups) {
+			body.followups = typeof options.followups === 'string'
+				? JSON.parse(options.followups)
+				: options.followups;
+		}
+		if (options.additionalContext) {
+			body.additionalContext = options.additionalContext;
+		}
+
+		return await qlikApiRequest.call(
+			context,
+			'POST',
+			`/api/v1/assistants/${assistantId}/starters`,
+			body,
+		);
+	}
+
+	if (operation === 'listThreads') {
+		const assistantId = context.getNodeParameter('assistantId', 0) as string;
+		const options = context.getNodeParameter('options', 0) as any;
+
+		const qs: any = {};
+		if (options.limit) {
+			qs.limit = options.limit;
+		}
+		if (options.filter) {
+			qs.filter = options.filter;
+		}
+
+		return await qlikApiRequest.call(context, 'GET', `/api/v1/assistants/${assistantId}/threads`, undefined, qs);
+	}
+
+	if (operation === 'createThread') {
+		const assistantId = context.getNodeParameter('assistantId', 0) as string;
+		const name = context.getNodeParameter('name', 0) as string;
+
+		const body: any = { name };
+
+		return await qlikApiRequest.call(
+			context,
+			'POST',
+			`/api/v1/assistants/${assistantId}/threads`,
+			body,
+		);
+	}
+
 	if (operation === 'delete') {
 		const assistantId = context.getNodeParameter('assistantId', 0) as string;
 		await qlikApiRequest.call(context, 'DELETE', `/api/v1/assistants/${assistantId}`);

package/src/nodes/QlikCloud/resources/assistants/index.ts

@@ -1,5 +1,6 @@
 import type { INodeProperties } from 'n8n-workflow';
 
+// Get All Assistants
 export const assistantsGetAllDescription: INodeProperties[] = [
 	{
 		displayName: 'Options',
@@ -19,12 +20,34 @@ export const assistantsGetAllDescription: INodeProperties[] = [
 				name: 'limit',
 				type: 'number',
 				default: 50,
-				description: 'Max number of assistants to return',
+				description: 'The number of assistants to get',
+			},
+			{
+				displayName: 'Next Page',
+				name: 'next',
+				type: 'string',
+				default: '',
+				description: 'Optional parameter to request the next page',
+			},
+			{
+				displayName: 'Previous Page',
+				name: 'prev',
+				type: 'string',
+				default: '',
+				description: 'Optional parameter to request the previous page',
+			},
+			{
+				displayName: 'Sort By',
+				name: 'sort',
+				type: 'string',
+				default: '',
+				description: 'Optional resource field name to sort on (e.g., name). Prefix with `-` for descending order',
 			},
 		],
 	},
 ];
 
+// Get Single Assistant
 export const assistantsGetDescription: INodeProperties[] = [
 	{
 		displayName: 'Assistant ID',
@@ -42,9 +65,10 @@ export const assistantsGetDescription: INodeProperties[] = [
 	},
 ];
 
+// Create Assistant
 export const assistantsCreateDescription: INodeProperties[] = [
 	{
-		displayName: 'Assistant Name',
+		displayName: 'Name',
 		name: 'name',
 		type: 'string',
 		default: '',
@@ -55,7 +79,49 @@ export const assistantsCreateDescription: INodeProperties[] = [
 				operation: ['create'],
 			},
 		},
-		description: 'Name of the new assistant',
+		description: 'The name of the assistant',
+	},
+	{
+		displayName: 'Title',
+		name: 'title',
+		type: 'string',
+		default: '',
+		required: true,
+		displayOptions: {
+			show: {
+				resource: ['assistants'],
+				operation: ['create'],
+			},
+		},
+		description: 'The title of the assistant',
+	},
+	{
+		displayName: 'Description',
+		name: 'description',
+		type: 'string',
+		default: '',
+		required: true,
+		displayOptions: {
+			show: {
+				resource: ['assistants'],
+				operation: ['create'],
+			},
+		},
+		description: 'The description of the assistant',
+	},
+	{
+		displayName: 'Space ID',
+		name: 'spaceId',
+		type: 'string',
+		default: '',
+		required: true,
+		displayOptions: {
+			show: {
+				resource: ['assistants'],
+				operation: ['create'],
+			},
+		},
+		description: 'Unique identifier of the space to contain the assistant',
 	},
 	{
 		displayName: 'Options',
@@ -71,16 +137,70 @@ export const assistantsCreateDescription: INodeProperties[] = [
 		},
 		options: [
 			{
-				displayName: 'Description',
-				name: 'description',
+				displayName: 'Tags',
+				name: 'tags',
+				type: 'string',
+				default: '',
+				description: 'Comma-separated list of tags for the assistant',
+			},
+			{
+				displayName: 'Knowledge Bases',
+				name: 'knowledgeBases',
 				type: 'string',
 				default: '',
-				description: 'Description of the assistant',
+				description: 'Comma-separated list of knowledge base IDs',
+			},
+			{
+				displayName: 'Welcome Message',
+				name: 'welcomeMessage',
+				type: 'string',
+				default: '',
+				description: 'Initial message in the chat conversation',
+			},
+			{
+				displayName: 'Custom Properties (JSON)',
+				name: 'customProperties',
+				type: 'json',
+				default: '{}',
+				description: 'Freeform JSON to allow custom customization options',
 			},
 		],
 	},
 ];
 
+// Update Assistant
+export const assistantsUpdateDescription: INodeProperties[] = [
+	{
+		displayName: 'Assistant ID',
+		name: 'assistantId',
+		type: 'string',
+		default: '',
+		required: true,
+		displayOptions: {
+			show: {
+				resource: ['assistants'],
+				operation: ['update'],
+			},
+		},
+		description: 'The ID of the assistant to update',
+	},
+	{
+		displayName: 'JSON Patch Operations',
+		name: 'body',
+		type: 'json',
+		default: '[]',
+		required: true,
+		displayOptions: {
+			show: {
+				resource: ['assistants'],
+				operation: ['update'],
+			},
+		},
+		description: 'Array of JSON Patch operations to apply to the assistant',
+	},
+];
+
+// Search Assistant
 export const assistantsSearchDescription: INodeProperties[] = [
 	{
 		displayName: 'Assistant ID',
@@ -153,6 +273,57 @@ export const assistantsSearchDescription: INodeProperties[] = [
 	},
 ];
 
+// Get Feedback
+export const assistantsGetFeedbackDescription: INodeProperties[] = [
+	{
+		displayName: 'Assistant ID',
+		name: 'assistantId',
+		type: 'string',
+		default: '',
+		required: true,
+		displayOptions: {
+			show: {
+				resource: ['assistants'],
+				operation: ['getFeedback'],
+			},
+		},
+		description: 'The ID of the assistant to get feedback for',
+	},
+];
+
+// Bulk Search Source Chunks
+export const assistantsBulkSearchSourcesDescription: INodeProperties[] = [
+	{
+		displayName: 'Assistant ID',
+		name: 'assistantId',
+		type: 'string',
+		default: '',
+		required: true,
+		displayOptions: {
+			show: {
+				resource: ['assistants'],
+				operation: ['bulkSearchSources'],
+			},
+		},
+		description: 'The ID of the assistant to search sources for',
+	},
+	{
+		displayName: 'Chunk IDs',
+		name: 'chunkIds',
+		type: 'json',
+		default: '[]',
+		required: true,
+		displayOptions: {
+			show: {
+				resource: ['assistants'],
+				operation: ['bulkSearchSources'],
+			},
+		},
+		description: 'Array of chunk IDs to search for',
+	},
+];
+
+// Delete Assistant
 export const assistantsDeleteDescription: INodeProperties[] = [
 	{
 		displayName: 'Assistant ID',
@@ -170,6 +341,186 @@ export const assistantsDeleteDescription: INodeProperties[] = [
 	},
 ];
 
+// List Starters
+export const assistantsListStartersDescription: INodeProperties[] = [
+	{
+		displayName: 'Assistant ID',
+		name: 'assistantId',
+		type: 'string',
+		default: '',
+		required: true,
+		displayOptions: {
+			show: {
+				resource: ['assistants'],
+				operation: ['listStarters'],
+			},
+		},
+		description: 'The ID of the assistant',
+	},
+	{
+		displayName: 'Options',
+		name: 'options',
+		type: 'collection',
+		placeholder: 'Add Option',
+		default: {},
+		displayOptions: {
+			show: {
+				resource: ['assistants'],
+				operation: ['listStarters'],
+			},
+		},
+		options: [
+			{
+				displayName: 'Limit',
+				name: 'limit',
+				type: 'number',
+				default: 50,
+				description: 'The number of starters to get',
+			},
+		],
+	},
+];
+
+// Create Starter
+export const assistantsCreateStarterDescription: INodeProperties[] = [
+	{
+		displayName: 'Assistant ID',
+		name: 'assistantId',
+		type: 'string',
+		default: '',
+		required: true,
+		displayOptions: {
+			show: {
+				resource: ['assistants'],
+				operation: ['createStarter'],
+			},
+		},
+		description: 'The ID of the assistant',
+	},
+	{
+		displayName: 'Question',
+		name: 'question',
+		type: 'string',
+		default: '',
+		required: true,
+		displayOptions: {
+			show: {
+				resource: ['assistants'],
+				operation: ['createStarter'],
+			},
+		},
+		description: 'Starter sample question',
+	},
+	{
+		displayName: 'Options',
+		name: 'options',
+		type: 'collection',
+		placeholder: 'Add Option',
+		default: {},
+		displayOptions: {
+			show: {
+				resource: ['assistants'],
+				operation: ['createStarter'],
+			},
+		},
+		options: [
+			{
+				displayName: 'Followups (JSON)',
+				name: 'followups',
+				type: 'json',
+				default: '[]',
+				description: 'List of followup questions',
+			},
+			{
+				displayName: 'Additional Context',
+				name: 'additionalContext',
+				type: 'string',
+				default: '',
+				description: 'Optional context for the question',
+			},
+		],
+	},
+];
+
+// List Threads
+export const assistantsListThreadsDescription: INodeProperties[] = [
+	{
+		displayName: 'Assistant ID',
+		name: 'assistantId',
+		type: 'string',
+		default: '',
+		required: true,
+		displayOptions: {
+			show: {
+				resource: ['assistants'],
+				operation: ['listThreads'],
+			},
+		},
+		description: 'The ID of the assistant',
+	},
+	{
+		displayName: 'Options',
+		name: 'options',
+		type: 'collection',
+		placeholder: 'Add Option',
+		default: {},
+		displayOptions: {
+			show: {
+				resource: ['assistants'],
+				operation: ['listThreads'],
+			},
+		},
+		options: [
+			{
+				displayName: 'Limit',
+				name: 'limit',
+				type: 'number',
+				default: 50,
+				description: 'The number of threads to get',
+			},
+			{
+				displayName: 'Filter',
+				name: 'filter',
+				type: 'string',
+				default: '',
+				description: 'Optional parameter to filter threads',
+			},
+		],
+	},
+];
+
+// Create Thread
+export const assistantsCreateThreadDescription: INodeProperties[] = [
+	{
+		displayName: 'Assistant ID',
+		name: 'assistantId',
+		type: 'string',
+		default: '',
+		required: true,
+		displayOptions: {
+			show: {
+				resource: ['assistants'],
+				operation: ['createThread'],
+			},
+		},
+		description: 'The ID of the assistant',
+	},
+	{
+		displayName: 'Thread Name',
+		name: 'name',
+		type: 'string',
+		default: '',
+		required: true,
+		displayOptions: {
+			show: {
+				resource: ['assistants'],
+				operation: ['createThread'],
+			},
+		},
+		description: 'The name of the thread',
+	},
+];
+
 export const assistantDescription: INodeProperties[] = [
 	{
 		displayName: 'Operation',
@@ -200,17 +551,59 @@ export const assistantDescription: INodeProperties[] = [
 				action: 'Create an assistant',
 				description: 'Create a new assistant',
 			},
+			{
+				name: 'Update',
+				value: 'update',
+				action: 'Update an assistant',
+				description: 'Update assistant properties',
+			},
 			{
 				name: 'Search',
 				value: 'search',
 				action: 'Search assistant sources',
 				description: 'Perform search in assistant sources',
 			},
+			{
+				name: 'Get Feedback',
+				value: 'getFeedback',
+				action: 'Get assistant feedback',
+				description: 'Retrieve feedback summary for the assistant',
+			},
+			{
+				name: 'Bulk Search Sources',
+				value: 'bulkSearchSources',
+				action: 'Bulk search source chunks',
+				description: 'Perform a bulk search for source chunks',
+			},
+			{
+				name: 'List Starters',
+				value: 'listStarters',
+				action: 'List assistant starters',
+				description: 'Retrieve list of starters for the assistant',
+			},
+			{
+				name: 'Create Starter',
+				value: 'createStarter',
+				action: 'Create an assistant starter',
+				description: 'Create a new starter for the assistant',
+			},
+			{
+				name: 'List Threads',
+				value: 'listThreads',
+				action: 'List assistant threads',
+				description: 'Retrieve list of threads for the assistant',
+			},
+			{
+				name: 'Create Thread',
+				value: 'createThread',
+				action: 'Create an assistant thread',
+				description: 'Create a new thread for the assistant',
+			},
 			{
 				name: 'Delete',
 				value: 'delete',
 				action: 'Delete an assistant',
-				description: 'Delete an assistant',
+				description: 'Delete an assistant and all its resources',
 			},
 		],
 		default: 'getAll',
@@ -218,6 +611,13 @@ export const assistantDescription: INodeProperties[] = [
 	...assistantsGetAllDescription,
 	...assistantsGetDescription,
 	...assistantsCreateDescription,
+	...assistantsUpdateDescription,
 	...assistantsSearchDescription,
+	...assistantsGetFeedbackDescription,
+	...assistantsBulkSearchSourcesDescription,
+	...assistantsListStartersDescription,
+	...assistantsCreateStarterDescription,
+	...assistantsListThreadsDescription,
+	...assistantsCreateThreadDescription,
 	...assistantsDeleteDescription,
 ];