Merge pull request #422 from nextcloud/feat/memories

feat: Implement memories

Author: janepie

appinfo/routes.php

@@ -36,6 +36,10 @@
 		['name' => 'assistantApi#getOutputFile', 'url' => '/api/{apiVersion}/task/{ocpTaskId}/output-file/{fileId}/download', 'verb' => 'GET', 'requirements' => $requirements],
 		['name' => 'assistantApi#runFileAction', 'url' => '/api/{apiVersion}/file-action/{fileId}/{taskTypeId}', 'verb' => 'POST', 'requirements' => $requirements],
 
+		['name' => 'chattyLLM#newSession', 'url' => '/chat/sessions', 'verb' => 'POST', 'postfix' => 'restful'],
+		['name' => 'chattyLLM#updateChatSession', 'url' => '/chat/sessions/{sessionId}', 'verb' => 'PUT', 'postfix' => 'restful'],
+		['name' => 'chattyLLM#deleteSession', 'url' => '/chat/sessions/{sessionId}', 'verb' => 'DELETE', 'postfix' => 'restful'],
+
 		['name' => 'chattyLLM#newSession', 'url' => '/chat/new_session', 'verb' => 'PUT'],
 		['name' => 'chattyLLM#updateSessionTitle', 'url' => '/chat/update_session', 'verb' => 'PATCH'],
 		['name' => 'chattyLLM#deleteSession', 'url' => '/chat/delete_session', 'verb' => 'DELETE'],

lib/BackgroundJob/GenerateNewChatSummaries.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Assistant\BackgroundJob;
+
+use OCA\Assistant\Service\SessionSummaryService;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\BackgroundJob\TimedJob;
+
+class GenerateNewChatSummaries extends TimedJob {
+	public function __construct(
+		ITimeFactory $timeFactory,
+		private SessionSummaryService $sessionSummaryService,
+	) {
+		parent::__construct($timeFactory);
+		$this->setInterval(60 * 10); // 10min
+	}
+	public function run($argument) {
+		$userId = $argument['userId'];
+		$this->sessionSummaryService->generateSummariesForNewSessions($userId);
+	}
+}

lib/BackgroundJob/RegenerateOutdatedChatSummariesJob.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Assistant\BackgroundJob;
+
+use OCA\Assistant\Service\SessionSummaryService;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\BackgroundJob\TimedJob;
+
+class RegenerateOutdatedChatSummariesJob extends TimedJob {
+
+	public function __construct(
+		ITimeFactory $timeFactory,
+		private SessionSummaryService $sessionSummaryService,
+	) {
+		parent::__construct($timeFactory);
+		$this->setInterval(60 * 60 * 24); // 24h
+	}
+	public function run($argument) {
+		$userId = $argument['userId'];
+		$this->sessionSummaryService->regenerateSummariesForOutdatedSessions($userId);
+	}
+}

lib/Controller/ChattyLLMController.php

@@ -13,6 +13,7 @@
 use OCA\Assistant\Db\ChattyLLM\Session;
 use OCA\Assistant\Db\ChattyLLM\SessionMapper;
 use OCA\Assistant\ResponseDefinitions;
+use OCA\Assistant\Service\SessionSummaryService;
 use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\AppFramework\Db\MultipleObjectsReturnedException;
 use OCP\AppFramework\Http;
@@ -55,6 +56,7 @@ public function __construct(
 		private IAppConfig $appConfig,
 		private IUserManager $userManager,
 		private ?string $userId,
+		private SessionSummaryService $sessionSummaryService,
 	) {
 		parent::__construct($appName, $request);
 		$this->agencyActionData = [
@@ -190,6 +192,49 @@ public function updateSessionTitle(int $sessionId, string $title): JSONResponse
 		}
 	}
 
+	/**
+	 * Update session
+	 *
+	 * @param integer $sessionId The chat session ID
+	 * @param string|null $title The new chat session title
+	 * @param bool|null $is_remembered The new is_remembered status: Whether to remember the insights from this chat session across all chat session
+	 * @return JSONResponse<Http::STATUS_OK, list{}, array{}>|JSONResponse<Http::STATUS_INTERNAL_SERVER_ERROR|Http::STATUS_NOT_FOUND, array{error: string}, array{}>
+	 *
+	 * 200: The title has been updated successfully
+	 * 404: The session was not found
+	 */
+	#[NoAdminRequired]
+	#[OpenAPI(scope: OpenAPI::SCOPE_DEFAULT, tags: ['chat_api'])]
+	public function updateChatSession(int $sessionId, ?string $title = null, ?bool $is_remembered = null): JSONResponse {
+		if ($this->userId === null) {
+			return new JSONResponse(['error' => $this->l10n->t('Could not find session')], Http::STATUS_NOT_FOUND);
+		}
+		if ($title === null && $is_remembered === null) {
+			return new JSONResponse();
+		}
+
+		try {
+			$session = $this->sessionMapper->getUserSession($this->userId, $sessionId);
+			if ($title !== null) {
+				$session->setTitle($title);
+			}
+			if ($is_remembered !== null) {
+				$session->setIsRemembered($is_remembered);
+				// schedule summarizer jobs for this chat user
+				if ($is_remembered) {
+					$this->sessionSummaryService->scheduleJobsForUser($this->userId);
+				}
+			}
+			$this->sessionMapper->update($session);
+			return new JSONResponse();
+		} catch (\OCP\DB\Exception|\RuntimeException  $e) {
+			$this->logger->warning('Failed to update the chat session', ['exception' => $e]);
+			return new JSONResponse(['error' => $this->l10n->t('Failed to update the chat session')], Http::STATUS_INTERNAL_SERVER_ERROR);
+		} catch (DoesNotExistException|MultipleObjectsReturnedException $e) {
+			return new JSONResponse(['error' => $this->l10n->t('Could not find session')], Http::STATUS_NOT_FOUND);
+		}
+	}
+
 	/**
 	 * Delete a chat session
 	 *
@@ -779,6 +824,7 @@ public function checkSession(int $sessionId): JSONResponse {
 			'messageTaskId' => null,
 			'titleTaskId' => null,
 			'sessionTitle' => $session->getTitle(),
+			'is_remembered' => $session->getIsRemembered(),
 			'sessionAgencyPendingActions' => $p,
 		];
 		if (!empty($messageTasks)) {
@@ -990,6 +1036,9 @@ private function scheduleLLMChatTask(
 			'system_prompt' => $systemPrompt,
 			'history' => $history,
 		];
+		if (isset($this->taskProcessingManager->getAvailableTaskTypes()[TextToTextChat::ID]['optionalInputShape']['memories'])) {
+			$input['memories'] = $this->sessionSummaryService->getUserSessionSummaries($this->userId);
+		}
 		$task = new Task(TextToTextChat::ID, $input, Application::APP_ID . ':chatty-llm', $this->userId, $customId);
 		$this->taskProcessingManager->scheduleTask($task);
 		return $task->getId() ?? 0;
@@ -1017,6 +1066,10 @@ private function scheduleAgencyTask(string $content, int $confirmation, string $
 			'conversation_token' => $conversationToken,
 		];
 		/** @psalm-suppress UndefinedClass */
+		if (isset($this->taskProcessingManager->getAvailableTaskTypes()[\OCP\TaskProcessing\TaskTypes\ContextAgentInteraction::ID]['optionalInputShape']['memories'])) {
+			$taskInput['memories'] = $this->sessionSummaryService->getUserSessionSummaries($this->userId);
+		}
+		/** @psalm-suppress UndefinedClass */
 		$task = new Task(
 			\OCP\TaskProcessing\TaskTypes\ContextAgentInteraction::ID,
 			$taskInput,
@@ -1039,6 +1092,10 @@ private function scheduleAudioChatTask(
 			'history' => $history,
 		];
 		/** @psalm-suppress UndefinedClass */
+		if (isset($this->taskProcessingManager->getAvailableTaskTypes()[\OCP\TaskProcessing\TaskTypes\AudioToAudioChat::ID]['optionalInputShape']['memories'])) {
+			$input['memories'] = $this->sessionSummaryService->getUserSessionSummaries($this->userId);
+		}
+		/** @psalm-suppress UndefinedClass */
 		$task = new Task(
 			\OCP\TaskProcessing\TaskTypes\AudioToAudioChat::ID,
 			$input,
@@ -1061,6 +1118,10 @@ private function scheduleAgencyAudioTask(
 			'conversation_token' => $conversationToken,
 		];
 		/** @psalm-suppress UndefinedClass */
+		if (isset($this->taskProcessingManager->getAvailableTaskTypes()[\OCP\TaskProcessing\TaskTypes\ContextAgentAudioInteraction::ID]['optionalInputShape']['memories'])) {
+			$taskInput['memories'] = $this->sessionSummaryService->getUserSessionSummaries($this->userId);
+		}
+		/** @psalm-suppress UndefinedClass */
 		$task = new Task(
 			\OCP\TaskProcessing\TaskTypes\ContextAgentAudioInteraction::ID,
 			$taskInput,

lib/Db/ChattyLLM/Message.php

@@ -66,11 +66,11 @@ class Message extends Entity implements \JsonSerializable {
 	];
 
 	public function __construct() {
-		$this->addType('session_id', Types::INTEGER);
+		$this->addType('sessionId', Types::INTEGER);
 		$this->addType('role', Types::STRING);
 		$this->addType('content', Types::STRING);
 		$this->addType('timestamp', Types::INTEGER);
-		$this->addType('ocp_task_id', Types::INTEGER);
+		$this->addType('ocpTaskId', Types::INTEGER);
 		$this->addType('sources', Types::STRING);
 		$this->addType('attachments', Types::STRING);
 	}

lib/Db/ChattyLLM/Session.php

@@ -17,6 +17,8 @@
  * @method \void setUserId(string $userId)
  * @method \string|null getTitle()
  * @method \void setTitle(?string $title)
+ * @method \string|null getSummary()
+ * @method \void setSummary(?string $title)
  * @method \int getTimestamp()
  * @method \void setTimestamp(int $timestamp)
  * @method \string|null getAgencyConversationToken()
@@ -36,13 +38,34 @@ class Session extends Entity implements \JsonSerializable {
 	/** @var ?string */
 	protected $agencyPendingActions;
 
+	/**
+	 * Will be used to inject into assistant memories upon calling LLM
+	 *
+	 * @var ?string
+	 */
+	protected $summary;
+
+	/** @var int */
+	protected $isSummaryUpToDate;
+
+	/**
+	 * Whether to remember the insights from this chat session across all chat sessions
+	 *
+	 * @var int
+	 */
+	protected $isRemembered;
+
+
 	public static $columns = [
 		'id',
 		'user_id',
 		'title',
 		'timestamp',
 		'agency_conversation_token',
 		'agency_pending_actions',
+		'summary',
+		'is_summary_up_to_date',
+		'is_remembered',
 	];
 	public static $fields = [
 		'id',
@@ -51,14 +74,20 @@ class Session extends Entity implements \JsonSerializable {
 		'timestamp',
 		'agencyConversationToken',
 		'agencyPendingActions',
+		'summary',
+		'isSummaryUpToDate',
+		'isRemembered',
 	];
 
 	public function __construct() {
-		$this->addType('user_id', Types::STRING);
+		$this->addType('userId', Types::STRING);
 		$this->addType('title', Types::STRING);
 		$this->addType('timestamp', Types::INTEGER);
-		$this->addType('agency_conversation_token', Types::STRING);
-		$this->addType('agency_pending_actions', Types::STRING);
+		$this->addType('agencyConversationToken', Types::STRING);
+		$this->addType('agencyPendingActions', Types::STRING);
+		$this->addType('summary', Types::TEXT);
+		$this->addType('isSummaryUpToDate', Types::SMALLINT);
+		$this->addType('isRemembered', Types::SMALLINT);
 	}
 
 	#[\ReturnTypeWillChange]
@@ -70,6 +99,25 @@ public function jsonSerialize() {
 			'timestamp' => $this->getTimestamp(),
 			'agency_conversation_token' => $this->getAgencyConversationToken(),
 			'agency_pending_actions' => $this->getAgencyPendingActions(),
+			'summary' => $this->getSummary(),
+			'is_summary_up_to_date' => $this->getIsSummaryUpToDate(),
+			'is_remembered' => $this->getIsRemembered(),
 		];
 	}
+
+	public function setIsSummaryUpToDate(bool $value): void {
+		$this->setter('isSummaryUpToDate', [$value ? 1 : 0]);
+	}
+
+	public function setIsRemembered(bool $value): void {
+		$this->setter('isRemembered', [$value ? 1 : 0]);
+	}
+
+	public function getIsSummaryUpToDate(): bool {
+		return $this->getter('isSummaryUpToDate') === 1;
+	}
+
+	public function getIsRemembered(): bool {
+		return $this->getter('isRemembered') === 1;
+	}
 }

lib/Db/ChattyLLM/SessionMapper.php

@@ -79,6 +79,75 @@ public function getUserSessions(string $userId): array {
 		return $this->findEntities($qb);
 	}
 
+	/**
+	 * @return array<Session>
+	 * @throws \OCP\DB\Exception
+	 */
+	public function getRememberedUserSessions(string $userId, int $limit = 0): array {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select(Session::$columns)
+			->from($this->getTableName())
+			->where($qb->expr()->eq('user_id', $qb->createPositionalParameter($userId, IQueryBuilder::PARAM_STR)))
+			->andWhere($qb->expr()->eq('is_remembered', $qb->createPositionalParameter(1, IQueryBuilder::PARAM_INT)))
+			->orderBy('timestamp', 'DESC');
+
+		if ($limit > 0) {
+			$qb->setMaxResults($limit);
+		}
+
+		return $this->findEntities($qb);
+	}
+
+	/**
+	 * @return array<Session>
+	 * @throws \OCP\DB\Exception
+	 */
+	public function getRememberedUserSessionsWithOutdatedSummaries(string $userId, int $limit): array {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select(Session::$columns)
+			->from($this->getTableName())
+			->where($qb->expr()->eq('user_id', $qb->createPositionalParameter($userId, IQueryBuilder::PARAM_STR)))
+			->andWhere($qb->expr()->eq('is_remembered', $qb->createPositionalParameter(1, IQueryBuilder::PARAM_INT)))
+			->andWhere($qb->expr()->eq('is_summary_up_to_date', $qb->createPositionalParameter(0, IQueryBuilder::PARAM_INT)))
+			->setMaxResults($limit)
+			->orderBy('timestamp', 'DESC');
+
+		return $this->findEntities($qb);
+	}
+
+	/**
+	 * @return array<Session>
+	 * @throws \OCP\DB\Exception
+	 */
+	public function getRememberedSessionsWithOutdatedSummaries(int $limit): array {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select(Session::$columns)
+			->from($this->getTableName())
+			->where($qb->expr()->eq('is_remembered', $qb->createPositionalParameter(1, IQueryBuilder::PARAM_INT)))
+			->andWhere($qb->expr()->eq('is_summary_up_to_date', $qb->createPositionalParameter(0, IQueryBuilder::PARAM_INT)))
+			->setMaxResults($limit)
+			->orderBy('timestamp', 'DESC');
+
+		return $this->findEntities($qb);
+	}
+
+	/**
+	 * @return array<Session>
+	 * @throws \OCP\DB\Exception
+	 */
+	public function getRememberedUserSessionsWithoutSummaries(string $userId, int $limit): array {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select(Session::$columns)
+			->from($this->getTableName())
+			->where($qb->expr()->eq('user_id', $qb->createPositionalParameter($userId, IQueryBuilder::PARAM_STR)))
+			->andWhere($qb->expr()->eq('is_remembered', $qb->createPositionalParameter(1, IQueryBuilder::PARAM_INT)))
+			->andWhere($qb->expr()->isNull('summary'))
+			->setMaxResults($limit)
+			->orderBy('timestamp', 'DESC');
+
+		return $this->findEntities($qb);
+	}
+
 	/**
 	 * @param string $userId
 	 * @param integer $sessionId
@@ -110,4 +179,10 @@ public function deleteSession(string $userId, int $sessionId) {
 
 		$qb->executeStatement();
 	}
+
+	public function updateSessionIsRemembered(?string $userId, int $sessionId, bool $is_remembered) {
+		$session = $this->getUserSession($userId, $sessionId);
+		$session->setIsRemembered($is_remembered);
+		$this->update($session);
+	}
 }