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 you already have service credentials. If not, you will have to create and bind the service in Bluemix. See the Getting Started page for more details.
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
The credentials for the services are stored in the VCAP_SERVICES environment variable. In order 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, password.
The Watson Developer Cloud offers a variety of services for building cognitive apps.
Example: 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));
});
Example: Use the Concept Insights 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'
});
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, response) {
if (err)
console.log(err);
else
console.log(JSON.stringify(response, null, 2));
});
Example: 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));
});
Example: 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));
});
Example: 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));
});
Example: Analyze text and get a personality profile 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: 'type more than 100 unique words here...' },
function (err, response) {
if (err)
console.log('error:', err);
else
console.log(JSON.stringify(response, null, 2));
});
Node: Don't forget to update the text variable!
Example: Ask a healthcare-related question to 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));
});
Example: Analyze an English news article and get the relationships between sentence components (nouns, verbs, subjects, objects, etc.) 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));
});
Example: Use the Speech to Text to recognize the text from a wav file.
var watson = require('watson-developer-cloud');
var request = require('request');
var speech_to_text = watson.speech_to_text({
username: '<username>',
password: '<password>',
version: 'v1'
});
var params = {
// From file
audio: request('http://speech-to-text-demo.mybluemix.net/audio/sample1.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));
});
Example: Use the Text to Speech 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'
});
var params = {
text: 'Hello from IBM Watson',
voice: 'VoiceEnUsMichael', // optional voice
accept: 'audio/wav'
};
// pipe the synthesized text to a file
text_to_speech.synthesize(params).pipe(fs.createWriteStream('output.wav'));
Example: Use the Tradeoff Analytics to find the best phone that minimize price and weight and maximize screen size.
var watson = require('watson-developer-cloud');
var tradeoff_analytics = watson.tradeoff_analytics({
username: '<username>',
password: '<password>',
version: 'v1'
});
var params = {
'subject': 'phone',
'columns': [{
'key': 'price',
'full_name': 'Price (Eur)',
'type': 'NUMERIC',
'is_objective': true,
'goal': 'MIN'
}, {
'key': 'RAM',
'full_name': 'RAM (MB)',
'type': 'NUMERIC',
'is_objective': false,
'goal': 'MAX'
}, {
'key': 'weight',
'full_name': 'Weight (gr)',
'type': 'NUMERIC',
'is_objective': true,
'goal': 'MIN'
}],
'options': [{
'key': ' 1',
'name': 'Samsung Galaxy S4 White',
'values': {
'weight': 130,
'price': 239,
'RAM': 2048
}
}, {
'key': '2',
'name': 'Samsung Galaxy S4 Black',
'values': {
'weight': 130,
'price': 240,
'RAM': 2048
}
}, {
'key': '3',
'name': 'Samsung Galaxy S3 White',
'values': {
'weight': 133,
'price': 79,
'RAM': 2048
}
}]
};
tradeoff_analytics.dilemmas(params, function(err, res) {
if (err)
console.log(err);
else
console.log(JSON.stringify(res, null, 2));
});
Example: Use the Visual Recognition service to recognize the picture below.
var watson = require('watson-developer-cloud');
var request = require('request');
var visual_recognition = watson.visual_recognition({
username: '<username>',
password: '<password>',
version: 'v1'
});
var params = {
image_file: request('http://visual-recognition-demo.mybluemix.net/images/horses.jpg')
};
visual_recognition.recognize(params, function(err, res) {
if (err)
console.log(err);
else
console.log(JSON.stringify(res, 'labels', 2));
});
By default the wrapper will try to use the Bluemix VCAP_SERVICES 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
});
The example above will fail because you did not provide a username and password and the wrapper will not look into Bluemix for those values.
This wrapper relies in the request npm module writted by mikeal to call the Watson Services. In order to debug add 'request' to the NODE_DEBUG:
$ NODE_DEBUG='request' app.js
where app.js is your nodejs 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."