only_ever_generator 0.1.8 → 0.2.0

package/dist/constants/prompts/typology_prompt.js

@@ -1,30 +1,108 @@
 "use strict";
+// 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:
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.returnTypologyPrompt = void 0;
-const typologyPromptString = `
+// 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.
+// 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", "..."],
+//     "generate_cards": [
+//         state: true or false,
+//         false_reason: "reason for marking the source as false. Leave empty for true."
+//     ],
+//     "summary_cards": ["summary_card1", "summary_card2", "summary_card3", "..."]
+// }
+// Further instruction on how to perform these tasks are below.
+// Every source must be placed under a field. This is the broadest category of knowledge. A source should belong to at least one and at most 3 fields. Only include fields that a source is strongly associated with. The field names in your response must exactly match the names of 18 fields listed below.
+// 1.	Sciences: Focus on Biology, Chemistry, Physics, Astronomy, Mathematics, and Computer Science.
+// 2.	Technology & Engineering: Emphasize Information Technology, Engineering disciplines, AI, and Robotics.
+// 3.	Humanities & Cultural Studies: Highlight History, Literature, Languages, Arts, Philosophy, and Anthropological Studies.
+// 4.	Social Sciences & Global Studies: Include Sociology, Psychology, Economics, Political Science, Anthropology, and International Relations.
+// 5.	Business & Management: Encompass Entrepreneurship, Marketing, Finance, Leadership, and Ethics.
+// 6.	Health & Medicine: Cover Medical Sciences, Public Health, Nutrition, Wellness, and Mental Health.
+// 7.	Environmental Studies & Earth Sciences: Discuss Ecology, Climate Science, Geology, and Environmental Policy.
+// 8.	Education, Learning & Personal Development: Talk about Educational Theories, Teaching Methods, and Personal Skills.
+// 9.	Creative & Performing Arts: Include Visual Arts, Music, Theater, Dance, and Design Principles.
+// 10.	Law, Governance & Ethics: Focus on Legal Studies, Public Administration, Policy Analysis, and Ethical Decision-Making.
+// 11.	Recreation, Lifestyle & Practical Skills: Highlight Hobbies, Sports, Travel, Lifestyle Choices, and Practical Skills.
+// 12.	Technology & Media Literacy: Discuss Digital Literacy, Media Studies, and the Impact of Digital Media.
+// 13.	Philosophy & Critical Thinking: Emphasize Moral Philosophy, Ethical Frameworks, and Critical Thinking.
+// 14.	Space & Astronomical Sciences: Focus on Space Exploration, Astronomy, and Astrophysics.
+// 15.	Agriculture & Food Sciences: Discuss Sustainable Farming, Food Technology, and Nutrition.
+// 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.
+// 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.
+// 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.
+// 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.
+// 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.
+// Record 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.
+// 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."
+//     }
+//     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. **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", "..."]
+// }
+// `;
+const typologyPromptString = {
+    role: `
 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:
 
 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.
+2. Extract key concepts within the content.
+3. Extract concrete facts that are relevant to the subject and referenced in the content.
 4. Decide whether the identified concepts and facts should be used to generate learning materials like flashcards based on their educational value.
 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", "..."],
-    "generate_cards": [
-        state: true or false,
-        false_reason: "reason for marking the source as false. Leave empty for true."
-    ],
-    "summary_cards": ["summary_card1", "summary_card2", "summary_card3", "..."]
+"field": ["primary_field", "secondary_field", "tertiary_field"],
+"concepts": ["concept1", "concept2", "concept3", "..."],
+"facts": ["fact1", "fact2", "fact3", "..."],
+"generate_cards": {
+ "state": true or false,
+ "false_reason": "reason for marking the source as false. Leave empty for true."
+},
+"summary_cards": ["summary_card1", "summary_card2", "summary_card3", "..."]
 }
 
+
 Further instruction on how to perform these tasks are below.
-Every source must be placed under a field. This is the broadest category of knowledge. A source should belong to at least one and at most 3 fields. Only include fields that a source is strongly associated with. The field names in your response must exactly match the names of 18 fields listed below.
+    `,
+    fields: `
+    Every source must be placed under a field. This is the broadest category of knowledge. A source should belong to at least one and at most 3 fields. Only include fields that a source is strongly associated with. The field names in your response must exactly match the names of 18 fields listed below.
 
 1.	Sciences: Focus on Biology, Chemistry, Physics, Astronomy, Mathematics, and Computer Science.
 2.	Technology & Engineering: Emphasize Information Technology, Engineering disciplines, AI, and Robotics.
@@ -44,54 +122,68 @@ 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.
+    `,
+    concepts: `
+    Extract key concepts within the content after classifying the field. Please be as exhaustive as possible.
 
-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.
-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.
-
+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.
+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.
 List the concepts in the following JSON format:
-json
+
 {
-    "concepts": ["concept1", "concept2", "concept3", "..."]
+ "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.
-
-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.
+    `,
+    facts: `
+    After classifying the content and identifying key concepts, proceed to extract and list verifiable facts.
 
+Definition of a Fact: Ensure each fact is a standalone piece of information that is concrete and can be independently verified.
+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.
 Record the facts in the following JSON format:
-json
+
 {
-    "facts": ["fact1", "fact2", "fact3", "..."]
+ "facts": ["fact1", "fact2", "fact3", "..."]
 }
+    `,
+    generate: `
     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.
 
-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.
-
+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.
+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."
-    }
 
+"generate_cards": 
+ {   state: true or false,
+     false_reason: "reason for marking the source as false. Leave empty for true."
+ }
+    `,
+    summarize: `
     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. **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.
-
+Inclusion Criteria: The generate_cards should be true. Return an empty array if the generate_cards is false.
+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.
+Character Limit: Maintain a limit of 320 characters per card to ensure each message is concise yet informative.
+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", "summary_card2", "summary_card3", "..."]
 }
-`;
+    `,
+};
 function returnTypologyPrompt() {
-    return typologyPromptString;
+    let concatenatedString = '';
+    for (let key in typologyPromptString) {
+        if (typologyPromptString.hasOwnProperty(key)) {
+            concatenatedString += typologyPromptString[key];
+        }
+    }
+    return concatenatedString;
 }
 exports.returnTypologyPrompt = returnTypologyPrompt;

package/dist/gap_fill/calculate_gap_fill.js

@@ -10,6 +10,8 @@ function gapFilling(typologyResponse, cardgenResponse) {
     let allFacts = [];
     let generatedConceptsList = [];
     let generatedFactsList = [];
+    let remainingConcepts = [];
+    let remainingFacts = [];
     if (!isEmpty(typologyResponse)) {
         allConcepts.push(...((_a = typologyResponse.concepts) !== null && _a !== void 0 ? _a : []));
         allFacts.push(...((_b = typologyResponse === null || typologyResponse === void 0 ? void 0 : typologyResponse.facts) !== null && _b !== void 0 ? _b : []));
@@ -18,18 +20,20 @@ function gapFilling(typologyResponse, cardgenResponse) {
         allConcepts.push(...((_c = cardgenResponse.missing_concepts) !== null && _c !== void 0 ? _c : []));
         allFacts.push(...((_d = cardgenResponse.missing_facts) !== null && _d !== void 0 ? _d : []));
     }
-    for (let card of cardgenResponse.cards_data) {
-        if (card.concepts.length != 0) {
-            generatedConceptsList.push(...card.concepts);
-        }
-        if (card.facts.length != 0) {
-            generatedFactsList.push(...card.facts);
+    if (cardgenResponse.cards_data !== undefined && cardgenResponse.cards_data.length != 0) {
+        for (let card of 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));
+        remainingConcepts = allConcepts.filter((item) => !generatedConceptsSet.includes(item));
+        remainingFacts = allFacts.filter((item) => !generatedFactsSet.includes(item));
     }
-    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,

package/dist/index.js

@@ -11,13 +11,14 @@ 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" ,returnSourceData(),returnFields())
+//. 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" ,'',returnSourceData(),returnFields())
 // app.get('/', async (req, res)  => {
 //     // let data = oeGen.returnParsedContent();
 //     // let parsedData = parseResponse()
-//     res.send(200);
+//     let cardPrompt = returnCardGenPrompt();
+//     res.send(cardPrompt);
 // });
 // app.get('/openAI', async (req,res)=> {
 //   // let prompt = returnPromt();

package/package.json

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

package/src/bootstrap/app.ts

@@ -16,10 +16,12 @@ export class OnlyEverGenerator {
   public api_key: string = "";
   public openAiService: OpenAiService;
   parsedContent: string = "";
+  prompt: any;
   expectedFields: Array<string>;
   constructor(
     apiKey: string,
     model: string,
+    prompt: any,
     content: Array<any>,
     expected_fields: Array<string>
   ) {
@@ -99,6 +101,7 @@ export class OnlyEverGenerator {
     }
 
     return responseToReturn;
+   // return [typologyPrompt, cardPrompt];
   
   }
 

package/src/card_gen/generate_cards.ts

@@ -18,7 +18,8 @@ export class GenerateCards {
     };
       if(response.status_code == 200){
         response.metadata.status = "completed";
-        return this.parse(response);
+      //  return response;
+       return this.parse(response);
       } else {
         response.metadata.status = "failed";
         return response;
@@ -66,7 +67,10 @@ if(unparsedTestCards !== undefined && unparsedTestCards.length != 0) {
       data.card_content.back
     );
     let flashCardData = {
-      type: data.type,
+      type: {
+        category: 'learning',
+        sub_type: data.type,
+      },
       heading: data.card_reference,
       displayTitle: displayTitle,
       content: {
@@ -75,6 +79,7 @@ if(unparsedTestCards !== undefined && unparsedTestCards.length != 0) {
       },
       concepts: data.concepts,
       facts: data.facts,
+      bloomLevel: data.bloom_level,
     };
 
     return flashCardData;
@@ -98,7 +103,10 @@ if(unparsedTestCards !== undefined && unparsedTestCards.length != 0) {
       mcqAnswers
     );
     let mcqCard = {
-      type: data.type,
+       type: {
+        category: 'learning',
+        sub_type: data.type,
+      },
       heading: data.card_reference,
       displayTitle: displayTitle,
       content: {
@@ -107,6 +115,8 @@ if(unparsedTestCards !== undefined && unparsedTestCards.length != 0) {
       },
       concepts: data.concepts,
       facts: data.facts,
+      bloomLevel: data.bloom_level,
+
     };
     return mcqCard;
   }
@@ -129,7 +139,10 @@ if(unparsedTestCards !== undefined && unparsedTestCards.length != 0) {
       data.card_content.options
     );
     let clozeCardData = {
-      type: data.type,
+      type: {
+        category: 'learning',
+        sub_type: data.type,
+      },
       heading: data.card_reference,
       displayTitle: displayTitle,
       content: {
@@ -138,15 +151,27 @@ if(unparsedTestCards !== undefined && unparsedTestCards.length != 0) {
       },
       concepts: data.concepts,
       facts: data.facts,
+      bloomLevel: data.bloom_level,
+
     };
 
     return clozeCardData;
   }
 
-  generateClozeCardDisplayTitle(question: string, answers: any) {
-    let optionsString = answers
-      .map((item: { option: any }) => item.option)
+  generateClozeCardDisplayTitle(question: string, answers: Array<any>) {
+    let optionsString = '';
+    if(answers.length !== 0) {
+      optionsString = answers
+      .map((item: { option: any }) => {
+        if(item.option !== undefined) {
+          return item.option;
+        } else {
+          return '';
+        }
+      })
       .join(", ");
+    }
+    
     return `${question} ---- ${optionsString}`;
   }
 
@@ -164,13 +189,18 @@ if(unparsedTestCards !== undefined && unparsedTestCards.length != 0) {
       }
       let displayTitle = this.generateMatchCardDisplayTitle(transformedData);
       let matchCard = {
-        type: cardData.type,
+        type: {
+          category: 'learning',
+          sub_type: data.type,
+        },
         heading: cardData.card_reference,
         content: transformedData,
         //  content: cardData.card_content,
         displayTitle: displayTitle,
         concepts: cardData.concepts,
         facts: cardData.facts,
+       bloomLevel: cardData.bloom_level,
+
       };
 
       return matchCard;