only_ever_generator 0.5.0 → 0.5.2

package/dist/constants/prompt_data.js

@@ -297,6 +297,6 @@ const promptData = {
 function returnPromptData() {
     return {
         "typology": (0, typology_prompt_1.returnTypologyPrompt)(),
-        "card_generation": (0, card_gen_prompt_1.returnCardGenPrompt)(''),
+        "card_generation": (0, card_gen_prompt_1.returnCardGenPrompt)(),
     };
 }

package/dist/constants/prompts/card_gen_prompt.js

@@ -66,7 +66,6 @@ Test cards must be one of the following types:
 
 1. Multiple Choice Questions (MCQ): Provide multiple choices to pick from. One or more should be correct.
 
-json
 {
     "type": "mcq",
     "card_content": {
@@ -107,13 +106,13 @@ json
 •	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
+•	Maximum character length for the prompt: 90
+•	Maximum character length for each choice: 40
 •   Do not add numbering to the choice content since these will be randomly sorted when displaying to the user
 
 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.
+Strictly follow the above double curly braces {{c<n>: cloze_text}} for the clozes.
 
-json
 {
     "type": "cloze",
     "card_content": {
@@ -161,14 +160,13 @@ json
 
 4.	Match: Pairing items.
 
-json
+
 {
     "type": "match",
-
     "card_content" : [
         {
             "left_item" : "left_item text",
-            "right_item" : ["right_item text" ]
+            "right_item" : ["right_item text"] 
         },
         {
             "left_item" : "left_item text",
@@ -203,7 +201,7 @@ json
     "bloom_level": <1-5>
 }
 
-* Maximum character length for each item in a pair: 42
+* Maximum character length for each item in a pair: 24
 * Duplicate items are allowed on the left side but not on the right side. Or in other words the same item on the left can be paired with multiple items on the right.
 
 
@@ -215,7 +213,6 @@ json
 3. For each concept and fact start by trying to create a card at the highest bloom level possible.
 4. Do not skip any concepts or facts, and be thorough in your coverage. 
 5. 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.
 
@@ -229,6 +226,6 @@ Once you are done generating the test cards, review the full list of concepts an
 
 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(cardGenPrompt) {
+function returnCardGenPrompt() {
     return promptString;
 }

package/dist/constants/prompts/typology_prompt.js

@@ -30,10 +30,10 @@ json
         },
         {...}
     ],
-    "generate_cards": [
+    "generate_cards": {
         state: true or false,
         reason: "reason for marking the source as false. Leave empty for true."
-    ],
+},
     "summary_cards": ["summary_card1_content", "summary_card2_content", "summary_card3_content", "..."]
 }
 

package/dist/index.js

@@ -12,8 +12,8 @@ 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
+//. 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(),
@@ -46,24 +46,24 @@ Object.defineProperty(exports, "OnlyEverGenerator", { enumerable: true, get: fun
 //   let parsedData = new ParseCardResponse().parse(cardResp,false);
 //   res.send(parsedData)
 // });
-// app.get("/typology", async (req, res) => {
-//   {
-//     let typologyPrompt = returnTypologyPrompt();
-//     let cardPrompt = returnCardGenPrompt();
-//     let args = new GenerateArgs(
-//       true,
-//       true,
-//       false,
-//        {
-//         typology_prompt: typologyPrompt,
-//         card_gen_prompt: cardPrompt,
-//         summary_prompt: "",
-//       }
-//     )
-//     let typologyRequest = await oeGen.generate(false, true);
-//     res.send(typologyRequest);
-//   }
-// });
+// // app.get("/typology", async (req, res) => {
+// //   {
+// //     let 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/parse_card_response.js

@@ -45,8 +45,11 @@ class ParseCardResponse {
                     usage_data.status = "failed";
                 }
             }
+            if (cardData.length == 0) {
+                usage_data.status = "failed";
+            }
             return {
-                status_code: 200,
+                status_code: cardData.length == 0 ? 400 : 200,
                 metadata: usage_data,
                 type: type,
                 missing_concepts: [],

package/package.json

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

package/src/constants/prompt_data.ts

@@ -298,6 +298,6 @@ const promptData: any = {
 export function returnPromptData(){
     return {
         "typology": returnTypologyPrompt(),
-        "card_generation": returnCardGenPrompt(''),
+        "card_generation": returnCardGenPrompt(),
     };
 }

package/src/constants/prompts/card_gen_prompt.ts

@@ -63,7 +63,6 @@ Test cards must be one of the following types:
 
 1. Multiple Choice Questions (MCQ): Provide multiple choices to pick from. One or more should be correct.
 
-json
 {
     "type": "mcq",
     "card_content": {
@@ -104,13 +103,13 @@ json
 •	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
+•	Maximum character length for the prompt: 90
+•	Maximum character length for each choice: 40
 •   Do not add numbering to the choice content since these will be randomly sorted when displaying to the user
 
 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.
+Strictly follow the above double curly braces {{c<n>: cloze_text}} for the clozes.
 
-json
 {
     "type": "cloze",
     "card_content": {
@@ -158,14 +157,13 @@ json
 
 4.	Match: Pairing items.
 
-json
+
 {
     "type": "match",
-
     "card_content" : [
         {
             "left_item" : "left_item text",
-            "right_item" : ["right_item text" ]
+            "right_item" : ["right_item text"] 
         },
         {
             "left_item" : "left_item text",
@@ -200,7 +198,7 @@ json
     "bloom_level": <1-5>
 }
 
-* Maximum character length for each item in a pair: 42
+* Maximum character length for each item in a pair: 24
 * Duplicate items are allowed on the left side but not on the right side. Or in other words the same item on the left can be paired with multiple items on the right.
 
 
@@ -212,7 +210,6 @@ json
 3. For each concept and fact start by trying to create a card at the highest bloom level possible.
 4. Do not skip any concepts or facts, and be thorough in your coverage. 
 5. 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.
 
@@ -226,7 +223,7 @@ Once you are done generating the test cards, review the full list of concepts an
 
 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){
+export function returnCardGenPrompt(){
     return promptString;
 }
 

package/src/constants/prompts/typology_prompt.ts

@@ -27,10 +27,10 @@ json
         },
         {...}
     ],
-    "generate_cards": [
+    "generate_cards": {
         state: true or false,
         reason: "reason for marking the source as false. Leave empty for true."
-    ],
+},
     "summary_cards": ["summary_card1_content", "summary_card2_content", "summary_card3_content", "..."]
 }
 

package/src/index.ts

@@ -13,13 +13,16 @@ import { OnlyEverGenerator } from "./bootstrap/app";
 // import { GenerateCards } from "./card_gen/generate_cards";
 // import { OpenAiService } from "./services/open_ai_service";
 // import { ParseCardResponse } from "./parse/parse_card_response";
+// import { returnTypologyPrompt } from "./constants/prompts/typology_prompt";
+// import { returnCardGenPrompt } from "./constants/prompts/card_gen_prompt";
+// import { GenerateArgs } from "./utils/generate_args";
 
 /// While Publishing the package , and using this code as a separate npm module
 /// uncomment the below line and comment all the others, expect the import of OnlyEverGenerator
   export {OnlyEverGenerator};
 
-// //. All the Codes Below uses express and are strictly for development purpose, while publishing the package, comment everything
-// //below this line
+//. 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(),
@@ -57,24 +60,24 @@ import { OnlyEverGenerator } from "./bootstrap/app";
 //   res.send(parsedData)
 // });
 
-// app.get("/typology", async (req, res) => {
-//   {
-//     let typologyPrompt = returnTypologyPrompt();
-//     let cardPrompt = returnCardGenPrompt();
-//     let args = new GenerateArgs(
-//       true,
-//       true,
-//       false,
-//        {
-//         typology_prompt: typologyPrompt,
-//         card_gen_prompt: cardPrompt,
-//         summary_prompt: "",
-//       }
-//     )
-//     let typologyRequest = await oeGen.generate(false, true);
-//     res.send(typologyRequest);
-//   }
-// });
+// // app.get("/typology", async (req, res) => {
+// //   {
+// //     let 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/src/parse/parse_card_response.ts

@@ -39,9 +39,13 @@ export class ParseCardResponse {
           usage_data.status = "failed";
         }
       }
+      if(cardData.length == 0){
+        usage_data.status="failed";
+
+      }
 
       return {
-        status_code: 200,
+        status_code: cardData.length == 0 ? 400:200,
         metadata: usage_data,
         type: type,
         missing_concepts: [],