only_ever_generator 0.5.2 → 0.5.3

package/src/constants/prompts/typology_prompt.ts

@@ -1,13 +1,18 @@
 const typologyPromptString = `
-You are a dedicated assistant that categorizes and summarizes educational content. You will process educational content (in JSON format) that represents text from diverse sources such as PDFs, book chapters, videos, and websites. Follow these steps:
+You are a dedicated assistant that categorizes and summarizes educational content. You will process educational content (in JSON format) that represents text from diverse sources such as wikipedia, markdown notes, PDFs, book chapters, and websites.
+You will be provided with the following:
+1. Title of the source
+2. A list of main headings in the source
+3. The source content
 
+Follow these steps:
 1. Classify the content into one to three predefined fields of knowledge.
 2. Extract key concepts within the content. Be exhaustive and thorough.
-3. Extract concrete facts that are relevant to the subject and referenced in the content.
-4. Decide whether the provided text has educational value and should be used to generate test material and quizzes based on the identified concepts and facts.
+3. Extract concrete and relevant facts that are referenced in the content. Be exhaustive and thorough.
+4. Decide whether the content has any educational value and should be used to generate test material and quizzes based on the identified concepts and facts.
 5. If the generate_cards is true then summarize the content using a series of summary cards.
 
-Please format your findings in this JSON schema:
+Output your answer as valid JSON, in the form:
 json
 {
     "field": ["primary_field", "secondary_field", "tertiary_field"],
@@ -27,10 +32,10 @@ json
         },
         {...}
     ],
-    "generate_cards": {
+    "generate_cards": [
         state: true or false,
         reason: "reason for marking the source as false. Leave empty for true."
-},
+    ],
     "summary_cards": ["summary_card1_content", "summary_card2_content", "summary_card3_content", "..."]
 }
 
@@ -58,9 +63,9 @@ Every source must be placed under a field. This is the broadest category of know
 Extract key concepts within the content after classifying the field. This is a crucial part of the exercise. Be exhaustive and thorough.
 
 1. **Definition of a Concept**: Concepts are fundamental ideas that form the basis of knowledge in any discipline. They help organize and explain information, making it accessible and relatable.
-2. **Inclusion Criteria**: Include a concept only if it is discussed in detail, meaning it is explained thoroughly, tied to specific examples, or highlighted as a critical part of the subject matter.
+2. **Inclusion Criteria**: Include a concept only if it is discussed in detail and is an important part of the subject matter of the source.
 3. **How to describe a concept**: The concept should be described so that a reader can comprehend the gist of it.
-4. **Character Limit**: Maintain a limit of 60 characters for the  to ensure each concept is concise yet informative.
+4. **Character Limit**: Maintain a limit of 90 characters to ensure each concept is concise yet informative.
 5. **Reference**: Every concept must include a reference. A reference can either be the entire source or a specific heading in the source. Whenever possible, pick a main heading to direct the user to the most relevant part of the source material. The heading must exactly match one of the headings provided to you. Sometimes concepts may need to reference the entire text or multiple headings, leave the reference empty for such cases.
 
 List the concepts in the following JSON format:
@@ -74,12 +79,11 @@ json
         },
         {...}
     ]
-
 After classifying the content and identifying key concepts, proceed to extract and list verifiable facts.
 
 1. **Definition of a Fact**: Ensure each fact is a standalone piece of information that is concrete and can be independently verified.
-2. **Selection Criteria**: Choose facts based on their significance to the content's main themes or concepts, their educational value, or their foundational role in the subject.
-3. **Character Limit**: Maintain a limit of 60 characters for the  to ensure each message is concise yet informative.
+2. **Selection Criteria**: Inlcude facts based on their significance to the content's main themes or concepts, their educational value and their foundational role in the subject.
+3. **Character Limit**: Maintain a limit of 90 characters for the  to ensure each message is concise yet informative.
 4. **Reference**: Every fact must include a reference. A reference can either be the entire source or a specific heading in the source. Whenever possible, pick a main heading to direct the user to the most relevant part of the source material. The heading must exactly match one of the headings provided to you. Sometimes facts may need to reference the entire text or multiple headings, leave the reference empty for such cases.
 
 List the facts in the following JSON format:
@@ -93,22 +97,17 @@ json
         },
         {...}
     ]
+After you have examined the content —its field, its concepts, and its facts— determine whether it justifies the creation of quiz materials. 
 
-After analyzing the content, classifying its field, and identifying key concepts, and facts, assess whether the discovered elements warrant the creation of testing (quiz) materials.
-
-Consider if these elements provide significant educational value to an average learner by enhancing understanding, offering practical applications, or supporting crucial educational goals. If you decide that the source does not hold educational value that is worthy of generating testing material or quizzes for then please provide a reason in less than 90 characters.
-
-1. **Value Assessment**: Determine if the concepts and facts are essential for understanding the broader topic, are likely to be used in practical scenarios, or help in achieving educational benchmarks.
-2. **Criteria for Material Generation**: Generate testing materials if the concepts and facts are central to the content, have broad applicability, and are likely to reinforce or expand the learner’s knowledge significantly.
+Consider whether these elements offer the average learner meaningful insights, practical uses, or serve important educational aims. If, in your judgment, the material falls short of providing such value, explain why in fewer than 90 characters.
 
-Make your decision using this criterion and reflect it in the JSON format as follows:
+Reflect your in the JSON format as follows:
 
 json
 "generate_cards": 
     {   state: true or false,
         reason: "reason for marking the source as false. Leave empty for true."
     }
-
 After analyzing the content, identifying key concepts, and facts, summarize the material using a series of engaging and informative cards. 
 
 These cards should capture the essence of the content while highlighting the critical concepts and facts that you previously identified.
@@ -124,9 +123,11 @@ Format your output in JSON as follows:
 
 json
 {
-    "summary_cards": ["summary_card1_content", "summary_card2_content", "summary_card3_content", "..."]
+    "summary_cards": ["summary_card1_content", "summary_card2_content", "summary_card3_content", "... up to 8 summary cards"]
 }
 
+
+
 `;
 
 

package/src/index.ts

@@ -7,8 +7,6 @@
 // import config from "./config";
 // const app = express();
 // const port = 3000;
-
-import { OnlyEverGenerator } from "./bootstrap/app";
 // import { returnPromptData } from "./constants/prompt_data";
 // import { GenerateCards } from "./card_gen/generate_cards";
 // import { OpenAiService } from "./services/open_ai_service";
@@ -17,13 +15,16 @@ import { OnlyEverGenerator } from "./bootstrap/app";
 // import { returnCardGenPrompt } from "./constants/prompts/card_gen_prompt";
 // import { GenerateArgs } from "./utils/generate_args";
 
+import { OnlyEverGenerator } from "./bootstrap/app";
+
+
 /// While Publishing the package , and using this code as a separate npm module
 /// uncomment the below line and comment all the others, expect the import of OnlyEverGenerator
   export {OnlyEverGenerator};
 
-//. All the Codes Below uses express and are strictly for development purpose, while publishing the package, comment everything
-//below this line
-// let oeGen = new OnlyEverGenerator(config.openAIKey, "gpt-4o", {
+// . All the Codes Below uses express and are strictly for development purpose, while publishing the package, comment everything
+// below this line
+// let oeGen = new OnlyEverGenerator(config.openAIKey, "gpt-4o-mini", {
 //   prompt: returnPromptData(),
 //   content: returnSourceData(),
 // });
@@ -60,24 +61,12 @@ import { OnlyEverGenerator } from "./bootstrap/app";
 //   res.send(parsedData)
 // });
 
-// // app.get("/typology", async (req, res) => {
-// //   {
-// //     let typologyPrompt = returnTypologyPrompt();
-// //     let cardPrompt = returnCardGenPrompt();
-// //     let args = new GenerateArgs(
-// //       true,
-// //       true,
-// //       false,
-// //        {
-// //         typology_prompt: typologyPrompt,
-// //         card_gen_prompt: cardPrompt,
-// //         summary_prompt: "",
-// //       }
-// //     )
-// //     let typologyRequest = await oeGen.generate(false, true);
-// //     res.send(typologyRequest);
-// //   }
-// // });
+// app.get("/typology", async (req, res) => {
+//   {
+//     let typologyRequest = await oeGen.generate(true, true);
+//     res.send(typologyRequest);
+//   }
+// });
 
 // app.listen(port, () => {
 //   console.log(`Example app listening at http://localhost:${port}`);

package/src/parse/parse_card/parse_cloze_card.ts

@@ -1,10 +1,21 @@
 export class ParseClozeCard {
   parse(data: any) {
     try {
-      let displayTitle = this._generateClozeCardDisplayTitle(
-        data.card_content.prompt,
-        data.card_content.options
-      );
+      const content = data.card_content;
+      let correctOptions = content.correct_options;
+      let incorrectOptions = content.incorrect_options;
+      let allOptions = [...correctOptions, ...incorrectOptions];
+      let displayTitle = this._generateClozeCardDisplayTitle(data.card_content.prompt, allOptions);
+     let preparedData = this._prepareQuestionAndCorrectAnswers(content.prompt, correctOptions);
+     let finalQuestion = preparedData.prompt;
+     let parsedCorrectOptions = preparedData.options;
+     let parsedIncorrectoptions = incorrectOptions.map((e:any)=>{
+      return {
+        "option":e,
+        "cloze": "null"
+      };
+     });
+     const finalParsedOptions = [...parsedCorrectOptions,...parsedIncorrectoptions];
       let clozeCardData = {
         type: {
           category: "learning",
@@ -13,8 +24,8 @@ export class ParseClozeCard {
         heading: data.card_reference,
         displayTitle: displayTitle,
         content: {
-          question: data.card_content.prompt,
-          options: data.card_content.options,
+          question: finalQuestion,
+          options: finalParsedOptions,
         },
         concepts: data.concepts,
         facts: data.facts,
@@ -28,20 +39,16 @@ export class ParseClozeCard {
   }
 
   _generateClozeCardDisplayTitle(question: string, answers: Array<any>) {
+    try{
     let optionsString = "";
     if (answers.length !== 0) {
       optionsString = answers
-        .map((item: { option: any }) => {
-          if (item.option !== undefined) {
-            return item.option;
-          } else {
-            return "";
-          }
-        })
         .join(", ");
     }
 
-    return `${question} ---- ${optionsString}`;
+    return `${question} ---- ${optionsString}`;}catch(e){
+      throw Error("Error in generating display title");
+    }
   }
 
   /// validate the cloze card
@@ -53,6 +60,33 @@ export class ParseClozeCard {
   // 6. Less than 2 options
   // 7. Max character for individual cloze: 90
 
+  _prepareQuestionAndCorrectAnswers(rawPrompt:String, correctOptions: Array<any>){
+    try{
+    var finalCorrectOptions = <any>[];
+    const regex = /{{(.*?)}}/g;
+
+    const transformed = rawPrompt.replace(regex, (match, p1) => {
+      // p1 is the captured group inside {{ }} (e.g., "fruit", "green")
+      const idx = correctOptions.indexOf(p1);
+      if (idx !== -1) {
+        let cloze = `c${idx}`;
+        finalCorrectOptions.push( {
+          "option": p1,
+          "cloze": cloze,
+        });
+        return `{{c${idx}:${p1}}}`;
+      }
+      return match; // If not found in correct_options, leave as is or handle accordingly
+    });
+    return {
+      "prompt": transformed,
+      "options": finalCorrectOptions
+    }} catch(e){
+      throw Error("Error in preparing question and correct answers");
+    }
+
+  }
+
   _validateCloze(clozeCard: any) {
     let clozeRegex = /\{\{c(\d+):([^}]+)\}\}/g;
 
@@ -83,8 +117,8 @@ export class ParseClozeCard {
         throw Error(" Clozes in question doesnt match to clozes in options");
       }
       return clozeCard;
-    } catch (e) {
-      return false;
+    } catch (e: any) {
+     throw Error(`Error in validating cloze card ${e.message}`);
     }
   }
 }

package/src/parse/parse_card/parse_match_card.ts

@@ -1,9 +1,20 @@
 import { match } from "assert";
 
+type InputItem = {
+  left_item: string;
+  right_item: string;
+};
+
+type OutputItem = {
+  left_item: string;
+  right_item: string[];
+};
+
 export class ParseMatchCard {
   parse(cardData: any) {
     try {
       let content = cardData.card_content;
+      const finalContent =this._parseMatchContent(content);
 
       let displayTitle = this._generateMatchCardDisplayTitle(content);
       let matchCard = {
@@ -11,8 +22,8 @@ export class ParseMatchCard {
           category: "learning",
           sub_type: cardData.type,
         },
-        heading: cardData.card_reference,
-        content: content,
+        heading: cardData.card_content.card_reference,
+        content: finalContent,
         //  content: cardData.card_content,
         displayTitle: displayTitle,
         concepts: cardData.concepts,
@@ -26,11 +37,13 @@ export class ParseMatchCard {
     }
   }
 
+  
+
   _generateMatchCardDisplayTitle(answers: any) {
     let titles: string[] = [];
     let counter = 65;
     for (let data of answers) {
-      let value = data.right_item.join(",");
+      let value = data.right_item;
       let leftData = data.left_item;
       let letter = String.fromCharCode(counter);
       titles.push(`${letter}. ${leftData} -- ${value}`);
@@ -40,16 +53,38 @@ export class ParseMatchCard {
     return displayTitle;
   }
 
+   _parseMatchContent = (input: InputItem[]): OutputItem[] => {
+    const grouped = input.reduce<Record<string, OutputItem>>((acc, { left_item, right_item }) => {
+      if (!acc[left_item]) {
+        acc[left_item] = { left_item, right_item: [] };
+      }
+      acc[left_item].right_item.push(right_item);
+      return acc;
+    }, {});
+  
+    return Object.values(grouped);
+  };
+
   _validateMatch(matchCard: any){
     let matches = matchCard.content;
+    let content = [];
     try{
+        if(matches.length < 1 || matches.length > 8){
+            throw Error("Invalid number of matches");
+        }
+
         for(let elem of matches){
-            if(elem.left_item.length > 24 || elem.left_item.length == 0){
-                throw Error("Invalid Length of left item ");
-            }else if(elem.right_item[0].length>24 || elem.right_item[0].length == 0){
-                throw Error(" Invalid Length of right item")
+            if(elem.left_item.length <= 30 && elem.left_item.length != 0){
+              if(elem.right_item.length <= 40 && elem.right_item.length != 0){
+                content.push(elem);
             }
+          }
+        }
+        if(content.length >= 2){
+          matchCard.content = content;
 
+        }else{
+            throw Error("Invalid content");
         }
         return matchCard;
     }catch(e){

package/src/parse/parse_card_response.ts

@@ -15,7 +15,7 @@ export class ParseCardResponse {
           if (elem.type == "flash") {
             const flashCard = this.parseFlashCard(elem);
             if (flashCard != null && flashCard) {
-              this.parseFlashCard(flashCard);
+              cardData.push(flashCard);
             }
           } else if (elem.type == "mcq") {
             const mcqCard = new ParseMcqCard().parse(elem);