@postalsys/email-text-tools 1.2.3 → 1.2.5

package/examples/{reply.js → summary.js}

@@ -1,7 +1,7 @@
 'use strict';
 
 const fs = require('fs').promises;
-const extractReply = require('../lib/extract-reply');
+const generateSummary = require('../lib/generate-summary');
 const simpleParser = require('mailparser').simpleParser;
 
 async function main() {
@@ -9,15 +9,17 @@ async function main() {
 
     const parsed = await simpleParser(eml);
 
-    const replyText = await extractReply(
+    const summary = await generateSummary(
         {
+            from: parsed.from.value,
+            subject: parsed.subject,
             html: parsed.html,
             text: parsed.text
         },
         process.env.OPENAI_API_KEY
     );
 
-    console.log(replyText);
+    console.log(summary);
 }
 
 main();

package/index.js

@@ -5,6 +5,6 @@ const htmlToText = require('./lib/html-to-text');
 const inlineHtml = require('./lib/inline-html');
 const inlineText = require('./lib/inline-text');
 const mimeHtml = require('./lib/mime-html');
-const extractReply = require('./lib/extract-reply');
+const generateSummary = require('./lib/generate-summary');
 
-module.exports = { textToHtml, htmlToText, inlineHtml, inlineText, mimeHtml, extractReply };
+module.exports = { textToHtml, htmlToText, inlineHtml, inlineText, mimeHtml, generateSummary };

package/lib/generate-summary.js

@@ -0,0 +1,143 @@
+'use strict';
+
+const packageData = require('../package.json');
+const htmlToText = require('../lib/html-to-text');
+const nodeFetch = require('node-fetch');
+const fetchCmd = global.fetch || nodeFetch;
+
+const MAX_TEXT_LENGTH = 6 * 1024;
+const OPENAI_API_URL = 'https://api.openai.com/v1/chat/completions';
+
+const SYSTEM_PROMPT = `
+I want you to act as an email client that processes emails and highlights important parts.
+You do not comment or explain anything.
+`
+    .replace(/\s+/g, ' ')
+    .trim();
+
+const USER_PROMPT = `
+Describe the sentiment of the email using one word. Use either "positive", "neutral" or "negative". Prefix the sentiment with "Sentiment:".
+On a separate line, write a one-sentence summary of the email. Prefix the summary with "Summary:".
+I want you to only reply with the sentiment and summary, do not write explanations. 
+All the text that follows from now on is the email message:
+`
+    .replace(/\s+/g, ' ')
+    .trim();
+
+async function generateSummary(message, apiToken) {
+    let text = message.text;
+    if (message.html && (!text || message.html.length > text.length * 10)) {
+        text = htmlToText(message.html);
+    }
+
+    text = text.trim();
+    if (text.length > MAX_TEXT_LENGTH) {
+        text = text.substring(0, MAX_TEXT_LENGTH);
+    }
+
+    let header = [];
+    if (message.subject) {
+        header.push(`Subject: ${message.subject}`);
+    }
+    if (message.from) {
+        let from = [].concat(message.from || []).shift();
+        header.push(`From: ${from.name || from.address}`);
+    }
+
+    if (header.length) {
+        text = `${header.join('\n')}
+
+${text}`;
+    }
+
+    let headers = {
+        'User-Agent': `${packageData.name}/${packageData.version}`,
+        Authorization: `Bearer ${apiToken}`,
+        'Content-Type': 'application/json'
+    };
+
+    let payload = {
+        model: 'gpt-3.5-turbo',
+        messages: [
+            {
+                role: 'system',
+                content: `${SYSTEM_PROMPT}`
+            },
+            {
+                role: 'user',
+                content: `${USER_PROMPT}
+
+${text}`
+            }
+        ]
+    };
+
+    let res = await fetchCmd(OPENAI_API_URL, {
+        method: 'post',
+        headers,
+        body: JSON.stringify(payload)
+    });
+
+    let data = await res.json();
+
+    console.log(`-----
+${text}
+----
+${JSON.stringify(data)}`);
+
+    if (!res.ok) {
+        if (data && data.error) {
+            let error = new Error(data.error.message || data.error);
+            if (data.error.code) {
+                error.code = data.error.code;
+            }
+
+            error.statusCode = res.status;
+            throw error;
+        }
+
+        let error = new Error('Failed to run API request');
+        error.statusCode = res.status;
+        throw error;
+    }
+
+    if (!data) {
+        throw new Error(`Failed to POST API request`);
+    }
+
+    let output =
+        data &&
+        data.choices &&
+        data.choices
+            .filter(msg => msg && msg.message && msg.message.role === 'assistant' && msg.message.content)
+            .sort((a, b) => ((a && a.index) || 0) - ((b && b.index) || 0))
+            .map(msg => msg.message.content)
+            .join('\n')
+            .trim()
+            .replace(/^\s*"|"\s*$/g, '')
+            .trim();
+
+    let structured = {};
+
+    let summaryMatch = output.match(/\bsummary:\s*(.*)$/im);
+    if (summaryMatch) {
+        structured.summary = summaryMatch[1].replace(/^["'\s]+|["'\s]+$/g, '');
+    }
+
+    let sentimentMatch = output.match(/\bsentiment:\s*(.*)$/im);
+    if (sentimentMatch) {
+        structured.sentiment = sentimentMatch[1].replace(/^["'\s]+|["'\s]+$/g, '').toLowerCase();
+    }
+
+    const response = Object.assign(
+        {
+            id: data && data.id,
+            tokens: data && data.usage && data.usage.total_tokens
+        },
+        structured
+    );
+
+    return response;
+}
+
+module.exports = generateSummary;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@postalsys/email-text-tools",
-    "version": "1.2.3",
+    "version": "1.2.5",
     "description": "Email text tools",
     "main": "index.js",
     "scripts": {
@@ -34,6 +34,6 @@
         "moment-timezone": "0.5.41",
         "node-fetch": "2.6.7",
         "node-html-parser": "6.1.5",
-        "tlds": "1.236.0"
+        "tlds": "1.237.0"
     }
 }

package/lib/extract-reply.js

@@ -1,93 +0,0 @@
-'use strict';
-
-const packageData = require('../package.json');
-const htmlToText = require('../lib/html-to-text');
-const nodeFetch = require('node-fetch');
-const fetchCmd = global.fetch || nodeFetch;
-
-const MAX_TEXT_LENGTH = 6 * 1024;
-const OPENAI_API_URL = 'https://api.openai.com/v1/chat/completions';
-
-const PROMPT = `If the following email message includes a reply text, return it. If the message ends with a courtesy greeting, do not include it in the response. Extract the main content text if the message does not contain a reply. Do not add a comment, only return the message text or an empty response if you can not detect any text content. Here is the email message content:`;
-
-async function extractReply(message, apiToken) {
-    let text = message.text;
-    if (!text && message.html) {
-        text = htmlToText(message.text);
-    }
-
-    text = text.trim();
-    if (text.length > MAX_TEXT_LENGTH) {
-        text = text.substring(0, MAX_TEXT_LENGTH);
-    }
-
-    let headers = {
-        'User-Agent': `${packageData.name}/${packageData.version}`,
-        Authorization: `Bearer ${apiToken}`,
-        'Content-Type': 'application/json'
-    };
-
-    let payload = {
-        model: 'gpt-3.5-turbo',
-        messages: [
-            {
-                role: 'user',
-                content: `${PROMPT}
-
-${text}`
-            }
-        ]
-    };
-
-    let res = await fetchCmd(OPENAI_API_URL, {
-        method: 'post',
-        headers,
-        body: JSON.stringify(payload)
-    });
-
-    let data = await res.json();
-
-    if (!res.ok) {
-        if (data && data.error) {
-            let error = new Error(data.error.message || data.error);
-            if (data.error.code) {
-                error.code = data.error.code;
-            }
-
-            error.statusCode = res.status;
-            throw error;
-        }
-
-        let error = new Error('Failed to run API request');
-        error.statusCode = res.status;
-        throw error;
-    }
-
-    if (!data) {
-        throw new Error(`Failed to POST API request`);
-    }
-
-    console.log('OPENAI RESPONSE', JSON.stringify(data, false, 2));
-
-    let output =
-        data &&
-        data.choices &&
-        data.choices
-            .filter(msg => msg && msg.message && msg.message.role === 'assistant' && msg.message.content)
-            .sort((a, b) => ((a && a.index) || 0) - ((b && b.index) || 0))
-            .map(msg => msg.message.content)
-            .join('\n')
-            .trim()
-            .replace(/^\s*"|"\s*$/g, '')
-            .trim();
-
-    const response = {
-        id: data && data.id,
-        tokens: data && data.usage && data.usage.total_tokens,
-        text: output
-    };
-
-    return response;
-}
-
-module.exports = extractReply;