LLM OCP API: Improve scheduleTask docblock

marcelklehr · marcelklehr · commit 9f405a19f782 · 2023-07-07T13:39:10.000+02:00
Signed-off-by: Marcel Klehr &lt;mklehr@gmx.net&gt;
diff --git a/lib/public/LanguageModel/ILanguageModelManager.php b/lib/public/LanguageModel/ILanguageModelManager.php
@@ -62,7 +62,8 @@ public function runTask(ILanguageModelTask $task): string;
 
 	/**
 	 * Will schedule an LLM inference process in the background. The result will become available
-	 * with the \OCP\LanguageModel\Events\TaskFinishedEvent
+	 * with the \OCP\LanguageModel\Events\TaskSuccessfulEvent
+	 * If inference fails a \OCP\LanguageModel\Events\TaskFailedEvent will be dispatched instead
 	 *
 	 * @throws PreConditionNotMetException If no or not the requested provider was registered but this method was still called
 	 * @since 28.0.0

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,8 @@ public function runTask(ILanguageModelTask $task): string;`
`62`	`62`
`63`	`63`	`/**`
`64`	`64`	`* Will schedule an LLM inference process in the background. The result will become available`
`65`		`- * with the \OCP\LanguageModel\Events\TaskFinishedEvent`
	`65`	`+ * with the \OCP\LanguageModel\Events\TaskSuccessfulEvent`
	`66`	`+ * If inference fails a \OCP\LanguageModel\Events\TaskFailedEvent will be dispatched instead`
`66`	`67`	`*`
`67`	`68`	`* @throws PreConditionNotMetException If no or not the requested provider was registered but this method was still called`
`68`	`69`	`* @since 28.0.0`