only_ever_generator 0.2.6 → 0.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/dist/bootstrap/app.js +47 -44
  2. package/dist/card_gen/generate_cards.js +47 -32
  3. package/dist/constants/prompt_data.js +273 -273
  4. package/dist/constants/prompts/card_gen_prompt.js +180 -180
  5. package/dist/constants/prompts/typology_prompt.js +93 -93
  6. package/dist/logger.js +41 -0
  7. package/dist/parse/parse_source_content.js +23 -9
  8. package/dist/typology_gen/generate_typology.js +21 -12
  9. package/dist/utils/generate_args.js +1 -11
  10. package/package.json +33 -33
  11. package/readme.md +23 -23
  12. package/src/bootstrap/app.ts +150 -141
  13. package/src/card_gen/generate_cards.ts +251 -239
  14. package/src/config.ts +6 -6
  15. package/src/constants/api_constants.ts +2 -2
  16. package/src/constants/prompt_data.ts +296 -296
  17. package/src/constants/prompts/card_gen_prompt.ts +372 -372
  18. package/src/constants/prompts/typology_prompt.ts +202 -202
  19. package/src/constants/source_data.ts +47 -47
  20. package/src/gap_fill/calculate_gap_fill.ts +52 -52
  21. package/src/index.ts +61 -61
  22. package/src/logger.ts +31 -0
  23. package/src/parse/parse_card_response.ts +289 -289
  24. package/src/parse/parse_source_content.ts +94 -81
  25. package/src/parse/response_format_card.ts +210 -210
  26. package/src/parse/response_format_typology.ts +43 -43
  27. package/src/services/open_ai_service.ts +55 -54
  28. package/src/typology_gen/generate_typology.ts +71 -64
  29. package/src/utils/generate_args.ts +28 -37
  30. package/src/utils/parse_openai_response.ts +20 -20
  31. package/tsconfig.json +12 -12
  32. package/dist/class/parse/parse_source_content.js +0 -62
  33. package/dist/class/services/open_ai_service.js +0 -25
  34. package/dist/parse_response/parse_card_response.js +0 -288
  35. package/dist/parse_response/response_format_card.js +0 -210
  36. package/dist/parse_response/response_format_typology.js +0 -47
  37. package/dist/service/open_ai_request.js +0 -57
@@ -1,239 +1,251 @@
1
- import { OpenAiService } from "../services/open_ai_service";
2
-
3
- export class GenerateCards {
4
- openAiService: OpenAiService;
5
- constructor(openAiService: OpenAiService) {
6
- this.openAiService = openAiService;
7
- }
8
-
9
- async generateCards(prompt: string, parsedContent: string, isGapFill: boolean) {
10
- let response = await this.openAiService?.sendRequest(prompt, parsedContent);
11
- // console.log("response to card generation ", response);
12
- response["type"] = isGapFill ? "gap_fill":"card_gen";
13
- response.metadata = {
14
- "req_time": response.generated_at,
15
- "req_type": response.type,
16
- "req_tokens": response.usage_data?.prompt_tokens,
17
- "res_tokens": response.usage_data?.completion_tokens,
18
- // "created_at":response.created_at,
19
- };
20
- if(response.status_code == 200){
21
- response.metadata.status = "completed";
22
- //return response;
23
- return this.parse(response, isGapFill);
24
- } else {
25
- response.metadata.status = "failed";
26
- return response;
27
- }
28
- }
29
-
30
- parse(generatedData: any, isGapFill: boolean) {
31
- const cardData = [];
32
- let usage_data = generatedData.metadata;
33
- const status_code = generatedData.status_code;
34
- const missing_concepts = generatedData.generated_content.missing_concepts;
35
- const missing_facts = generatedData.generated_content.missing_facts;
36
- const unparsedTestCards = generatedData.generated_content.test_cards;
37
- const type = generatedData.type;
38
- if(unparsedTestCards !== undefined && unparsedTestCards.length != 0) {
39
- for (let elem of unparsedTestCards) {
40
- if (elem.type == "flash") {
41
- cardData.push(this.parseFlashCard(elem));
42
- } else if (elem.type == "mcq") {
43
- cardData.push(this.parseMcqCard(elem));
44
- } else if (elem.type == "cloze") {
45
- cardData.push(this.parseClozeCard(elem));
46
- } else if (elem.type == "match") {
47
- cardData.push(this.parseMatchCard(elem));
48
- }
49
- }
50
- } else {
51
- if(!isGapFill) {
52
- usage_data.status = "failed";
53
- }
54
- }
55
-
56
-
57
-
58
- return {
59
- status_code: status_code,
60
- metadata: usage_data,
61
- type: type,
62
- missing_concepts: missing_concepts,
63
- missing_facts: missing_facts,
64
- cards_data: cardData,
65
- };
66
- }
67
-
68
- parseFlashCard(data: any) {
69
- let displayTitle = this.generateFlashCardDisplayTitle(
70
- data.card_content.front,
71
- data.card_content.back
72
- );
73
- let flashCardData = {
74
- type: {
75
- category: 'learning',
76
- sub_type: data.type,
77
- },
78
- heading: data.card_reference,
79
- displayTitle: displayTitle,
80
- content: {
81
- front_content: data.card_content.front,
82
- back_content: data.card_content.back,
83
- },
84
- concepts: data.concepts,
85
- facts: data.facts,
86
- bloomLevel: data.bloom_level,
87
- };
88
-
89
- return flashCardData;
90
- }
91
-
92
- generateFlashCardDisplayTitle(front: string, back: string) {
93
- return `${front} ---- ${back}`;
94
- }
95
-
96
- parseMcqCard(data: any) {
97
- let mcqAnswers = [];
98
- if(data.card_content.choices !== undefined && data.card_content.choices.length != 0) {
99
- for (let choice of data.card_content.choices) {
100
- let answer = {
101
- answer: choice.choice,
102
- is_correct: choice.is_correct,
103
- };
104
- mcqAnswers.push(answer);
105
- }
106
- }
107
-
108
- let displayTitle = this.generateMcqCardDisplayTitle(
109
- data.card_content.prompt,
110
- mcqAnswers
111
- );
112
- let mcqCard = {
113
- type: {
114
- category: 'learning',
115
- sub_type: data.type,
116
- },
117
- heading: data.card_reference,
118
- displayTitle: displayTitle,
119
- content: {
120
- question: data.card_content.prompt,
121
- answers: mcqAnswers,
122
- },
123
- concepts: data.concepts,
124
- facts: data.facts,
125
- bloomLevel: data.bloom_level,
126
-
127
- };
128
- return mcqCard;
129
- }
130
-
131
- generateMcqCardDisplayTitle(question: string, answers: any) {
132
- let answersString = [];
133
- if(answers.length != 0) {
134
- for (let option of answers) {
135
- let currentIndex = answers.indexOf(option) + 1;
136
- let temp = `${currentIndex} . ${option.answer} `;
137
- answersString.push(temp);
138
- }
139
- let resultString = answersString.join("");
140
- let finalDisplayTitle = `${question} ---- ${resultString}`;
141
- return finalDisplayTitle;
142
- } else {
143
- return question;
144
- }
145
-
146
- }
147
-
148
- parseClozeCard(data: any) {
149
- let displayTitle = this.generateClozeCardDisplayTitle(
150
- data.card_content.text,
151
- data.card_content.options
152
- );
153
- let clozeCardData = {
154
- type: {
155
- category: 'learning',
156
- sub_type: data.type,
157
- },
158
- heading: data.card_reference,
159
- displayTitle: displayTitle,
160
- content: {
161
- question: data.card_content.text,
162
- options: data.card_content.options,
163
- },
164
- concepts: data.concepts,
165
- facts: data.facts,
166
- bloomLevel: data.bloom_level,
167
-
168
- };
169
-
170
- return clozeCardData;
171
- }
172
-
173
- generateClozeCardDisplayTitle(question: string, answers: Array<any>) {
174
- let optionsString = '';
175
- if(answers.length !== 0) {
176
- optionsString = answers
177
- .map((item: { option: any }) => {
178
- if(item.option !== undefined) {
179
- return item.option;
180
- } else {
181
- return '';
182
- }
183
- })
184
- .join(", ");
185
- }
186
-
187
- return `${question} ---- ${optionsString}`;
188
- }
189
-
190
- parseMatchCard(cardData: any) {
191
- let data = cardData.card_content;
192
- const transformedData: { [key: string]: string[] } = {};
193
-
194
- for (let key in data) {
195
- if (data.hasOwnProperty(key)) {
196
- transformedData[key] = [data[key]];
197
- // let value = data[key].replace(/[\[\]]/g, '');
198
- // let items = data[key].split(',').map((item: string) => item.trim());
199
- // map.set(key, items);
200
- // }
201
- }
202
- let displayTitle = this.generateMatchCardDisplayTitle(transformedData);
203
- let matchCard = {
204
- type: {
205
- category: 'learning',
206
- sub_type: data.type,
207
- },
208
- heading: cardData.card_reference,
209
- content: transformedData,
210
- // content: cardData.card_content,
211
- displayTitle: displayTitle,
212
- concepts: cardData.concepts,
213
- facts: cardData.facts,
214
- bloomLevel: cardData.bloom_level,
215
-
216
- };
217
-
218
- return matchCard;
219
- }
220
- }
221
-
222
- generateMatchCardDisplayTitle(answers: any) {
223
- let titles: string[] = [];
224
- let counter = 65;
225
- for (let key in answers) {
226
- if (answers.hasOwnProperty(key)) {
227
- let value = answers[key];
228
- // let items = value.split(',').map((item: string) => item.trim());
229
- // items.forEach((item: any) => {
230
- let letter = String.fromCharCode(counter);
231
- titles.push(`${letter}. ${key} -- ${value}`);
232
- counter++;
233
- // });
234
- }
235
- }
236
- let displayTitle = titles.join(",");
237
- return displayTitle;
238
- }
239
- }
1
+ import { ErrorLogger } from "../logger";
2
+ import { OpenAiService } from "../services/open_ai_service";
3
+
4
+ export class GenerateCards {
5
+ openAiService: OpenAiService;
6
+ constructor(openAiService: OpenAiService) {
7
+ this.openAiService = openAiService;
8
+ }
9
+
10
+ async generateCards(prompt: string, parsedContent: string, isGapFill: boolean) {
11
+ let response = await this.openAiService?.sendRequest(prompt, parsedContent);
12
+ // console.log("response to card generation ", response);
13
+ response["type"] = isGapFill ? "gap_fill":"card_gen";
14
+ response.metadata = {
15
+ "req_time": response.generated_at,
16
+ "req_type": response.type,
17
+ "req_tokens": response.usage_data?.prompt_tokens,
18
+ "res_tokens": response.usage_data?.completion_tokens,
19
+ // "created_at":response.created_at,
20
+ };
21
+ if(response.status_code == 200){
22
+ response.metadata.status = "completed";
23
+ //return response;
24
+ return this.parse(response, isGapFill);
25
+ } else {
26
+ response.metadata.status = "failed";
27
+ return response;
28
+ }
29
+ }
30
+
31
+ async parse(generatedData: any, isGapFill: boolean) {
32
+ try{
33
+ const cardData = [];
34
+ let usage_data = generatedData.metadata;
35
+ const status_code = generatedData.status_code;
36
+ const missing_concepts = generatedData.generated_content.missing_concepts;
37
+ const missing_facts = generatedData.generated_content.missing_facts;
38
+ const unparsedTestCards = generatedData.generated_content.test_cards;
39
+ const type = generatedData.type;
40
+ if(unparsedTestCards !== undefined && unparsedTestCards.length != 0) {
41
+ for (let elem of unparsedTestCards) {
42
+ if (elem.type == "flash") {
43
+ cardData.push(this.parseFlashCard(elem));
44
+ } else if (elem.type == "mcq") {
45
+ cardData.push(this.parseMcqCard(elem));
46
+ } else if (elem.type == "cloze") {
47
+ cardData.push(this.parseClozeCard(elem));
48
+ } else if (elem.type == "match") {
49
+ cardData.push(this.parseMatchCard(elem));
50
+ }
51
+ }
52
+ } else {
53
+ if(!isGapFill) {
54
+ usage_data.status = "failed";
55
+ }
56
+ }
57
+
58
+
59
+
60
+ return {
61
+ status_code: status_code,
62
+ metadata: usage_data,
63
+ type: type,
64
+ missing_concepts: missing_concepts,
65
+ missing_facts: missing_facts,
66
+ cards_data: cardData,
67
+ };
68
+ }catch (e:any){
69
+ await new ErrorLogger({
70
+ "type": 'card_parsing',
71
+ "data": e.message,
72
+ }).log();
73
+ return {
74
+ status_code: 500,
75
+ type: 'card_gen',
76
+ }
77
+ }
78
+ }
79
+
80
+ parseFlashCard(data: any) {
81
+ let displayTitle = this.generateFlashCardDisplayTitle(
82
+ data.card_content.front,
83
+ data.card_content.back
84
+ );
85
+ let flashCardData = {
86
+ type: {
87
+ category: 'learning',
88
+ sub_type: data.type,
89
+ },
90
+ heading: data.card_reference,
91
+ displayTitle: displayTitle,
92
+ content: {
93
+ front_content: data.card_content.front,
94
+ back_content: data.card_content.back,
95
+ },
96
+ concepts: data.concepts,
97
+ facts: data.facts,
98
+ bloomLevel: data.bloom_level,
99
+ };
100
+
101
+ return flashCardData;
102
+ }
103
+
104
+ generateFlashCardDisplayTitle(front: string, back: string) {
105
+ return `${front} ---- ${back}`;
106
+ }
107
+
108
+ parseMcqCard(data: any) {
109
+ let mcqAnswers = [];
110
+ if(data.card_content.choices !== undefined && data.card_content.choices.length != 0) {
111
+ for (let choice of data.card_content.choices) {
112
+ let answer = {
113
+ answer: choice.choice,
114
+ is_correct: choice.is_correct,
115
+ };
116
+ mcqAnswers.push(answer);
117
+ }
118
+ }
119
+
120
+ let displayTitle = this.generateMcqCardDisplayTitle(
121
+ data.card_content.prompt,
122
+ mcqAnswers
123
+ );
124
+ let mcqCard = {
125
+ type: {
126
+ category: 'learning',
127
+ sub_type: data.type,
128
+ },
129
+ heading: data.card_reference,
130
+ displayTitle: displayTitle,
131
+ content: {
132
+ question: data.card_content.prompt,
133
+ answers: mcqAnswers,
134
+ },
135
+ concepts: data.concepts,
136
+ facts: data.facts,
137
+ bloomLevel: data.bloom_level,
138
+
139
+ };
140
+ return mcqCard;
141
+ }
142
+
143
+ generateMcqCardDisplayTitle(question: string, answers: any) {
144
+ let answersString = [];
145
+ if(answers.length != 0) {
146
+ for (let option of answers) {
147
+ let currentIndex = answers.indexOf(option) + 1;
148
+ let temp = `${currentIndex} . ${option.answer} `;
149
+ answersString.push(temp);
150
+ }
151
+ let resultString = answersString.join("");
152
+ let finalDisplayTitle = `${question} ---- ${resultString}`;
153
+ return finalDisplayTitle;
154
+ } else {
155
+ return question;
156
+ }
157
+
158
+ }
159
+
160
+ parseClozeCard(data: any) {
161
+ let displayTitle = this.generateClozeCardDisplayTitle(
162
+ data.card_content.text,
163
+ data.card_content.options
164
+ );
165
+ let clozeCardData = {
166
+ type: {
167
+ category: 'learning',
168
+ sub_type: data.type,
169
+ },
170
+ heading: data.card_reference,
171
+ displayTitle: displayTitle,
172
+ content: {
173
+ question: data.card_content.text,
174
+ options: data.card_content.options,
175
+ },
176
+ concepts: data.concepts,
177
+ facts: data.facts,
178
+ bloomLevel: data.bloom_level,
179
+
180
+ };
181
+
182
+ return clozeCardData;
183
+ }
184
+
185
+ generateClozeCardDisplayTitle(question: string, answers: Array<any>) {
186
+ let optionsString = '';
187
+ if(answers.length !== 0) {
188
+ optionsString = answers
189
+ .map((item: { option: any }) => {
190
+ if(item.option !== undefined) {
191
+ return item.option;
192
+ } else {
193
+ return '';
194
+ }
195
+ })
196
+ .join(", ");
197
+ }
198
+
199
+ return `${question} ---- ${optionsString}`;
200
+ }
201
+
202
+ parseMatchCard(cardData: any) {
203
+ let data = cardData.card_content;
204
+ const transformedData: { [key: string]: string[] } = {};
205
+
206
+ for (let key in data) {
207
+ if (data.hasOwnProperty(key)) {
208
+ transformedData[key] = [data[key]];
209
+ // let value = data[key].replace(/[\[\]]/g, '');
210
+ // let items = data[key].split(',').map((item: string) => item.trim());
211
+ // map.set(key, items);
212
+ // }
213
+ }
214
+ let displayTitle = this.generateMatchCardDisplayTitle(transformedData);
215
+ let matchCard = {
216
+ type: {
217
+ category: 'learning',
218
+ sub_type: data.type,
219
+ },
220
+ heading: cardData.card_reference,
221
+ content: transformedData,
222
+ // content: cardData.card_content,
223
+ displayTitle: displayTitle,
224
+ concepts: cardData.concepts,
225
+ facts: cardData.facts,
226
+ bloomLevel: cardData.bloom_level,
227
+
228
+ };
229
+
230
+ return matchCard;
231
+ }
232
+ }
233
+
234
+ generateMatchCardDisplayTitle(answers: any) {
235
+ let titles: string[] = [];
236
+ let counter = 65;
237
+ for (let key in answers) {
238
+ if (answers.hasOwnProperty(key)) {
239
+ let value = answers[key];
240
+ // let items = value.split(',').map((item: string) => item.trim());
241
+ // items.forEach((item: any) => {
242
+ let letter = String.fromCharCode(counter);
243
+ titles.push(`${letter}. ${key} -- ${value}`);
244
+ counter++;
245
+ // });
246
+ }
247
+ }
248
+ let displayTitle = titles.join(",");
249
+ return displayTitle;
250
+ }
251
+ }
package/src/config.ts CHANGED
@@ -1,7 +1,7 @@
1
- import "dotenv/config";
2
-
3
- const config = {
4
- openAIKey : process.env.OPEN_AI_KEY as string
5
- }
6
-
1
+ import "dotenv/config";
2
+
3
+ const config = {
4
+ openAIKey : process.env.OPEN_AI_KEY as string
5
+ }
6
+
7
7
  export default config;
@@ -1,3 +1,3 @@
1
- export function openAiEndPoint(){
2
- return 'https://api.openai.com/v1/chat/completions';
1
+ export function openAiEndPoint(){
2
+ return 'https://api.openai.com/v1/chat/completions';
3
3
  }