STT & Text processing APIs

appinfo/routes.php

@@ -65,5 +65,14 @@
 		// Talk bots
 		['name' => 'talkBot#registerExAppTalkBot', 'url' => '/api/v1/talk_bot', 'verb' => 'POST'],
 		['name' => 'talkBot#unregisterExAppTalkBot', 'url' => '/api/v1/talk_bot', 'verb' => 'DELETE'],
+
+		// Speech-To-Text
+		['name' => 'speechToText#registerProvider', 'url' => '/api/v1/speech_to_text', 'verb' => 'POST'],
+		['name' => 'speechToText#unregisterProvider', 'url' => '/api/v1/speech_to_text', 'verb' => 'DELETE'],
+
+		// Text-Processing
+		['name' => 'textProcessing#registerProvider', 'url' => '/api/v1/text_processing', 'verb' => 'POST'],
+		['name' => 'textProcessing#unregisterProvider', 'url' => '/api/v1/text_processing', 'verb' => 'DELETE'],
+		['name' => 'textProcessing#registerProvider', 'url' => '/api/v1/text_processing/task_type', 'verb' => 'POST'],
 	],
 ];

docs/tech_details/api/speechtotext.rst

@@ -0,0 +1,47 @@
+==============
+Speech-To-Text
+==============
+
+AppAPI provides a Speech-To-Text (STT) service
+that can be used to register ExApp as a custom STT model and transcribe audio files via it.
+
+Registering ExApp STT provider (OCS)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+OCS endpoint: ``POST /apps/app_api/api/v1/speech_to_text``
+
+Request data
+************
+
+.. code-block:: json
+
+	{
+		"name": "unique_provider_name",
+		"display_name": "Provider Display Name",
+		"action_handler_route": "/handler_route_on_ex_app",
+	}
+
+Response
+********
+
+On successful registration response with status code 200 is returned.
+
+Unregistering ExApp STT provider (OCS)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+OCS endpoint: ``DELETE /apps/app_api/api/v1/speech_to_text``
+
+Request data
+************
+
+.. code-block:: json
+
+	{
+		"name": "unique_provider_name",
+	}
+
+Response
+********
+
+On successful unregister response with status code 200 is returned.
+

docs/tech_details/api/textprocessing.rst

@@ -0,0 +1,90 @@
+===============
+Text-Processing
+===============
+
+AppAPI provides a text-processing service
+that can be used to register ExApps providers and to process passed through text.
+
+Registering text-processing provider (OCS)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+OCS endpoint: ``POST /apps/app_api/api/v1/text_processing``
+
+Request data
+************
+
+.. code-block:: json
+
+	{
+		"name": "unique_provider_name",
+		"display_name": "Provider Display Name",
+		"description": "Provider Description",
+		"action_handler_route": "/handler_route_on_ex_app",
+		"action_type": "unique_task_type_name",
+	}
+
+Response
+********
+
+On successful registration response with status code 200 is returned.
+
+Unregistering text-processing provider (OCS)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+OCS endpoint: ``DELETE /apps/app_api/api/v1/text_processing``
+
+Request data
+************
+
+.. code-block:: json
+
+	{
+		"name": "unique_provider_name",
+	}
+
+Response
+********
+
+On successful unregister response with status code 200 is returned.
+
+
+Registering Text-Processing task type (OCS)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+OCS endpoint: ``POST /apps/app_api/api/v1/text_processing/task_type``
+
+Request data
+************
+
+.. code-block:: json
+
+	{
+		"name": "unique_task_type_name",
+		"display_name": "Task Type Display Name",
+		"description": "Task Type Description",
+	}
+
+Response
+********
+
+On successful registration response with status code 200 is returned.
+
+Unregistering Text-Processing task type (OCS)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+OCS endpoint: ``DELETE /apps/app_api/api/v1/text_processing/task_type``
+
+Request data
+************
+
+.. code-block:: json
+
+	{
+		"name": "unique_task_type_name",
+	}
+
+Response
+********
+
+On successful unregister response with status code 200 is returned.
+

lib/AppInfo/Application.php

@@ -15,6 +15,8 @@
 use OCA\AppAPI\Profiler\AppAPIDataCollector;
 use OCA\AppAPI\PublicCapabilities;
 
+use OCA\AppAPI\Service\SpeechToTextService;
+use OCA\AppAPI\Service\TextProcessingService;
 use OCA\DAV\Events\SabrePluginAuthInitEvent;
 use OCA\Files\Event\LoadAdditionalScriptsEvent;
 use OCP\AppFramework\App;
@@ -56,6 +58,19 @@ public function register(IRegistrationContext $context): void {
 		$context->registerEventListener(UserDeletedEvent::class, UserDeletedListener::class);
 		$context->registerNotifierService(ExAppNotifier::class);
 		$context->registerNotifierService(ExAppAdminNotifier::class);
+
+		// Dynamic anonymous providers registration
+		$container = $this->getContainer();
+		try {
+			/** @var TextProcessingService $textProcessingService */
+			$textProcessingService = $container->get(TextProcessingService::class);
+			$textProcessingService->registerExAppTextProcessingProviders($context);
+
+			/** @var SpeechToTextService $speechToTextService */
+			$speechToTextService = $container->get(SpeechToTextService::class);
+			$speechToTextService->registerExAppSpeechToTextProviders($context);
+		} catch (NotFoundExceptionInterface|ContainerExceptionInterface) {
+		}
 	}
 
 	public function boot(IBootContext $context): void {
@@ -73,10 +88,13 @@ public function boot(IBootContext $context): void {
 	public function registerDavAuth(): void {
 		$container = $this->getContainer();
 
-		$dispatcher = $container->query(IEventDispatcher::class);
-		$dispatcher->addListener('OCA\DAV\Connector\Sabre::addPlugin', function (SabrePluginEvent $event) use ($container) {
-			$event->getServer()->addPlugin($container->query(DavPlugin::class));
-		});
+		try {
+			$dispatcher = $container->get(IEventDispatcher::class);
+			$dispatcher->addListener('OCA\DAV\Connector\Sabre::addPlugin', function (SabrePluginEvent $event) use ($container) {
+				$event->getServer()->addPlugin($container->get(DavPlugin::class));
+			});
+		} catch (NotFoundExceptionInterface|ContainerExceptionInterface) {
+		}
 	}
 
 	/**

lib/Controller/SpeechToTextController.php

@@ -0,0 +1,86 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\AppAPI\Controller;
+
+use OCA\AppAPI\AppInfo\Application;
+use OCA\AppAPI\Attribute\AppAPIAuth;
+use OCA\AppAPI\Service\AppAPIService;
+use OCA\AppAPI\Service\SpeechToTextService;
+use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
+use OCP\AppFramework\Http\Attribute\PublicPage;
+use OCP\AppFramework\Http\DataResponse;
+use OCP\AppFramework\Http\Response;
+use OCP\AppFramework\OCS\OCSBadRequestException;
+use OCP\AppFramework\OCSController;
+use OCP\IRequest;
+
+class SpeechToTextController extends OCSController {
+	protected $request;
+	private AppAPIService $service;
+	private SpeechToTextService $speechToTextService;
+
+	public function __construct(
+		IRequest $request,
+		AppAPIService $service,
+		SpeechToTextService $speechToTextService,
+	) {
+		parent::__construct(Application::APP_ID, $request);
+
+		$this->request = $request;
+		$this->service = $service;
+		$this->speechToTextService = $speechToTextService;
+	}
+
+	/**
+	 * @NoAdminRequired
+	 * @PublicPage
+	 *
+	 * @param string $name
+	 * @param string $displayName
+	 * @param string $actionHandlerRoute
+	 *
+	 * @throws OCSBadRequestException
+	 * @return Response
+	 */
+	#[NoCSRFRequired]
+	#[PublicPage]
+	#[AppAPIAuth]
+	public function registerProvider(string $name, string $displayName, string $actionHandlerRoute): Response {
+		$appId = $this->request->getHeader('EX-APP-ID');
+		$exApp = $this->service->getExApp($appId);
+
+		$provider = $this->speechToTextService->registerSpeechToTextProvider($exApp, $name, $displayName, $actionHandlerRoute);
+
+		if ($provider === null) {
+			throw new OCSBadRequestException('Failed to register STT provider');
+		}
+
+		return new DataResponse();
+	}
+
+	/**
+	 * @NoAdminRequired
+	 * @PublicPage
+	 *
+	 * @param string $name
+	 *
+	 * @throws OCSBadRequestException
+	 * @return Response
+	 */
+	#[NoCSRFRequired]
+	#[PublicPage]
+	#[AppAPIAuth]
+	public function unregisterProvider(string $name): Response {
+		$appId = $this->request->getHeader('EX-APP-ID');
+		$exApp = $this->service->getExApp($appId);
+		$unregistered = $this->speechToTextService->unregisterSpeechToTextProvider($exApp, $name);
+
+		if ($unregistered === null) {
+			throw new OCSBadRequestException('Failed to unregister STT provider');
+		}
+
+		return new DataResponse();
+	}
+}

lib/Controller/TextProcessingController.php

@@ -0,0 +1,88 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\AppAPI\Controller;
+
+use OCA\AppAPI\AppInfo\Application;
+use OCA\AppAPI\Attribute\AppEcosystemAuth;
+use OCA\AppAPI\Service\AppAPIService;
+use OCA\AppAPI\Service\TextProcessingService;
+use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
+use OCP\AppFramework\Http\Attribute\PublicPage;
+use OCP\AppFramework\Http\DataResponse;
+use OCP\AppFramework\Http\Response;
+use OCP\AppFramework\OCS\OCSBadRequestException;
+use OCP\AppFramework\OCSController;
+use OCP\IRequest;
+
+class TextProcessingController extends OCSController {
+	protected $request;
+	private AppEcosystemV2Service $service;
+	private TextProcessingService $textProcessingService;
+
+	public function __construct(
+		IRequest $request,
+		AppEcosystemV2Service $service,
+		TextProcessingService $textProcessingService,
+	) {
+		parent::__construct(Application::APP_ID, $request);
+
+		$this->request = $request;
+		$this->service = $service;
+		$this->textProcessingService = $textProcessingService;
+	}
+
+	/**
+	 * @NoAdminRequired
+	 * @PublicPage
+	 *
+	 * @param string $name
+	 * @param string $displayName
+	 * @param string $description
+	 * @param string $actionHandlerRoute
+	 * @param string $actionType
+	 *
+	 * @throws OCSBadRequestException
+	 * @return Response
+	 */
+	#[NoCSRFRequired]
+	#[PublicPage]
+	#[AppEcosystemAuth]
+	public function registerProvider(string $name, string $displayName, string $description, string $actionHandlerRoute, string $actionType): Response {
+		$appId = $this->request->getHeader('EX-APP-ID');
+		$exApp = $this->service->getExApp($appId);
+
+		$provider = $this->textProcessingService->registerTextProcesingProvider($exApp, $name, $displayName, $description, $actionHandlerRoute);
+
+		if ($provider === null) {
+			throw new OCSBadRequestException('Failed to register text processing provider');
+		}
+
+		return new DataResponse();
+	}
+
+	/**
+	 * @NoAdminRequired
+	 * @PublicPage
+	 *
+	 * @param string $name
+	 *
+	 * @throws OCSBadRequestException
+	 * @return Response
+	 */
+	#[NoCSRFRequired]
+	#[PublicPage]
+	#[AppEcosystemAuth]
+	public function unregisterProvider(string $name): Response {
+		$appId = $this->request->getHeader('EX-APP-ID');
+		$exApp = $this->service->getExApp($appId);
+		$unregistered = $this->textProcessingService->unregisterTextProcessingProvider($exApp, $name);
+
+		if ($unregistered === null) {
+			throw new OCSBadRequestException('Failed to unregister text processing provider');
+		}
+
+		return new DataResponse();
+	}
+}