only_ever_generator 0.0.8 → 0.1.0

package/dist/bootstrap/app.js

@@ -18,51 +18,66 @@ const typology_prompt_1 = require("../constants/prompts/typology_prompt");
 const generate_typology_1 = require("../typology_gen/generate_typology");
 const generate_args_1 = require("../utils/generate_args");
 const source_data_1 = require("../constants/source_data");
-/// OnlyEverGenerator 
+function isEmpty(obj) {
+    return Object.keys(obj).length === 0;
+}
+/// OnlyEverGenerator
 class OnlyEverGenerator {
     constructor(apiKey, model, content, expected_fields) {
-        this.api_key = '';
-        this.parsedContent = '';
+        this.api_key = "";
+        this.parsedContent = "";
         this.typologyResponse = {};
         this.cardgenResponse = {};
         this.summarizeResponse = {};
+        this.gapFillResponse = {};
         this.api_key = apiKey;
-        this.openAiService = new open_ai_service_1.OpenAiService(apiKey, model !== null && model !== void 0 ? model : 'gpt-3.5-turbo-1106');
+        this.openAiService = new open_ai_service_1.OpenAiService(apiKey, model !== null && model !== void 0 ? model : "gpt-3.5-turbo-1106");
         this.parsedContent = new parse_source_content_1.ParseSourceContent(content).parse();
         this.expectedFields = (0, source_data_1.returnFields)();
     }
-    ;
     generate() {
         return __awaiter(this, arguments, void 0, function* (generate_typology = false, generate_card = false) {
-            var _a, _b;
+            var _a, _b, _c;
             let typologyPrompt = (0, typology_prompt_1.returnTypologyPrompt)();
             let cardPrompt = (0, card_gen_prompt_1.returnCardGenPrompt)();
             let args = new generate_args_1.GenerateArgs(generate_card, generate_typology, false, {
                 typology_prompt: typologyPrompt,
                 card_gen_prompt: cardPrompt,
-                summary_prompt: ''
+                summary_prompt: "",
             });
             const responseToReturn = [];
             const whatNeedsToBeGenerated = args.getWhatNeedsToBeGenerated();
             for (let elem of whatNeedsToBeGenerated)
-                if (elem == 'generate_tyopology') {
-                    this.typologyResponse = yield this.generateTypology((_a = args.prompts.typology_prompt) !== null && _a !== void 0 ? _a : '');
+                if (elem == "generate_tyopology") {
+                    this.typologyResponse = yield this.generateTypology((_a = args.prompts.typology_prompt) !== null && _a !== void 0 ? _a : "");
                     responseToReturn.push(this.typologyResponse);
                 }
-                else if (elem == 'generate_card') {
-                    this.cardgenResponse = yield this.generateCard((_b = args.prompts.card_gen_prompt) !== null && _b !== void 0 ? _b : '', this.parsedContent + JSON.stringify(this.typologyResponse));
+                else if (elem == "generate_card") {
+                    this.cardgenResponse = yield this.generateCard((_b = args.prompts.card_gen_prompt) !== null && _b !== void 0 ? _b : "", this.parsedContent + JSON.stringify(this.typologyResponse), false);
                     responseToReturn.push(this.cardgenResponse);
                 }
+            if (this.cardgenResponse.status_code == 200) {
+                let gapFill = this.gapFilling();
+                if (gapFill.remainingConcepts.length !== 0 ||
+                    gapFill.remainingFacts.length !== 0) {
+                    this.gapFillResponse = yield this.generateCard((_c = args.prompts.card_gen_prompt) !== null && _c !== void 0 ? _c : "", this.parsedContent +
+                        "Generate cards only suitable for the given remaining concepts and facts" +
+                        JSON.stringify(gapFill) +
+                        "Exclude generating these cards" +
+                        JSON.stringify(this.cardgenResponse.cards_data), true);
+                }
+                responseToReturn.push(this.gapFillResponse);
+            }
             return responseToReturn;
         });
     }
     _returnParsedContent() {
         return this.parsedContent;
     }
-    generateCard(prompt, content) {
+    generateCard(prompt, content, isGapFill) {
         return __awaiter(this, void 0, void 0, function* () {
             let generateCards = new generate_cards_1.GenerateCards(this.openAiService);
-            let cardgenResponse = yield generateCards.generateCards(prompt !== null && prompt !== void 0 ? prompt : '', content);
+            let cardgenResponse = yield generateCards.generateCards(prompt !== null && prompt !== void 0 ? prompt : "", content, isGapFill);
             // let response =  await this.openAiService?.sendRequest(prompt,this.parsedContent);
             // response['type'] = 'card_gen';
             return cardgenResponse;
@@ -74,5 +89,40 @@ class OnlyEverGenerator {
             return response;
         });
     }
+    gapFilling() {
+        var _a, _b, _c, _d, _e;
+        let allConcepts = [];
+        let allFacts = [];
+        let generatedConceptsList = [];
+        let generatedFactsList = [];
+        if (!isEmpty(this.typologyResponse)) {
+            allConcepts.push(...((_a = this.typologyResponse.concepts) !== null && _a !== void 0 ? _a : []));
+            allFacts.push(...((_c = (_b = this.typologyResponse) === null || _b === void 0 ? void 0 : _b.facts) !== null && _c !== void 0 ? _c : []));
+        }
+        if (!isEmpty(this.cardgenResponse)) {
+            allConcepts.push(...((_d = this.cardgenResponse.missing_concepts) !== null && _d !== void 0 ? _d : []));
+            allFacts.push(...((_e = this.cardgenResponse.missing_facts) !== null && _e !== void 0 ? _e : []));
+        }
+        for (let card of this.cardgenResponse.cards_data) {
+            if (card.concepts.length != 0) {
+                generatedConceptsList.push(...card.concepts);
+            }
+            if (card.facts.length != 0) {
+                generatedFactsList.push(...card.facts);
+            }
+        }
+        let generatedConceptsSet = Array.from(new Set(generatedConceptsList));
+        let generatedFactsSet = Array.from(new Set(generatedFactsList));
+        let remainingConcepts = allConcepts.filter((item) => !generatedConceptsSet.includes(item));
+        let remainingFacts = allFacts.filter((item) => !generatedFactsSet.includes(item));
+        return {
+            //   allConcepts: allConcepts,
+            //   allFacts: allFacts,
+            //   generatedConcepts: generatedConceptsSet,
+            //   generatedFacts: generatedFactsSet,
+            remainingConcepts: remainingConcepts,
+            remainingFacts: remainingFacts,
+        };
+    }
 }
 exports.OnlyEverGenerator = OnlyEverGenerator;

package/dist/card_gen/generate_cards.js

@@ -14,12 +14,12 @@ class GenerateCards {
     constructor(openAiService) {
         this.openAiService = openAiService;
     }
-    generateCards(prompt, parsedContent) {
+    generateCards(prompt, parsedContent, isGapFill) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
             let response = yield ((_a = this.openAiService) === null || _a === void 0 ? void 0 : _a.sendRequest(prompt, parsedContent));
-            console.log("response to card generation ", response);
-            response["type"] = "card_gen";
+            // console.log("response to card generation ", response);
+            response["type"] = isGapFill ? "gap_fill" : "card_gen";
             response.metadata = {
                 "req_time": response.generated_at,
                 "req_type": response.type,
@@ -42,25 +42,28 @@ class GenerateCards {
         const missing_concepts = generatedData.generated_content.missing_concepts;
         const missing_facts = generatedData.generated_content.missing_facts;
         const unparsedTestCards = generatedData.generated_content.test_cards;
-        for (let elem of unparsedTestCards) {
-            if (elem.type == "flash") {
-                cardData.push(this.parseFlashCard(elem));
-            }
-            else if (elem.type == "mcq") {
-                cardData.push(this.parseMcqCard(elem));
-            }
-            else if (elem.type == "cloze") {
-                cardData.push(this.parseClozeCard(elem));
-            }
-            else if (elem.type == "match") {
-                cardData.push(this.parseMatchCard(elem));
+        const type = generatedData.type;
+        if (unparsedTestCards !== undefined && unparsedTestCards.length != 0) {
+            for (let elem of unparsedTestCards) {
+                if (elem.type == "flash") {
+                    cardData.push(this.parseFlashCard(elem));
+                }
+                else if (elem.type == "mcq") {
+                    cardData.push(this.parseMcqCard(elem));
+                }
+                else if (elem.type == "cloze") {
+                    cardData.push(this.parseClozeCard(elem));
+                }
+                else if (elem.type == "match") {
+                    cardData.push(this.parseMatchCard(elem));
+                }
             }
         }
         usage_data["created_at"] = created_at;
-        usage_data["type"] = "card_gen";
         return {
             status_code: status_code,
             metadata: usage_data,
+            type: type,
             missing_concepts: missing_concepts,
             missing_facts: missing_facts,
             cards_data: cardData,

package/dist/constants/prompts/card_gen_prompt.js

@@ -27,7 +27,7 @@ json
         {
             "type": "flash" | "mcq" | "cloze" | "match",
             "card_content": { "front": "...", "back": "..." | "prompt": "...", "choices": [ ... ] | "prompt": "...", "options": [ ... ] | "right_choice 1": "...", "left_choice 1": "..." },
-            "card_reference": "source_title#heading",
+            "card_reference": "heading",
             "concepts": ["Concept1", "Concept2", "..."],
             "facts": ["Fact1", "Fact2", "..."]
         }
@@ -35,11 +35,10 @@ json
 
 **Criteria**
 •	Each test card must include at least one concept or fact.
-•	Deprioritize the Flashcards, must not exceed 15% of the total number of cards.
+•	Flashcards must not exceed 15% of the total number of cards.
 •	Each concept and fact must have at least one test card.
 
 Further instructions are provided below.
-
 Concepts are fundamental ideas that form the basis of knowledge in any discipline. They help organize and explain information, making it accessible and relatable.
 
 You are provided with a list of identified concepts. Review this list and the content to determine if any concepts are missing.
@@ -67,7 +66,7 @@ json
 {
     "missing_facts": ["fact1", "fact2", "fact3", "..."]
 }
-    After you have the complete list of concepts and facts, including any missing ones you identified, proceed to generate test cards for each.
+After you have the complete list of concepts and facts, including any missing ones you identified, proceed to generate test cards for each.
 
 	1.	Clarity: Ensure the test content is clear and unambiguous.
 	2.	Specificity: Be specific about what you are asking. Avoid vague or overly broad questions or prompts.
@@ -77,23 +76,29 @@ json
 Test cards must be one of the following types:
 
 1.	Flashcards: Have a front and back. 
+2.  A flashcard consists of two sides: a front and a back. Both the front and back text content must not exceed more than 300 characters in length.
 
-json
+json schema for Flash Cards:
 {
     "type": "flash",
     "card_content": {
-        "front": "<content for the front>",
-        "back": "<content for the back>"
+        "front": "<content for the front of the flashcard>",
+        "back": "<content for the back of the flashcard>"
     },
-    "card_reference": "source_title#heading",
+    "card_reference": "heading",
     "concepts": ["Concept1", "Concept2", "..."],
     "facts": ["Fact1", "Fact2", "..."]
 }
 
-- Each side must not exceed 300 characters.
+
 2. Multiple Choice Questions (MCQ): Provide multiple choices to pick from. One or more should be correct.
+•	Minimum choices required: 2
+•	Maximum choices allowed: 8
+•	Minimum correct choices required: 1
+•	Maximum character length for the prompt: 320
+•	Maximum character length for each choice: 42
 
-json
+json schema for mcqs
 {
     "type": "mcq",
     "card_content": {
@@ -104,156 +109,55 @@ json
             "... up to 8 choices"
         ]
     },
-    "card_reference": "source_title#heading",
+    "card_reference": "heading",
     "concepts": ["Concept1", "Concept2", "..."],
     "facts": ["Fact1", "Fact2", "..."]
 }
 
+3.	Cloze: 
+Fill-in-the-blank style test card. Use double curly braces {{}} to indicate a cloze this is absolute necessagr
 •	Minimum choices required: 2
 •	Maximum choices allowed: 8
 •	Minimum correct choices required: 1
 •	Maximum character length for the prompt: 320
-•	Maximum character length for each choice: 42
-
-3.	Cloze: Fill-in-the-blank style test card. Use double curly braces {{}} to indicate a cloze.
+•	Maximum character length for an individual cloze: 90
 
-json
+json schema for cloze
 {
     "type": "cloze",
-    "card_content":{
-    "text": "<clozed_text>",
-    "options": [
-            {"option" : "<cloze_0>", "cloze" : "<position_0>"},
-            {"option" : "<cloze_1>", "cloze" : "<position_1>,
-            {"option" : "<cloze_2>", "cloze" : "<position_2>"},
-            ....
-            {"option" : "<cloze_6>", "cloze" : "<position_6>"},
+    "card_content": {
+        "text": "Accidentals in music denote {{c0:notes}} that do not belong to the {{c1:scale}} or {{c2:mode}} indicated by the key signature.",
+        "options": [
+            {"option": "notes", "cloze": "c0"},
+            {"option": "scale", "cloze": "c1"},
+            {"option": "mode", "cloze": "c2"},
+            {"option": "chords", "cloze": null},
+            "... up to 8 choices"
         ]
-
-    }
-    "card_reference": "source_title#heading",
+    },
+    "card_reference": "heading",
     "concepts": ["Concept1", "Concept2", "..."],
     "facts": ["Fact1", "Fact2", "..."]
 }
 
-•	Minimum choices required: 2
-•	Maximum choices allowed: 8
-•	Minimum correct choices required: 1
-•	Maximum character length for the prompt: 320
-•	Maximum character length for an individual cloze: 90
+
 
 4.	Match: Pairing items.
+•	Maximum character length for each item in a pair: 42
 
-json
+json schema for match
 {
     "type": "match",
     "card_content": {
-    "<left_text1>": "<right_text1>",
-    "<left_text2>": "<right_text2>",
-    "<left_text3>": "<right_text3>",
-    ...
-    "<left_text8>": "<right_text8>"
-}
-    "card_reference": "source_title#heading",
+        "right_choice 1": "left_choice 1",
+        "right_choice 2": "left_choice 2",
+        "... up to 8 total pairs"
+    },
+    "card_reference": "heading",
     "concepts": ["Concept1", "Concept2", "..."],
     "facts": ["Fact1", "Fact2", "..."]
 }
 
-•	Maximum character length for each item in a pair: 42
-
-
-The schema for each card type is below.
-
-A flashcard consists of two sides: a front and a back. Both the front and back text content must not exceed more than 300 characters in length.
-
-The content schema should be represented in this manner:
-json
-{
-    "front": "<content for the front of the flashcard>",
-    "back": "<content for the back of the flashcard>"
-}
-
-
-The schema for an mcq card is shown below.
-
-json
-{
-    "prompt": "<question text>",
-    "choices": 
-    [
-        {
-            choice: "choice 1",
-            is_correct: true or false
-        },
-        {
-            choice: "choice 2",
-            is_correct: true or false
-        }
-        "... up to 8 choices"
-    ]
-}
-
-Minimum choices required: 2
-Maximum choices allowed: 8
-Minimum correct choices required: 1
-Maximum character length for the prompt: 320
-Maximum character length for each choice: 42
-
-
-For questions of the "type": "cloze", which refers to a fill-in-the-blank style question, the format is outlined below. I have used the sample text here because it is easier to illustrate the schema with an example:
-
-json
-{
-    "prompt": "Accidentals in music denote {{c0:notes}} that do not belong to the {{c1:scale}} or {{c2:mode}} indicated by the key signature."
-    "options": 
-    [
-        {
-            "option: "notes",
-            "cloze": "c0"
-        },
-        {
-            "option: "chords",
-            "cloze": null
-        },
-        {
-            "option: "scale",
-            "cloze": "c1"
-        },
-        {
-            "option: "mode",
-            "cloze": "c2"
-        },
-        
-        {
-            "option: "tilda",
-            "cloze": null
-        },
-        {
-            "option: "score",
-            "cloze": null
-        },
-        "... up to a maximum of 8 choices total"
-    ]
-}
-
-Minimum choices required: 2
-Maximum choices allowed: 8
-Minimum correct choices required: 1
-Maximum character length for the prompt: 320
-Maximum character length for an individual cloze: 90
-
-The schema for match type cards are as follows.
-json
-{
-    "<left_text1>": "<right_text1>",
-    "<left_text2>": "<right_text2>",
-    "<left_text3>": "<right_text3>",
-    ...
-    "<left_text8>": "<right_text8>"
-}
-
-Maximum character length for each item in a pair: 42
-Each test card needs 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 reference schema is as follows: source_title#main_heading, where #main_heading is optional.
 Once you are done generating the test cards. Go back and evaulate the full list of concepts and fact that include any of the missing concepts or facts along with the list that was provided as the input. 
 
 Are there any concept or fact that don't have a test card yet? If yes, go back and create one.
@@ -267,7 +171,6 @@ Once you are done generating the test cards, review the full list of concepts an
 	3.	Repeat this step until all concepts and facts are covered.
 
 Only stop generating test questions once you believe there is sufficient testing material for learners to fully understand the concepts and remember the facts. The same concept or fact can have multiple test cards, so continue creating test cards until you are confident that there are enough for learners to fully grasp the source material.
-
 `;
 function returnCardGenPrompt() {
     return promptString;

package/dist/index.js

@@ -1,11 +1,14 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OnlyEverGenerator = void 0;
 // import express from "express";
 // import { returnCardGenPrompt } from "./constants/prompts/card_gen_prompt";
 // import { returnTypologyPrompt } from "./constants/prompts/typology_prompt";
 // import { GenerateArgs } from "./utils/generate_args";
 // import { returnFields, returnHeadings, returnSourceData } from "./constants/source_data";
+// import config from "./config";
+// const app = express();
+// const port = 3000;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OnlyEverGenerator = void 0;
 const app_1 = require("./bootstrap/app");
 Object.defineProperty(exports, "OnlyEverGenerator", { enumerable: true, get: function () { return app_1.OnlyEverGenerator; } });
 /// All the Codes Below uses express and are strictly for development purpose, while publishing the package, comment everything
@@ -22,7 +25,7 @@ Object.defineProperty(exports, "OnlyEverGenerator", { enumerable: true, get: fun
 //     let content = returnSourceData().toString()
 //     let headings = returnHeadings();
 //     // let aiRequest = await openAIRequest(prompt,content);
-//     let aiRequest = await oeGen.generateCard(prompt,content);
+//     let aiRequest = await oeGen.generateCard(prompt,content, false);
 //     res.send(aiRequest);
 // }); 
 // app.get('/typology', async(req,res)=>{

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "only_ever_generator",
-  "version": "0.0.8",
+  "version": "0.1.0",
   "main": "dist/index.js",
   "scripts": {
-    "start": "nodemon dist/index.js",
+    "start": "npm run build && nodemon dist/index.js",
     "build": "tsc",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
@@ -21,6 +21,7 @@
     "axios": "^1.7.2",
     "dotenv": "^16.4.5",
     "express": "^4.19.2"
+
   },
   "eslintConfig": {
     "parser": "typescript-eslint-parser",

package/src/bootstrap/app.ts

@@ -8,81 +8,152 @@ import { GenerateArgs } from "../utils/generate_args";
 import { returnFields } from "../constants/source_data";
 import { returnTypologyData } from "../parse/response_format_typology";
 
+function isEmpty(obj: object): boolean {
+  return Object.keys(obj).length === 0;
+}
+/// OnlyEverGenerator
 
-/// OnlyEverGenerator 
+export class OnlyEverGenerator {
+  public api_key: string = "";
+  public openAiService: OpenAiService;
+  parsedContent: string = "";
+  expectedFields: Array<string>;
+  constructor(
+    apiKey: string,
+    model: string,
+    content: Array<any>,
+    expected_fields: Array<string>
+  ) {
+    this.api_key = apiKey;
+    this.openAiService = new OpenAiService(
+      apiKey,
+      model ?? "gpt-3.5-turbo-1106"
+    );
+    this.parsedContent = new ParseSourceContent(content).parse();
+    this.expectedFields = returnFields();
+  }
 
-export class OnlyEverGenerator{
-    public api_key: string = '';
-    public openAiService: OpenAiService;
-    parsedContent: string = '';
-    expectedFields: Array<string>
-    constructor(apiKey:string, model: string, content: Array<any>, expected_fields: Array<string>){
-        this.api_key = apiKey;
-        this.openAiService = new OpenAiService(apiKey,model ?? 'gpt-3.5-turbo-1106');
-        this.parsedContent = new ParseSourceContent(content).parse();
-        this.expectedFields = returnFields()
-    };
+  typologyResponse: any = {};
+  cardgenResponse: any = {};
+  summarizeResponse = {};
+  gapFillResponse: any = {};
 
-    typologyResponse = {};
-    cardgenResponse = {};
-    summarizeResponse = {};
+  async generate(
+    generate_typology: boolean = false,
+    generate_card: boolean = false
+  ): Promise<Array<any>> {
+    let typologyPrompt = returnTypologyPrompt();
+    let cardPrompt = returnCardGenPrompt();
+    let args = new GenerateArgs(generate_card, generate_typology, false, {
+      typology_prompt: typologyPrompt,
+      card_gen_prompt: cardPrompt,
+      summary_prompt: "",
+    });
+    const responseToReturn = [];
+    const whatNeedsToBeGenerated = args.getWhatNeedsToBeGenerated();
+    for (let elem of whatNeedsToBeGenerated)
+      if (elem == "generate_tyopology") {
+        this.typologyResponse = await this.generateTypology(
+          args.prompts.typology_prompt ?? ""
+        );
+        responseToReturn.push(this.typologyResponse);
+      } else if (elem == "generate_card") {
+        this.cardgenResponse = await this.generateCard(
+          args.prompts.card_gen_prompt ?? "",
+          this.parsedContent + JSON.stringify(this.typologyResponse),
+          false
+        );
+        responseToReturn.push(this.cardgenResponse);
+      }
+    if (this.cardgenResponse.status_code == 200) {
+      let gapFill = this.gapFilling();
+      if (
+        gapFill.remainingConcepts.length !== 0 ||
+        gapFill.remainingFacts.length !== 0
+      ) {
+        this.gapFillResponse = await this.generateCard(
+          args.prompts.card_gen_prompt ?? "",
+          this.parsedContent +
+            "Generate cards only suitable for the given remaining concepts and facts" +
+            JSON.stringify(gapFill) +
+            "Exclude generating these cards" +
+            JSON.stringify(this.cardgenResponse.cards_data),
+          true
+        );
+      }
+      responseToReturn.push(this.gapFillResponse);
+    }
 
-    
-    
+    return responseToReturn;
+  }
 
-    async generate( 
-       generate_typology: boolean =false,
-       generate_card : boolean = false,
-    ): Promise<Array<any>> {
-      let typologyPrompt = returnTypologyPrompt();
-      let cardPrompt = returnCardGenPrompt();
-      let args = new GenerateArgs(
-        generate_card,
-        generate_typology,
-        false,
-        {
-          typology_prompt: typologyPrompt,
-          card_gen_prompt: cardPrompt,
-          summary_prompt: ''
-        },
-        
-      );
-        const responseToReturn = [];
-        const whatNeedsToBeGenerated = args.getWhatNeedsToBeGenerated();
-        for(let elem of whatNeedsToBeGenerated)
-        if(elem == 'generate_tyopology'){
-            this.typologyResponse = await this.generateTypology(args.prompts.typology_prompt ?? '');
-            responseToReturn.push(this.typologyResponse);
-        }else if(elem == 'generate_card'){
-            this.cardgenResponse =  await this.generateCard(args.prompts.card_gen_prompt ?? '', this.parsedContent +  JSON.stringify(this.typologyResponse));
-            responseToReturn.push(this.cardgenResponse);
-        }
+  _returnParsedContent() {
+    return this.parsedContent;
+  }
 
-        return responseToReturn;
-        
-    }
-    
-    _returnParsedContent(){
-        return this.parsedContent;
-    }
+  async generateCard(prompt: string, content: string, isGapFill: boolean) {
+    let generateCards = new GenerateCards(this.openAiService);
+    let cardgenResponse = await generateCards.generateCards(
+      prompt ?? "",
+      content,
+      isGapFill
+    );
+    // let response =  await this.openAiService?.sendRequest(prompt,this.parsedContent);
+    // response['type'] = 'card_gen';
+    return cardgenResponse;
+  }
+
+  async generateTypology(prompt: string) {
+    let response = await new GenerateTypology(
+      this.openAiService,
+      prompt,
+      this.parsedContent,
+      this.expectedFields
+    ).generate();
+    return response;
+  }
 
+  gapFilling() {
+    let allConcepts: string[] = [];
+    let allFacts: string[] = [];
+    let generatedConceptsList: string[] = [];
+    let generatedFactsList: string[] = [];
+    if (!isEmpty(this.typologyResponse)) {
+      allConcepts.push(...(this.typologyResponse.concepts ?? []));
+      allFacts.push(...(this.typologyResponse?.facts ?? []));
+    }
 
-    async generateCard(prompt: string, content: string){
-        let generateCards = new GenerateCards(this.openAiService);
-        let cardgenResponse =  await generateCards.generateCards(prompt ?? '', content);
-        // let response =  await this.openAiService?.sendRequest(prompt,this.parsedContent);
-        // response['type'] = 'card_gen';
-         return cardgenResponse;
+    if (!isEmpty(this.cardgenResponse)) {
+      allConcepts.push(...(this.cardgenResponse.missing_concepts ?? []));
+      allFacts.push(...(this.cardgenResponse.missing_facts ?? []));
     }
 
-    async generateTypology(prompt:string){
-        let response =  await new GenerateTypology(
-            this.openAiService,
-            prompt,
-            this.parsedContent,
-            this.expectedFields,
-        ).generate();
-        return response;
+    for (let card of this.cardgenResponse.cards_data) {
+      if (card.concepts.length != 0) {
+        generatedConceptsList.push(...card.concepts);
+      }
+      if (card.facts.length != 0) {
+        generatedFactsList.push(...card.facts);
+      }
     }
-    
-}
+
+    let generatedConceptsSet = Array.from(new Set(generatedConceptsList));
+    let generatedFactsSet = Array.from(new Set(generatedFactsList));
+
+    let remainingConcepts: string[] = allConcepts.filter(
+      (item) => !generatedConceptsSet.includes(item)
+    );
+    let remainingFacts: string[] = allFacts.filter(
+      (item) => !generatedFactsSet.includes(item)
+    );
+
+    return {
+      //   allConcepts: allConcepts,
+      //   allFacts: allFacts,
+      //   generatedConcepts: generatedConceptsSet,
+      //   generatedFacts: generatedFactsSet,
+      remainingConcepts: remainingConcepts,
+      remainingFacts: remainingFacts,
+    };
+  }
+}

package/src/card_gen/generate_cards.ts

@@ -6,10 +6,10 @@ export class GenerateCards {
     this.openAiService = openAiService;
   }
 
-  async generateCards(prompt: string, parsedContent: string) {
+  async generateCards(prompt: string, parsedContent: string, isGapFill: boolean) {
     let response = await this.openAiService?.sendRequest(prompt, parsedContent);
-    console.log("response to card generation ", response);
-    response["type"] = "card_gen";
+   // console.log("response to card generation ", response);
+    response["type"] = isGapFill ? "gap_fill":"card_gen";
        response.metadata = {
         "req_time": response.generated_at,
         "req_type": response.type,
@@ -31,24 +31,27 @@ export class GenerateCards {
     const missing_concepts = generatedData.generated_content.missing_concepts;
     const missing_facts = generatedData.generated_content.missing_facts;
     const unparsedTestCards = generatedData.generated_content.test_cards;
-
-    for (let elem of unparsedTestCards) {
-      if (elem.type == "flash") {
-        cardData.push(this.parseFlashCard(elem));
-      } else if (elem.type == "mcq") {
-        cardData.push(this.parseMcqCard(elem));
-      } else if (elem.type == "cloze") {
-        cardData.push(this.parseClozeCard(elem));
-      } else if (elem.type == "match") {
-        cardData.push(this.parseMatchCard(elem));
-      }
+    const type = generatedData.type;
+if(unparsedTestCards !== undefined && unparsedTestCards.length != 0) {
+  for (let elem of unparsedTestCards) {
+    if (elem.type == "flash") {
+      cardData.push(this.parseFlashCard(elem));
+    } else if (elem.type == "mcq") {
+      cardData.push(this.parseMcqCard(elem));
+    } else if (elem.type == "cloze") {
+      cardData.push(this.parseClozeCard(elem));
+    } else if (elem.type == "match") {
+      cardData.push(this.parseMatchCard(elem));
     }
+  }
+}
+    
     usage_data["created_at"] = created_at;
-    usage_data["type"] = "card_gen";
 
     return {
       status_code: status_code,
       metadata: usage_data,
+      type: type,
       missing_concepts: missing_concepts,
       missing_facts: missing_facts,
       cards_data: cardData,

package/src/constants/prompts/card_gen_prompt.ts

@@ -24,7 +24,7 @@ json
         {
             "type": "flash" | "mcq" | "cloze" | "match",
             "card_content": { "front": "...", "back": "..." | "prompt": "...", "choices": [ ... ] | "prompt": "...", "options": [ ... ] | "right_choice 1": "...", "left_choice 1": "..." },
-            "card_reference": "source_title#heading",
+            "card_reference": "heading",
             "concepts": ["Concept1", "Concept2", "..."],
             "facts": ["Fact1", "Fact2", "..."]
         }
@@ -32,11 +32,10 @@ json
 
 **Criteria**
 •	Each test card must include at least one concept or fact.
-•	Deprioritize the Flashcards, must not exceed 15% of the total number of cards.
+•	Flashcards must not exceed 15% of the total number of cards.
 •	Each concept and fact must have at least one test card.
 
 Further instructions are provided below.
-
 Concepts are fundamental ideas that form the basis of knowledge in any discipline. They help organize and explain information, making it accessible and relatable.
 
 You are provided with a list of identified concepts. Review this list and the content to determine if any concepts are missing.
@@ -64,7 +63,7 @@ json
 {
     "missing_facts": ["fact1", "fact2", "fact3", "..."]
 }
-    After you have the complete list of concepts and facts, including any missing ones you identified, proceed to generate test cards for each.
+After you have the complete list of concepts and facts, including any missing ones you identified, proceed to generate test cards for each.
 
 	1.	Clarity: Ensure the test content is clear and unambiguous.
 	2.	Specificity: Be specific about what you are asking. Avoid vague or overly broad questions or prompts.
@@ -74,23 +73,29 @@ json
 Test cards must be one of the following types:
 
 1.	Flashcards: Have a front and back. 
+2.  A flashcard consists of two sides: a front and a back. Both the front and back text content must not exceed more than 300 characters in length.
 
-json
+json schema for Flash Cards:
 {
     "type": "flash",
     "card_content": {
-        "front": "<content for the front>",
-        "back": "<content for the back>"
+        "front": "<content for the front of the flashcard>",
+        "back": "<content for the back of the flashcard>"
     },
-    "card_reference": "source_title#heading",
+    "card_reference": "heading",
     "concepts": ["Concept1", "Concept2", "..."],
     "facts": ["Fact1", "Fact2", "..."]
 }
 
-- Each side must not exceed 300 characters.
+
 2. Multiple Choice Questions (MCQ): Provide multiple choices to pick from. One or more should be correct.
+•	Minimum choices required: 2
+•	Maximum choices allowed: 8
+•	Minimum correct choices required: 1
+•	Maximum character length for the prompt: 320
+•	Maximum character length for each choice: 42
 
-json
+json schema for mcqs
 {
     "type": "mcq",
     "card_content": {
@@ -101,156 +106,55 @@ json
             "... up to 8 choices"
         ]
     },
-    "card_reference": "source_title#heading",
+    "card_reference": "heading",
     "concepts": ["Concept1", "Concept2", "..."],
     "facts": ["Fact1", "Fact2", "..."]
 }
 
+3.	Cloze: 
+Fill-in-the-blank style test card. Use double curly braces {{}} to indicate a cloze this is absolute necessagr
 •	Minimum choices required: 2
 •	Maximum choices allowed: 8
 •	Minimum correct choices required: 1
 •	Maximum character length for the prompt: 320
-•	Maximum character length for each choice: 42
-
-3.	Cloze: Fill-in-the-blank style test card. Use double curly braces {{}} to indicate a cloze.
+•	Maximum character length for an individual cloze: 90
 
-json
+json schema for cloze
 {
     "type": "cloze",
-    "card_content":{
-    "text": "<clozed_text>",
-    "options": [
-            {"option" : "<cloze_0>", "cloze" : "<position_0>"},
-            {"option" : "<cloze_1>", "cloze" : "<position_1>,
-            {"option" : "<cloze_2>", "cloze" : "<position_2>"},
-            ....
-            {"option" : "<cloze_6>", "cloze" : "<position_6>"},
+    "card_content": {
+        "text": "Accidentals in music denote {{c0:notes}} that do not belong to the {{c1:scale}} or {{c2:mode}} indicated by the key signature.",
+        "options": [
+            {"option": "notes", "cloze": "c0"},
+            {"option": "scale", "cloze": "c1"},
+            {"option": "mode", "cloze": "c2"},
+            {"option": "chords", "cloze": null},
+            "... up to 8 choices"
         ]
-
-    }
-    "card_reference": "source_title#heading",
+    },
+    "card_reference": "heading",
     "concepts": ["Concept1", "Concept2", "..."],
     "facts": ["Fact1", "Fact2", "..."]
 }
 
-•	Minimum choices required: 2
-•	Maximum choices allowed: 8
-•	Minimum correct choices required: 1
-•	Maximum character length for the prompt: 320
-•	Maximum character length for an individual cloze: 90
+
 
 4.	Match: Pairing items.
+•	Maximum character length for each item in a pair: 42
 
-json
+json schema for match
 {
     "type": "match",
     "card_content": {
-    "<left_text1>": "<right_text1>",
-    "<left_text2>": "<right_text2>",
-    "<left_text3>": "<right_text3>",
-    ...
-    "<left_text8>": "<right_text8>"
-}
-    "card_reference": "source_title#heading",
+        "right_choice 1": "left_choice 1",
+        "right_choice 2": "left_choice 2",
+        "... up to 8 total pairs"
+    },
+    "card_reference": "heading",
     "concepts": ["Concept1", "Concept2", "..."],
     "facts": ["Fact1", "Fact2", "..."]
 }
 
-•	Maximum character length for each item in a pair: 42
-
-
-The schema for each card type is below.
-
-A flashcard consists of two sides: a front and a back. Both the front and back text content must not exceed more than 300 characters in length.
-
-The content schema should be represented in this manner:
-json
-{
-    "front": "<content for the front of the flashcard>",
-    "back": "<content for the back of the flashcard>"
-}
-
-
-The schema for an mcq card is shown below.
-
-json
-{
-    "prompt": "<question text>",
-    "choices": 
-    [
-        {
-            choice: "choice 1",
-            is_correct: true or false
-        },
-        {
-            choice: "choice 2",
-            is_correct: true or false
-        }
-        "... up to 8 choices"
-    ]
-}
-
-Minimum choices required: 2
-Maximum choices allowed: 8
-Minimum correct choices required: 1
-Maximum character length for the prompt: 320
-Maximum character length for each choice: 42
-
-
-For questions of the "type": "cloze", which refers to a fill-in-the-blank style question, the format is outlined below. I have used the sample text here because it is easier to illustrate the schema with an example:
-
-json
-{
-    "prompt": "Accidentals in music denote {{c0:notes}} that do not belong to the {{c1:scale}} or {{c2:mode}} indicated by the key signature."
-    "options": 
-    [
-        {
-            "option: "notes",
-            "cloze": "c0"
-        },
-        {
-            "option: "chords",
-            "cloze": null
-        },
-        {
-            "option: "scale",
-            "cloze": "c1"
-        },
-        {
-            "option: "mode",
-            "cloze": "c2"
-        },
-        
-        {
-            "option: "tilda",
-            "cloze": null
-        },
-        {
-            "option: "score",
-            "cloze": null
-        },
-        "... up to a maximum of 8 choices total"
-    ]
-}
-
-Minimum choices required: 2
-Maximum choices allowed: 8
-Minimum correct choices required: 1
-Maximum character length for the prompt: 320
-Maximum character length for an individual cloze: 90
-
-The schema for match type cards are as follows.
-json
-{
-    "<left_text1>": "<right_text1>",
-    "<left_text2>": "<right_text2>",
-    "<left_text3>": "<right_text3>",
-    ...
-    "<left_text8>": "<right_text8>"
-}
-
-Maximum character length for each item in a pair: 42
-Each test card needs 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 reference schema is as follows: source_title#main_heading, where #main_heading is optional.
 Once you are done generating the test cards. Go back and evaulate the full list of concepts and fact that include any of the missing concepts or facts along with the list that was provided as the input. 
 
 Are there any concept or fact that don't have a test card yet? If yes, go back and create one.
@@ -264,7 +168,6 @@ Once you are done generating the test cards, review the full list of concepts an
 	3.	Repeat this step until all concepts and facts are covered.
 
 Only stop generating test questions once you believe there is sufficient testing material for learners to fully understand the concepts and remember the facts. The same concept or fact can have multiple test cards, so continue creating test cards until you are confident that there are enough for learners to fully grasp the source material.
-
 `;
 
 

package/src/index.ts

@@ -4,11 +4,11 @@
 // import { returnTypologyPrompt } from "./constants/prompts/typology_prompt";
 // import { GenerateArgs } from "./utils/generate_args";
 // import { returnFields, returnHeadings, returnSourceData } from "./constants/source_data";
-import { OnlyEverGenerator } from "./bootstrap/app";
 // import config from "./config";
 // const app = express();
 // const port = 3000;
 
+import { OnlyEverGenerator } from "./bootstrap/app";
 
 
 /// While Publishing the package , and using this code as a separate npm module
@@ -34,7 +34,7 @@ export {OnlyEverGenerator};
 //     let content = returnSourceData().toString()
 //     let headings = returnHeadings();
 //     // let aiRequest = await openAIRequest(prompt,content);
-//     let aiRequest = await oeGen.generateCard(prompt,content);
+//     let aiRequest = await oeGen.generateCard(prompt,content, false);
 //     res.send(aiRequest);
 // });