Merge pull request #568 from watson-developer-cloud/release-2.1.1

Release 2.1.0

Author: ehdsouza

README.md

@@ -25,6 +25,7 @@ Python client library to quickly get started with the various [Watson APIs][wdc]
   * [Changes for v2.0](#changes-for-v20)
   * [Migration](#migration)
   * [Configuring the http client](#configuring-the-http-client-supported-from-v110)
+  * [Disable SSL certificate verification](#disable-ssl-certificate-verification)
   * [Sending request headers](#sending-request-headers)
   * [Parsing HTTP response info](#parsing-http-response-info)
   * [Dependencies](#dependencies)
@@ -106,40 +107,42 @@ You supply either an IAM service **API key** or an **access token**:
 
 ```python
 # In the constructor, letting the SDK manage the IAM token
-discovery = DiscoveryV1(version='2017-10-16',
+discovery = DiscoveryV1(version='2018-08-01',
+                        url='<url_as_per_region>',
                         iam_apikey='<iam_apikey>',
                         iam_url='<iam_url>') # optional - the default value is https://iam.bluemix.net/identity/token
 ```
 
 ```python
 # after instantiation, letting the SDK manage the IAM token
-discovery = DiscoveryV1(version='2017-10-16')
+discovery = DiscoveryV1(version='2018-08-01', url='<url_as_per_region>')
 discovery.set_iam_apikey('<iam_apikey>')
 ```
 
 #### Supplying the access token
 ```python
 # in the constructor, assuming control of managing IAM token
-discovery = DiscoveryV1(version='2017-10-16',
+discovery = DiscoveryV1(version='2018-08-01',
+                        url='<url_as_per_region>',
                         iam_access_token='<iam_access_token>')
 ```
 
 ```python
 # after instantiation, assuming control of managing IAM token
-discovery = DiscoveryV1(version='2017-10-16')
+discovery = DiscoveryV1(version='2018-08-01', url='<url_as_per_region>')
 discovery.set_iam_access_token('<access_token>')
 ```
 
 ### Username and password
 ```python
 from watson_developer_cloud import DiscoveryV1
 # In the constructor
-discovery = DiscoveryV1(version='2017-10-16', username='<username>', password='<password>')
+discovery = DiscoveryV1(version='2018-08-01', url='<url_as_per_region>', username='<username>', password='<password>')
 ```
 
 ```python
 # After instantiation
-discovery = DiscoveryV1(version='2017-10-16')
+discovery = DiscoveryV1(version='2018-08-01', url='<url_as_per_region>')
 discovery.set_username_and_password('<username>', '<password>')
 ```
 
@@ -150,12 +153,12 @@ discovery.set_username_and_password('<username>', '<password>')
 ```python
 from watson_developer_cloud import VisualRecognitionV3
 # In the constructor
-visual_recognition = VisualRecognitionV3(version='2018-05-22', api_key='<api_key>')
+visual_recognition = VisualRecognitionV3(version='2018-03-19', url='<url_as_per_region>', api_key='<api_key>')
 ```
 
 ```python
 # After instantiation
-visual_recognition = VisualRecognitionV3(version='2018-05-22')
+visual_recognition = VisualRecognitionV3(version='2018-03-19')
 visual_recognition.set_api_key('<api_key>')
 ```
 
@@ -174,7 +177,8 @@ from watson_developer_cloud import AssistantV1
 assistant = AssistantV1(
     username='xxx',
     password='yyy',
-    version='2017-04-21')
+    url='<url_as_per_region>',
+    version='2018-07-10')
 
 response = assistant.list_workspaces(headers={'Custom-Header': 'custom_value'})
 print(response.get_result())
@@ -195,14 +199,22 @@ from watson_developer_cloud import AssistantV1
 assistant = AssistantV1(
     username='xxx',
     password='yyy',
-    version='2017-04-21')
+    url='<url_as_per_region>',
+    version='2018-07-10')
 
 assistant.set_http_config({'timeout': 100})
 response = assistant.message(workspace_id=workspace_id, input={
     'text': 'What\'s the weather like?'}).get_result()
 print(json.dumps(response, indent=2))
 ```
 
+## Disable SSL certificate verification
+For ICP(IBM Cloud Private), you can disable the SSL certificate verification by:
+
+```python
+service.disable_SSL_verification()
+```
+
 ## Sending request headers
 Custom headers can be passed in any request in the form of a `dict` as:
 ```python
@@ -218,7 +230,8 @@ from watson_developer_cloud import AssistantV1
 assistant = AssistantV1(
     username='xxx',
     password='yyy',
-    version='2017-04-21')
+    url='<url_as_per_region>',
+    version='2018-07-10')
 
 response = assistant.list_workspaces(headers={'Custom-Header': 'custom_value'}).get_result()
 ```
@@ -231,7 +244,8 @@ from watson_developer_cloud import AssistantV1
 assistant = AssistantV1(
     username='xxx',
     password='yyy',
-    version='2017-04-21')
+    url='<url_as_per_region>',
+    version='2018-07-10')
 
 assistant.set_detailed_response(True)
 response = assistant.list_workspaces(headers={'Custom-Header': 'custom_value'}).get_result()

examples/assistant_v1.py

@@ -4,7 +4,7 @@
 
 # If service instance provides API key authentication
 # assistant = AssistantV1(
-#     version='2017-04-21',
+#     version='2018-07-10',
 #     ## url is optional, and defaults to the URL below. Use the correct URL for your region.
 #     url='https://gateway.watsonplatform.net/assistant/api',
 #     iam_apikey='iam_apikey')
@@ -14,7 +14,7 @@
     password='YOUR SERVICE PASSWORD',
     ## url is optional, and defaults to the URL below. Use the correct URL for your region.
     # url='https://gateway.watsonplatform.net/assistant/api',
-    version='2017-04-21')
+    version='2018-07-10')
 
 #########################
 # Workspaces

examples/assistant_v2.py

@@ -0,0 +1,41 @@
+from __future__ import print_function
+import json
+from watson_developer_cloud import AssistantV2
+
+# If service instance provides API key authentication
+# assistant = AssistantV2(
+#     version='2017-04-21',
+#     ## url is optional, and defaults to the URL below. Use the correct URL for your region.
+#     url='https://gateway.watsonplatform.net/assistant/api',
+#     iam_apikey='iam_apikey')
+
+assistant = AssistantV2(
+    username='YOUR SERVICE USERNAME',
+    password='YOUR SERVICE PASSWORD',
+    ## url is optional, and defaults to the URL below. Use the correct URL for your region.
+    url='https://gateway.watsonplatform.net/assistant/api',
+    version='2017-04-21')
+
+#########################
+# Sessions
+#########################
+
+session = assistant.create_session("<YOUR ASSISTANT ID>").get_result()
+print(json.dumps(session, indent=2))
+
+assistant.delete_session("<YOUR ASSISTANT ID>", "<YOUR SESSION ID>").get_result()
+
+#########################
+# Message
+#########################
+
+message = assistant.message(
+    "<YOUR ASSISTANT ID>",
+    "<YOUR SESSION ID>",
+    input={'text': 'What\'s the weather like?'},
+    context={
+        'metadata': {
+            'deployment': 'myDeployment'
+        }
+    }).get_result()
+print(json.dumps(message, indent=2))

examples/conversation_v1.py

@@ -4,7 +4,7 @@
 
 ## If service instance provides API key authentication
 # conversation = ConversationV1(
-#     version='2018-02-16',
+#     version='2018-07-10',
 #     ## url is optional, and defaults to the URL below. Use the correct URL for your region.
 #     url='https://gateway.watsonplatform.net/conversation/api',
 #     iam_apikey='iam_apikey')
@@ -14,7 +14,7 @@
     password='YOUR SERVICE PASSWORD',
     ## url is optional, and defaults to the URL below. Use the correct URL for your region.
     # url='https://gateway.watsonplatform.net/conversation/api',
-    version='2018-02-16')
+    version='2018-07-10')
 
 # When you send multiple requests for the same conversation, include the
 # context object from the previous response.

examples/discovery_v1.py

@@ -5,13 +5,13 @@
 
 # If service instance provides API key authentication
 # discovery = DiscoveryV1(
-#     version='2017-10-16',
+#     version='2018-08-01',
 #     ## url is optional, and defaults to the URL below. Use the correct URL for your region.
 #     url='https://gateway.watsonplatform.net/discovery/api',
 #     iam_apikey='iam_apikey')
 
 discovery = DiscoveryV1(
-    version='2017-10-16',
+    version='2018-08-01',
     ## url is optional, and defaults to the URL below. Use the correct URL for your region.
     # url='https://gateway.watsonplatform.net/discovery/api',
     username='YOUR SERVICE USERNAME',

examples/language_translator_v3.py

@@ -4,14 +4,14 @@
 from watson_developer_cloud import LanguageTranslatorV3
 
 # language_translator = LanguageTranslatorV3(
-#     version='2018-05-31',
+#     version='2018-05-01.',
 #     ### url is optional, and defaults to the URL below. Use the correct URL for your region.
 #     # url='https://gateway.watsonplatform.net/language-translator/api',
 #     iam_apikey='your_apikey')
 
 # Authenticate with username/password if your service instance doesn't provide an API key
 language_translator = LanguageTranslatorV3(
-    version='2018-05-31',
+    version='2018-05-01.',
     username='YOUR SERVICE USERNAME',
     password='YOUR SERVICE PASSWORD')
 

examples/microphone-speech-to-text.py

@@ -74,7 +74,8 @@ def recognize_using_weboscket(*args):
     mycallback = MyRecognizeCallback()
     speech_to_text.recognize_using_websocket(audio=audio_source,
                                              content_type='audio/l16; rate=44100',
-                                             recognize_callback=mycallback)
+                                             recognize_callback=mycallback,
+                                             interim_results=True)
 
 ###############################################
 #### Prepare the for recording using Pyaudio ##

examples/natural_language_understanding_v1.py

@@ -5,13 +5,13 @@
 
 # If service instance provides API key authentication
 # service = NaturalLanguageUnderstandingV1(
-#     version='2017-02-27',
+#     version='2018-03-16',
 #     ## url is optional, and defaults to the URL below. Use the correct URL for your region.
 #     url='https://gateway.watsonplatform.net/natural-language-understanding/api',
 #     iam_apikey='your_apikey')
 
 service = NaturalLanguageUnderstandingV1(
-    version='2017-02-27',
+    version='2018-03-16',
     ## url is optional, and defaults to the URL below. Use the correct URL for your region.
     # url='https://gateway.watsonplatform.net/natural-language-understanding/api',
     username='YOUR SERVICE USERNAME',

examples/personality_insights_v3.py

@@ -6,21 +6,26 @@
 import json
 from os.path import join, dirname
 from watson_developer_cloud import PersonalityInsightsV3
+import csv
 
 # # If service instance provides API key authentication
 # service = PersonalityInsightsV3(
-#     version='2016-10-20',
+#     version='2017-10-13',
 #     ## url is optional, and defaults to the URL below. Use the correct URL for your region.
 #     url='https://gateway.watsonplatform.net/personality-insights/api',
 #     iam_apikey='your_apikey')
 
 service = PersonalityInsightsV3(
-    version='2016-10-20',
+    version='2017-10-13',
     ## url is optional, and defaults to the URL below. Use the correct URL for your region.
     # url='https://gateway.watsonplatform.net/personality-insights/api',
     username='YOUR SERVICE USERNAME',
     password='YOUR SERVICE PASSWORD')
 
+############################
+# Profile with JSON output #
+############################
+
 with open(join(dirname(__file__), '../resources/personality-v3.json')) as \
         profile_json:
     profile = service.profile(
@@ -30,3 +35,21 @@
         consumption_preferences=True).get_result()
 
     print(json.dumps(profile, indent=2))
+
+###########################
+# Profile with CSV output #
+###########################
+
+with open(join(dirname(__file__), '../resources/personality-v3.json')) as \
+        profile_json:
+    response = service.profile(
+        profile_json.read(),
+        content_type='application/json',
+        accept="text/csv",
+        csv_headers=True).get_result()
+
+profile = response.content
+cr = csv.reader(profile.splitlines())
+my_list = list(cr)
+for row in my_list:
+    print(row)

examples/tone_analyzer_v3.py

@@ -8,15 +8,15 @@
 # service = ToneAnalyzerV3(
 #     ## url is optional, and defaults to the URL below. Use the correct URL for your region.
 #     url='https://gateway.watsonplatform.net/tone-analyzer/api',
-#     version='2017-09-26',
+#     version='2017-09-21',
 #     iam_apikey='your_apikey')
 
 service = ToneAnalyzerV3(
     ## url is optional, and defaults to the URL below. Use the correct URL for your region.
     # url='https://gateway.watsonplatform.net/tone-analyzer/api',
     username='YOUR SERVICE USERNAME',
     password='YOUR SERVICE PASSWORD',
-    version='2017-09-26')
+    version='2017-09-21')
 
 print("\ntone_chat() example 1:\n")
 utterances = [{