only_ever_generator 0.0.6 → 0.0.8

package/dist/index.js

@@ -1,90 +1,16 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OnlyEverGenerator = void 0;
 // import express from "express";
 // import { returnCardGenPrompt } from "./constants/prompts/card_gen_prompt";
 // import { returnTypologyPrompt } from "./constants/prompts/typology_prompt";
 // import { GenerateArgs } from "./utils/generate_args";
-// import { returnHeadings, returnSourceData } from "./constants/source_data";
-// import { OnlyEverGenerator } from "./bootstrap/app";
-const parse_source_content_1 = require("./class/parse/parse_source_content");
-const open_ai_service_1 = require("./class/services/open_ai_service");
-const card_gen_prompt_1 = require("./constants/prompts/card_gen_prompt");
-const typology_prompt_1 = require("./constants/prompts/typology_prompt");
-const generate_typology_1 = require("./typology_gen/generate_typology");
-const generate_args_1 = require("./utils/generate_args");
-// import config from "./config";
-// const app = express();
-// const port = 3000;
-/// 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
-class OnlyEverGenerator {
-    constructor(apiKey, model, content) {
-        this.api_key = '';
-        this.parsedContent = '';
-        this.typologyResponse = {};
-        this.cardgenResponse = {};
-        this.summarizeResponse = {};
-        this.api_key = apiKey;
-        this.openAiService = new open_ai_service_1.OpenAiService(apiKey, model !== null && model !== void 0 ? model : 'gpt-3.5-turbo-1106');
-        this.parsedContent = new parse_source_content_1.ParseSourceContent(content).parse();
-    }
-    ;
-    generate() {
-        return __awaiter(this, arguments, void 0, function* (generate_card = false, generate_typology = false) {
-            var _a, _b;
-            let typologyPrompt = (0, typology_prompt_1.returnTypologyPrompt)();
-            let cardPrompt = (0, card_gen_prompt_1.returnCardGenPrompt)();
-            let args = new generate_args_1.GenerateArgs(generate_card, generate_typology, false, {
-                typology_prompt: typologyPrompt,
-                card_gen_prompt: cardPrompt,
-                summary_prompt: ''
-            });
-            const responseToReturn = [];
-            const whatNeedsToBeGenerated = args.getWhatNeedsToBeGenerated();
-            for (let elem of whatNeedsToBeGenerated)
-                if (elem == 'generate_tyopology') {
-                    this.typologyResponse = yield this.generateTypology((_a = args.prompts.typology_prompt) !== null && _a !== void 0 ? _a : '');
-                    responseToReturn.push(this.typologyResponse);
-                }
-                else if (elem == 'generate_card') {
-                    this.cardgenResponse = yield this.generateCard((_b = args.prompts.card_gen_prompt) !== null && _b !== void 0 ? _b : '', this.parsedContent + JSON.stringify(this.typologyResponse));
-                    responseToReturn.push(this.cardgenResponse);
-                }
-            return responseToReturn;
-        });
-    }
-    _returnParsedContent() {
-        return this.parsedContent;
-    }
-    generateCard(prompt, content) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            let response = yield ((_a = this.openAiService) === null || _a === void 0 ? void 0 : _a.sendRequest(prompt, this.parsedContent));
-            response['type'] = 'card_gen';
-            return response;
-        });
-    }
-    generateTypology(prompt) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let response = yield new generate_typology_1.GenerateTypology(this.openAiService, prompt, this.parsedContent).generate();
-            return response;
-        });
-    }
-}
-exports.OnlyEverGenerator = OnlyEverGenerator;
+// import { returnFields, returnHeadings, returnSourceData } from "./constants/source_data";
+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())
+// 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()

package/dist/parse/parse_card_response.js

@@ -0,0 +1,288 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParseCardResponse = void 0;
+const cardResponse = {
+    "status_code": 200,
+    "usage_data": {
+        "prompt_tokens": 9781,
+        "completion_tokens": 1915,
+        "total_tokens": 11696
+    },
+    "generated_content": {
+        "missing_concepts": [
+            "Faraday's laws of electrolysis",
+            "Humphry Davy",
+            "Electrolytic cell",
+            "Decomposition potential",
+            "Oxidation",
+            "Reduction",
+            "Electrolysis of seawater",
+            "Electrometallurgy",
+            "Electroplating",
+            "Electrochemical machining",
+            "Electrochemistry",
+            "Electrocatalysis",
+            "Electrorefining",
+            "Electrolysis of carbon dioxide",
+            "Energy changes during electrolysis",
+            "Electrocrystallization",
+            "Electrolysis of Iron Ore"
+        ],
+        "missing_facts": [
+            "Michael Faraday introduced the term 'electrolysis' in 1834",
+            "The first demonstration of key electrolysis concepts was by William Nicholson and Anthony Carlisle in the early nineteenth century",
+            "Humphry Davy discovered several alkali and alkaline earth metals by electrolysis",
+            "Electrolysis played a key role in isolating and identifying new elements like lithium, chlorine, and fluorine",
+            "The Hall–Héroult process led to a significant drop in the price of aluminum",
+            "Hydrogen and oxygen are produced in a 2:1 ratio by the electrolysis of water",
+            "The electrolysis of seawater can result in the production of alkali hydroxides",
+            "Electrometallurgy is used in the production of various metals",
+            "Electroplating involves the deposition of a thin metal film onto a substrate material",
+            "Electrochemical machining is used for deburring or etching metal surfaces",
+            "Electrocatalysis involves the acceleration of electrochemical reactions",
+            "Electrorefining is used to obtain pure metals from impure ones",
+            "The electrolysis of carbon dioxide can produce methane, ethylene, or ethanol",
+            "Energy changes during electrolysis involve the addition of electrical energy, equal to the change in Gibbs free energy plus system losses",
+            "Electrocrystallization is a method for obtaining conductive crystals using electrolysis",
+            "Electrolysis of Iron Ore can eventually result in the reduction of emissions from steel production"
+        ],
+        "test_cards": [
+            {
+                "type": "flash",
+                "card_content": {
+                    "front": "Who introduced the term 'electrolysis' and in which year?",
+                    "back": "Michael Faraday introduced the term 'electrolysis' in 1834"
+                },
+                "card_reference": "Electrolysis#Etymology",
+                "concepts": [],
+                "facts": [
+                    "Michael Faraday introduced the term 'electrolysis' in 1834"
+                ]
+            },
+            {
+                "type": "flash",
+                "card_content": {
+                    "front": "What was the significance of the Hall–Héroult process?",
+                    "back": "The Hall–Héroult process led to a significant drop in the price of aluminum"
+                },
+                "card_reference": "Electrolysis#Industrial uses",
+                "concepts": [
+                    "Hall–Héroult process"
+                ],
+                "facts": [
+                    "The Hall–Héroult process led to a significant drop in the price of aluminum"
+                ]
+            },
+            {
+                "type": "mcq",
+                "card_content": {
+                    "prompt": "What does the electrolysis of water produce?",
+                    "choices": [
+                        {
+                            "choice": "Oxygen and carbon dioxide",
+                            "is_correct": false
+                        },
+                        {
+                            "choice": "Hydrogen and oxygen",
+                            "is_correct": true
+                        },
+                        {
+                            "choice": "Nitrogen and helium",
+                            "is_correct": false
+                        }
+                    ]
+                },
+                "card_reference": "Electrolysis#Process of electrolysis",
+                "concepts": [
+                    "Electrometallurgy"
+                ],
+                "facts": [
+                    "Hydrogen and oxygen are produced in a 2:1 ratio by the electrolysis of water"
+                ]
+            },
+            {
+                "type": "cloze",
+                "card_content": {
+                    "prompt": "Electrolysis is the passing of a direct electric current through an {{c0:electrolyte}} producing chemical reactions at the electrodes and decomposition of the materials.",
+                    "options": [
+                        {
+                            "option": "electrolyte",
+                            "cloze": "c0"
+                        },
+                        {
+                            "option": "anode",
+                            "cloze": "null"
+                        },
+                        {
+                            "option": "cathode",
+                            "cloze": "null"
+                        }
+                    ]
+                },
+                "card_reference": "Electrolysis#Overview",
+                "concepts": [],
+                "facts": []
+            },
+            {
+                "type": "match",
+                "card_content": {
+                    "right_choice 1": "Electrometallurgy",
+                    "right_choice 2": "Electroplating",
+                    "right_choice 3": "Electrochemical machining",
+                    "right_choice 4": "Electrochemistry",
+                    "right_choice 5": "Electrocatalysis",
+                    "right_choice 6": "Electrorefining",
+                    "right_choice 7": "Electrolysis of carbon dioxide",
+                    "right_choice 8": "Energy changes during electrolysis",
+                    "Electrometallurgy": "The process of producing metals using electricity",
+                    "Electroplating": "Deposition of thin metal film onto a substrate material",
+                    "Electrochemical machining": "Deburring or etching metal surfaces",
+                    "Electrochemistry": "Study of the interchange of chemical and electrical energy",
+                    "Electrocatalysis": "Acceleration of electrochemical reactions",
+                    "Electrorefining": "Obtaining pure metals from impure ones"
+                },
+                "card_reference": "Electrolysis#Industrial uses",
+                "concepts": [
+                    "Electrometallurgy",
+                    "Electroplating",
+                    "Electrochemical machining",
+                    "Electrochemistry",
+                    "Electrocatalysis",
+                    "Electrorefining",
+                    "Electrolysis of carbon dioxide",
+                    "Energy changes during electrolysis"
+                ],
+                "facts": [
+                    "Electrometallurgy is used in the production of various metals",
+                    "Electroplating involves the deposition of a thin metal film onto a substrate material",
+                    "Electrochemical machining is used for deburring or etching metal surfaces",
+                    "Electrochemistry is the study of the interchange of chemical and electrical energy",
+                    "Electrocatalysis involves the acceleration of electrochemical reactions",
+                    "Electrorefining is used to obtain pure metals from impure ones",
+                    "The electrolysis of carbon dioxide can produce methane, ethylene, or ethanol",
+                    "Energy changes during electrolysis involve the addition of electrical energy, equal to the change in Gibbs free energy plus system losses"
+                ]
+            },
+            {
+                "type": "mcq",
+                "card_content": {
+                    "prompt": "What is a key application of electrolysis?",
+                    "choices": [
+                        {
+                            "choice": "Production of metal from ore",
+                            "is_correct": false
+                        },
+                        {
+                            "choice": "Pulsing current results",
+                            "is_correct": false
+                        },
+                        {
+                            "choice": "Generating electrical potential",
+                            "is_correct": false
+                        },
+                        {
+                            "choice": "Production of chlorine and sodium hydroxide",
+                            "is_correct": true
+                        }
+                    ]
+                },
+                "card_reference": "Electrolysis#Industrial uses",
+                "concepts": [
+                    "Electrochemistry",
+                    "Electrocatalysis",
+                    "Electrorefining"
+                ],
+                "facts": [
+                    "Production of chlorine and sodium hydroxide, called the Chloralkali process"
+                ]
+            },
+            {
+                "type": "cloze",
+                "card_content": {
+                    "prompt": "Oxidation of ions or neutral molecules occurs at the {{c0:anode}}. Reduction of ions or neutral molecules occurs at the {{c1:cathode}}.",
+                    "options": [
+                        {
+                            "option": "anode",
+                            "cloze": "c0"
+                        },
+                        {
+                            "option": "cathode",
+                            "cloze": "c1"
+                        },
+                        {
+                            "option": "electrolyte",
+                            "cloze": "null"
+                        }
+                    ]
+                },
+                "card_reference": "Electrolysis#Oxidation and reduction at the electrodes",
+                "concepts": [
+                    "Oxidation",
+                    "Reduction"
+                ],
+                "facts": []
+            },
+            {
+                "type": "match",
+                "card_content": {
+                    "right_choice 1": "Electrolysis",
+                    "right_choice 2": "Electrocrystallization",
+                    "right_choice 3": "Electrolysis of Iron Ore",
+                    "right_choice 4": "Electrolysis of seawater",
+                    "right_choice 5": "Electrometallurgy"
+                },
+                "card_reference": "Electrolysis#Research trends",
+                "concepts": [
+                    "Electrolysis",
+                    "Electrocrystallization",
+                    "Electrolysis of Iron Ore",
+                    "Electrolysis of seawater",
+                    "Electrometallurgy"
+                ],
+                "facts": []
+            }
+        ]
+    },
+    "generated_at": 1718625081,
+    "type": "card_gen"
+};
+class ParseCardResponse {
+    constructor(generatedData) {
+        this.generatedData = generatedData;
+    }
+    parse() {
+        const cardData = [];
+        const usage_data = this.generatedData.usage_data;
+        const created_at = this.generatedData.created_at;
+        const unparsedTestCards = this.generatedData.test_cards;
+        for (let elem of unparsedTestCards) {
+            if (elem.type == 'flash') {
+                cardData.push(this.parseFlashCard(elem));
+            }
+            else if (elem.type == 'mcq') {
+                cardData.push(this.parseFlashCard(elem));
+            }
+            else if (elem.type == 'cloze') {
+                cardData.push(this.parseClozeCard(elem));
+            }
+            else if (elem.type == 'match') {
+                cardData.push(this.parseMatchCard(elem));
+            }
+        }
+        usage_data['created_at'] = created_at;
+        usage_data['type'] = 'card_gen';
+        return {
+            'usage_data': usage_data,
+            'cards_data': cardData
+        };
+    }
+    parseFlashCard(data) {
+    }
+    parseMcqCard(data) {
+    }
+    parseClozeCard(data) {
+    }
+    parseMatchCard(data) {
+    }
+}
+exports.ParseCardResponse = ParseCardResponse;

package/dist/parse/parse_source_content.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParseSourceContent = void 0;
+class ParseSourceContent {
+    constructor(sourceContent) {
+        this.titles_to_remove = ['See also', 'References', 'Further reading', 'External links', 'Notes and references', 'Bibliography', 'Notes', 'Cited sources'];
+        this.content = sourceContent;
+    }
+    parse() {
+        let dataAfterRemovingUnWantedBlocks = this.removeSectionsByTitle(this.content);
+        let afterSanitized = this.sanitizeBlocks(dataAfterRemovingUnWantedBlocks);
+        return JSON.stringify(afterSanitized);
+    }
+    removeSectionsByTitle(data) {
+        let dataAfterRemoving = [];
+        for (let elem of data) {
+            if (elem.block_type == 'heading' && this.titles_to_remove.includes(elem.content)) {
+                continue;
+            }
+            if (elem.children) {
+                elem.children = this.removeSectionsByTitle(elem.children);
+            }
+            dataAfterRemoving.push(elem);
+        }
+        return dataAfterRemoving;
+    }
+    sanitizeWikiContent(content) {
+        // Remove newline characters
+        content = content.replace(/\\n/g, ' ');
+        // Remove internal link references, keeping only the link text
+        // Pattern explanation: [[link|text|index|wiki]] --> text
+        content = content.replace(/\[\[.*?\|(.*?)\|.*?\|wiki\]\]/g, '$1');
+        // Remove external links, keeping only the link text
+        // Pattern explanation: [url text] --> text
+        content = content.replace(/\[http[s]?:\/\/[^\s]+ ([^\]]+)\]/g, '$1');
+        // Remove Markdown link references, keeping only the link text
+        // Pattern explanation: ![link text](url) --> link text
+        content = content.replace(/\!\[([^\]]+)\]\([^\)]+\)/g, '$1');
+        return content;
+    }
+    sanitizeBlocks(blocks) {
+        let sanitizedBlocks = [];
+        blocks.forEach(block => {
+            let sanitizedBlock = {};
+            for (let key in block) {
+                let value = block[key];
+                if (typeof value === 'string') {
+                    sanitizedBlock[key] = this.sanitizeWikiContent(value);
+                }
+                else if (Array.isArray(value)) {
+                    sanitizedBlock[key] = this.sanitizeBlocks(value);
+                }
+                else {
+                    sanitizedBlock[key] = value;
+                }
+            }
+            sanitizedBlocks.push(sanitizedBlock);
+        });
+        return sanitizedBlocks;
+    }
+}
+exports.ParseSourceContent = ParseSourceContent;

package/dist/parse/response_format_card.js

@@ -0,0 +1,210 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseResponse = exports.returnResponse = void 0;
+const responseData = {
+    "flash_cards": [
+        {
+            "question": "What is the primary function of the 'Electrolysis'?",
+            "answer": "Electrolysis is the passing of a direct electric current through an electrolyte producing chemical reactions at the electrodes and decomposition of the materials.",
+            "heading": "Overview"
+        },
+        {
+            "question": "What did Michael Faraday discover while studying the process of electrolysis under Humphry Davy?",
+            "answer": "Michael Faraday discovered two laws of electrolysis.",
+            "heading": "History"
+        },
+        {
+            "question": "What can electrolysis be used for in the manufacturing sector?",
+            "answer": "Electrolysis can be used for electroplating and electrochemical machining.",
+            "heading": "Manufacturing processes"
+        },
+        {
+            "question": "In the context of electrolysis, what does the term 'Decomposition potential' refer to?",
+            "answer": "Decomposition potential or decomposition voltage refers to the minimum voltage between anode and cathode of an electrolytic cell needed for electrolysis to occur.",
+            "heading": "Decomposition potential"
+        }
+    ],
+    "mcqs": [
+        {
+            "question": "What is the primary purpose of 'Electrometallurgy'?",
+            "answers": [
+                {
+                    "answer": "Production of aluminium",
+                    "is_correct": true
+                },
+                {
+                    "answer": "Chlorine production",
+                    "is_correct": false
+                },
+                {
+                    "answer": "Purifying copper",
+                    "is_correct": false
+                },
+                {
+                    "answer": "Rust removal",
+                    "is_correct": false
+                },
+                {
+                    "answer": "Hydrogen production",
+                    "is_correct": false
+                }
+            ],
+            "heading": "Industrial uses"
+        },
+        {
+            "question": "What can electrolysis be used for in the context of batteries?",
+            "answers": [
+                {
+                    "answer": "Spontaneous redox reactions",
+                    "is_correct": true
+                },
+                {
+                    "answer": "Energy-releasing reactions",
+                    "is_correct": false
+                },
+                {
+                    "answer": "Disinfectant production",
+                    "is_correct": false
+                },
+                {
+                    "answer": "Fuel production",
+                    "is_correct": false
+                },
+                {
+                    "answer": "Gas diffusion in reactors",
+                    "is_correct": false
+                }
+            ],
+            "heading": "Related processes"
+        }
+    ],
+    "cloze_cards": [
+        {
+            "question": "Electrolysis is the passing of a {{c0:direct electric current}} through an {{c1:electrolyte}} producing {{c2:chemical reactions}} at the {{c3:electrodes}} and {{c4:decomposition}} of the materials.",
+            "options": [
+                {
+                    "option": "direct electric current",
+                    "cloze": "c0"
+                },
+                {
+                    "option": "electrolyte",
+                    "cloze": "c1"
+                },
+                {
+                    "option": "chemical reactions",
+                    "cloze": "c2"
+                },
+                {
+                    "option": "electrodes",
+                    "cloze": "c3"
+                },
+                {
+                    "option": "decomposition",
+                    "cloze": "c4"
+                },
+                {
+                    "option": "metallic objects",
+                    "cloze": null
+                }
+            ]
+        },
+        {
+            "question": "In electrolysis, the decomposition potential or decomposition voltage refers to the minimum voltage between {{c0:anode}} and {{c1:cathode}} of an electrolytic cell needed for electrolysis to occur.",
+            "options": [
+                {
+                    "option": "anode",
+                    "cloze": "c0"
+                },
+                {
+                    "option": "cathode",
+                    "cloze": "c1"
+                },
+                {
+                    "option": "electrolyte",
+                    "cloze": null
+                },
+                {
+                    "option": "chemical reactions",
+                    "cloze": null
+                },
+                {
+                    "option": "oxygen",
+                    "cloze": null
+                },
+                {
+                    "option": "hydrogen",
+                    "cloze": null
+                }
+            ]
+        }
+    ]
+};
+function returnResponse() {
+    return responseData;
+}
+exports.returnResponse = returnResponse;
+function parseResponse() {
+    let cardData = [];
+    let data = returnResponse();
+    let keys = Object.keys(data);
+    if (keys) {
+        for (let elem of keys) {
+            if (elem == 'flash_cards') {
+                cardData.push(...parseFlashCard(data.flash_cards));
+            }
+            else if (elem == 'cloze_cards') {
+                cardData.push(...parseClozeCards(data.cloze_cards));
+            }
+            else if (elem == 'mcqs') {
+                cardData.push(...parseMcq(data.mcqs));
+            }
+        }
+    }
+    return cardData;
+}
+exports.parseResponse = parseResponse;
+/// takes array of 
+function parseFlashCard(cards) {
+    let flashCardData = [];
+    for (let elem of cards) {
+        flashCardData.push({
+            "type": "flash",
+            "heading": elem.heading,
+            "content": JSON.stringify({
+                "front_content": elem.question,
+                "back_content": elem.answer
+            })
+        });
+    }
+    return flashCardData;
+}
+/// takes array of 
+function parseMcq(cardsData) {
+    let mcqCards = [];
+    for (let elem of cardsData) {
+        mcqCards.push({
+            "type": "mcq",
+            "heading": elem.heading,
+            "content": JSON.stringify({
+                "question": elem.question,
+                "answers": elem.answers
+            })
+        });
+    }
+    return mcqCards;
+}
+/// takes array of 
+function parseClozeCards(cardsData) {
+    let clozeCards = [];
+    for (let elem of cardsData) {
+        clozeCards.push({
+            "type": "cloze",
+            "heading": elem.heading,
+            "content": JSON.stringify({
+                "question": elem.question,
+                "options": elem.options
+            })
+        });
+    }
+    return clozeCards;
+}