feat: add limit input to search task type

Signed-off-by: Julien Veyssier <[email protected]>

Author: julien-nc

lib/Service/LangRopeService.php

@@ -339,10 +339,10 @@ public function query(string $userId, string $prompt, bool $useContext = true, ?
 	 * @param string $prompt
 	 * @param ?string $scopeType
 	 * @param ?array<string> $scopeList
+	 * @param int|null $limit
 	 * @return array
-	 * @throws RuntimeException
 	 */
-	public function docSearch(string $userId, string $prompt, ?string $scopeType = null, ?array $scopeList = null): array {
+	public function docSearch(string $userId, string $prompt, ?string $scopeType = null, ?array $scopeList = null, ?int $limit = null): array {
 		$params = [
 			'query' => $prompt,
 			'userId' => $userId,
@@ -351,6 +351,9 @@ public function docSearch(string $userId, string $prompt, ?string $scopeType = n
 			$params['scopeType'] = $scopeType;
 			$params['scopeList'] = $scopeList;
 		}
+		if ($limit !== null) {
+			$params['ctxLimit'] = $limit;
+		}
 
 		return $this->requestToExApp('/docSearch', 'POST', $params);
 	}

lib/TaskProcessing/ContextChatSearchProvider.php

@@ -48,7 +48,9 @@ public function getInputShapeEnumValues(): array {
 	}
 
 	public function getInputShapeDefaults(): array {
-		return [];
+		return [
+			'limit' => 10,
+		];
 	}
 
 	public function getOptionalInputShape(): array {
@@ -89,6 +91,11 @@ public function process(?string $userId, array $input, callable $reportProgress)
 			throw new \RuntimeException('Invalid input, expected "prompt" key with string value');
 		}
 
+		if (!isset($input['limit']) || !is_numeric($input['limit'])) {
+			throw new \RuntimeException('Invalid input, expected "limit" key with number value');
+		}
+		$limit = (int)$input['limit'];
+
 		if (
 			!isset($input['scopeType']) || !is_string($input['scopeType'])
 			|| !isset($input['scopeList']) || !is_array($input['scopeList'])
@@ -108,7 +115,13 @@ public function process(?string $userId, array $input, callable $reportProgress)
 
 		// unscoped query
 		if ($input['scopeType'] === ScopeType::NONE) {
-			$response = $this->langRopeService->docSearch($userId, $input['prompt']);
+			$response = $this->langRopeService->docSearch(
+				$userId,
+				$input['prompt'],
+				null,
+				null,
+				$limit,
+			);
 			if (isset($response['error'])) {
 				throw new \RuntimeException('No result in ContextChat response. ' . $response['error']);
 			}
@@ -139,6 +152,7 @@ public function process(?string $userId, array $input, callable $reportProgress)
 			$input['prompt'],
 			$input['scopeType'],
 			$processedScopes,
+			$limit,
 		);
 
 		return $this->processResponse($userId, $response);
@@ -154,7 +168,7 @@ public function process(?string $userId, array $input, callable $reportProgress)
 	 */
 	private function processResponse(string $userId, array $response): array {
 		if (isset($response['error'])) {
-			throw new \RuntimeException('No result in ContextChat response: ' . $response['error']);
+			throw new \RuntimeException('Error received in ContextChat document search request: ' . $response['error']);
 		}
 		if (!array_is_list($response)) {
 			throw new \RuntimeException('Invalid response from ContextChat, expected a list: ' . json_encode($response));

lib/TaskProcessing/ContextChatSearchTaskType.php

@@ -73,6 +73,11 @@ public function getInputShape(): array {
 				$this->l->t('Required to nicely render the scope list in assistant'),
 				EShapeType::Text,
 			),
+			'limit' => new ShapeDescriptor(
+				$this->l->t('Max result number'),
+				$this->l->t('Maximum number of results returned by Context Chat'),
+				EShapeType::Number,
+			),
 		];
 	}