Merge pull request #77 from gjs29/master

Rename Search client to Retrieve and Rank

Author: jsstylos

examples/search_lifecycle.v1.js renamed to examples/retrieve_and_rank_lifecycle.v1.js

@@ -3,7 +3,7 @@
 var watson = require('watson-developer-cloud');
 var async  = require('async');
 
-var search = watson.search({
+var retrieve = watson.retrieve_and_rank({
   username: 'INSERT YOUR USERNAME FOR THE SERVICE HERE',
   password: 'INSERT YOUR PASSWORD FOR THE SERVICE HERE',
   version: 'v1',
@@ -15,13 +15,13 @@ var clusterId;
 async.series([
   function deleteExistingClusters(done) {
     console.log('Deleting exisiting Solr clusters.');
-    search.deleteClusters({}, function(err, res) {
+    retrieve.deleteClusters({}, function(err, res) {
       printResponse(err, 'Error deleting exisiting Solr clusters: ', res, done);
     });
   },
 
   function createCluster(done) {
-    search.createCluster({}, function getId(err, res) {
+    retrieve.createCluster({}, function getId(err, res) {
       if (err) {
         return console.log('Error creating Solr cluster: ' + JSON.stringify(err));
       }
@@ -37,21 +37,21 @@ async.series([
 
   function listClusters(done) {
     console.log('Listing Solr clusters.');
-    search.listClusters({}, function(err, res) {
+    retrieve.listClusters({}, function(err, res) {
       printResponse(err, 'Error listing Solr clusters: ', res, done);
     });
   },
 
   function deleteCluster(done) {
     console.log('Deleting Solr cluster ' + clusterId);
-    search.deleteCluster({clusterId: clusterId}, function(err) {
+    retrieve.deleteCluster({clusterId: clusterId}, function(err) {
       printResponse(err, 'Error deleting Solr cluster: ', 'Deleted Solr cluster ' + clusterId, done);
     });
   }
 ]);
 
 function waitForCluster(clusterId, callback) {
-  search.pollCluster({clusterId: clusterId}, function isReady(err, res) {
+  retrieve.pollCluster({clusterId: clusterId}, function isReady(err, res) {
     if(err) {
       return console.log('Error polling Solr cluster: ' + JSON.stringify(err, null, 2));
     }

examples/search_solr.v1.js renamed to examples/retrieve_and_rank_solr.v1.js

@@ -6,19 +6,19 @@ var async  = require('async');
 var username = 'INSERT YOUR USERNAME FOR THE SERVICE HERE';
 var password = 'INSERT YOUR PASSWORD FOR THE SERVICE HERE';
 
-var search = watson.search({
+var retrieve = watson.retrieve_and_rank({
   username: username,
   password: password,
   version: 'v1',
-  url: 'https://gateway.watsonplatform.net/search/api'
+  url: 'https://gateway.watsonplatform.net/retrieve/api'
 });
 
 var clusterId = 'INSERT YOUR CLUSTER ID HERE';
 var collectionName = 'example_collection';
 var configName     = 'example_config';
 var configZipPath = 'path/to/config.zip';
 
-var solrClient = search.createSolrClient({
+var solrClient = retrieve.createSolrClient({
   clusterId: clusterId,
   collectionName: collectionName,
   username: username,
@@ -28,7 +28,7 @@ var solrClient = search.createSolrClient({
 async.series([
   function uploadConfig(done) {
     console.log('Uploading Solr config ' +  configName);
-    search.uploadConfig({
+    retrieve.uploadConfig({
         clusterId: clusterId,
         configName: configName,
         configZipPath: configZipPath
@@ -41,14 +41,14 @@ async.series([
 
   function listConfigs(done) {
     console.log('Listing Solr configs for cluster ' + clusterId);
-    search.listConfigs({clusterId: clusterId}, function(err, res) {
+    retrieve.listConfigs({clusterId: clusterId}, function(err, res) {
       printResponse(err, 'Error listing Solr configs: ', res, done);
     });
   },
 
   function getConfig(done) {
     console.log('Getting Solr config ' + configName);
-    search.getConfig({
+    retrieve.getConfig({
       clusterId: clusterId,
       configName: configName
     }, function(err) {
@@ -63,7 +63,7 @@ async.series([
   },
 
   function createCollection(done) {
-    search.createCollection({
+    retrieve.createCollection({
       clusterId: clusterId,
       collectionName: collectionName,
       configName: configName
@@ -74,7 +74,7 @@ async.series([
   },
 
   function listCollections(done) {
-    search.listCollections({clusterId: clusterId}, function(err, res) {
+    retrieve.listCollections({clusterId: clusterId}, function(err, res) {
       printResponse(err, 'Error listing Solr collections: ', res, done);
     });
   },
@@ -117,7 +117,7 @@ async.series([
 
   function deleteCollection(done) {
     console.log('Deleting Solr collection ' + collectionName);
-    search.deleteCollection({
+    retrieve.deleteCollection({
       clusterId: clusterId,
       collectionName: collectionName
     }, function(err) {
@@ -128,7 +128,7 @@ async.series([
 
   function deleteConfig(done) {
     console.log('Deleting Solr config ' + configName);
-    search.deleteConfig({
+    retrieve.deleteConfig({
       clusterId: clusterId,
       configName: configName
     }, function(err) {

lib/index.js

@@ -106,8 +106,9 @@ var watson = {};
   'language_translation',
   'tone_analyzer',
   'dialog',
-  'search',
+  'retrieve_and_rank',
   // deprecated
+  'search',
   'language_identification',
   'machine_translation',
   'user_modeling',