Update Tone analyzer example as per issue #494

* updating tone_detection.js to remove social and language tones as per issue #494

* tone_detection.js es5 -> es6

* updating conversation instance version date to 2017-05-26 and watson-developer-cloud to 3.0.1 as per issue #494

* fix for issue #494: replacing emotionTone with tone as in the latest release of tone analyzer in which social tones are removed and only significant/dominant tones are returned.  Explicit interpretation of tone significance is no longer required.

* update for issue #494: fixing comments to replace emotionTone with tone, etc.

* issue #494: removing extra semi-colon, cleaning up comments, and removing `tone` in updateUserTone as it is never used.

Author: aprilwebster

examples/conversation_tone_analyzer_integration/package.json

@@ -8,7 +8,7 @@
   "dependencies": {
     "bluebird": "^3.4.1",
     "dotenv": "^2.0.0",
-    "watson-developer-cloud": "^2.0.3"
+    "watson-developer-cloud": "^3.0.1"
   },
   "engines": {
     "node": ">=4"

examples/conversation_tone_analyzer_integration/tone_conversation_integration.v1.js

@@ -41,7 +41,7 @@ require('dotenv').config({ silent: true });
 var conversation = new ConversationV1({
   username: process.env.CONVERSATION_USERNAME || '<conversation_username>',
   password: process.env.CONVERSATION_PASSWORD || '<conversation_password>',
-  version_date: ConversationV1.VERSION_DATE_2017_09_01
+  version_date: '2017-05-26'
 });
 
 /**
@@ -50,7 +50,7 @@ var conversation = new ConversationV1({
 var tone_analyzer = new ToneAnalyzerV3({
   username: process.env.TONE_ANALYZER_USERNAME || '<tone_analyzer_username>',
   password: process.env.TONE_ANALYZER_PASSWORD || '<tone_analyzer_password>',
-  version_date: '2016-05-19'
+  version_date: '2017-09-21'
 });
 
 /**

examples/conversation_tone_analyzer_integration/tone_detection.js

@@ -18,25 +18,6 @@
 
 var Promise = require('bluebird');
 
-/**
- * Thresholds for identifying meaningful tones returned by the Watson Tone Analyzer.  Current values are
- * based on the recommendations made by the Watson Tone Analyzer at
- * https://www.ibm.com/watson/developercloud/doc/tone-analyzer/understanding-tone.shtml
- * These thresholds can be adjusted to client/domain requirements.
- */
-var PRIMARY_EMOTION_SCORE_THRESHOLD = 0.5;
-var LANGUAGE_HIGH_SCORE_THRESHOLD = 0.75;
-var LANGUAGE_NO_SCORE_THRESHOLD = 0.0;
-var SOCIAL_HIGH_SCORE_THRESHOLD = 0.75;
-var SOCIAL_LOW_SCORE_THRESHOLD = 0.25;
-
-/**
- * Labels for the tone categories returned by the Watson Tone Analyzer
- */
-var EMOTION_TONE_LABEL = 'emotion_tone';
-var LANGUAGE_TONE_LABEL = 'language_tone';
-var SOCIAL_TONE_LABEL = 'social_tone';
-
 /**
  * Public functions for this module
  */
@@ -65,18 +46,14 @@ function invokeToneAsync(conversationPayload, tone_analyzer) {
 }
 
 /**
- * updateUserTone processes the Tone Analyzer payload to pull out the emotion, language and social
- * tones, and identify the meaningful tones (i.e., those tones that meet the specified thresholds).
- * The conversationPayload json object is updated to include these tones.
+ * updateUserTone processes the Tone Analyzer payload to identify the most significant tone
+ * (i.e., the tone with the largest score). The conversationPayload json object is updated
+ * to include these tones.
  * @param conversationPayload json object returned by the Watson Conversation Service
  * @param toneAnalyzerPayload json object returned by the Watson Tone Analyzer Service
  * @return conversationPayload where the user object has been updated with tone information from the toneAnalyzerPayload
  */
 function updateUserTone(conversationPayload, toneAnalyzerPayload, maintainHistory) {
-  var emotionTone = null;
-  var languageTone = null;
-  var socialTone = null;
-
   if (typeof conversationPayload.context === 'undefined') {
     conversationPayload.context = {};
   }
@@ -88,23 +65,9 @@ function updateUserTone(conversationPayload, toneAnalyzerPayload, maintainHistor
   // For convenience sake, define a variable for the user object
   var user = conversationPayload.context.user;
 
-  // Extract the tones - emotion, language and social
+  // Extract the document-level tones
   if (toneAnalyzerPayload && toneAnalyzerPayload.document_tone) {
-    toneAnalyzerPayload.document_tone.tone_categories.forEach(function(toneCategory) {
-      if (toneCategory.category_id === EMOTION_TONE_LABEL) {
-        emotionTone = toneCategory;
-      }
-      if (toneCategory.category_id === LANGUAGE_TONE_LABEL) {
-        languageTone = toneCategory;
-      }
-      if (toneCategory.category_id === SOCIAL_TONE_LABEL) {
-        socialTone = toneCategory;
-      }
-    });
-
-    updateEmotionTone(user, emotionTone, maintainHistory);
-    updateLanguageTone(user, languageTone, maintainHistory);
-    updateSocialTone(user, socialTone, maintainHistory);
+    updateTone(user, toneAnalyzerPayload.document_tone.tones, maintainHistory);
   }
 
   conversationPayload.context.user = user;
@@ -114,149 +77,48 @@ function updateUserTone(conversationPayload, toneAnalyzerPayload, maintainHistor
 
 /**
  * initToneContext initializes a user object containing tone data (from the Watson Tone Analyzer)
- * @return user json object with the emotion, language and social tones.  The current
- * tone identifies the tone for a specific conversation turn, and the history provides the conversation for
- * all tones up to the current tone for a conversation instance with a user.
+ * @return user json object. The current tone identifies the tone for a specific conversation turn,
+ * and the history provides the conversation for all tones up to the current tone for a conversation
+ * instance with a user.
  */
 function initUser() {
   return {
     user: {
       tone: {
-        emotion: {
-          current: null
-        },
-        language: {
-          current: null
-        },
-        social: {
-          current: null
-        }
+        current: null
       }
     }
   };
 }
 
 /**
- * updateEmotionTone updates the user emotion tone with the primary emotion - the emotion tone that has
- * a score greater than or equal to the EMOTION_SCORE_THRESHOLD; otherwise primary emotion will be 'neutral'
+ * updateTone updates the user tone with the primary tone - the tone with the largest score
  * @param user a json object representing user information (tone) to be used in conversing with the Conversation Service
- * @param emotionTone a json object containing the emotion tones in the payload returned by the Tone Analyzer
+ * @param tones an array containing the document-level tones in the payload returned by the Tone Analyzer
  */
-function updateEmotionTone(user, emotionTone, maintainHistory) {
+function updateTone(user, tones, maintainHistory) {
   var maxScore = 0.0;
-  var primaryEmotion = null;
-  var primaryEmotionScore = null;
+  var primaryTone = null;
+  var primaryToneScore = null;
 
-  emotionTone.tones.forEach(function(tone) {
+  tones.forEach(function(tone) {
     if (tone.score > maxScore) {
       maxScore = tone.score;
-      primaryEmotion = tone.tone_name.toLowerCase();
-      primaryEmotionScore = tone.score;
+      primaryTone = tone.tone_name.toLowerCase();
+      primaryToneScore = tone.score;
     }
   });
 
-  if (maxScore <= PRIMARY_EMOTION_SCORE_THRESHOLD) {
-    primaryEmotion = 'neutral';
-    primaryEmotionScore = null;
-  }
-
-  // update user emotion tone
-  user.tone.emotion.current = primaryEmotion;
+  // update user tone
+  user.tone.current = primaryTone;
 
   if (maintainHistory) {
-    if (typeof user.tone.emotion.history === 'undefined') {
-      user.tone.emotion.history = [];
+    if (typeof user.tone.history === 'undefined') {
+      user.tone.history = [];
     }
-    user.tone.emotion.history.push({
-      tone_name: primaryEmotion,
-      score: primaryEmotionScore
+    user.tone.history.push({
+      tone_name: primaryTone,
+      score: primaryToneScore
     });
   }
 }
-
-/**
- * updateLanguageTone updates the user with the language tones interpreted based on the specified thresholds
- * @param user a json object representing user information (tone) to be used in conversing with the Conversation Service
- * @param languageTone a json object containing the language tones in the payload returned by the Tone Analyzer
- */
-function updateLanguageTone(user, languageTone, maintainHistory) {
-  var currentLanguage = [];
-  var currentLanguageObject = [];
-
-  // Process each language tone and determine if it is high or low
-  languageTone.tones.forEach(function(tone) {
-    if (tone.score >= LANGUAGE_HIGH_SCORE_THRESHOLD) {
-      currentLanguage.push(tone.tone_name.toLowerCase() + '_high');
-      currentLanguageObject.push({
-        tone_name: tone.tone_name.toLowerCase(),
-        score: tone.score,
-        interpretation: 'likely high'
-      });
-    } else if (tone.score <= LANGUAGE_NO_SCORE_THRESHOLD) {
-      currentLanguageObject.push({
-        tone_name: tone.tone_name.toLowerCase(),
-        score: tone.score,
-        interpretation: 'no evidence'
-      });
-    } else {
-      currentLanguageObject.push({
-        tone_name: tone.tone_name.toLowerCase(),
-        score: tone.score,
-        interpretation: 'likely medium'
-      });
-    }
-  });
-
-  // update user language tone
-  user.tone.language.current = currentLanguage;
-  if (maintainHistory) {
-    if (typeof user.tone.language.history === 'undefined') {
-      user.tone.language.history = [];
-    }
-    user.tone.language.history.push(currentLanguageObject);
-  }
-}
-
-/**
- * updateSocialTone updates the user with the social tones interpreted based on the specified thresholds
- * @param user a json object representing user information (tone) to be used in conversing with the Conversation Service
- * @param socialTone a json object containing the social tones in the payload returned by the Tone Analyzer
- */
-function updateSocialTone(user, socialTone, maintainHistory) {
-  var currentSocial = [];
-  var currentSocialObject = [];
-
-  // Process each social tone and determine if it is high or low
-  socialTone.tones.forEach(function(tone) {
-    if (tone.score >= SOCIAL_HIGH_SCORE_THRESHOLD) {
-      currentSocial.push(tone.tone_name.toLowerCase() + '_high');
-      currentSocialObject.push({
-        tone_name: tone.tone_name.toLowerCase(),
-        score: tone.score,
-        interpretation: 'likely high'
-      });
-    } else if (tone.score <= SOCIAL_LOW_SCORE_THRESHOLD) {
-      currentSocial.push(tone.tone_name.toLowerCase() + '_low');
-      currentSocialObject.push({
-        tone_name: tone.tone_name.toLowerCase(),
-        score: tone.score,
-        interpretation: 'likely low'
-      });
-    } else {
-      currentSocialObject.push({
-        tone_name: tone.tone_name.toLowerCase(),
-        score: tone.score,
-        interpretation: 'likely medium'
-      });
-    }
-  });
-
-  // update user social tone
-  user.tone.social.current = currentSocial;
-  if (maintainHistory) {
-    if (typeof user.tone.social.history === 'undefined') {
-      user.tone.social.history = [];
-    }
-    user.tone.social.history.push(currentSocialObject);
-  }
-}