Massive refactoring: Turn LanguageModel OCP API into TextProcessing API

Signed-off-by: Marcel Klehr <mklehr@gmx.net>

1 files changed, 235 insertions, 0 deletions

diff --git a/lib/public/TextProcessing/Task.php b/lib/public/TextProcessing/Task.php
new file mode 100644
index 00000000000..59cd38b720c
--- /dev/null
+++ b/lib/public/TextProcessing/Task.php
@@ -0,0 +1,235 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2023 Marcel Klehr <mklehr@gmx.net>
+ *
+ * @author Marcel Klehr <mklehr@gmx.net>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace OCP\TextProcessing;
+
+/**
+ * This is a text processing task
+ * @since 27.1.0
+ * @template T of ITaskType
+ */
+final class Task implements \JsonSerializable {
+	protected ?int $id = null;
+	protected ?string $output = null;
+
+	/**
+	 * @since 27.1.0
+	 */
+	public const TYPES = [
+		FreePromptTaskType::class,
+		SummaryTaskType::class,
+		HeadlineTaskType::class,
+		TopicsTaskType::class,
+	];
+
+	/**
+	 * @since 27.1.0
+	 */
+	public const STATUS_FAILED = 4;
+	/**
+	 * @since 27.1.0
+	 */
+	public const STATUS_SUCCESSFUL = 3;
+	/**
+	 * @since 27.1.0
+	 */
+	public const STATUS_RUNNING = 2;
+	/**
+	 * @since 27.1.0
+	 */
+	public const STATUS_SCHEDULED = 1;
+	/**
+	 * @since 27.1.0
+	 */
+	public const STATUS_UNKNOWN = 0;
+
+	/**
+	 * @psalm-var self::STATUS_*
+	 */
+	protected int $status = self::STATUS_UNKNOWN;
+
+	/**
+	 * @param class-string<T> $type
+	 * @param string $input
+	 * @param string $appId
+	 * @param string|null $userId
+	 * @param string $identifier An arbitrary identifier for this task. max length: 255 chars
+	 * @since 27.1.0
+	 */
+	final public function __construct(
+		protected string $type,
+		protected string $input,
+		protected string $appId,
+		protected ?string $userId,
+		protected string $identifier = '',
+	) {
+	}
+
+	/**
+	 * @psalm-param IProvider<T> $provider
+	 * @param IProvider $provider
+	 * @return string
+	 * @since 27.1.0
+	 */
+	public function visitProvider(IProvider $provider): string {
+		if ($this->canUseProvider($provider)) {
+			return $provider->process($this->getInput());
+		} else {
+			throw new \RuntimeException('Task of type ' . $this->getType() . ' cannot visit provider with task type ' . $provider->getTaskType());
+		}
+	}
+
+	/**
+	 * @psalm-param IProvider<T> $provider
+	 * @param IProvider $provider
+	 * @return bool
+	 * @since 27.1.0
+	 */
+	public function canUseProvider(IProvider $provider): bool {
+		return $provider->getTaskType() === $this->getType();
+	}
+
+	/**
+	 * @return class-string<T>
+	 * @since 27.1.0
+	 */
+	final public function getType(): string {
+		return $this->type;
+	}
+
+	/**
+	 * @return string|null
+	 * @since 27.1.0
+	 */
+	final public function getOutput(): ?string {
+		return $this->output;
+	}
+
+	/**
+	 * @param string|null $output
+	 * @since 27.1.0
+	 */
+	final public function setOutput(?string $output): void {
+		$this->output = $output;
+	}
+
+	/**
+	 * @psalm-return self::STATUS_*
+	 * @since 27.1.0
+	 */
+	final public function getStatus(): int {
+		return $this->status;
+	}
+
+	/**
+	 * @psalm-param self::STATUS_* $status
+	 * @since 27.1.0
+	 */
+	final public function setStatus(int $status): void {
+		$this->status = $status;
+	}
+
+	/**
+	 * @return int|null
+	 * @since 27.1.0
+	 */
+	final public function getId(): ?int {
+		return $this->id;
+	}
+
+	/**
+	 * @param int|null $id
+	 * @since 27.1.0
+	 */
+	final public function setId(?int $id): void {
+		$this->id = $id;
+	}
+
+	/**
+	 * @return string
+	 * @since 27.1.0
+	 */
+	final public function getInput(): string {
+		return $this->input;
+	}
+
+	/**
+	 * @return string
+	 * @since 27.1.0
+	 */
+	final public function getAppId(): string {
+		return $this->appId;
+	}
+
+	/**
+	 * @return string
+	 * @since 27.1.0
+	 */
+	final public function getIdentifier(): string {
+		return $this->identifier;
+	}
+
+	/**
+	 * @return string|null
+	 * @since 27.1.0
+	 */
+	final public function getUserId(): ?string {
+		return $this->userId;
+	}
+
+	/**
+	 * @return array{id: ?string, type: class-string<T>, status: int, userId: ?string, appId: string, input: string, output: ?string, identifier: string}
+	 * @since 27.1.0
+	 */
+	public function jsonSerialize(): array {
+		return [
+			'id' => $this->getId(),
+			'type' => $this->getType(),
+			'status' => $this->getStatus(),
+			'userId' => $this->getUserId(),
+			'appId' => $this->getAppId(),
+			'input' => $this->getInput(),
+			'output' => $this->getOutput(),
+			'identifier' => $this->getIdentifier(),
+		];
+	}
+
+	/**
+	 * @param string $type
+	 * @param string $input
+	 * @param string|null $userId
+	 * @param string $appId
+	 * @param string $identifier
+	 * @return Task
+	 * @throws \InvalidArgumentException
+	 * @since 27.1.0
+	 */
+	final public static function factory(string $type, string $input, ?string $userId, string $appId, string $identifier = ''): Task {
+		if (!in_array($type, self::TYPES)) {
+			throw new \InvalidArgumentException('Unknown task type');
+		}
+		return new Task($type, $input, $appId, $userId, $identifier);
+	}
+}