DeepSeekAiProvider::generateQuestions() - Code Metrics - Inspection of "Internal: Rename Utils directory to Helpers" - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#6396)

by Angel Fernando Quiroz

created 2025-06-26 16:13 UTC

DeepSeekAiProvider::generateQuestions() A

↳ Parent: DeepSeekAiProvider

Complexity

Conditions	1
Paths	1

Size

Total Lines	21
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	17
nc	1
nop	4
dl	0
loc	21
rs	9.7
c	0
b	0
f	0

<?php

declare(strict_types=1);

/* For licensing terms, see /license.txt */

namespace Chamilo\CoreBundle\AiProvider;

use Chamilo\CoreBundle\Entity\AiRequests;
use Chamilo\CoreBundle\Repository\AiRequestsRepository;
use Chamilo\CoreBundle\Settings\SettingsManager;
use Exception;
use RuntimeException;
use Symfony\Bundle\SecurityBundle\Security;
use Symfony\Component\Security\Core\User\UserInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;

class DeepSeekAiProvider implements AiProviderInterface
{
    private string $apiUrl;
    private string $apiKey;
    private string $model;
    private float $temperature;
    private string $organizationId;
    private int $monthlyTokenLimit;
    private HttpClientInterface $httpClient;
    private AiRequestsRepository $aiRequestsRepository;
    private Security $security;

    public function __construct(
        HttpClientInterface $httpClient,
        SettingsManager $settingsManager,
        AiRequestsRepository $aiRequestsRepository,
        Security $security
    ) {
        $this->httpClient = $httpClient;
        $this->aiRequestsRepository = $aiRequestsRepository;
        $this->security = $security;

        // Get AI providers from settings
        $configJson = $settingsManager->getSetting('ai_helpers.ai_providers', true);
        $config = json_decode($configJson, true) ?? [];

        if (!isset($config['deepseek'])) {
            throw new RuntimeException('DeepSeek configuration is missing.');
        }

        $this->apiUrl = $config['deepseek']['url'] ?? 'https://api.deepseek.com/chat/completions';
        $this->apiKey = $config['deepseek']['api_key'] ?? '';
        $this->model = $config['deepseek']['model'] ?? 'deepseek-chat';
        $this->temperature = $config['deepseek']['temperature'] ?? 0.7;
        $this->organizationId = $config['deepseek']['organization_id'] ?? '';
        $this->monthlyTokenLimit = $config['deepseek']['monthly_token_limit'] ?? 1000;

        if (empty($this->apiKey)) {
            throw new RuntimeException('DeepSeek API key is missing.');
        }
    }

    public function generateQuestions(string $topic, int $numQuestions, string $questionType, string $language): ?string
    {
        $prompt = \sprintf(
            'Generate %d "%s" questions in Aiken format in the %s language about "%s".
            Ensure each question follows this format:

            1. The question text.
            A. Option A
            B. Option B
            C. Option C
            D. Option D
            ANSWER: (Correct answer letter)

            The output should be plain text without additional symbols or markdown.',
            $numQuestions,
            $questionType,
            $language,
            $topic
        );

        return $this->requestDeepSeekAI($prompt, 'quiz');
    }

    public function generateLearnPath(string $topic, int $chaptersCount, string $language, int $wordsCount, bool $addTests, int $numQuestions): ?array
    {
        // Step 1: Generate the Table of Contents
        $tableOfContentsPrompt = \sprintf(
            'Generate a structured table of contents for a course in "%s" with %d chapters on "%s".
            Return a numbered list, each chapter on a new line. No conclusion.',
            $language,
            $chaptersCount,
            $topic
        );

        $lpStructure = $this->requestDeepSeekAI($tableOfContentsPrompt, 'learnpath');
        if (!$lpStructure) {
            return ['success' => false, 'message' => 'Failed to generate course structure.'];
        }

        // Step 2: Generate content for each chapter
        $lpItems = [];
        $chapters = explode("\n", trim($lpStructure));
        foreach ($chapters as $index => $chapterTitle) {
            $chapterTitle = trim($chapterTitle);
            if (empty($chapterTitle)) {
                continue;
            }

            $chapterPrompt = \sprintf(
                'Create a learning chapter in HTML for "%s" in "%s" with %d words.
                Title: "%s". Assume the reader already knows the context.',
                $topic,
                $language,
                $wordsCount,
                $chapterTitle
            );

            $chapterContent = $this->requestDeepSeekAI($chapterPrompt, 'learnpath');
            if (!$chapterContent) {
                continue;
            }

            $lpItems[] = [
                'title' => $chapterTitle,
                'content' => "<html><head><title>{$chapterTitle}</title></head><body>{$chapterContent}</body></html>",
            ];
        }

        // Step 3: Generate quizzes if enabled
        $quizItems = [];
        if ($addTests) {
            foreach ($lpItems as &$chapter) {
                $quizPrompt = \sprintf(
                    'Generate %d multiple-choice questions in Aiken format in %s about "%s".
        Ensure each question follows this format:

        1. The question text.
        A. Option A
        B. Option B
        C. Option C
        D. Option D
        ANSWER: (Correct answer letter)

        Each question must have exactly 4 options and one answer line.
        Return only valid questions without extra text.',
                    $numQuestions,
                    $language,
                    $chapter['title']
                );

                $quizContent = $this->requestDeepSeekAI($quizPrompt, 'learnpath');

                if ($quizContent) {
                    $validQuestions = $this->filterValidAikenQuestions($quizContent);

                    if (!empty($validQuestions)) {
                        $quizItems[] = [
                            'title' => 'Quiz: '.$chapter['title'],
                            'content' => implode("\n\n", $validQuestions),
                        ];
                    }
                }
            }
        }

        return [
            'success' => true,
            'topic' => $topic,
            'lp_items' => $lpItems,
            'quiz_items' => $quizItems,
        ];
    }

    private function filterValidAikenQuestions(string $quizContent): array
    {
        $questions = preg_split('/\n{2,}/', trim($quizContent));

        $validQuestions = [];
        foreach ($questions as $questionBlock) {
            $lines = explode("\n", trim($questionBlock));

            if (\count($lines) < 6) {
                continue;
            }

            $options = \array_slice($lines, 1, 4);
            $validOptions = array_filter($options, fn ($line) => preg_match('/^[A-D]\. .+/', $line));

            $answerLine = end($lines);
            if (4 === \count($validOptions) && preg_match('/^ANSWER: [A-D]$/', $answerLine)) {
                $validQuestions[] = implode("\n", $lines);
            }
        }

        return $validQuestions;
    }

    private function requestDeepSeekAI(string $prompt, string $toolName): ?string
    {
        $userId = $this->getUserId();
        if (!$userId) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            throw new RuntimeException('User not authenticated.');
        }

        $payload = [
            'model' => $this->model,
            'messages' => [
                ['role' => 'system', 'content' => 'You are a helpful AI assistant that generates structured educational content.'],
                ['role' => 'user', 'content' => $prompt],
            ],
            'temperature' => $this->temperature,
            'max_tokens' => 300,
        ];

        try {
            $response = $this->httpClient->request('POST', $this->apiUrl, [
                'headers' => [
                    'Authorization' => 'Bearer '.$this->apiKey,
                    'Content-Type' => 'application/json',
                ],
                'json' => $payload,
            ]);

            $statusCode = $response->getStatusCode();
            $data = $response->toArray();

            if (200 === $statusCode && isset($data['choices'][0]['message']['content'])) {
                $generatedContent = $data['choices'][0]['message']['content'];

                $aiRequest = new AiRequests();
                $aiRequest->setUserId($userId)
                    ->setToolName($toolName)
                    ->setRequestText($prompt)
                    ->setPromptTokens($data['usage']['prompt_tokens'] ?? 0)
                    ->setCompletionTokens($data['usage']['completion_tokens'] ?? 0)
                    ->setTotalTokens($data['usage']['total_tokens'] ?? 0)
                    ->setAiProvider('deepseek')
                ;

                $this->aiRequestsRepository->save($aiRequest);

                return $generatedContent;
            }

            return null;
        } catch (Exception $e) {
            error_log('ERROR - DeepSeek Request failed: '.$e->getMessage());

            return null;
        }
    }

    private function getUserId(): ?int
    {
        $user = $this->security->getUser();

        return $user instanceof UserInterface ? $user->getId() : null;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/* For licensing terms, see /license.txt */
6
7			namespace Chamilo\CoreBundle\AiProvider;
8
9			use Chamilo\CoreBundle\Entity\AiRequests;
10			use Chamilo\CoreBundle\Repository\AiRequestsRepository;
11			use Chamilo\CoreBundle\Settings\SettingsManager;
12			use Exception;
13			use RuntimeException;
14			use Symfony\Bundle\SecurityBundle\Security;
15			use Symfony\Component\Security\Core\User\UserInterface;
16			use Symfony\Contracts\HttpClient\HttpClientInterface;
17
18			class DeepSeekAiProvider implements AiProviderInterface
19			{
20			private string $apiUrl;
21			private string $apiKey;
22			private string $model;
23			private float $temperature;
24			private string $organizationId;
25			private int $monthlyTokenLimit;
26			private HttpClientInterface $httpClient;
27			private AiRequestsRepository $aiRequestsRepository;
28			private Security $security;
29
30			public function __construct(
31			HttpClientInterface $httpClient,
32			SettingsManager $settingsManager,
33			AiRequestsRepository $aiRequestsRepository,
34			Security $security
35			) {
36			$this->httpClient = $httpClient;
37			$this->aiRequestsRepository = $aiRequestsRepository;
38			$this->security = $security;
39
40			// Get AI providers from settings
41			$configJson = $settingsManager->getSetting('ai_helpers.ai_providers', true);
42			$config = json_decode($configJson, true) ?? [];
43
44			if (!isset($config['deepseek'])) {
45			throw new RuntimeException('DeepSeek configuration is missing.');
46			}
47
48			$this->apiUrl = $config['deepseek']['url'] ?? 'https://api.deepseek.com/chat/completions';
49			$this->apiKey = $config['deepseek']['api_key'] ?? '';
50			$this->model = $config['deepseek']['model'] ?? 'deepseek-chat';
51			$this->temperature = $config['deepseek']['temperature'] ?? 0.7;
52			$this->organizationId = $config['deepseek']['organization_id'] ?? '';
53			$this->monthlyTokenLimit = $config['deepseek']['monthly_token_limit'] ?? 1000;
54
55			if (empty($this->apiKey)) {
56			throw new RuntimeException('DeepSeek API key is missing.');
57			}
58			}
59
60			public function generateQuestions(string $topic, int $numQuestions, string $questionType, string $language): ?string
61			{
62			$prompt = \sprintf(
63			'Generate %d "%s" questions in Aiken format in the %s language about "%s".
64			Ensure each question follows this format:
65
66			1. The question text.
67			A. Option A
68			B. Option B
69			C. Option C
70			D. Option D
71			ANSWER: (Correct answer letter)
72
73			The output should be plain text without additional symbols or markdown.',
74			$numQuestions,
75			$questionType,
76			$language,
77			$topic
78			);
79
80			return $this->requestDeepSeekAI($prompt, 'quiz');
81			}
82
83			public function generateLearnPath(string $topic, int $chaptersCount, string $language, int $wordsCount, bool $addTests, int $numQuestions): ?array
84			{
85			// Step 1: Generate the Table of Contents
86			$tableOfContentsPrompt = \sprintf(
87			'Generate a structured table of contents for a course in "%s" with %d chapters on "%s".
88			Return a numbered list, each chapter on a new line. No conclusion.',
89			$language,
90			$chaptersCount,
91			$topic
92			);
93
94			$lpStructure = $this->requestDeepSeekAI($tableOfContentsPrompt, 'learnpath');
95			if (!$lpStructure) {
96			return ['success' => false, 'message' => 'Failed to generate course structure.'];
97			}
98
99			// Step 2: Generate content for each chapter
100			$lpItems = [];
101			$chapters = explode("\n", trim($lpStructure));
102			foreach ($chapters as $index => $chapterTitle) {
103			$chapterTitle = trim($chapterTitle);
104			if (empty($chapterTitle)) {
105			continue;
106			}
107
108			$chapterPrompt = \sprintf(
109			'Create a learning chapter in HTML for "%s" in "%s" with %d words.
110			Title: "%s". Assume the reader already knows the context.',
111			$topic,
112			$language,
113			$wordsCount,
114			$chapterTitle
115			);
116
117			$chapterContent = $this->requestDeepSeekAI($chapterPrompt, 'learnpath');
118			if (!$chapterContent) {
119			continue;
120			}
121
122			$lpItems[] = [
123			'title' => $chapterTitle,
124			'content' => "<html><head><title>{$chapterTitle}</title></head><body>{$chapterContent}</body></html>",
125			];
126			}
127
128			// Step 3: Generate quizzes if enabled
129			$quizItems = [];
130			if ($addTests) {
131			foreach ($lpItems as &$chapter) {
132			$quizPrompt = \sprintf(
133			'Generate %d multiple-choice questions in Aiken format in %s about "%s".
134			Ensure each question follows this format:
135
136			1. The question text.
137			A. Option A
138			B. Option B
139			C. Option C
140			D. Option D
141			ANSWER: (Correct answer letter)
142
143			Each question must have exactly 4 options and one answer line.
144			Return only valid questions without extra text.',
145			$numQuestions,
146			$language,
147			$chapter['title']
148			);
149
150			$quizContent = $this->requestDeepSeekAI($quizPrompt, 'learnpath');
151
152			if ($quizContent) {
153			$validQuestions = $this->filterValidAikenQuestions($quizContent);
154
155			if (!empty($validQuestions)) {
156			$quizItems[] = [
157			'title' => 'Quiz: '.$chapter['title'],
158			'content' => implode("\n\n", $validQuestions),
159			];
160			}
161			}
162			}
163			}
164
165			return [
166			'success' => true,
167			'topic' => $topic,
168			'lp_items' => $lpItems,
169			'quiz_items' => $quizItems,
170			];
171			}
172
173			private function filterValidAikenQuestions(string $quizContent): array
174			{
175			$questions = preg_split('/\n{2,}/', trim($quizContent));
176
177			$validQuestions = [];
178			foreach ($questions as $questionBlock) {
179			$lines = explode("\n", trim($questionBlock));
180
181			if (\count($lines) < 6) {
182			continue;
183			}
184
185			$options = \array_slice($lines, 1, 4);
186			$validOptions = array_filter($options, fn ($line) => preg_match('/^[A-D]\. .+/', $line));
187
188			$answerLine = end($lines);
189			if (4 === \count($validOptions) && preg_match('/^ANSWER: [A-D]$/', $answerLine)) {
190			$validQuestions[] = implode("\n", $lines);
191			}
192			}
193
194			return $validQuestions;
195			}
196
197			private function requestDeepSeekAI(string $prompt, string $toolName): ?string
198			{
199			$userId = $this->getUserId();
200			if (!$userId) {
			0 ignored issues – show Bug Best Practice introduced 2025-03-06 00:41 UTC by Report Bug Copy Issue Report The expression `$userId` of type `integer\|null` is loosely compared to `false`; this is ambiguous if the integer can be 0. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
201			throw new RuntimeException('User not authenticated.');
202			}
203
204			$payload = [
205			'model' => $this->model,
206			'messages' => [
207			['role' => 'system', 'content' => 'You are a helpful AI assistant that generates structured educational content.'],
208			['role' => 'user', 'content' => $prompt],
209			],
210			'temperature' => $this->temperature,
211			'max_tokens' => 300,
212			];
213
214			try {
215			$response = $this->httpClient->request('POST', $this->apiUrl, [
216			'headers' => [
217			'Authorization' => 'Bearer '.$this->apiKey,
218			'Content-Type' => 'application/json',
219			],
220			'json' => $payload,
221			]);
222
223			$statusCode = $response->getStatusCode();
224			$data = $response->toArray();
225
226			if (200 === $statusCode && isset($data['choices'][0]['message']['content'])) {
227			$generatedContent = $data['choices'][0]['message']['content'];
228
229			$aiRequest = new AiRequests();
230			$aiRequest->setUserId($userId)
231			->setToolName($toolName)
232			->setRequestText($prompt)
233			->setPromptTokens($data['usage']['prompt_tokens'] ?? 0)
234			->setCompletionTokens($data['usage']['completion_tokens'] ?? 0)
235			->setTotalTokens($data['usage']['total_tokens'] ?? 0)
236			->setAiProvider('deepseek')
237			;
238
239			$this->aiRequestsRepository->save($aiRequest);
240
241			return $generatedContent;
242			}
243
244			return null;
245			} catch (Exception $e) {
246			error_log('ERROR - DeepSeek Request failed: '.$e->getMessage());
247
248			return null;
249			}
250			}
251
252			private function getUserId(): ?int
253			{
254			$user = $this->security->getUser();
255
256			return $user instanceof UserInterface ? $user->getId() : null;
257			}
258			}
259

chamilo / chamilo-lms

Pull Request — master (#6396)

DeepSeekAiProvider::generateQuestions() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like