LLM OCP API: Add @SInCE

Signed-off-by: Marcel Klehr <[email protected]>
(cherry picked from commit 9935034)

lib/public/LanguageModel/AbstractLanguageModelTask.php

@@ -4,11 +4,20 @@
 
 use OC\LanguageModel\Db\Task;
 
+/**
+ * @since 28.0.0
+ */
 abstract class AbstractLanguageModelTask implements ILanguageModelTask {
 	protected ?int $id;
 	protected ?string $output;
 	protected int $status = ILanguageModelTask::STATUS_UNKNOWN;
 
+	/**
+	 * @param string $input
+	 * @param string $appId
+	 * @param string|null $userId
+	 * @since 28.0.0
+	 */
 	final public function __construct(
 		protected string $input,
 		protected string $appId,
@@ -20,76 +29,99 @@ final public function __construct(
 	 * @param ILanguageModelProvider $provider
 	 * @return string
 	 * @throws \RuntimeException
+	 * @since 28.0.0
 	 */
 	abstract public function visitProvider(ILanguageModelProvider $provider): string;
 
+	/**
+	 * @param ILanguageModelProvider $provider
+	 * @return bool
+	 * @since 28.0.0
+	 */
 	abstract public function canUseProvider(ILanguageModelProvider $provider): bool;
 
+	/**
+	 * @return string
+	 * @since 28.0.0
+	 */
 	abstract public function getType(): string;
 
 	/**
 	 * @return string|null
+	 * @since 28.0.0
 	 */
 	final public function getOutput(): ?string {
 		return $this->output;
 	}
 
 	/**
 	 * @param string|null $output
+	 * @since 28.0.0
 	 */
 	final public function setOutput(?string $output): void {
 		$this->output = $output;
 	}
 
 	/**
 	 * @return int
+	 * @since 28.0.0
 	 */
 	final public function getStatus(): int {
 		return $this->status;
 	}
 
 	/**
 	 * @param int $status
+	 * @since 28.0.0
 	 */
 	final public function setStatus(int $status): void {
 		$this->status = $status;
 	}
 
 	/**
 	 * @return int|null
+	 * @since 28.0.0
 	 */
 	final public function getId(): ?int {
 		return $this->id;
 	}
 
 	/**
 	 * @param int|null $id
+	 * @since 28.0.0
 	 */
 	final public function setId(?int $id): void {
 		$this->id = $id;
 	}
 
 	/**
 	 * @return string
+	 * @since 28.0.0
 	 */
 	final public function getInput(): string {
 		return $this->input;
 	}
 
 	/**
 	 * @return string
+	 * @since 28.0.0
 	 */
 	final public function getAppId(): string {
 		return $this->appId;
 	}
 
 	/**
 	 * @return string|null
+	 * @since 28.0.0
 	 */
 	final public function getUserId(): ?string {
 		return $this->userId;
 	}
 
+	/**
+	 * @return array
+	 * @since 28.0.0
+	 */
 	public function jsonSerialize() {
 		return [
 			'id' => $this->getId(),
@@ -103,6 +135,11 @@ public function jsonSerialize() {
 	}
 
 
+	/**
+	 * @param Task $taskEntity
+	 * @return ILanguageModelTask
+	 * @since 28.0.0
+	 */
 	final public static function fromTaskEntity(Task $taskEntity): ILanguageModelTask {
 		$task = self::factory($taskEntity->getType(), $taskEntity->getInput(), $taskEntity->getuserId(), $taskEntity->getAppId());
 		$task->setId($taskEntity->getId());
@@ -117,6 +154,7 @@ final public static function fromTaskEntity(Task $taskEntity): ILanguageModelTas
 	 * @param string $appId
 	 * @return ILanguageModelTask
 	 * @throws \InvalidArgumentException
+	 * @since 28.0.0
 	 */
 	final public static function factory(string $type, string $input, ?string $userId, string $appId): ILanguageModelTask {
 		if (!in_array($type, self::TYPES)) {

lib/public/LanguageModel/Events/TaskFailedEvent.php

@@ -15,6 +15,7 @@ public function __construct(ILanguageModelTask $task,
 
 	/**
 	 * @return string
+	 * @since 28.0.0
 	 */
 	public function getErrorMessage(): string {
 		return $this->errorMessage;

lib/public/LanguageModel/FreePromptTask.php

@@ -4,13 +4,17 @@
 
 use RuntimeException;
 
+/**
+ * @since 28.0.0
+ */
 final class FreePromptTask extends AbstractLanguageModelTask {
+	/**
+	 * @since 28.0.0
+	 */
 	public const TYPE = 'free_prompt';
 
 	/**
-	 * @param ILanguageModelProvider $provider
-	 * @throws RuntimeException
-	 * @return string
+	 * @inheritDoc
 	 */
 	public function visitProvider(ILanguageModelProvider $provider): string {
 		return $provider->prompt($this->getInput());

lib/public/LanguageModel/HeadlineTask.php

@@ -4,7 +4,13 @@
 
 use RuntimeException;
 
+/**
+ * @since 28.0.0
+ */
 final class HeadlineTask extends AbstractLanguageModelTask {
+	/**
+	 * @since 28.0.0
+	 */
 	public const TYPE = 'headline';
 
 	/**

lib/public/LanguageModel/ILanguageModelManager.php

@@ -68,6 +68,7 @@ public function scheduleTask(ILanguageModelTask $task) : void;
 	 * @return ILanguageModelTask
 	 * @throws RuntimeException If the query failed
 	 * @throws \ValueError If the task could not be found
+	 * @since 28.0.0
 	 */
 	public function getTask(int $id): ILanguageModelTask;
 }

lib/public/LanguageModel/ILanguageModelTask.php

@@ -2,72 +2,113 @@
 
 namespace OCP\LanguageModel;
 
+/**
+ * @since 28.0.0
+ */
 interface ILanguageModelTask extends \JsonSerializable {
+	/**
+	 * @since 28.0.0
+	 */
 	public const STATUS_FAILED = 4;
+	/**
+	 * @since 28.0.0
+	 */
 	public const STATUS_SUCCESSFUL = 3;
+	/**
+	 * @since 28.0.0
+	 */
 	public const STATUS_RUNNING = 2;
+	/**
+	 * @since 28.0.0
+	 */
 	public const STATUS_SCHEDULED = 1;
+	/**
+	 * @since 28.0.0
+	 */
 	public const STATUS_UNKNOWN = 0;
 
+	/**
+	 * @since 28.0.0
+	 */
 	public const TYPES = [
 		FreePromptTask::TYPE => FreePromptTask::class,
 		SummaryTask::TYPE => SummaryTask::class,
 		HeadlineTask::TYPE => HeadlineTask::class,
 		TopicsTask::TYPE => TopicsTask::class,
 	];
 
+	/**
+	 * @param ILanguageModelProvider $provider
+	 * @return string
+	 * @since 28.0.0
+	 */
 	public function visitProvider(ILanguageModelProvider $provider): string;
 
+	/**
+	 * @param ILanguageModelProvider $provider
+	 * @return bool
+	 * @since 28.0.0
+	 */
 	public function canUseProvider(ILanguageModelProvider $provider): bool;
 
 
 	/**
 	 * @return string
+	 * @since 28.0.0
 	 */
 	public function getType(): string;
 
 	/**
 	 * @return int
+	 * @since 28.0.0
 	 */
 	public function getStatus(): int;
 
 	/**
 	 * @param int $status
+	 * @since 28.0.0
 	 */
 	public function setStatus(int $status): void;
 
 	/**
 	 * @param int|null $id
+	 * @since 28.0.0
 	 */
 	public function setId(?int $id): void;
 
 	/**
 	 * @return int|null
+	 * @since 28.0.0
 	 */
 	public function getId(): ?int;
 
 	/**
 	 * @return string
+	 * @since 28.0.0
 	 */
 	public function getInput(): string;
 
 	/**
 	 * @param string|null $output
+	 * @since 28.0.0
 	 */
 	public function setOutput(?string $output): void;
 
 	/**
 	 * @return null|string
+	 * @since 28.0.0
 	 */
 	public function getOutput(): ?string;
 
 	/**
 	 * @return string
+	 * @since 28.0.0
 	 */
 	public function getAppId(): string;
 
 	/**
 	 * @return string|null
+	 * @since 28.0.0
 	 */
 	public function getUserId(): ?string;
 }