aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/TextProcessing
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/TextProcessing')
-rw-r--r--lib/public/TextProcessing/Events/AbstractTextProcessingEvent.php24
-rw-r--r--lib/public/TextProcessing/Events/TaskFailedEvent.php5
-rw-r--r--lib/public/TextProcessing/Events/TaskSuccessfulEvent.php5
-rw-r--r--lib/public/TextProcessing/Exception/TaskFailureException.php5
-rw-r--r--lib/public/TextProcessing/FreePromptTaskType.php21
-rw-r--r--lib/public/TextProcessing/HeadlineTaskType.php21
-rw-r--r--lib/public/TextProcessing/IManager.php21
-rw-r--r--lib/public/TextProcessing/IProvider.php21
-rw-r--r--lib/public/TextProcessing/IProviderWithExpectedRuntime.php21
-rw-r--r--lib/public/TextProcessing/IProviderWithId.php21
-rw-r--r--lib/public/TextProcessing/IProviderWithUserId.php21
-rw-r--r--lib/public/TextProcessing/ITaskType.php21
-rw-r--r--lib/public/TextProcessing/SummaryTaskType.php21
-rw-r--r--lib/public/TextProcessing/Task.php21
-rw-r--r--lib/public/TextProcessing/TopicsTaskType.php21
15 files changed, 52 insertions, 218 deletions
diff --git a/lib/public/TextProcessing/Events/AbstractTextProcessingEvent.php b/lib/public/TextProcessing/Events/AbstractTextProcessingEvent.php
index 329889e61f0..8b944254020 100644
--- a/lib/public/TextProcessing/Events/AbstractTextProcessingEvent.php
+++ b/lib/public/TextProcessing/Events/AbstractTextProcessingEvent.php
@@ -3,25 +3,8 @@
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/>.
- *
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\TextProcessing\Events;
@@ -30,13 +13,14 @@ use OCP\TextProcessing\Task;
/**
* @since 27.1.0
+ * @deprecated 30.0.0
*/
abstract class AbstractTextProcessingEvent extends Event {
/**
* @since 27.1.0
*/
public function __construct(
- private Task $task
+ private Task $task,
) {
parent::__construct();
}
diff --git a/lib/public/TextProcessing/Events/TaskFailedEvent.php b/lib/public/TextProcessing/Events/TaskFailedEvent.php
index f9765e362dc..dfdb9137f95 100644
--- a/lib/public/TextProcessing/Events/TaskFailedEvent.php
+++ b/lib/public/TextProcessing/Events/TaskFailedEvent.php
@@ -1,11 +1,16 @@
<?php
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
namespace OCP\TextProcessing\Events;
use OCP\TextProcessing\Task;
/**
* @since 27.1.0
+ * @deprecated 30.0.0
*/
class TaskFailedEvent extends AbstractTextProcessingEvent {
/**
diff --git a/lib/public/TextProcessing/Events/TaskSuccessfulEvent.php b/lib/public/TextProcessing/Events/TaskSuccessfulEvent.php
index df4d2ba6227..0716f4d45c6 100644
--- a/lib/public/TextProcessing/Events/TaskSuccessfulEvent.php
+++ b/lib/public/TextProcessing/Events/TaskSuccessfulEvent.php
@@ -1,9 +1,14 @@
<?php
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
namespace OCP\TextProcessing\Events;
/**
* @since 27.1.0
+ * @deprecated 30.0.0
*/
class TaskSuccessfulEvent extends AbstractTextProcessingEvent {
}
diff --git a/lib/public/TextProcessing/Exception/TaskFailureException.php b/lib/public/TextProcessing/Exception/TaskFailureException.php
index 300864711e7..06fbdf5e765 100644
--- a/lib/public/TextProcessing/Exception/TaskFailureException.php
+++ b/lib/public/TextProcessing/Exception/TaskFailureException.php
@@ -1,10 +1,15 @@
<?php
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
namespace OCP\TextProcessing\Exception;
/**
* Exception thrown when a task failed
* @since 28.0.0
+ * @deprecated 30.0.0
*/
class TaskFailureException extends \RuntimeException {
}
diff --git a/lib/public/TextProcessing/FreePromptTaskType.php b/lib/public/TextProcessing/FreePromptTaskType.php
index 2cb8d6b7946..2433f24dbd7 100644
--- a/lib/public/TextProcessing/FreePromptTaskType.php
+++ b/lib/public/TextProcessing/FreePromptTaskType.php
@@ -3,24 +3,8 @@
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/>.
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\TextProcessing;
@@ -31,6 +15,7 @@ use OCP\L10N\IFactory;
/**
* This is the text processing task type for free prompting
* @since 27.1.0
+ * @deprecated 30.0.0
*/
class FreePromptTaskType implements ITaskType {
private IL10N $l;
diff --git a/lib/public/TextProcessing/HeadlineTaskType.php b/lib/public/TextProcessing/HeadlineTaskType.php
index 7061ca1d69b..00eb66466ae 100644
--- a/lib/public/TextProcessing/HeadlineTaskType.php
+++ b/lib/public/TextProcessing/HeadlineTaskType.php
@@ -3,24 +3,8 @@
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/>.
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\TextProcessing;
@@ -31,6 +15,7 @@ use OCP\L10N\IFactory;
/**
* This is the text processing task type for creating headline
* @since 27.1.0
+ * @deprecated 30.0.0
*/
class HeadlineTaskType implements ITaskType {
private IL10N $l;
diff --git a/lib/public/TextProcessing/IManager.php b/lib/public/TextProcessing/IManager.php
index 2f517a4ebe2..701ad18940f 100644
--- a/lib/public/TextProcessing/IManager.php
+++ b/lib/public/TextProcessing/IManager.php
@@ -3,24 +3,8 @@
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/>.
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
@@ -36,6 +20,7 @@ use RuntimeException;
* API surface for apps interacting with and making use of LanguageModel providers
* without known which providers are installed
* @since 27.1.0
+ * @deprecated 30.0.0
*/
interface IManager {
/**
diff --git a/lib/public/TextProcessing/IProvider.php b/lib/public/TextProcessing/IProvider.php
index fc57add1835..24efbc1ec8c 100644
--- a/lib/public/TextProcessing/IProvider.php
+++ b/lib/public/TextProcessing/IProvider.php
@@ -3,24 +3,8 @@
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/>.
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
@@ -33,6 +17,7 @@ use RuntimeException;
* implement a text processing provider
* @psalm-template-covariant T of ITaskType
* @since 27.1.0
+ * @deprecated 30.0.0
*/
interface IProvider {
/**
diff --git a/lib/public/TextProcessing/IProviderWithExpectedRuntime.php b/lib/public/TextProcessing/IProviderWithExpectedRuntime.php
index 17767fc02d4..b3986e8b3a8 100644
--- a/lib/public/TextProcessing/IProviderWithExpectedRuntime.php
+++ b/lib/public/TextProcessing/IProviderWithExpectedRuntime.php
@@ -3,24 +3,8 @@
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/>.
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
@@ -31,6 +15,7 @@ namespace OCP\TextProcessing;
* @since 28.0.0
* @template T of ITaskType
* @template-extends IProvider<T>
+ * @deprecated 30.0.0
*/
interface IProviderWithExpectedRuntime extends IProvider {
/**
diff --git a/lib/public/TextProcessing/IProviderWithId.php b/lib/public/TextProcessing/IProviderWithId.php
index 1bd02278d1c..359ec9cef71 100644
--- a/lib/public/TextProcessing/IProviderWithId.php
+++ b/lib/public/TextProcessing/IProviderWithId.php
@@ -3,24 +3,8 @@
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/>.
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\TextProcessing;
@@ -29,6 +13,7 @@ namespace OCP\TextProcessing;
* @since 28.0.0
* @extends IProvider<T>
* @template T of ITaskType
+ * @deprecated 30.0.0
*/
interface IProviderWithId extends IProvider {
/**
diff --git a/lib/public/TextProcessing/IProviderWithUserId.php b/lib/public/TextProcessing/IProviderWithUserId.php
index 0a01a4c56c4..197dd3d9740 100644
--- a/lib/public/TextProcessing/IProviderWithUserId.php
+++ b/lib/public/TextProcessing/IProviderWithUserId.php
@@ -3,24 +3,8 @@
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/>.
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
@@ -31,6 +15,7 @@ namespace OCP\TextProcessing;
* @since 28.0.0
* @template T of ITaskType
* @template-extends IProvider<T>
+ * @deprecated 30.0.0
*/
interface IProviderWithUserId extends IProvider {
/**
diff --git a/lib/public/TextProcessing/ITaskType.php b/lib/public/TextProcessing/ITaskType.php
index d08da3f7ac7..5ec1e8dd049 100644
--- a/lib/public/TextProcessing/ITaskType.php
+++ b/lib/public/TextProcessing/ITaskType.php
@@ -3,24 +3,8 @@
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/>.
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\TextProcessing;
@@ -29,6 +13,7 @@ namespace OCP\TextProcessing;
* This is a task type interface that is implemented by text processing
* task types
* @since 27.1.0
+ * @deprecated 30.0.0
*/
interface ITaskType {
/**
diff --git a/lib/public/TextProcessing/SummaryTaskType.php b/lib/public/TextProcessing/SummaryTaskType.php
index 670a7cb4da6..656a50ebc62 100644
--- a/lib/public/TextProcessing/SummaryTaskType.php
+++ b/lib/public/TextProcessing/SummaryTaskType.php
@@ -3,24 +3,8 @@
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/>.
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\TextProcessing;
@@ -31,6 +15,7 @@ use OCP\L10N\IFactory;
/**
* This is the text processing task type for summaries
* @since 27.1.0
+ * @deprecated 30.0.0
*/
class SummaryTaskType implements ITaskType {
private IL10N $l;
diff --git a/lib/public/TextProcessing/Task.php b/lib/public/TextProcessing/Task.php
index c62b7b2fff8..d968ad9ba3e 100644
--- a/lib/public/TextProcessing/Task.php
+++ b/lib/public/TextProcessing/Task.php
@@ -3,24 +3,8 @@
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/>.
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\TextProcessing;
@@ -29,6 +13,7 @@ namespace OCP\TextProcessing;
* This is a text processing task
* @since 27.1.0
* @psalm-template-covariant T of ITaskType
+ * @deprecated 30.0.0
*/
final class Task implements \JsonSerializable {
protected ?int $id = null;
diff --git a/lib/public/TextProcessing/TopicsTaskType.php b/lib/public/TextProcessing/TopicsTaskType.php
index 5a994a7a8d2..c693ee3d27f 100644
--- a/lib/public/TextProcessing/TopicsTaskType.php
+++ b/lib/public/TextProcessing/TopicsTaskType.php
@@ -3,24 +3,8 @@
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/>.
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\TextProcessing;
@@ -31,6 +15,7 @@ use OCP\L10N\IFactory;
/**
* This is the text processing task type for topics extraction
* @since 27.1.0
+ * @deprecated 30.0.0
*/
class TopicsTaskType implements ITaskType {
private IL10N $l;