only_ever_generator 0.4.3 → 0.4.5

package/dist/index.js

@@ -1,6 +1,8 @@
 "use strict";
 // import express from "express";
 // import {
+//   returnCardResponse,
+//   returnHeadings,
 //   returnSourceData,
 // } from "./constants/source_data";
 // import config from "./config";
@@ -28,9 +30,22 @@ 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.generate(false,true);
+//     let aiRequest = await oeGen.generate(true,true);
 //    res.send(aiRequest);
 // });
+// app.get("/parseCardData", async(req,res)=>{
+//   let cardResp = returnCardResponse();
+//   let headings = returnHeadings();
+//   cardResp.metadata = {
+//     "req_time": cardResp.generated_at ?? new Date(),
+//     "req_type": cardResp.type,
+//     "req_tokens": cardResp.usage_data?.prompt_tokens,
+//     "res_tokens": cardResp.usage_data?.completion_tokens,
+//     "model": '40-mini'
+// };
+//   let parsedData = new GenerateCards(new OpenAiService("","")).parse(cardResp,false,headings);
+//   res.send(parsedData)
+// });
 // // app.get("/typology", async (req, res) => {
 // //   {
 // //     let typologyPrompt = returnTypologyPrompt();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "only_ever_generator",
-  "version": "0.4.3",
+  "version": "0.4.5",
   "main": "dist/index.js",
   "scripts": {
     "start": "npm run build && nodemon dist/index.js",

package/src/card_gen/generate_cards.ts

@@ -30,56 +30,61 @@ export class GenerateCards {
   }
 
   parse(generatedData: any, isGapFill: boolean, headings:Array<any>) {
-    try{
-    const cardData = [];
     let usage_data = generatedData.metadata;
     const status_code = generatedData.status_code;
-    const missing_concepts = generatedData.generated_content.missing_concepts;
-    const missing_facts = generatedData.generated_content.missing_facts;
+    try{
+      const cardData = [];
     const unparsedTestCards = generatedData.generated_content.test_cards;
     const type = generatedData.type;
-if(unparsedTestCards !== undefined && unparsedTestCards.length != 0) {
-  for (let elem of unparsedTestCards) {
-    if(headings.includes(elem.card_reference)){
-
-    }else{
-      elem.card_reference = '';
-    }
-    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));
+    if(unparsedTestCards !== undefined && unparsedTestCards.length != 0) {
+      for (let elem of unparsedTestCards) {
+        // if(headings.includes(elem.card_reference)){
+
+        // }else{
+        //   elem.card_reference = '';
+        // }
+        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));
+        }
+      }
+    } else {
+      if(!isGapFill) {
+        usage_data.status = "failed";
+      }
     }
-  }
-} else {
-  if(!isGapFill) {
-    usage_data.status = "failed";
-  }
-}
     
    
 
     return {
-      status_code: isGapFill? status_code : cardData.length> 0 ? status_code: 500,
+      status_code: 500,
       metadata: usage_data,
       type: type,
-      missing_concepts: missing_concepts,
-      missing_facts: missing_facts,
+      missing_concepts: [],
+      missing_facts: [],
       cards_data: cardData,
     };
   }catch (e:any){
     new ErrorLogger({
       "type": 'card_parsing',
       "data": e.message,
+      "response": generatedData,
      }).log();
      return {
       status_code: 500,
-      type: 'card_gen',
+      metadata : usage_data,
+      type:  generatedData.type,
      }
+     
+    //  return {
+    //   status_code: 500,
+    //   type: 'card_gen',
+    //  }
   }
   }
 

package/src/constants/prompts/card_gen_prompt.ts

@@ -1,118 +1,109 @@
-const promptString: string = `
-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:
+const promptString: string = `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:
 
 1. Title of the source
 2. Main headings
 3. The content
-4. The field of knowledge it belongs
-5. Key concepts in the source
-6. Important facts in the source.
-7. Summary of the content using cards
+4. The field of knowledge it belongs to
+5. Key concepts in the source and the relevant main heading it references.
+6. Important facts in the source and the relevant main heading it references.
 
-Follow these steps:
+**Follow these steps:**
+1. Read the entire source, concepts and facts in the provide input.
+2. Generate test cards for concepts: Take each concept and re-read the text under the reference heading for that concept. Start by trying to create a card that is at the highest bloom level possible (5 being the highest). Then work your way down to the lower bloom levels. Generate as many cards as possible for each concept. Keep going through the list of concepts till you have completed all of them.
+3. Generate test cards for facts: Take each fact and re-read the text under the reference heading for that fact. Generate as many cards as possible to test that concept. Keep going through the list of concepts till you have completed all of them.
 
-1. Analyze the content to identify any key concepts missing from the provided list.
-2. Analyze the content to identify any important facts missing from the provided list.
-3. Generate test cards for each concept and fact, tethered to either the entire source or specific headings.
-4. Ensure all concepts and facts have at least one test card.
+**Note:** Further detailed instructions on how to create the content for each test card type will be provided subsequently.
+
+**Format your response in the following JSON format:**
 
-Please format your response in the following format.
 json
-    "missing_concepts": ["concept1", "concept2", "concept3", "..."],
-    "missing_facts": ["fact1", "fact2", "fact3", "..."],
+{
     "test_cards": [
         {
-            "type": "flash" | "mcq" | "cloze" | "match",
-            "card_content": {schema for content is explained below in detail}
-            "card_reference": "heading",
-            "concepts": ["Concept1", "Concept2", "..."],
-            "facts": ["Fact1", "Fact2", "..."]
+            "type": "mcq" | "cloze" | "match",
+            "card_content": "{content}",
+            "concepts": [
+                "concept1",
+                "concept2",
+                "..."
+            ],
+            "facts": [
+                "fact1",
+                "fact2",
+                "..."
+            ],
+            "bloom_level": 1 | 2 | 3 | 4 | 5
         }
     ]
+}
 
-**Criteria**
-•	Each test card must include at least one concept or fact.
-•	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.
-
-You are provided with a list of identified concepts. Review this list and the content to determine if any concepts are missing.
-
-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 has not been previously included in the list provided to you.
 
-List the concepts in the following JSON format:
+**Criteria:**
 
-json
-{
-    "missing_concepts": 
-    [
-        "concept1", 
-        "concept2", 
-        "concept3", 
-        "..."
-    ]
-}
-    You are provided with a list of identified facts. Review this list and the content to determine if any facts are missing.
+* Each test card must include at least one concept or fact.
+* Each concept and fact must have at least one test card.
+* The final output should include test cards that cover the first 5 levels of Bloom's Taxonomy.
 
-1. **Definition of a Fact**: Standalone information that is concrete and independently verifiable.
-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. Only inlcude those that have not present in the list provided to you.
+**Further Instructions:**
 
-Record the facts in the following JSON format:
-json
-{
-    "missing_facts": ["fact1", "fact2", "fact3", "..."]
-}
+* Ensure variety in the types of test cards (MCQs, cloze tests, matching).
+* Balance the distribution of Bloom's Taxonomy levels across the test cards.
+* Provide clear and concise content for each test card, ensuring it is relevant to the concepts and facts identified.
+* Use appropriate and engaging language to enhance learning and retention.
 
-After you have the complete list of concepts and facts, including any missing ones you identified, proceed to generate test cards for each.
+This section provides detailed guidance on how to generate cards.
 
-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.
+**Guidance on the card content**
 
-Include the following property for each card:
+	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 related to the key concepts or facts you want to test.
 
-bloom_level: Indicate the level of Bloom’s Taxonomy the card corresponds to (from level 1 to level 5). Ensure that you produce a balanced number of cards across all levels, focusing on levels 1 through 5. Aim for a diverse range of cognitive challenges.
+Include the following properties for each card:
 
-Ensure that you produce at least one card for each concept and fact. Do not skip any concepts or facts, and be thorough in your coverage. Cards should span across different levels of Bloom’s Taxonomy, from level 1 (Remembering) to level 5 (Evaluating), but exclude level 6 (Creating).
+bloom_level: Indicate the level of Bloom’s Taxonomy the card corresponds to (from level 1 to level 5). Ensure that you produce a balanced number of cards across all levels, focusing on levels 1 (Remembering) through 5 (Evaluating). Aim for a diverse range of cognitive challenges.
 
 Test cards must be one of the following types:
 
-1.	Flashcards: Have a front and back. 
-
-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>
-}
-
-- Each side must not exceed 300 characters.
-2. Multiple Choice Questions (MCQ): Provide multiple choices to pick from. One or more should be correct.
+1. 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 content", "is_correct": true or false},
+            {"choice": "choice content", "is_correct": true or false},
+            "... up to 8 choices"
+        ]
+    },
+    "concepts": 
+    [
+        {
+            "concept_text": "concept1_content",
+            "reference": "source_title#main_heading"
+        },
+        {
+            "concept_text": "concept2_content",
+            "reference": "source_title#main_heading"
+        },
+        {...}
+    ],
+    "facts": 
+    [
+            {
+                "factt_text": "fact1_content",
+                "reference": "source_title#main_heading"
+            },
+            {
+                "fact_text": "fact2_content",
+                "reference": "source_title#main_heading"
+            },
+            {...}
+    ],
+    "bloom_level": <1-5>
 }
 
 •	Minimum choices required: 2
@@ -120,26 +111,48 @@ json:
 •	Minimum correct choices required: 1
 •	Maximum character length for the prompt: 320
 •	Maximum character length for each choice: 42
+•   Do not add numbering to the choice content since these will be randomly sorted when displaying to the user
 
-3.	Cloze: A test card where a portion of text is masked for the learner to identify from the provided options. Use double curly braces {{c<n>: cloze_text}} to indicate a cloze, where n is the index number of the cloze (starting from 0) and cloze_text is the word or phrase being clozed.
+2.	Cloze: A test card where a portion of text is masked for the learner to identify from the provided options. Use double curly braces {{c<n>: cloze_text}} to indicate a cloze, where n is the index number of the cloze (starting from 0) and cloze_text is the word or phrase being clozed.
 
 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"
+        ]
+    },
+    "concepts": 
+    [
+        {
+            "concept_text": "concept1_content",
+            "reference": "source_title#main_heading"
+        },
+        {
+            "concept_text": "concept2_content",
+            "reference": "source_title#main_heading"
+        },
+        {...}
+    ],
+    "facts": 
+    [
+            {
+                "factt_text": "fact1_content",
+                "reference": "source_title#main_heading"
+            },
+            {
+                "fact_text": "fact2_content",
+                "reference": "source_title#main_heading"
+            },
+            {...}
+    ],
+    "bloom_level": <1-5>
 }
 
 •	Minimum choices required: 2
@@ -152,49 +165,75 @@ json
 
 json
 {
-"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>
+    "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"
+    ],
+    "concepts": 
+    [
+        {
+            "concept_text": "concept1_content",
+            "reference": "source_title#main_heading"
+        },
+        {
+            "concept_text": "concept2_content",
+            "reference": "source_title#main_heading"
+        },
+        {...}
+    ],
+    "facts": 
+    [
+            {
+                "factt_text": "fact1_content",
+                "reference": "source_title#main_heading"
+            },
+            {
+                "fact_text": "fact2_content",
+                "reference": "source_title#main_heading"
+            },
+            {...}
+    ],
+    "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. 
+
+** Criteria **
+
+1. Ensure that you produce at least one if not more card for each concept and fact. 
+2. For each concept and fact start by trying to create a card at the highest bloom level possible.
+3. Do not skip any concepts or facts, and be thorough in your coverage. 
+4. Cards should span across different levels of Bloom’s Taxonomy, from level 1 (Remembering) to level 5 (Evaluating), but exclude level 6 (Creating)
+
+Once you are done generating the test cards. Go back and evaulate the full list of concepts and facts 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.
 
 Once you are done creating come back to this step again to check if you have full coverage of all the concepts and facts in the source. You can stop generating test questions once you achieve full coverage.
-Generate atleast 10 cards.  
 
+Once you are done generating the test cards, review the full list of concepts and facts, including any missing ones you identified.
+
+	1.	Ensure every concept and fact has at least one test card (if not more).
+	2.	If any concept or fact is missing a test card, create one for it.
+	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.
 `;
 export function returnCardGenPrompt(cardGenPrompt: any){
     return promptString;
 }
-//     let concatenatedString: string = '';
-//     for (let key in cardGenPrompt) {
-//       if (cardGenPrompt.hasOwnProperty(key)) {
-//         concatenatedString += cardGenPrompt[key];
-//       }
-//     }
-//         return concatenatedString;
-// }
+
 

package/src/constants/prompts/typology_prompt.ts

@@ -15,7 +15,7 @@ json
     [
         {
             "concept_text": "concept_content",
-            "reference": "source_title#main_heading"
+            "reference": "main_heading"
         },
         {...}
     ],
@@ -23,7 +23,7 @@ json
     [
         {
             "fact_text": "fact_content",
-            "reference": "source_title#main_heading"
+            "reference": "main_heading"
         },
         {...}
     ],
@@ -70,7 +70,7 @@ json
     [
         {
             "concept_text": "concept_content",
-            "reference": "source_title#main_heading"
+            "reference": "main_heading"
         },
         {...}
     ]
@@ -88,7 +88,7 @@ json
     [
         {
             "fact_text": "fact_content",
-            "reference": "source_title#main_heading"
+            "reference": "main_heading"
         },
         {...}
     ]