return a message on the file action endpoint for the client integration

Signed-off-by: Julien Veyssier <julien-nc@posteo.net>

Author: julien-nc

lib/Controller/AssistantApiController.php

@@ -28,6 +28,8 @@
 use OCP\IRequest;
 use OCP\Lock\LockedException;
 use OCP\TaskProcessing\Task;
+use OCP\TaskProcessing\TaskTypes\AudioToText;
+use OCP\TaskProcessing\TaskTypes\TextToTextSummary;
 use Psr\Log\LoggerInterface;
 use Throwable;
 
@@ -418,16 +420,26 @@ public function getOutputFile(int $ocpTaskId, int $fileId): DataDownloadResponse
 	 *
 	 * @param int $fileId The input file ID
 	 * @param string $taskTypeId The task type of the operation to perform
-	 * @return DataResponse<Http::STATUS_OK, array{taskId: int}, array{}>|DataResponse<Http::STATUS_BAD_REQUEST, array{error: string}, array{}>
+	 * @return DataResponse<Http::STATUS_OK, string, array{}>|DataResponse<Http::STATUS_BAD_REQUEST, array{error: string}, array{}>
 	 *
 	 * 200: The task has been scheduled successfully
 	 * 400: There was an issue while scheduling the task
 	 */
 	#[NoAdminRequired]
 	public function runFileAction(int $fileId, string $taskTypeId): DataResponse {
 		try {
-			$taskId = $this->taskProcessingService->runFileAction($this->userId, $fileId, $taskTypeId);
-			return new DataResponse(['taskId' => $taskId]);
+			$this->taskProcessingService->runFileAction($this->userId, $fileId, $taskTypeId);
+			if ($taskTypeId === AudioToText::ID) {
+				$message = $this->l10n->t('Transcription task submitted successfully');
+			} elseif ($taskTypeId === TextToTextSummary::ID) {
+				$message = $this->l10n->t('Summarization task submitted successfully');
+			} elseif (class_exists('OCP\\TaskProcessing\\TaskTypes\\TextToSpeech')
+				&& $taskTypeId === \OCP\TaskProcessing\TaskTypes\TextToSpeech::ID) {
+				$message = $this->l10n->t('Text-to-speech task submitted successfully');
+			} else {
+				$message = $this->l10n->t('Assistant task submitted successfully');
+			}
+			return new DataResponse($message);
 		} catch (Exception|Throwable $e) {
 			return new DataResponse(['error' => $e->getMessage()], Http::STATUS_BAD_REQUEST);
 		}

openapi.json

@@ -2195,16 +2195,7 @@
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
                                                 "data": {
-                                                    "type": "object",
-                                                    "required": [
-                                                        "taskId"
-                                                    ],
-                                                    "properties": {
-                                                        "taskId": {
-                                                            "type": "integer",
-                                                            "format": "int64"
-                                                        }
-                                                    }
+                                                    "type": "string"
                                                 }
                                             }
                                         }

src/files/fileActions.js

@@ -62,7 +62,6 @@ function registerSummarizeAction() {
 			const url = generateOcsUrl('/apps/assistant/api/v1/file-action/{fileId}/core:text2text:summary', { fileId: node.fileid })
 			try {
 				const response = await axios.post(url)
-				console.debug('taskId', response.data.ocs.data.taskId)
 				showSuccess(
 					t('assistant', 'Summarization task submitted successfully.') + '\n'
 						+ t('assistant', 'You will be notified when it is ready.') + '\n'
@@ -101,7 +100,6 @@ function registerTtsAction() {
 			const url = generateOcsUrl('/apps/assistant/api/v1/file-action/{fileId}/core:text2speech', { fileId: node.fileid })
 			try {
 				const response = await axios.post(url)
-				console.debug('taskId', response.data.ocs.data.taskId)
 				showSuccess(
 					t('assistant', 'Text-to-speech task submitted successfully.') + '\n'
 						+ t('assistant', 'You will be notified when it is ready.') + '\n'
@@ -140,7 +138,6 @@ function registerSttAction() {
 			const url = generateOcsUrl('/apps/assistant/api/v1/file-action/{fileId}/core:audio2text', { fileId: node.fileid })
 			try {
 				const response = await axios.post(url)
-				console.debug('taskId', response.data.ocs.data.taskId)
 				showSuccess(
 					t('assistant', 'Transcription task submitted successfully.') + '\n'
 						+ t('assistant', 'You will be notified when it is ready.') + '\n'