Skip to content

Latest commit

 

History

History
48 lines (36 loc) · 1.78 KB

README.md

File metadata and controls

48 lines (36 loc) · 1.78 KB
Raw

Text Summary for Personality Insights

last-release npm-version npm-license npm-downloads

Generate a text summary for a specified personality profile (v2 or v3).

Installation

$ npm install personality-text-summary

Usage

  var PersonalityTextSummaries = require('personality-text-summary');

  // locale is one of {'en', 'es', 'ja', 'ko'}.  version refers to which version of Watson Personality Insights to use, v2 or v3.
  var v3EnglishTextSummaries = new PersonalityTextSummaries({ locale: 'en', version: 'v3' });

  // retrieve the summary for a specified personality profile (json)
  var textSummary  = v3EnglishTextSummaries.getSummary(myV3EnPersonalityProfile);
  console.log('The summary for the provided profile is ' + textSummary);

A few helper methods also exist to get additional text information:

  var facet = v3EnglishTextSummaries.getFacet('facet_intellect');
  /*
    "LowTerm": "Concrete",
    "HighDescription": "You are open to and intrigued by new ideas and love to explore them",
    "HighTerm": "Philosophical",
    "LowDescription": "You prefer dealing with the world as it is, rarely considering abstract ideas",
    "Big5": "big5_openness"
  */

License

This library is licensed under Apache 2.0. Full license text is available in LICENSE.

Changelog

01-01-2017

  • Added v3 summary