only_ever_generator 0.3.8 → 0.4.0

package/dist/bootstrap/app.js

@@ -61,7 +61,7 @@ class OnlyEverGenerator {
                         responseToReturn.push(this.cardgenResponse);
                         /// check if gap fill is required ie coverage determination 
                         if (this.cardgenResponse.status_code == 200) {
-                            this.gapFillResponse = yield this.generationForGapFill(this.typologyResponse, this.cardgenResponse);
+                            this.gapFillResponse = yield this._generationForGapFill(this.typologyResponse, this.cardgenResponse);
                             responseToReturn.push(this.gapFillResponse);
                         }
                     }
@@ -79,7 +79,7 @@ class OnlyEverGenerator {
             return false;
         }
     }
-    generationForGapFill(typologyData, cardGenData) {
+    _generationForGapFill(typologyData, cardGenData) {
         return __awaiter(this, void 0, void 0, function* () {
             let gapFill = (0, calculate_gap_fill_1.gapFilling)(typologyData, cardGenData);
             let response;
@@ -108,5 +108,21 @@ class OnlyEverGenerator {
             return response;
         });
     }
+    gapFill(factsMaps, aiCards) {
+        return __awaiter(this, void 0, void 0, function* () {
+            /// factsmap 
+            /// {
+            /// remaining_facts: [],
+            /// remaining_concepts: [],
+            //}
+            /// aicards is data
+            let response;
+            response = yield this.generateCard(this.promptForCardGen +
+                "Generate cards only suitable for the given remaining concepts and facts" +
+                JSON.stringify(factsMaps) +
+                "Exclude generating  cards with content in the following", JSON.stringify(aiCards), true);
+            return response;
+        });
+    }
 }
 exports.OnlyEverGenerator = OnlyEverGenerator;

package/dist/card_gen/generate_cards.js

@@ -199,20 +199,14 @@ class GenerateCards {
     }
     parseMatchCard(cardData) {
         let content = cardData.card_content;
-        const transformedData = {};
-        for (let key in content) {
-            if (content.hasOwnProperty(key)) {
-                transformedData[key] = [content[key]];
-            }
-        }
-        let displayTitle = this.generateMatchCardDisplayTitle(transformedData);
+        let displayTitle = this.generateMatchCardDisplayTitle(content);
         let matchCard = {
             type: {
                 category: 'learning',
                 sub_type: cardData.type,
             },
             heading: cardData.card_reference,
-            content: transformedData,
+            content: content,
             //  content: cardData.card_content,
             displayTitle: displayTitle,
             concepts: cardData.concepts,
@@ -224,16 +218,12 @@ class GenerateCards {
     generateMatchCardDisplayTitle(answers) {
         let titles = [];
         let counter = 65;
-        for (let key in answers) {
-            if (answers.hasOwnProperty(key)) {
-                let value = answers[key];
-                //     let items = value.split(',').map((item: string) => item.trim());
-                //     items.forEach((item: any) => {
-                let letter = String.fromCharCode(counter);
-                titles.push(`${letter}. ${key} -- ${value}`);
-                counter++;
-                //     });
-            }
+        for (let data of answers) {
+            let value = data.right_item.join(',');
+            let left = data.left_item;
+            let letter = String.fromCharCode(counter);
+            titles.push(`${letter}. ${data} -- ${value}`);
+            counter++;
         }
         let displayTitle = titles.join(",");
         return displayTitle;

package/dist/constants/api_constants.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.openAiEndPoint = void 0;
+exports.openAiEndPoint = openAiEndPoint;
 function openAiEndPoint() {
     return 'https://api.openai.com/v1/chat/completions';
 }
-exports.openAiEndPoint = openAiEndPoint;

package/dist/constants/prompt_data.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.returnPromptData = void 0;
+exports.returnPromptData = returnPromptData;
 const card_gen_prompt_1 = require("./prompts/card_gen_prompt");
 const typology_prompt_1 = require("./prompts/typology_prompt");
 const promptData = {
@@ -300,4 +300,3 @@ function returnPromptData() {
         "card_generation": (0, card_gen_prompt_1.returnCardGenPrompt)(''),
     };
 }
-exports.returnPromptData = returnPromptData;

package/dist/constants/prompts/card_gen_prompt.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.returnCardGenPrompt = void 0;
+exports.returnCardGenPrompt = returnCardGenPrompt;
 const promptString = `
 As a dedicated assistant at a learning company, your role is to analyze educational content and create test cards that help learners understand and remember key concepts and facts. You will be provided with:
 
@@ -67,12 +67,13 @@ 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.
 
-	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.
-	3.	Simplicity: Use simple and direct language. Avoid complex sentences or jargon unless testing understanding of that jargon.
-	4.	Relevance: Ensure the test content is directly related to the key concepts or facts you want to test.
+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.
+3.	Simplicity: Use simple and direct language. Avoid complex sentences or jargon unless testing understanding of that jargon.
+4.	Relevance: Ensure the test content is directly related to the key concepts or facts you want to test.
 
 Include the following property for each card:
 
@@ -84,37 +85,39 @@ Test cards must be one of the following types:
 
 1.	Flashcards: Have a front and back. 
 
-json
+json:
 {
-    "type": "flash",
-    "card_content": {
-        "front": "<content for the front>",
-        "back": "<content for the back>"
-    },
-    "card_reference": "heading",
-    "concepts": ["Concept1", "Concept2", "..."],
-    "facts": ["Fact1", "Fact2", "..."],
-    "bloom_level": <1-5>
+"type": "flash",
+"card_content": {
+    "front": "<content for the front>",
+    "back": "<content for the back>"
+},
+"card_reference": "heading",
+"concepts": ["Concept1", "Concept2", "..."],
+"facts": ["Fact1", "Fact2", "..."],
+"bloom_level": <1-5>
 }
+
 - Each side must not exceed 300 characters.
 2. Multiple Choice Questions (MCQ): Provide multiple choices to pick from. One or more should be correct.
 
-json
+json:
 {
-    "type": "mcq",
-    "card_content": {
-        "prompt": "<question text>",
-        "choices": [
-            {"choice": "choice 1", "is_correct": true or false},
-            {"choice": "choice 2", "is_correct": true or false},
-            "... up to 8 choices"
-        ]
-    },
-    "card_reference": "heading",
-    "concepts": ["Concept1", "Concept2", "..."],
-    "facts": ["Fact1", "Fact2", "..."],
-    "bloom_level": <1-5>
+"type": "mcq",
+"card_content": {
+    "prompt": "<question text>",
+    "choices": [
+        {"choice": "choice 1", "is_correct": true or false},
+        {"choice": "choice 2", "is_correct": true or false},
+        "... up to 8 choices"
+    ]
+},
+"card_reference": "heading",
+"concepts": ["Concept1", "Concept2", "..."],
+"facts": ["Fact1", "Fact2", "..."],
+"bloom_level": <1-5>
 }
+
 •	Minimum choices required: 2
 •	Maximum choices allowed: 8
 •	Minimum correct choices required: 1
@@ -125,22 +128,23 @@ json
 
 json
 {
-    "type": "cloze",
-    "card_content": {
-        "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": "scale", "cloze": "c1"},
-            {"option": "mode", "cloze": "c2"},
-            {"option": "chords", "cloze": "null"},
-            "... up to 8 choices"
-        ]
-    },
-    "card_reference": "heading",
-    "concepts": ["Concept1", "Concept2", "..."],
-    "facts": ["Fact1", "Fact2", "..."],
-    "bloom_level": <1-5>
+"type": "cloze",
+"card_content": {
+    "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": "scale", "cloze": "c1"},
+        {"option": "mode", "cloze": "c2"},
+        {"option": "chords", "cloze": "null"},
+        "... up to 8 choices"
+    ]
+},
+"card_reference": "heading",
+"concepts": ["Concept1", "Concept2", "..."],
+"facts": ["Fact1", "Fact2", "..."],
+"bloom_level": <1-5>
 }
+
 •	Minimum choices required: 2
 •	Maximum choices allowed: 8
 •	Minimum correct choices required: 1
@@ -148,20 +152,33 @@ json
 •	Maximum character length for an individual cloze: 90
 
 4.	Match: Pairing items.
+
 json
 {
-    "type": "match",
-    "card_content": {
-        "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", "..."],
-    "bloom_level": <1-5>
+"type": "match",
+"card_content": [
+   {
+    "left_item": "left choice",
+    "right_item": [right item]
+   },
+   {
+    "left_item":" left choice",
+    "right_item": [right item]
+   },
+   {
+    "left_item": "left choice",
+    "right_item": [right item]
+   },
+    "... up to 8 total pairs"
+],
+"card_reference": "heading",
+"concepts": ["Concept1", "Concept2", "..."],
+"facts": ["Fact1", "Fact2", "..."],
+"bloom_level": <1-5>
 }
+
 •	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: ""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. 
@@ -175,7 +192,6 @@ Generate atleast 10 cards.
 function returnCardGenPrompt(cardGenPrompt) {
     return promptString;
 }
-exports.returnCardGenPrompt = returnCardGenPrompt;
 //     let concatenatedString: string = '';
 //     for (let key in cardGenPrompt) {
 //       if (cardGenPrompt.hasOwnProperty(key)) {

package/dist/constants/prompts/typology_prompt.js

@@ -1,26 +1,40 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.returnTypologyPrompt = void 0;
+exports.returnTypologyPrompt = returnTypologyPrompt;
 const typologyPromptString = `
-As a dedicated assistant at a learning company, your role involves analyzing educational content to categorize and summarize it. You will process content (in JSON format) that represents text and images 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 PDFs, book chapters, videos, and websites. Follow these steps:
 
 1. Classify the content into one to three predefined fields of knowledge.
-2. Identify key concepts within the content.
-3. Detect concrete facts that are empirically verified and relevant to the subject.
-4. Decide whether the identified concepts and facts should be used to generate learning materials like flashcards based on their educational value.
+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.
 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:
 json
 {
     "field": ["primary_field", "secondary_field", "tertiary_field"],
-    "concepts": ["concept1", "concept2", "concept3", "..."],
-    "facts": ["fact1", "fact2", "fact3", "..."],
+    "concepts": 
+    [
+        {
+            "concept_text": "concept_content",
+            "reference": "source_title#main_heading"
+        },
+        {...}
+    ],
+    "facts": 
+    [
+        {
+            "fact_text": "fact_content",
+            "reference": "source_title#main_heading"
+        },
+        {...}
+    ],
     "generate_cards": [
         state: true or false,
-        false_reason: "reason for marking the source as false. Leave empty for true."
+        reason: "reason for marking the source as false. Leave empty for true."
     ],
-    "summary_cards": ["summary_card1", "summary_card2", "summary_card3", "..."]
+    "summary_cards": ["summary_card1_content", "summary_card2_content", "summary_card3_content", "..."]
 }
 
 Further instruction on how to perform these tasks are below.
@@ -44,54 +58,78 @@ Every source must be placed under a field. This is the broadest category of know
 16.	Trades & Craftsmanship: Cover Hands-on Skills in Trades and Crafts.
 17.	Reference & Indexing: Include Summaries, Timelines, Directories, Glossaries, Bibliographies, and other Reference Material.
 18.	Other: Use for content that doesn’t fit into the above categories.
+Extract key concepts within the content after classifying the field. This is a crucial part of the exercise. Be exhaustive and thorough.
 
-Identify key concepts within the content after classifying the field. Concepts are the fundamental ideas or categories that form the basis of knowledge within any discipline. They help organize and explain information, making it accessible and relatable.
-
-1. **Definition of a Concept**: Concepts should be significant ideas that recur within the content and are essential for understanding the main themes.
+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.
+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.
+5. **Reference**: Every concept must include a reference. A reference can either be the entire source or a specific heading in the source. The reference indicates the part of the text that is most relevant for that particular concept. 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. If a concept needs to reference multiple sections or the entire source then simply leave the reference as empty.
 
 List the concepts in the following JSON format:
+
 json
-{
-    "concepts": ["concept1", "concept2", "concept3", "..."]
-}
-After classifying the content and identifying key concepts, proceed to extract and list verifiable facts. Facts are objective statements that must be supported by empirical evidence or observation, such as specific data on events, people, numbers, dates, or well-established ideas.
+"concepts": 
+    [
+        {
+            "concept_text": "concept_content",
+            "reference": "source_title#main_heading"
+        },
+        {...}
+    ]
+
+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.
+4. **Reference**: Every fact must include a reference. The reference indicates the part of the text that is most relevant for that particular concept. 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. If a fact needs to reference multiple sections or the entire source then simply leave the reference as empty.
 
-Record the facts in the following JSON format:
+List the facts in the following JSON format:
 json
-{
-    "facts": ["fact1", "fact2", "fact3", "..."]
-}
-    After analyzing the content, classifying its field, and identifying key concepts, and facts, assess whether the discovered elements warrant the creation of testing 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 testing cards don't need to be generated then please provide a reason in less than 90 characters.
+"facts": 
+    [
+        {
+            "fact_text": "fact_content",
+            "reference": "source_title#main_heading"
+        },
+        {...}
+    ]
+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.
 
 Make your decision using this criterion and reflect it in the JSON format as follows:
+
 json
 "generate_cards": 
     {   state: true or false,
-        false_reason: "reason for marking the source as false. Leave empty for true."
+        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.
+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.
 
 
 1. **Inclusion Criteria**: The generate_cards should be true. Return an empty array if the generate_cards is false.
 2. **Summarization Objective**: Each card is a step in a journey through the content. The series should collectively summarize the source while emphasizing important learning points.
 3. **Character Limit**: Maintain a limit of 320 characters per card to ensure each message is concise yet informative.
+4. **Card limit**: Limit the total number of cards to less than or equal to 8.
 4. **Engagement and Flow**: Write in an engaging style that maintains the user’s interest. Arrange the cards in a logical order that reflects the flow of the original content.
 
 Format your output in JSON as follows:
+
 json
 {
-    "summary_cards": ["summary_card1", "summary_card2", "summary_card3", "..."]
+    "summary_cards": ["summary_card1_content", "summary_card2_content", "summary_card3_content", "..."]
 }
+
+
 `;
 function returnTypologyPrompt() {
     return typologyPromptString;
 }
-exports.returnTypologyPrompt = returnTypologyPrompt;

package/dist/constants/source_data.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.returnHeadings = exports.returnSourceData = exports.returnFields = void 0;
+exports.returnFields = returnFields;
+exports.returnSourceData = returnSourceData;
+exports.returnHeadings = returnHeadings;
 const sourceString = [
     {
         "block_type": "paragraph",
@@ -1254,7 +1256,6 @@ const headings = [
 function returnFields() {
     return ["Sciences", "Technology & Engineering", "Humanities & Cultural Studies", "Social Sciences & Global Studies", "Business & Management", "Health & Medicine", "Environmental Studies & Earth Sciences", "Education, Learning & Personal Development", "Creative & Performing Arts", "Law, Governance & Ethics", "Recreation, Lifestyle & Practical Skills", "Technology & Media Literacy", "Philosophy & Critical Thinking", "Space & Astronomical Sciences", "Agriculture & Food Sciences", "Trades & Craftsmanship", "Reference & Indexing", "Other"];
 }
-exports.returnFields = returnFields;
 const sourceContent = {
     type: 'source',
     title: 'Time zone',
@@ -1309,8 +1310,6 @@ const sourceContent = {
 function returnSourceData() {
     return sourceContent;
 }
-exports.returnSourceData = returnSourceData;
 function returnHeadings() {
     return headings;
 }
-exports.returnHeadings = returnHeadings;

package/dist/gap_fill/calculate_gap_fill.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.gapFilling = void 0;
+exports.gapFilling = gapFilling;
 function isEmpty(obj) {
     return Object.keys(obj).length === 0;
 }
@@ -43,4 +43,3 @@ function gapFilling(typologyResponse, cardgenResponse) {
         remainingFacts: remainingFacts,
     };
 }
-exports.gapFilling = gapFilling;

package/dist/index.js

@@ -10,9 +10,9 @@ 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
-//below this line
-// let oeGen = new OnlyEverGenerator(config.openAIKey, "gpt-3.5-turbo-1106", {
+// //. 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", {
 //   prompt: returnPromptData(),
 //   content: returnSourceData(),
 // });
@@ -28,27 +28,27 @@ 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, false);
-//   //  res.send(aiRequest);
-// });
-// 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);
-//   }
+//     let aiRequest = await oeGen.generate(false,true);
+//    res.send(aiRequest);
 // });
+// // 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.listen(port, () => {
 //   console.log(`Example app listening at http://localhost:${port}`);
 // });

package/dist/parse/response_format_card.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseResponse = exports.returnResponse = void 0;
+exports.returnResponse = returnResponse;
+exports.parseResponse = parseResponse;
 const responseData = {
     "flash_cards": [
         {
@@ -142,7 +143,6 @@ const responseData = {
 function returnResponse() {
     return responseData;
 }
-exports.returnResponse = returnResponse;
 function parseResponse() {
     let cardData = [];
     let data = returnResponse();
@@ -162,7 +162,6 @@ function parseResponse() {
     }
     return cardData;
 }
-exports.parseResponse = parseResponse;
 /// takes array of 
 function parseFlashCard(cards) {
     let flashCardData = [];

package/dist/parse/response_format_typology.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.returnTypologyData = void 0;
+exports.returnTypologyData = returnTypologyData;
 const typologyResponse = {
     "usage_data": {
         "prompt_tokens": 11611,
@@ -44,4 +44,3 @@ const typologyResponse = {
 function returnTypologyData() {
     return typologyResponse;
 }
-exports.returnTypologyData = returnTypologyData;

package/dist/utils/parse_openai_response.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseOpenAiFailureResponse = exports.parseOpenAiSuccessResponse = void 0;
+exports.parseOpenAiSuccessResponse = parseOpenAiSuccessResponse;
+exports.parseOpenAiFailureResponse = parseOpenAiFailureResponse;
 function parseOpenAiSuccessResponse(responseData) {
     let choices = JSON.parse(responseData.choices[0].message.content);
     let usuage = responseData.usage;
@@ -12,7 +13,6 @@ function parseOpenAiSuccessResponse(responseData) {
         'generated_at': new Date(createdTime * 1000)
     };
 }
-exports.parseOpenAiSuccessResponse = parseOpenAiSuccessResponse;
 function parseOpenAiFailureResponse(errorResponse) {
     var _a, _b;
     // let statusCode = 
@@ -21,4 +21,3 @@ function parseOpenAiFailureResponse(errorResponse) {
         'message': (_b = (_a = errorResponse.data) === null || _a === void 0 ? void 0 : _a.error) === null || _b === void 0 ? void 0 : _b.code
     };
 }
-exports.parseOpenAiFailureResponse = parseOpenAiFailureResponse;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "only_ever_generator",
-  "version": "0.3.8",
+  "version": "0.4.0",
   "main": "dist/index.js",
   "scripts": {
     "start": "npm run build && nodemon dist/index.js",
@@ -13,16 +13,16 @@
   "devDependencies": {
     "@types/express": "^4.17.21",
     "@types/node": "^20.14.2",
+    "dotenv": "^16.4.5",
+    "express": "^4.19.2",
     "nodemon": "^3.1.3",
     "ts-node": "^10.9.2",
-    "typescript": "^5.4.5",
-    "dotenv": "^16.4.5",
-    "express": "^4.19.2"
+    "typescript": "^5.5.4"
   },
   "dependencies": {
-    "axios": "^1.7.2"
- 
-
+    "axios": "^1.7.7",
+    "n": "^10.0.0",
+    "stable": "^0.1.8"
   },
   "eslintConfig": {
     "parser": "typescript-eslint-parser",

package/readme.md

@@ -20,4 +20,16 @@ let oeGenerator = new OnlyEverGenerator(
 let responsesArray = await oeGenerator.generate(true,true);
 
 
+Exposed a new method ```gapFill``` from OnlyEverGenerator
+
+
+  async gapFill(factsMaps: any, aiCards: Array<any>) {}
+    /// factsmap 
+    /// {
+    /// remaining_facts: [],
+     /// remaining_concepts: [],
+    //}
+
+    /// aicards is array of ai cards
+
 ```

package/src/bootstrap/app.ts

@@ -79,7 +79,7 @@ export class OnlyEverGenerator {
 
           /// check if gap fill is required ie coverage determination 
           if(this.cardgenResponse.status_code == 200) {
-            this.gapFillResponse = await this.generationForGapFill(this.typologyResponse, this.cardgenResponse);
+            this.gapFillResponse = await this._generationForGapFill(this.typologyResponse, this.cardgenResponse);
             responseToReturn.push(this.gapFillResponse);
           }
 
@@ -99,7 +99,7 @@ export class OnlyEverGenerator {
 
   }
 
-  async generationForGapFill(typologyData: any, cardGenData: any) {
+  async _generationForGapFill(typologyData: any, cardGenData: any) {
       let gapFill = gapFilling(typologyData, cardGenData);
       let response :any ;
       if (
@@ -145,6 +145,29 @@ export class OnlyEverGenerator {
     return response;
   }
 
+  async gapFill(factsMaps: any, aiCards: Array<any>) {
+    /// factsmap 
+    /// {
+    /// remaining_facts: [],
+     /// remaining_concepts: [],
+    //}
+
+    /// aicards is data
+    let response :any ;
+
+      response = await this.generateCard(
+       this.promptForCardGen +
+          "Generate cards only suitable for the given remaining concepts and facts" +
+          JSON.stringify(factsMaps) +
+          "Exclude generating  cards with content in the following",
+          JSON.stringify(aiCards),
+        true
+      );
+    
+    return response;
+  
+}
+
   
 
 }

package/src/card_gen/generate_cards.ts

@@ -207,21 +207,15 @@ return question;
 
   parseMatchCard(cardData: any) {
     let content = cardData.card_content;
-    const transformedData: { [key: string]: string[] } = {};
 
-    for (let key in content) {
-      if (content.hasOwnProperty(key)) {
-        transformedData[key] = [content[key]];
-      }
-    }
-    let displayTitle = this.generateMatchCardDisplayTitle(transformedData);
+    let displayTitle = this.generateMatchCardDisplayTitle(content);
     let matchCard = {
       type: {
         category: 'learning',
         sub_type: cardData.type,
       },
       heading: cardData.card_reference,
-      content: transformedData,
+      content: content,
       //  content: cardData.card_content,
       displayTitle: displayTitle,
       concepts: cardData.concepts,
@@ -237,16 +231,13 @@ return question;
   generateMatchCardDisplayTitle(answers: any) {
     let titles: string[] = [];
     let counter = 65;
-    for (let key in answers) {
-      if (answers.hasOwnProperty(key)) {
-        let value = answers[key];
-        //     let items = value.split(',').map((item: string) => item.trim());
-        //     items.forEach((item: any) => {
+    for (let data of answers) {
+      
+        let value = data.right_item.join(',');
+        let left = data.left_item;
         let letter = String.fromCharCode(counter);
-        titles.push(`${letter}. ${key} -- ${value}`);
+        titles.push(`${letter}. ${data} -- ${value}`);
         counter++;
-        //     });
-      }
     }
     let displayTitle = titles.join(",");
     return displayTitle;

package/src/constants/prompts/card_gen_prompt.ts

@@ -64,12 +64,13 @@ 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.
 
-	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.
-	3.	Simplicity: Use simple and direct language. Avoid complex sentences or jargon unless testing understanding of that jargon.
-	4.	Relevance: Ensure the test content is directly related to the key concepts or facts you want to test.
+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.
+3.	Simplicity: Use simple and direct language. Avoid complex sentences or jargon unless testing understanding of that jargon.
+4.	Relevance: Ensure the test content is directly related to the key concepts or facts you want to test.
 
 Include the following property for each card:
 
@@ -81,37 +82,39 @@ Test cards must be one of the following types:
 
 1.	Flashcards: Have a front and back. 
 
-json
+json:
 {
-    "type": "flash",
-    "card_content": {
-        "front": "<content for the front>",
-        "back": "<content for the back>"
-    },
-    "card_reference": "heading",
-    "concepts": ["Concept1", "Concept2", "..."],
-    "facts": ["Fact1", "Fact2", "..."],
-    "bloom_level": <1-5>
+"type": "flash",
+"card_content": {
+    "front": "<content for the front>",
+    "back": "<content for the back>"
+},
+"card_reference": "heading",
+"concepts": ["Concept1", "Concept2", "..."],
+"facts": ["Fact1", "Fact2", "..."],
+"bloom_level": <1-5>
 }
+
 - Each side must not exceed 300 characters.
 2. Multiple Choice Questions (MCQ): Provide multiple choices to pick from. One or more should be correct.
 
-json
+json:
 {
-    "type": "mcq",
-    "card_content": {
-        "prompt": "<question text>",
-        "choices": [
-            {"choice": "choice 1", "is_correct": true or false},
-            {"choice": "choice 2", "is_correct": true or false},
-            "... up to 8 choices"
-        ]
-    },
-    "card_reference": "heading",
-    "concepts": ["Concept1", "Concept2", "..."],
-    "facts": ["Fact1", "Fact2", "..."],
-    "bloom_level": <1-5>
+"type": "mcq",
+"card_content": {
+    "prompt": "<question text>",
+    "choices": [
+        {"choice": "choice 1", "is_correct": true or false},
+        {"choice": "choice 2", "is_correct": true or false},
+        "... up to 8 choices"
+    ]
+},
+"card_reference": "heading",
+"concepts": ["Concept1", "Concept2", "..."],
+"facts": ["Fact1", "Fact2", "..."],
+"bloom_level": <1-5>
 }
+
 •	Minimum choices required: 2
 •	Maximum choices allowed: 8
 •	Minimum correct choices required: 1
@@ -122,22 +125,23 @@ json
 
 json
 {
-    "type": "cloze",
-    "card_content": {
-        "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": "scale", "cloze": "c1"},
-            {"option": "mode", "cloze": "c2"},
-            {"option": "chords", "cloze": "null"},
-            "... up to 8 choices"
-        ]
-    },
-    "card_reference": "heading",
-    "concepts": ["Concept1", "Concept2", "..."],
-    "facts": ["Fact1", "Fact2", "..."],
-    "bloom_level": <1-5>
+"type": "cloze",
+"card_content": {
+    "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": "scale", "cloze": "c1"},
+        {"option": "mode", "cloze": "c2"},
+        {"option": "chords", "cloze": "null"},
+        "... up to 8 choices"
+    ]
+},
+"card_reference": "heading",
+"concepts": ["Concept1", "Concept2", "..."],
+"facts": ["Fact1", "Fact2", "..."],
+"bloom_level": <1-5>
 }
+
 •	Minimum choices required: 2
 •	Maximum choices allowed: 8
 •	Minimum correct choices required: 1
@@ -145,20 +149,33 @@ json
 •	Maximum character length for an individual cloze: 90
 
 4.	Match: Pairing items.
+
 json
 {
-    "type": "match",
-    "card_content": {
-        "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", "..."],
-    "bloom_level": <1-5>
+"type": "match",
+"card_content": [
+   {
+    "left_item": "left choice",
+    "right_item": [right item]
+   },
+   {
+    "left_item":" left choice",
+    "right_item": [right item]
+   },
+   {
+    "left_item": "left choice",
+    "right_item": [right item]
+   },
+    "... up to 8 total pairs"
+],
+"card_reference": "heading",
+"concepts": ["Concept1", "Concept2", "..."],
+"facts": ["Fact1", "Fact2", "..."],
+"bloom_level": <1-5>
 }
+
 •	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: ""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. 

package/src/constants/prompts/typology_prompt.ts

@@ -1,23 +1,37 @@
 const typologyPromptString = `
-As a dedicated assistant at a learning company, your role involves analyzing educational content to categorize and summarize it. You will process content (in JSON format) that represents text and images 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 PDFs, book chapters, videos, and websites. Follow these steps:
 
 1. Classify the content into one to three predefined fields of knowledge.
-2. Identify key concepts within the content.
-3. Detect concrete facts that are empirically verified and relevant to the subject.
-4. Decide whether the identified concepts and facts should be used to generate learning materials like flashcards based on their educational value.
+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.
 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:
 json
 {
     "field": ["primary_field", "secondary_field", "tertiary_field"],
-    "concepts": ["concept1", "concept2", "concept3", "..."],
-    "facts": ["fact1", "fact2", "fact3", "..."],
+    "concepts": 
+    [
+        {
+            "concept_text": "concept_content",
+            "reference": "source_title#main_heading"
+        },
+        {...}
+    ],
+    "facts": 
+    [
+        {
+            "fact_text": "fact_content",
+            "reference": "source_title#main_heading"
+        },
+        {...}
+    ],
     "generate_cards": [
         state: true or false,
-        false_reason: "reason for marking the source as false. Leave empty for true."
+        reason: "reason for marking the source as false. Leave empty for true."
     ],
-    "summary_cards": ["summary_card1", "summary_card2", "summary_card3", "..."]
+    "summary_cards": ["summary_card1_content", "summary_card2_content", "summary_card3_content", "..."]
 }
 
 Further instruction on how to perform these tasks are below.
@@ -41,52 +55,77 @@ Every source must be placed under a field. This is the broadest category of know
 16.	Trades & Craftsmanship: Cover Hands-on Skills in Trades and Crafts.
 17.	Reference & Indexing: Include Summaries, Timelines, Directories, Glossaries, Bibliographies, and other Reference Material.
 18.	Other: Use for content that doesn’t fit into the above categories.
+Extract key concepts within the content after classifying the field. This is a crucial part of the exercise. Be exhaustive and thorough.
 
-Identify key concepts within the content after classifying the field. Concepts are the fundamental ideas or categories that form the basis of knowledge within any discipline. They help organize and explain information, making it accessible and relatable.
-
-1. **Definition of a Concept**: Concepts should be significant ideas that recur within the content and are essential for understanding the main themes.
+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.
+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.
+5. **Reference**: Every concept must include a reference. A reference can either be the entire source or a specific heading in the source. The reference indicates the part of the text that is most relevant for that particular concept. 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. If a concept needs to reference multiple sections or the entire source then simply leave the reference as empty.
 
 List the concepts in the following JSON format:
+
 json
-{
-    "concepts": ["concept1", "concept2", "concept3", "..."]
-}
-After classifying the content and identifying key concepts, proceed to extract and list verifiable facts. Facts are objective statements that must be supported by empirical evidence or observation, such as specific data on events, people, numbers, dates, or well-established ideas.
+"concepts": 
+    [
+        {
+            "concept_text": "concept_content",
+            "reference": "source_title#main_heading"
+        },
+        {...}
+    ]
+
+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.
+4. **Reference**: Every fact must include a reference. The reference indicates the part of the text that is most relevant for that particular concept. 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. If a fact needs to reference multiple sections or the entire source then simply leave the reference as empty.
 
-Record the facts in the following JSON format:
+List the facts in the following JSON format:
 json
-{
-    "facts": ["fact1", "fact2", "fact3", "..."]
-}
-    After analyzing the content, classifying its field, and identifying key concepts, and facts, assess whether the discovered elements warrant the creation of testing 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 testing cards don't need to be generated then please provide a reason in less than 90 characters.
+"facts": 
+    [
+        {
+            "fact_text": "fact_content",
+            "reference": "source_title#main_heading"
+        },
+        {...}
+    ]
+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.
 
 Make your decision using this criterion and reflect it in the JSON format as follows:
+
 json
 "generate_cards": 
     {   state: true or false,
-        false_reason: "reason for marking the source as false. Leave empty for true."
+        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.
+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.
 
 
 1. **Inclusion Criteria**: The generate_cards should be true. Return an empty array if the generate_cards is false.
 2. **Summarization Objective**: Each card is a step in a journey through the content. The series should collectively summarize the source while emphasizing important learning points.
 3. **Character Limit**: Maintain a limit of 320 characters per card to ensure each message is concise yet informative.
+4. **Card limit**: Limit the total number of cards to less than or equal to 8.
 4. **Engagement and Flow**: Write in an engaging style that maintains the user’s interest. Arrange the cards in a logical order that reflects the flow of the original content.
 
 Format your output in JSON as follows:
+
 json
 {
-    "summary_cards": ["summary_card1", "summary_card2", "summary_card3", "..."]
+    "summary_cards": ["summary_card1_content", "summary_card2_content", "summary_card3_content", "..."]
 }
+
+
 `;
 
 

package/src/index.ts

@@ -13,9 +13,9 @@ import { OnlyEverGenerator } from "./bootstrap/app";
 /// 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-3.5-turbo-1106", {
+// //. 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", {
 //   prompt: returnPromptData(),
 //   content: returnSourceData(),
 // });
@@ -33,28 +33,28 @@ import { OnlyEverGenerator } from "./bootstrap/app";
 //   //   let content = returnSourceData().toString()
 //   //   let headings = returnHeadings();
 //   //   // let aiRequest = await openAIRequest(prompt,content);
-//   //   let aiRequest = await oeGen.generateCard(prompt,content, false);
-//   //  res.send(aiRequest);
+//     let aiRequest = await oeGen.generate(false,true);
+//    res.send(aiRequest);
 // });
 
-// 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 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.listen(port, () => {
 //   console.log(`Example app listening at http://localhost:${port}`);