@aj-archipelago/cortex 0.0.5 → 0.0.7

package/pathways/edit.js

@@ -1,4 +1,10 @@
+// edit.js
+// Grammar and spelling correction module
+// This module exports a prompt that takes an input text and corrects all spelling and grammar errors found within the text.
+
 module.exports = {
+    // Set the temperature to 0 to favor more deterministic output when generating corrections.
     temperature: 0,
+
     prompt: `Correct all spelling and grammar errors in the input text.\n\nInput:\n{{text}}\n\nOutput:\n`
 }

package/pathways/entities.js

@@ -1,9 +1,21 @@
+// entities.js
+// Entity extraction module
+// This module exports a prompt that takes an input text and extracts the top entities and their definitions as specified by the count parameter.
+
 module.exports = {
+    // Set the temperature to 0 to favor more deterministic output when generating entity extraction.
     temperature: 0,
+
     prompt: `{{text}}\n\nList the top {{count}} entities and their definitions for the above in the format {{format}}:`,
+
+    // Define the format for displaying the extracted entities and their definitions.
     format: `(name: definition)`,
+
+    // Define input parameters for the prompt, such as the number of entities to extract.
     inputParameters: {
         count: 5,
     },
+
+    // Set the list option to true as the prompt is expected to return a list of entities.
     list: true,
 }

package/pathways/index.js

@@ -7,6 +7,6 @@ module.exports = {
     "paraphrase": require('./paraphrase'),
     "sentiment": require('./sentiment'),
     "summary": require('./summary'),
-    "topics": require('./topics'),
+    "transcribe": require('./transcribe'),
     "translate": require('./translate'),
 }

package/pathways/paraphrase.js

@@ -1,3 +1,7 @@
+// paraphrase.js
+// Paraphrasing module
+// This module exports a prompt that takes an input text and rewrites it in a different way while maintaining the original meaning.
+
 module.exports = {
     prompt: `Rewrite the following:\n\n{{{text}}}`
 }

package/pathways/sentiment.js

@@ -1,3 +1,7 @@
+// sentiment.js
+// Sentiment detection module
+// This module exports a prompt that takes an input text and asks how it makes the AI feel.
+
 module.exports = {
-    prompt: `How does this article make you feel?\n\n{{text}}`,
+    prompt: `How does the text below make you feel?\n\n{{text}}`,
 }

package/pathways/summary.js

@@ -1,43 +1,60 @@
+// summary.js
+// Text summarization module with custom resolver
+// This module exports a prompt that takes an input text and generates a summary using a custom resolver.
+
+// Import required modules
 const { semanticTruncate } = require('../graphql/chunker');
 const { PathwayResolver } = require('../graphql/pathwayResolver');
 
 module.exports = {
+    // The main prompt function that takes the input text and asks to generate a summary.
     prompt: `{{{text}}}\n\nWrite a summary of the above text:\n\n`,
 
+    // Define input parameters for the prompt, such as the target length of the summary.
     inputParameters: {
-        targetLength: 500,
+        targetLength: 0,
     },
+
+    // Custom resolver to generate summaries by reprompting if they are too long or too short.
     resolver: async (parent, args, contextValue, info) => {
         const { config, pathway, requestState } = contextValue;
         const originalTargetLength = args.targetLength;
+
+        // If targetLength is not provided, execute the prompt once and return the result.
+        if (originalTargetLength === 0) {
+            let pathwayResolver = new PathwayResolver({ config, pathway, args, requestState });
+            return await pathwayResolver.resolve(args);
+        }
+
         const errorMargin = 0.2;
         const lowTargetLength = originalTargetLength * (1 - errorMargin);
         const targetWords = Math.round(originalTargetLength / 6.6);
 
-        // if the text is shorter than the summary length, just return the text
+        // If the text is shorter than the summary length, just return the text.
         if (args.text.length <= originalTargetLength) {
             return args.text;
         }
 
         const MAX_ITERATIONS = 5;
         let summary = '';
-        let bestSummary = '';
-        let pathwayResolver = new PathwayResolver({ config, pathway, requestState });
-        // modify the prompt to be words-based instead of characters-based
+        let pathwayResolver = new PathwayResolver({ config, pathway, args, requestState });
+
+        
+        // Modify the prompt to be words-based instead of characters-based.
         pathwayResolver.pathwayPrompt = `{{{text}}}\n\nWrite a summary of the above text in exactly ${targetWords} words:\n\n`
 
         let i = 0;
-        // reprompt if summary is too long or too short
+        // Reprompt if summary is too long or too short.
         while (((summary.length > originalTargetLength) || (summary.length < lowTargetLength)) && i < MAX_ITERATIONS) {
             summary = await pathwayResolver.resolve(args);
             i++;
         }
 
-        // if the summary is still too long, truncate it
+        // If the summary is still too long, truncate it.
         if (summary.length > originalTargetLength) {
             return semanticTruncate(summary, originalTargetLength);
         } else {
             return summary;
         }
     }
-}
+}

package/pathways/transcribe.js

@@ -0,0 +1,8 @@
+module.exports = {
+    prompt: `{{text}}`,
+    model: `oai-whisper`,
+    inputParameters: {
+        file: ``,
+    },
+    timeout: 600, // in seconds
+}

package/pathways/translate.js

@@ -1,9 +1,18 @@
-// Description: Translate a text from one language to another
+// translate.js
+// Translation module
+// This module exports a prompt that takes an input text and translates it from one language to another.
 
 module.exports = {
+    // Set the temperature to 0 to favor more deterministic output when generating translations.
     temperature: 0,
+
     prompt: `Translate the following text to {{to}}:\n\nOriginal Language:\n{{{text}}}\n\n{{to}}:\n`,
+
+    // Define input parameters for the prompt, such as the target language for translation.
     inputParameters: {
         to: `Arabic`,
     },
+
+    // Set the timeout for the translation process, in seconds.
+    timeout: 300,
 }

package/tests/chunking.test.js

@@ -4,6 +4,11 @@ jest.setTimeout(1800000);
 
 const testServer = getTestServer();
 
+//stop server after all tests
+afterAll(async () => {
+    await testServer.stop();
+});
+
 it('chunking test of translate endpoint with huge text', async () => {
     const response = await testServer.executeOperation({
         query: 'query translate($text: String!) { translate(text: $text) { result } }',

package/tests/main.test.js

@@ -14,6 +14,11 @@ const getTestServer = () => {
 
 const testServer = getTestServer();
 
+//stop server after all tests
+afterAll(async () => {
+    await testServer.stop();
+});
+
 it('validates bias endpoint', async () => {
     const response = await testServer.executeOperation({
         query: 'query bias($text: String!) { bias(text: $text) { result } }',
@@ -88,19 +93,6 @@ it('validates summary endpoint', async () => {
     expect(response.data?.summary.result).toBeDefined();
 });
 
-it('validates topics endpoint with given num of count return', async () => {
-    const response = await testServer.executeOperation({
-        query: 'query topics($text: String!, $count: Int) { topics(text: $text, count: $count) { result } }',
-        variables: { text: 'hello there my dear world!', count: 3 },
-    });
-
-    expect(response.errors).toBeUndefined();
-    expect(response.data?.topics.result.length).toBe(3);
-    response.data?.topics.result.forEach((topic) => {
-        expect(topic).toBeDefined();
-    });
-});
-
 module.exports = {
     getTestServer,
 };

package/tests/translate.test.js

@@ -4,6 +4,11 @@ jest.setTimeout(1800000);
 
 const testServer = getTestServer();
 
+//stop server after all tests
+afterAll(async () => {
+    await testServer.stop();
+});
+
 it('test translate endpoint with huge arabic text english translation and check return non-arabic/english', async () => {
     const response = await testServer.executeOperation({
         query: 'query translate($text: String!, $to:String) { translate(text: $text, to:$to) { result } }',

package/pathways/topics.js

@@ -1,9 +0,0 @@
-module.exports = {
-    prompt: [`{{text}}\n\nList the top {{count}} news categories for the above article (e.g. 1. Finance):`,
-            `{{previousResult}}\n\nPick the {{count}} most important news categories from the above:`
-    ],
-    inputParameters: {
-        count: 5,
-    },
-    list: true,
-}