Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Summarize email thread #8653

Merged
merged 1 commit into from
Aug 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions appinfo/routes.php
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,11 @@
'url' => '/api/settings/allownewaccounts',
'verb' => 'POST'
],
[
'name' => 'settings#setEnabledThreadSummary',
'url' => '/api/settings/threadsummary',
'verb' => 'PUT'
],
[
'name' => 'trusted_senders#setTrusted',
'url' => '/api/trustedsenders/{email}',
Expand Down Expand Up @@ -360,6 +365,11 @@
'url' => '/api/thread/{id}',
'verb' => 'POST'
],
[
'name' => 'thread#summarize',
'url' => '/api/thread/{id}/summary',
'verb' => 'GET'
],
[
'name' => 'outbox#send',
'url' => '/api/outbox/{id}',
Expand Down
11 changes: 10 additions & 1 deletion lib/Controller/PageController.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
use OCA\Mail\Db\SmimeCertificate;
use OCA\Mail\Db\TagMapper;
use OCA\Mail\Service\AccountService;
use OCA\Mail\Service\AiIntegrationsService;
use OCA\Mail\Service\AliasesService;
use OCA\Mail\Service\OutboxService;
use OCA\Mail\Service\SmimeService;
Expand Down Expand Up @@ -73,6 +74,7 @@ class PageController extends Controller {
private IEventDispatcher $dispatcher;
private ICredentialstore $credentialStore;
private SmimeService $smimeService;
private AiIntegrationsService $aiIntegrationsService;

public function __construct(string $appName,
IRequest $request,
Expand All @@ -90,7 +92,8 @@ public function __construct(string $appName,
OutboxService $outboxService,
IEventDispatcher $dispatcher,
ICredentialStore $credentialStore,
SmimeService $smimeService) {
SmimeService $smimeService,
AiIntegrationsService $aiIntegrationsService) {
parent::__construct($appName, $request);

$this->urlGenerator = $urlGenerator;
Expand All @@ -108,6 +111,7 @@ public function __construct(string $appName,
$this->dispatcher = $dispatcher;
$this->credentialStore = $credentialStore;
$this->smimeService = $smimeService;
$this->aiIntegrationsService = $aiIntegrationsService;
}

/**
Expand Down Expand Up @@ -244,6 +248,11 @@ public function index(): TemplateResponse {
$this->config->getAppValue('mail', 'allow_new_mail_accounts', 'yes') === 'yes'
);

$this->initialStateService->provideInitialState(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

always set summaries to no if llm apis are not available

'enabled_thread_summary',
$this->config->getAppValue('mail', 'enabled_thread_summary', 'no') === 'yes' && $this->aiIntegrationsService->isLlmAvailable()
);

$this->initialStateService->provideInitialState(
'smime-certificates',
array_map(
Expand Down
22 changes: 21 additions & 1 deletion lib/Controller/SettingsController.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,22 +34,29 @@
use OCP\AppFramework\Http\JSONResponse;
use OCP\IConfig;
use OCP\IRequest;
use OCP\TextProcessing\IManager;
use OCP\TextProcessing\SummaryTaskType;
use Psr\Container\ContainerInterface;

use function array_merge;

class SettingsController extends Controller {
private ProvisioningManager $provisioningManager;
private AntiSpamService $antiSpamService;
private ContainerInterface $container;

private IConfig $config;

public function __construct(IRequest $request,
ProvisioningManager $provisioningManager,
AntiSpamService $antiSpamService,
IConfig $config) {
IConfig $config,
ContainerInterface $container) {
parent::__construct(Application::APP_ID, $request);
$this->provisioningManager = $provisioningManager;
$this->antiSpamService = $antiSpamService;
$this->config = $config;
$this->container = $container;
}

public function index(): JSONResponse {
Expand Down Expand Up @@ -119,4 +126,17 @@ public function deleteAntiSpamEmail(): JSONResponse {
public function setAllowNewMailAccounts(bool $allowed) {
$this->config->setAppValue('mail', 'allow_new_mail_accounts', $allowed ? 'yes' : 'no');
}

public function setEnabledThreadSummary(bool $enabled) {
hamza221 marked this conversation as resolved.
Show resolved Hide resolved
$this->config->setAppValue('mail', 'enabled_thread_summary', $enabled ? 'yes' : 'no');
}

public function isLlmConfigured() {
try {
$manager = $this->container->get(IManager::class);
} catch (\Throwable $e) {
return new JSONResponse(['data' => false]);
}
return new JSONResponse(['data' => in_array(SummaryTaskType::class, $manager->getAvailableTaskTypes(), true)]);
}
}
48 changes: 46 additions & 2 deletions lib/Controller/ThreadController.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,27 +28,35 @@
use OCA\Mail\Exception\ServiceException;
use OCA\Mail\Http\TrapError;
use OCA\Mail\Service\AccountService;
use OCA\Mail\Service\AiIntegrationsService;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Db\DoesNotExistException;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\JSONResponse;
use OCP\IRequest;
use Psr\Log\LoggerInterface;

class ThreadController extends Controller {
private string $currentUserId;
private AccountService $accountService;
private IMailManager $mailManager;
private AiIntegrationsService $aiIntergrationsService;
private LoggerInterface $logger;


public function __construct(string $appName,
IRequest $request,
string $UserId,
AccountService $accountService,
IMailManager $mailManager) {
IMailManager $mailManager,
AiIntegrationsService $aiIntergrationsService,
LoggerInterface $logger) {
parent::__construct($appName, $request);

$this->currentUserId = $UserId;
$this->accountService = $accountService;
$this->mailManager = $mailManager;
$this->aiIntergrationsService = $aiIntergrationsService;
$this->logger = $logger;
}

/**
Expand Down Expand Up @@ -111,4 +119,40 @@ public function delete(int $id): JSONResponse {

return new JSONResponse();
}

/**
* @NoAdminRequired
*
* @param int $id
*
* @return JSONResponse
*/
public function summarize(int $id): JSONResponse {
try {
$message = $this->mailManager->getMessage($this->currentUserId, $id);
$mailbox = $this->mailManager->getMailbox($this->currentUserId, $message->getMailboxId());
$account = $this->accountService->find($this->currentUserId, $mailbox->getAccountId());
} catch (DoesNotExistException $e) {
return new JSONResponse([], Http::STATUS_FORBIDDEN);
}
if (empty($message->getThreadRootId())) {
return new JSONResponse([], Http::STATUS_NOT_FOUND);
}
$thread = $this->mailManager->getThread($account, $message->getThreadRootId());
try {
$summary = $this->aiIntergrationsService->summarizeThread(
$message->getThreadRootId(),
$thread,
$this->currentUserId,
);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Calling this in a route is risky as it will likely exceed the PHP max execution time. Also, you might want to cache the output. :)

} catch (\Throwable $e) {
$this->logger->error('Summarizing thread failed: ' . $e->getMessage(), [
'exception' => $e,
]);
return new JSONResponse([], Http::STATUS_NO_CONTENT);
hamza221 marked this conversation as resolved.
Show resolved Hide resolved
hamza221 marked this conversation as resolved.
Show resolved Hide resolved
}

return new JSONResponse(['data' => $summary]);
}

}
80 changes: 80 additions & 0 deletions lib/Service/AiIntegrationsService.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<?php

declare(strict_types=1);

/**
* @author Hamza Mahjoubi <[email protected]>
*
* Mail
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/

namespace OCA\Mail\Service;

use OCA\Mail\Exception\ServiceException;
use OCP\TextProcessing\IManager;
use OCP\TextProcessing\SummaryTaskType;
use OCP\TextProcessing\Task;
use Psr\Container\ContainerInterface;
use function array_map;

class AiIntegrationsService {

/** @var ContainerInterface */
private ContainerInterface $container;


public function __construct(ContainerInterface $container) {
$this->container = $container;
}
/**
* @param string $threadId
* @param array $messages
* @param string $currentUserId
*
* @return null|string
*
* @throws ServiceException
*/
public function summarizeThread(string $threadId, array $messages, string $currentUserId): null|string {
try {
$manager = $this->container->get(IManager::class);
} catch (\Throwable $e) {
throw new ServiceException('Text processing is not available in your current Nextcloud version', $e);
}
if(in_array(SummaryTaskType::class, $manager->getAvailableTaskTypes(), true)) {
$messagesBodies = array_map(function ($message) {
return $message->getPreviewText();
}, $messages);

$taskPrompt = implode("\n", $messagesBodies);
$summaryTask = new Task(SummaryTaskType::class, $taskPrompt, "mail", $currentUserId, $threadId);
$manager->runTask($summaryTask);

return $summaryTask->getOutput();
} else {
throw new ServiceException('No language model available for summary');
}
}

public function isLlmAvailable(): bool {
try {
$manager = $this->container->get(IManager::class);
} catch (\Throwable $e) {
return false;
}
return in_array(SummaryTaskType::class, $manager->getAvailableTaskTypes(), true);
}
}
19 changes: 18 additions & 1 deletion lib/Settings/AdminSettings.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
use OCA\Mail\AppInfo\Application;
use OCA\Mail\Integration\GoogleIntegration;
use OCA\Mail\Integration\MicrosoftIntegration;
use OCA\Mail\Service\AiIntegrationsService;
use OCA\Mail\Service\AntiSpamService;
use OCA\Mail\Service\Provisioning\Manager as ProvisioningManager;
use OCP\AppFramework\Http\TemplateResponse;
Expand All @@ -49,19 +50,22 @@ class AdminSettings implements ISettings {
private GoogleIntegration $googleIntegration;
private MicrosoftIntegration $microsoftIntegration;
private IConfig $config;
private AiIntegrationsService $aiIntegrationsService;

public function __construct(IInitialStateService $initialStateService,
ProvisioningManager $provisioningManager,
AntiSpamService $antiSpamService,
GoogleIntegration $googleIntegration,
MicrosoftIntegration $microsoftIntegration,
IConfig $config) {
IConfig $config,
AiIntegrationsService $aiIntegrationsService) {
$this->initialStateService = $initialStateService;
$this->provisioningManager = $provisioningManager;
$this->antiSpamService = $antiSpamService;
$this->googleIntegration = $googleIntegration;
$this->microsoftIntegration = $microsoftIntegration;
$this->config = $config;
$this->aiIntegrationsService = $aiIntegrationsService;
}

public function getForm() {
Expand All @@ -85,6 +89,19 @@ public function getForm() {
'allow_new_mail_accounts',
$this->config->getAppValue('mail', 'allow_new_mail_accounts', 'yes') === 'yes'
);

$this->initialStateService->provideInitialState(
Application::APP_ID,
'enabled_thread_summary',
$this->config->getAppValue('mail', 'enabled_thread_summary', 'no') === 'yes'
);

$this->initialStateService->provideInitialState(
Application::APP_ID,
'enabled_llm_backend',
$this->aiIntegrationsService->isLlmAvailable()
);

$this->initialStateService->provideLazyInitialState(
Application::APP_ID,
'ldap_aliases_integration',
Expand Down
4 changes: 4 additions & 0 deletions psalm.xml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@
<referencedClass name="Symfony\Component\Console\Input\InputInterface" />
<referencedClass name="Symfony\Component\Console\Input\InputOption" />
<referencedClass name="Symfony\Component\Console\Output\OutputInterface" />
<referencedClass name="OCP\TextProcessing\IManager" />
<referencedClass name="OCP\TextProcessing\SummaryTaskType" />
<referencedClass name="OCP\TextProcessing\Task" />
<referencedClass name="OCP\TextProcessing\SummaryTaskType" />
</errorLevel>
</UndefinedClass>
<UndefinedDocblockClass>
Expand Down
Loading
Loading