watson-developer-cloud
Advanced tools
Wrapper to use the Watson Developer Cloud services, a collection of REST APIs and SDKs that use cognitive computing to solve complex problems.
If you are having difficulties using the APIs or have a question about the IBM Watson Services, please ask a question on dW Answers or Stack Overflow.
$ npm install watson-developer-cloud --save
The examples below assume that you already have service credentials. If not, you will have to create and bind the service in Bluemix.
If you are running your application in Bluemix, you don't need to specify the
credentials; the wrapper will get them for you by looking at the VCAP_SERVICES
environment variable.
The credentials for the services are stored in the
VCAP_SERVICES environment variable. To get them, you need
to first create and bind the service to your application.
There are two ways to get the credentials. You can use Bluemix to access your
app and view the VCAP_SERVICES there or you can run:
$ cf env <application-name>
Example output:
System-Provided:
{
"VCAP_SERVICES": {
"visual_recognition": [{
"credentials": {
"password": "<password>",
"url": "<url>",
"username": "<username>"
},
"label": "visual_recognition",
"name": "visual-recognition-service",
"plan": "free"
}]
}
}
You need to copy username and password.
The Watson Developer Cloud offers a variety of services for building cognitive apps.
Fetch an ephemeral token for use with browser applications using the the [Authorization][authorization] service.
The token can then be passed in HTTP headers using the X-Watson-Authorization-Token header. Tokens are valid for 1 hour.
var watson = require('watson-developer-cloud');
var authorization = watson.authorization({
username: '<username>',
password: '<password>',
version: 'v1'
});
var params = {
// URL of the resource you wish to access
url: 'https://stream.watsonplatform.net/text-to-speech/api'
};
authorization.getToken(params, function (token) {
if (!token) {
console.log('error:', err);
} else {
// Use your token here
}
});
Map euphemisms or colloquial terms to more commonly understood phrases using the Concept Expansion service.
var watson = require('watson-developer-cloud');
var concept_expansion = watson.concept_expansion({
username: '<username>',
password: '<password>',
version: 'v1'
});
var params = {
seeds: ['motrin','tylenol','aspirin'],
dataset: 'mtsamples',
label: 'medications'
};
concept_expansion.expand(params, function (err, response) {
if (err)
console.log('error:', err);
else
console.log(JSON.stringify(response, null, 2));
});
Use the Concept Insights service to identify words in the text that correspond to concepts in a Wikipedia graph.
var watson = require('watson-developer-cloud');
var concept_insights = watson.concept_insights({
username: '<username>',
password: '<password>',
version: 'v1'
});
/*** Annotate Text ***/
var params = {
user: 'wikipedia',
graph: 'en-20120601',
text: 'IBM Watson won the Jeopardy television show hosted by Alex Trebek'
};
// Retrieve the concepts for input text
concept_insights.annotateText(params, function(err, res) {
if (err)
console.log(err);
else {
console.log("\n*** Annotate Text ***\n");
console.log(JSON.stringify(res, null, 2));
}
});
/*** Semantic Search ***/
var payload = {
func: 'semanticSearch',
ids: [
'/graph/wikipedia/en-20120601/Software_development_process',
'/graph/wikipedia/en-20120601/Programming_tool'
],
corpus: 'ibmresearcher',
user: 'public',
limit: 5
};
concept_insights.semanticSearch(payload, function(error, results) {
if (error)
console.log(error);
else {
console.log("\n*** Semantic Search ***\n");
console.log(JSON.stringify(results, null, 2));
}
});
Use the Dialog service to list all the dialogs you have.
var watson = require('watson-developer-cloud');
var dialog = watson.dialog({
username: '<username>',
password: '<password>',
version: 'v1'
});
dialog.getDialogs({}, function (err, dialogs) {
if (err)
console.log('error:', err);
else
console.log(JSON.stringify(dialogs, null, 2));
});
Identify a language using the Language Identification service.
var watson = require('watson-developer-cloud');
var language_identification = watson.language_identification({
username: '<username>',
password: '<password>',
version: 'v1'
});
language_identification.identify({
text: 'The language identification service takes text input and identifies the language used.' },
function (err, response) {
if (err)
console.log('error:', err);
else
console.log(JSON.stringify(response, null, 2));
});
Translate text from one language to another or idenfity a language using the Language Translation service.
var watson = require('watson-developer-cloud');
var language_translation = watson.language_translation({
username: '<username>',
password: '<password>',
version: 'v2'
});
language_translation.translate({
text: 'A sentence must have a verb', source : 'en', target: 'es' },
function (err, translation) {
if (err)
console.log('error:', err);
else
console.log(JSON.stringify(translation, null, 2));
});
language_identification.identify({
text: 'The language translation service takes text input and identifies the language used.' },
function (err, language) {
if (err)
console.log('error:', err);
else
console.log(JSON.stringify(language, null, 2));
});
Translate text from one language to another using the Machine Translation service.
var watson = require('watson-developer-cloud');
var machine_translation = watson.machine_translation({
username: '<username>',
password: '<password>',
version: 'v1'
});
machine_translation.translate({
text: 'A sentence must have a verb', from : 'enus', to: 'eses' },
function (err, response) {
if (err)
console.log('error:', err);
else
console.log(JSON.stringify(response, null, 2));
});
Get resonance information for individual words in a sentence from the Message Resonance service.
var watson = require('watson-developer-cloud');
var message_resonance = watson.message_resonance({
username: '<username>',
password: '<password>',
version:'v1'
});
message_resonance.resonance({
text: 'IBM Watson Developer Cloud', dataset: 1 },
function(err, response) {
if (err)
console.log('error:', err);
else
console.log(JSON.stringify(response, null, 2));
});
Use Natural Language Classifier service to create a classifier instance by providing a set of representative strings and a set of one or more correct classes for each as training. Then use the trained classifier to classify your new question for best matching answers or to retrieve next actions for your application.
var watson = require('watson-developer-cloud');
var natural_language_classifier = watson.natural_language_classifier({
username: '<username>',
password: '<password>',
version: 'v1'
});
natural_language_classifier.classify({
text: 'Is it sunny?',
classifier: '<classifier-id>' },
function(err, response) {
if (err)
console.log('error:', err);
else
console.log(JSON.stringify(response, null, 2));
});
For the command line interface and tutorial, See Natural Language Classifier CLI
Analyze text in english and get a personality profile by using the Personality Insights service.
var watson = require('watson-developer-cloud');
var personality_insights = watson.personality_insights({
username: '<username>',
password: '<password>',
version: 'v2'
});
personality_insights.profile({
text: 'Enter more than 100 unique words here...',
language: 'es' },
function (err, response) {
if (err)
console.log('error:', err);
else
console.log(JSON.stringify(response, null, 2));
});
Note: Don't forget to update the text variable!
Ask a healthcare-related question of the Question and Answer service.
var watson = require('watson-developer-cloud');
var question_and_answer_healthcare = watson.question_and_answer({
username: '<username>',
password: '<password>',
version: 'v1',
dataset: 'healthcare' /* The dataset can be specified when creating
* the service or when calling it */
});
question_and_answer_healthcare.ask({
text: 'What is HIV?'}, function (err, response) {
if (err)
console.log('error:', err);
else
console.log(JSON.stringify(response, null, 2));
});
Analyze an English news article and get the relationships between sentence components (nouns, verbs, subjects, objects, etc.) by using the Relationship Extraction service.
var watson = require('watson-developer-cloud');
var relationship_extraction = watson.relationship_extraction({
username: '<username>',
password: '<password>',
version: 'v1'
});
relationship_extraction.extract({
text: 'IBM Watson developer cloud',
dataset: 'ie-en-news' },
function (err, response) {
if (err)
console.log('error:', err);
else
console.log(JSON.stringify(response, null, 2));
});
Use the Speech to Text service to recognize the text from a .wav file.
var watson = require('watson-developer-cloud');
var fs = require('fs');
var speech_to_text = watson.speech_to_text({
username: '<username>',
password: '<password>',
version: 'v1',
url: 'https://stream.watsonplatform.net/speech-to-text/api'
});
var params = {
// From file
audio: fs.createReadStream('./resources/speech.wav'),
content_type: 'audio/l16; rate=44100'
};
speech_to_text.recognize(params, function(err, res) {
if (err)
console.log(err);
else
console.log(JSON.stringify(res, null, 2));
});
Use the Text to Speech service to synthesize text into a .wav file.
var watson = require('watson-developer-cloud');
var fs = require('fs');
var text_to_speech = watson.text_to_speech({
username: '<username>',
password: '<password>',
version: 'v1',
url: 'https://stream.watsonplatform.net/text-to-speech/api'
});
var params = {
text: 'Hello from IBM Watson',
voice: 'en-US_MichaelVoice', // Optional voice
accept: 'audio/wav'
};
// Pipe the synthesized text to a file
text_to_speech.synthesize(params).pipe(fs.createWriteStream('output.wav'));
Use the Tradeoff Analytics service to find the best phone that minimizes price and weight and maximizes screen size.
var watson = require('watson-developer-cloud');
var tradeoff_analytics = watson.tradeoff_analytics({
username: '<username>',
password: '<password>',
version: 'v1'
});
// From file
var params = require('./resources/problem.json');
tradeoff_analytics.dilemmas(params, function(err, res) {
if (err)
console.log(err);
else
console.log(JSON.stringify(res, null, 2));
});
Use the Visual Recognition service to recognize the following picture.
var watson = require('watson-developer-cloud');
var fs = require('fs');
var visual_recognition = watson.visual_recognition({
username: '<username>',
password: '<password>',
version: 'v1'
});
var params = {
// From file
image_file: fs.createReadStream('./resources/car.png')
};
visual_recognition.recognize(params, function(err, res) {
if (err)
console.log(err);
else
console.log(JSON.stringify(res, 'labels', 2));
});
By default, the wrapper tries to use the Bluemix VCAP_SERVICES environment
variable to get the credentials for a given service. You can avoid this by
using:
use_vcap_services.
var watson = require('watson-developer-cloud');
var concept_expansion = watson.concept_expansion({
version: 'v1',
use_vcap_services: false
});
This example fails because you did not provide a username and password and the wrapper will not look into Bluemix for these values.
By default, the wrapper tries to use Basic Auth and will ask for api_key or username and password and send an Authorization: Basic XXXXXXX. You can avoid this by using:
use_unauthenticated.
var watson = require('watson-developer-cloud');
var dialog = watson.dialog({
version: 'v1',
use_unauthenticated: true
});
This wrapper relies on the request npm module writted by
mikeal to call the Watson Services. To debug the apps, add
'request' to the NODE_DEBUG environment variable:
$ NODE_DEBUG='request' node app.js
where app.js is your Node.js file.
Running all the tests:
$ npm test
Running a specific test:
$ mocha -g '<test name>'
Find more open source projects on the IBM Github Page.
This library is licensed under Apache 2.0. Full license text is available in COPYING.
See CONTRIBUTING.
FAQs
Client library to use the IBM Watson Services
The npm package watson-developer-cloud receives a total of 3,929 weekly downloads. As such, watson-developer-cloud popularity was classified as popular.
We found that watson-developer-cloud demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."