Merge pull request #198 from watson-developer-cloud/tone-analyzer

Add tone_chat

Author: glennrfisher

examples/tone_analyzer_v3.py

@@ -8,3 +8,6 @@
     version='2016-02-11')
 
 print(json.dumps(tone_analyzer.tone(text='I am very happy'), indent=2))
+
+utterances = [{'text': 'I am very happy', 'user': 'glenn'}]
+print(json.dumps(tone_analyzer.tone_chat(utterances), indent=2))

resources/tone_response.json resources/tone-v3-expect1.jsonresources/tone_response.json renamed to resources/tone-v3-expect1.json

@@ -0,0 +1,30 @@
+{
+  "utterances_tone": [
+    {
+      "utterance_id": 0,
+      "utterance_text": "I am very happy",
+      "tones": [
+        {
+          "score": 0.875529,
+          "tone_id": "polite",
+          "tone_name": "polite"
+        },
+        {
+          "score": 0.838693,
+          "tone_id": "satisfied",
+          "tone_name": "satisfied"
+        },
+        {
+          "score": 0.844135,
+          "tone_id": "sympathetic",
+          "tone_name": "sympathetic"
+        },
+        {
+          "score": 0.916255,
+          "tone_id": "excited",
+          "tone_name": "excited"
+        }
+      ]
+    }
+  ]
+}

resources/tone-v3-expect2.json

@@ -5,11 +5,11 @@
 
 @responses.activate
 ## Simple test, just calling tone() with some text
-def test_success():
+def test_tone():
     tone_url = 'https://gateway.watsonplatform.net/tone-analyzer/api/v3/tone'
     tone_args = '?version=2016-05-19'
     tone_response = None
-    with open(os.path.join(os.path.dirname(__file__), '../resources/tone_response.json')) as response_json:
+    with open(os.path.join(os.path.dirname(__file__), '../resources/tone-v3-expect1.json')) as response_json:
         tone_response = response_json.read()
 
     responses.add(responses.POST, tone_url,
@@ -29,11 +29,11 @@ def test_success():
 
 @responses.activate
 ## Invoking tone() with some modifiers given in 'params': specific tones requested, and sentences skipped
-def test_with_args():
+def test_tone_with_args():
     tone_url = 'https://gateway.watsonplatform.net/tone-analyzer/api/v3/tone'
     tone_args = { 'version': '2016-05-19', 'tones': 'social', 'sentences': 'false' }
     tone_response = None
-    with open(os.path.join(os.path.dirname(__file__), '../resources/tone_response.json')) as response_json:
+    with open(os.path.join(os.path.dirname(__file__), '../resources/tone-v3-expect1.json')) as response_json:
         tone_response = response_json.read()
 
     responses.add(responses.POST, tone_url,
@@ -54,3 +54,25 @@ def test_with_args():
     assert actualArgs == tone_args
     assert responses.calls[0].response.text == tone_response
     assert len(responses.calls) == 1
+
+@responses.activate
+## Invoking tone_chat()
+def test_tone_chat():
+    tone_url = 'https://gateway.watsonplatform.net/tone-analyzer/api/v3/tone_chat'
+    tone_args = '?version=2016-05-19'
+    tone_response = None
+    with open(os.path.join(os.path.dirname(__file__), '../resources/tone-v3-expect2.json')) as response_json:
+        tone_response = response_json.read()
+
+    responses.add(responses.POST, tone_url,
+                  body=tone_response, status=200,
+                  content_type='application/json')
+
+    tone_analyzer = watson_developer_cloud.ToneAnalyzerV3("2016-05-19",
+            username="username", password="password")
+    utterances = [{'text': 'I am very happy', 'user': 'glenn'}]
+    tone_analyzer.tone_chat(utterances)
+
+    assert responses.calls[0].request.url == tone_url + tone_args
+    assert responses.calls[0].response.text == tone_response
+    assert len(responses.calls) == 1

test/test_tone_analyzer_v3.py

@@ -1,4 +1,4 @@
-# Copyright 2016 IBM All Rights Reserved.
+# Copyright 2017 IBM All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,15 +13,25 @@
 # limitations under the License.
 
 """
-The v3 Tone Analyzer service
-(https://www.ibm.com/watson/developercloud/tone-analyzer.html)
+The IBM Watson Tone Analyzer Service uses linguistic analysis to detect
+three types of tones from written text: emotions, social tendencies, and
+language style. Emotions identified include things like anger, cheerfulness
+and sadness. Identified social tendencies include things from the Big Five
+personality traits used by some psychologists. These include openness,
+conscientiousness, extraversion, agreeableness, and neuroticism. Identified
+language styles include things like confident, analytical, and tentative.
+Input email and other written media into the Tone Analyzer service, and use
+the results to determine if your writing comes across with the tone,
+personality traits, and writing style that you want for your intended
+audience.
 """
 
-from watson_developer_cloud.watson_developer_cloud_service import \
-    WatsonDeveloperCloudService
+from .watson_developer_cloud_service import WatsonDeveloperCloudService
 
 
 class ToneAnalyzerV3(WatsonDeveloperCloudService):
+    """Client for the ToneAnalyzer service."""
+
     default_url = 'https://gateway.watsonplatform.net/tone-analyzer/api'
     latest_version = '2016-05-19'
 
@@ -30,6 +40,10 @@ def __init__(self, version, url=default_url, **kwargs):
                                              **kwargs)
         self.version = version
 
+    #########################
+    # tone
+    #########################
+
     def tone(self, text, tones=None, sentences=None):
         """
         The tone API is the main API call: it analyzes the "tone" of a piece
@@ -51,3 +65,21 @@ def tone(self, text, tones=None, sentences=None):
         data = {'text': text}
         return self.request(method='POST', url='/v3/tone', params=params,
                             json=data, accept_json=True)
+
+    def tone_chat(self, utterances):
+        """
+        Analyze customer engagement tone.
+
+        Use the Tone Analyzer for Customer Engagement Endpoint to monitor
+        customer service and customer support conversations.
+
+        :param utterances: The content to be analyzed.
+        """
+        params = {'version': self.version}
+        data = {'utterances': utterances}
+        return self.request(
+            method='POST',
+            url='/v3/tone_chat',
+            params=params,
+            json=data,
+            accept_json=True)