only_ever_generator 0.2.7 → 0.2.8

package/readme.md

@@ -1,23 +1,23 @@
-This is a NPM package that handles the all the ai generation for _source on OnlyEver.
-The Generation includes, Knowledge Taxonomy , Summary and Test Cards data for the _source.
-
-The class [OnlyEverGenerator] is the Entry point for the generation module it has two required fields, 
-[api_key] which is open ai token 
-[model] open ai model : 'gpt-3.5-turbo-1106'
-[content] source content : Array<BaseBlocks>
-
-The [OnlyEverGenerator] currently exposes a main method, [generate] which handles all types of generation and takes a Param 
-```
-generate(generate_typology = false,generate_card = false) method takes two args, generate_typology and generate_cards, which are both boolean.
-For Eg: 
-let oeGenerator = new OnlyEverGenerator(
-    api_key,
-    model,
-    [Block1,Block2,Block3], // oe content model
-);
- 
-
-let responsesArray = await oeGenerator.generate(true,true);
-
-
-```
+This is a NPM package that handles the all the ai generation for _source on OnlyEver.
+The Generation includes, Knowledge Taxonomy , Summary and Test Cards data for the _source.
+
+The class [OnlyEverGenerator] is the Entry point for the generation module it has two required fields, 
+[api_key] which is open ai token 
+[model] open ai model : 'gpt-3.5-turbo-1106'
+[content] source content : Array<BaseBlocks>
+
+The [OnlyEverGenerator] currently exposes a main method, [generate] which handles all types of generation and takes a Param 
+```
+generate(generate_typology = false,generate_card = false) method takes two args, generate_typology and generate_cards, which are both boolean.
+For Eg: 
+let oeGenerator = new OnlyEverGenerator(
+    api_key,
+    model,
+    [Block1,Block2,Block3], // oe content model
+);
+ 
+
+let responsesArray = await oeGenerator.generate(true,true);
+
+
+```

package/src/bootstrap/app.ts

@@ -1,154 +1,150 @@
-import { GenerateCards } from "../card_gen/generate_cards";
-import { ParseSourceContent } from "../parse/parse_source_content";
-import { OpenAiService } from "../services/open_ai_service";
-import { returnCardGenPrompt } from "../constants/prompts/card_gen_prompt";
-import { returnTypologyPrompt } from "../constants/prompts/typology_prompt";
-import { GenerateTypology } from "../typology_gen/generate_typology";
-import { GenerateArgs } from "../utils/generate_args";
-import { returnFields } from "../constants/source_data";
-import { returnTypologyData } from "../parse/response_format_typology";
-import { gapFilling } from "../gap_fill/calculate_gap_fill";
-import { title } from "process";
-import { ErrorLogger } from "../logger";
-
-
-/// OnlyEverGenerator
-
-export class OnlyEverGenerator {
-  public api_key: string = "";
-  public openAiService: OpenAiService;
-
-/// these fields will be populated inside the constructor
-  parsedContent: any = {};
-  promptForTypology: string = "";
-  promptForCardGen: string = "";
-  expectedFields: Array<string>;
-
-
-  typologyResponse: any = {};
-  cardgenResponse: any = {};
-  summarizeResponse = {};
-  gapFillResponse: any = {};
-
-
-  constructor(
-    apiKey: string,
-    model: string,
-    generationContent : any
-  ) {
-    this.api_key = apiKey;
-    this.openAiService = new OpenAiService(
-      apiKey,
-      model ?? "gpt-3.5-turbo-1106"
-    );
-    const parsedData = new ParseSourceContent(generationContent.content).parseData()
-    this.parsedContent = {
-      title: parsedData.title,
-      headings: parsedData.headings,
-      content: parsedData.content,
-
-    },
-    // parsedData.type == 'cards' ? this.typologyResponse = parsedData.taxonomy :  this.typologyResponse = null;
-    this.typologyResponse = parsedData.taxonomy
-    
-    this.expectedFields =  generationContent.content.fields; //returnFields();
-    this.promptForTypology = returnTypologyPrompt(generationContent.prompt.typology);
-    this.promptForCardGen = returnCardGenPrompt(generationContent.prompt.card_generation);
-  }
-
-
- 
-  async generate(
-    generate_typology: boolean = false,
-    generate_card: boolean = false
-  ): Promise<Array<any>> {
-    let args = new GenerateArgs(generate_card, generate_typology, false, );
-    const responseToReturn = [];
-    const whatNeedsToBeGenerated = args.getWhatNeedsToBeGenerated();
-    for (let elem of whatNeedsToBeGenerated)
-      if (elem == "generate_tyopology") {
-        this.typologyResponse = await this.generateTypology(
-        this.promptForTypology
-        );
-        responseToReturn.push(this.typologyResponse);
-      } else if (elem == "generate_card") {
-        /// for cards gen to occur, there must be presence of source taxonomy
-        if(this.shouldTheCardBeGeneratedAfterTypologyResponse()){
-          this.cardgenResponse =  await this.generateCard(
-            this.promptForCardGen,
-            JSON.stringify(this.typologyResponse),
-            false,
-          )
-          responseToReturn.push(this.cardgenResponse);
-
-          /// check if gap fill is required ie coverage determination 
-          if(this.cardgenResponse.status_code == 200) {
-            this.gapFillResponse = await this.generationForGapFill(this.typologyResponse, this.cardgenResponse);
-            responseToReturn.push(this.gapFillResponse);
-          }
-
-        }
-    }
-    return responseToReturn;
-   // return [typologyPrompt, cardPrompt];
-  
-  }
-
-  shouldTheCardBeGeneratedAfterTypologyResponse(){
-    if(this.typologyResponse){
-      return this.typologyResponse.generate_cards.state == true;
-    }else{
-      return false;
-    }
-
-  }
-
-  async generationForGapFill(typologyData: any, cardGenData: any) {
-      let gapFill = gapFilling(typologyData, cardGenData);
-      let response :any ;
-      if (
-        gapFill.remainingConcepts.length !== 0 ||
-        gapFill.remainingFacts.length !== 0
-      ) {
-        response = await this.generateCard(
-         this.promptForCardGen +
-            "Generate cards only suitable for the given remaining concepts and facts" +
-            JSON.stringify(gapFill) +
-            "Exclude generating these cards",
-            JSON.stringify(cardGenData.cards_data),
-          true
-        );
-      }
-      return response;
-    
-  }
-
-
-
-  async generateCard(prompt: string, additionalContent: string, isGapFill: boolean) {
-    let generateCards = new GenerateCards(this.openAiService);
-    this.cardgenResponse = await generateCards.generateCards(
-      prompt ?? "",
-      this.parsedContent + additionalContent,
-      isGapFill
-    );
-  
-    // let response =  await this.openAiService?.sendRequest(prompt,this.parsedContent);
-    // response['type'] = 'card_gen';
-    return this.cardgenResponse;
-  }
-
-
-  async generateTypology(prompt: string) {
-    let response = await new GenerateTypology(
-      this.openAiService,
-      prompt,
-      JSON.stringify(this.parsedContent),
-      this.expectedFields
-    ).generate();
-    return response;
-  }
-
-  
-
-}
+import { GenerateCards } from "../card_gen/generate_cards";
+import { ParseSourceContent } from "../parse/parse_source_content";
+import { OpenAiService } from "../services/open_ai_service";
+import { returnCardGenPrompt } from "../constants/prompts/card_gen_prompt";
+import { returnTypologyPrompt } from "../constants/prompts/typology_prompt";
+import { GenerateTypology } from "../typology_gen/generate_typology";
+import { GenerateArgs } from "../utils/generate_args";
+import { gapFilling } from "../gap_fill/calculate_gap_fill";
+
+
+/// OnlyEverGenerator
+
+export class OnlyEverGenerator {
+  public api_key: string = "";
+  public openAiService: OpenAiService;
+
+/// these fields will be populated inside the constructor
+  parsedContent: any = {};
+  promptForTypology: string = "";
+  promptForCardGen: string = "";
+  expectedFields: Array<string>;
+
+
+  typologyResponse: any = {};
+  cardgenResponse: any = {};
+  summarizeResponse = {};
+  gapFillResponse: any = {};
+
+
+  constructor(
+    apiKey: string,
+    model: string,
+    generationContent : any
+  ) {
+    this.api_key = apiKey;
+    this.openAiService = new OpenAiService(
+      apiKey,
+      model ?? "gpt-3.5-turbo-1106"
+    );
+    const parsedData = new ParseSourceContent(generationContent.content).parseData()
+    this.parsedContent = {
+      title: parsedData.title,
+      headings: parsedData.headings,
+      content: parsedData.content,
+
+    },
+    // parsedData.type == 'cards' ? this.typologyResponse = parsedData.taxonomy :  this.typologyResponse = null;
+    this.typologyResponse = parsedData.taxonomy
+    
+    this.expectedFields =  generationContent.content.fields; //returnFields();
+    this.promptForTypology = returnTypologyPrompt(generationContent.prompt.typology);
+    this.promptForCardGen = returnCardGenPrompt(generationContent.prompt.card_generation);
+  }
+
+
+ 
+  async generate(
+    generate_typology: boolean = false,
+    generate_card: boolean = false
+  ): Promise<Array<any>> {
+    let args = new GenerateArgs(generate_card, generate_typology, false, );
+    const responseToReturn = [];
+    const whatNeedsToBeGenerated = args.getWhatNeedsToBeGenerated();
+    for (let elem of whatNeedsToBeGenerated)
+      if (elem == "generate_tyopology") {
+        this.typologyResponse = await this.generateTypology(
+        this.promptForTypology
+        );
+        responseToReturn.push(this.typologyResponse);
+      } else if (elem == "generate_card") {
+        /// for cards gen to occur, there must be presence of source taxonomy
+        if(this.shouldTheCardBeGeneratedAfterTypologyResponse()){
+          this.cardgenResponse =  await this.generateCard(
+            this.promptForCardGen,
+            JSON.stringify(this.typologyResponse),
+            false,
+          )
+          responseToReturn.push(this.cardgenResponse);
+
+          /// check if gap fill is required ie coverage determination 
+          if(this.cardgenResponse.status_code == 200) {
+            this.gapFillResponse = await this.generationForGapFill(this.typologyResponse, this.cardgenResponse);
+            responseToReturn.push(this.gapFillResponse);
+          }
+
+        }
+    }
+    return responseToReturn;
+   // return [typologyPrompt, cardPrompt];
+  
+  }
+
+  shouldTheCardBeGeneratedAfterTypologyResponse(){
+    if(this.typologyResponse){
+      return this.typologyResponse.generate_cards.state == true;
+    }else{
+      return false;
+    }
+
+  }
+
+  async generationForGapFill(typologyData: any, cardGenData: any) {
+      let gapFill = gapFilling(typologyData, cardGenData);
+      let response :any ;
+      if (
+        gapFill.remainingConcepts.length !== 0 ||
+        gapFill.remainingFacts.length !== 0
+      ) {
+        response = await this.generateCard(
+         this.promptForCardGen +
+            "Generate cards only suitable for the given remaining concepts and facts" +
+            JSON.stringify(gapFill) +
+            "Exclude generating these cards",
+            JSON.stringify(cardGenData.cards_data),
+          true
+        );
+      }
+      return response;
+    
+  }
+
+
+
+  async generateCard(prompt: string, additionalContent: string, isGapFill: boolean) {
+    let generateCards = new GenerateCards(this.openAiService);
+    this.cardgenResponse = await generateCards.generateCards(
+      prompt ?? "",
+      this.parsedContent + additionalContent,
+      isGapFill
+    );
+  
+    // let response =  await this.openAiService?.sendRequest(prompt,this.parsedContent);
+    // response['type'] = 'card_gen';
+    return this.cardgenResponse;
+  }
+
+
+  async generateTypology(prompt: string) {
+    let response = await new GenerateTypology(
+      this.openAiService,
+      prompt,
+      JSON.stringify(this.parsedContent),
+      this.expectedFields
+    ).generate();
+    return response;
+  }
+
+  
+
+}