chore(conversation): remove conversation service and all associated code

BREAKING CHANGE: The Conversation service will no longer be available To migrate your code, use the Assistant v1 or v2 service.
watson-developer-cloud · Oct 11, 2018 · c810de2 · c810de2
1 parent 83d9232
commit c810de2
Show file tree

Hide file tree

Showing 30 changed files with 114 additions and 8,349 deletions.
diff --git a/README.md b/README.md
@@ -282,7 +282,7 @@ function (err, token) {
 
 ### Assistant v2
 
-Use the [Assistant][conversation] service to determine the intent of a message.
+Use the [Assistant][assistant] service to determine the intent of a message.
 
 Note: You must first create a workspace via IBM Cloud. See [the documentation](https://console.bluemix.net/docs/services/conversation/index.html#about) for details.
 
@@ -314,7 +314,7 @@ assistant.message(
 
 ### Assistant v1
 
-Use the [Assistant][conversation] service to determine the intent of a message.
+Use the [Assistant][assistant] service to determine the intent of a message.
 
 Note: You must first create a workspace via IBM Cloud. See [the documentation](https://console.bluemix.net/docs/services/conversation/index.html#about) for details.
 
@@ -343,11 +343,6 @@ assistant.message(
 );
 ```
 
-
-### Conversation
-
-This service has been renamed to Assistant.
-
 ### Discovery
 
 Use the [Discovery Service][discovery] to search and analyze structured and unstructured data.
@@ -701,7 +696,6 @@ This library is licensed under Apache 2.0. Full license text is available in
 See [CONTRIBUTING](https://github.com/watson-developer-cloud/node-sdk/blob/master/.github/CONTRIBUTING.md).
 
 [assistant]: https://www.ibm.com/watson/services/conversation/
-[conversation]: https://www.ibm.com/watson/services/conversation/
 [discovery]: https://www.ibm.com/watson/services/discovery/
 [personality_insights]: https://www.ibm.com/watson/services/personality-insights/
 [visual_recognition]: https://www.ibm.com/watson/services/visual-recognition/

diff --git a/conversation/v1-generated.ts b/conversation/v1-generated.ts
diff --git a/conversation/v1.ts b/conversation/v1.ts
diff --git a/...on_tone_analyzer_integration/.env.example → ...nt_tone_analyzer_integration/.env.example b/...on_tone_analyzer_integration/.env.example → ...nt_tone_analyzer_integration/.env.example
@@ -1,7 +1,7 @@
 # see README.md for details
 
-CONVERSATION_USERNAME=<Conversation Username>
-CONVERSATION_PASSWORD=<Conversation Password>
+ASSISTANT_USERNAME=<Assistant Username>
+ASSISTANT_PASSWORD=<Assistant Password>
 WORKSPACE_ID=<Workspace ID>
 
 TONE_ANALYZER_USERNAME=<Tone Analyzer Username>

diff --git a/...tion_tone_analyzer_integration/.gitignore → ...tant_tone_analyzer_integration/.gitignore b/...tion_tone_analyzer_integration/.gitignore → ...tant_tone_analyzer_integration/.gitignore
diff --git a/examples/assistant_tone_analyzer_integration/README.md b/examples/assistant_tone_analyzer_integration/README.md
@@ -0,0 +1,30 @@
+# Assistant and Tone Analyzer Integration Example
+
+This example provides sample code for integrating [Tone Analyzer][tone_analyzer] and [Assistant][assistant].
+
+  * [tone_detection.js][tone_assistant_integration_example_tone_detection] - sample code to initialize a user object in the assistant payload's context (initUser), to call Tone Analyzer to retrieve tone for a user's input (invokeToneAsync), and to update tone in the user object in the assistant payload's context (updateUserTone).
+
+  * [tone_assistant_integration.v1.js][tone_assistant_integration_example] - sample code to use tone_detection.js to get and add tone to the payload and send a request to the Assistant Service's message endpoint.
+
+
+Requirements to run the sample code
+
+  * [Tone Analyzer Service credentials][bluemix_tone_analyzer_service]
+  * [Assistant Service credentials][bluemix_assistant_service]
+  * [Assistant Workspace ID][assistant_simple_workspace]
+
+Credentials & the Workspace ID can be set in environment properties, a .env file, or directly in the code.
+
+
+Command to run the sample code
+
+`npm install # just once, to download dependencies`
+`node tone_assistant_integration.v1.js`
+
+[assistant]: https://www.ibm.com/watson/services/conversation/
+[tone_analyzer]: https://www.ibm.com/watson/services/tone-analyzer/
+[bluemix_assistant_service]: https://console.bluemix.net/catalog/services/watson-assistant-formerly-conversation
+[bluemix_tone_analyzer_service]: https://console.ng.bluemix.net/catalog/services/tone-analyzer/
+[assistant_simple_workspace]: https://github.com/watson-developer-cloud/assistant-simple#workspace
+[tone_assistant_integration_example]: https://github.com/watson-developer-cloud/node-sdk/blob/master/examples/assistant_tone_analyzer_integration/tone_assistant_integration.v1.js
+[tone_assistant_integration_example_tone_detection]: https://github.com/watson-developer-cloud/node-sdk/blob/master/examples/assistant_tone_analyzer_integration/tone_detection.js
diff --git a/...ne_analyzer_integration/package-lock.json → ...ne_analyzer_integration/package-lock.json b/...ne_analyzer_integration/package-lock.json → ...ne_analyzer_integration/package-lock.json
diff --git a/...on_tone_analyzer_integration/package.json → ...nt_tone_analyzer_integration/package.json b/...on_tone_analyzer_integration/package.json → ...nt_tone_analyzer_integration/package.json
@@ -1,8 +1,8 @@
 {
-  "name": "conversation_tone_analyzer_integration",
+  "name": "assistant_tone_analyzer_integration",
   "version": "1.0.0",
-  "description": "Example combining the Watson Conversation and Tone Analyzer services",
-  "main": "tone_conversation_integration.v1.js",
+  "description": "Example combining the Watson Assistant and Tone Analyzer services",
+  "main": "tone_assistant_integration.v1.js",
   "author": "https://github.com/aprilwebster",
   "license": "Apache-2.0",
   "dependencies": {
@@ -11,6 +11,6 @@
     "watson-developer-cloud": "latest"
   },
   "engines": {
-    "node": ">=4"
+    "node": ">=6"
   }
 }