Merge branch 'NXD-12-generate-quiz' into NXD-12

Signed-off-by: Tal Jacob <taljacob2@gmail.com>

Author: taljacob2

.vscode/launch.json

@@ -9,21 +9,21 @@
             "name": "Backend: Run Script: dev",
             "request": "launch",
             "command": "npm run dev",
-            "cwd": "${workspaceFolder}\\nextstep-backend"
+            "cwd": "${workspaceFolder}/nextstep-backend"
         },
         {
             "type": "node-terminal",
             "name": "Backend: Run Script: test",
             "request": "launch",
             "command": "npm run test",
-            "cwd": "${workspaceFolder}\\nextstep-backend"
+            "cwd": "${workspaceFolder}/nextstep-backend"
         },
         {
             "type": "node-terminal",
             "name": "Frontend: Run Script: dev",
             "request": "launch",
             "command": "npm run dev",
-            "cwd": "${workspaceFolder}\\nextstep-frontend"
+            "cwd": "${workspaceFolder}/nextstep-frontend"
         }
     ]
 }

nextstep-backend/src/controllers/quizzes_controller.ts

@@ -14,4 +14,20 @@ const getQuizzesByTags = async (req: Request, res: Response): Promise<void> => {
     }
 };
 
-export default { getQuizzesByTags };
+const getGeneratedQuizBySubject = async (req: Request, res: Response): Promise<void> => {
+    try {
+        const { subject } = req.body;
+
+        if (!subject) {
+            res.status(400).json({ error: 'Missing required fields' });
+            return;
+        }
+
+        const generatedQuiz = await companiesService.generateQuiz(subject);
+        res.json(generatedQuiz);
+    } catch (err) {
+        handleError(err, res);
+    }
+};
+
+export default { getQuizzesByTags, getGeneratedQuizBySubject };

nextstep-backend/src/openapi/swagger.yaml

@@ -1116,7 +1116,7 @@ paths:
         '400':
           description: Bad Request
 
-  /quiz:
+  /quiz/raw:
     get:
       tags:
         - Quizzes
@@ -1145,6 +1145,48 @@ paths:
         '500':
           description: Internal server error
 
+  /quiz/generate:
+    post:
+      tags:
+        - Quizzes
+      summary: Generate a quiz for a certain subject.
+      description: Generate a quiz for a certain subject. The quiz is generated based on our real-world quizzes database.
+      security:
+        - BearerAuth: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+                - subject
+              properties:
+                subject:
+                  type: string
+                  description: The subject of the quiz to be generated
+      responses:
+        '200':
+          description: A generated quiz custom-tailored for the targeted subject.
+          content:
+            application/json:
+              schema:
+                type: object # TODO:
+        '400':
+          description: Bad request - Missing required fields
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  error:
+                    type: string
+                    description: Error message indicating missing fields
+        '401':
+          description: Unauthorized
+        '500':
+          description: Internal server error
+
 components:
   schemas:
     Post:

nextstep-backend/src/routes/quizzes_routes.ts

@@ -3,6 +3,8 @@ import Quiz from '../controllers/quizzes_controller';
 
 const router = express.Router();
 
-router.get('/', Quiz.getQuizzesByTags);
+router.get('/raw', Quiz.getQuizzesByTags);
+
+router.post('/generate', Quiz.getGeneratedQuizBySubject);
 
 export default router;

nextstep-backend/src/services/companies_service.ts

@@ -5,6 +5,7 @@ import { CompanyModel } from '../models/company_model';
 import { CompanyData, ICompany, QuizData } from 'types/company_types';
 import { Document, PipelineStage } from 'mongoose';
 import path from 'path';
+import { chatWithAI } from './chat_api_service';
 
 // Predefined tags to match against quizzes
 const PREDEFINED_TAGS = [
@@ -304,16 +305,15 @@ export const initCompanies = async (): Promise<number> => {
   return allCompanies.length;
 };
 
-
 /**
  * Search for quizzes that best match the given tags using MongoDB aggregation
  * and $text search for content fields.
  * Returns quizzes sorted by relevance (text score + tag matches).
  */
 export const searchQuizzesByTags = async (tags: string[]): Promise<QuizData[]> => {
-  if (!tags || tags.length === 0) {
-    return []; // No tags provided, return empty results
-  }
+  // if (!tags || tags.length === 0) {
+  //   return []; // No tags provided, return empty results
+  // }
 
   // For $text search, tags are space-separated words or phrases.
   // We'll also use them for array matching.
@@ -462,4 +462,70 @@ export const searchQuizzesByTags = async (tags: string[]): Promise<QuizData[]> =
     console.error('Error during quiz search aggregation:', error);
     return [];
   }
-};
+};
+
+/**
+ * Generate a custom-tailored quiz on any subject, based on our real quiz database.
+ * @param quizSubject The subject you want to generate a quiz for.
+ *                    Example: "Java Spring Boot Microservices Interview Questions" or "QA Automation Python"
+ */
+export const generateQuiz = async (quizSubject: string): Promise<any> => {
+  // Take the first 10 best matching quizzes.
+  const tags = quizSubject.split(' ');
+  const quizzes = (await searchQuizzesByTags(tags)).slice(0, 10);
+
+  const GEN_QUIZ_SYSTEM_PROMPT = "You are an AI assistant specialized in generating personalized interview quiz content based on real-world interview data. Your goal is to create a new, well-structured interview quiz tailored to a user's specific search query, drawing insights and patterns from a provided set of actual interview quizzes.";
+
+  const prompt = `
+**User Search Query:**
+${quizSubject}
+
+**Relevant Real Quiz Data (JSON Array):**
+\`\`\`json
+${quizzes}
+\`\`\`
+
+**Instructions:**
+Analyze: Review the User Search Query and the provided Relevant Real Quiz Data.
+Synthesize: Combine common themes, technologies, question types, process details, and implied soft skill requirements found across the relevant real quizzes, prioritizing relevance to the user's query.
+Generate One Quiz: Create one (1) brand new, highly relevant, and unique interview quiz specifically tailored to the User Search Query. Do NOT simply copy-paste existing quizzes.
+Structure: Format the output as a single JSON object adhering strictly to the QuizData interface below.
+Content Details:
+  _id: Generate a unique string, e.g., "generated_[TIMESTAMP]".
+  title: A concise and relevant title for the generated quiz.
+  tags: Include highly relevant technical and role-based tags, both English and Hebrew if appropriate, derived from the query and the provided data.
+  content: A comprehensive narrative combining the interview process and specific questions, similar in style to the provided examples.
+  job_role: Infer the most appropriate job role from the user query and real data.
+  company_name_en, company_name_he: You can use a generic "Leading Tech Company" / "חברת טכנולוגיה מובילה" or "Startup in [relevant field]" / "סטארטאפ בתחום ה[רלוונטי]".
+  process_details: A concise summary of a typical interview process for this role/company type, extracted or synthesized from the provided data.
+  question_list: Crucially, all generated specific interview questions. An array of individual questions. Each element should be a distinct question.
+  answer_list: Crucially, parse the question_list string into an array of individual answers. Each element should be a distinct answer, corresponding to the questions.
+  keywords: Extract 5-10 additional relevant technical or conceptual keywords that the user might find useful for preparation.
+  interviewer_mindset: Describe the soft skills, characteristics, temperament, and professional attributes that an interviewer for this specific job role (based on the user's query and the context from real quizzes) would likely be looking for. Focus on traits that would give the applicant "extra points," such as straightforwardness, curiosity, social skills, professionalism, collaboration, communication (with colleagues, 3rd parties, customers), problem-solving approach, adaptability, initiative, attention to detail, etc. Aim for a paragraph or two.
+
+**Desired Output Format (JSON)**:
+\`\`\`json
+{
+  "_id": "string",
+  "title": "string",
+  "tags": ["string", "string", ...],
+  "content": "string",
+  "job_role": "string",
+  "company_name_en": "string",
+  "company_name_he": "string",
+  "process_details": "string",
+  "question_list": ["string", "string", ...],
+  "answer_list": ["string", "string", ...],
+  "keywords": ["string", "string", ...],
+  "interviewer_mindset": "string"
+}
+\`\`\`
+
+Return ONLY the JSON, without any other text, so I could easily retrieve it.
+`;
+
+  const aiResponse = await chatWithAI(GEN_QUIZ_SYSTEM_PROMPT, [prompt]);
+  const parsed = JSON.parse(aiResponse.trim().replace("```json", "").replace("```", "")) as any;
+
+  return parsed;
+}