Merge branch 'master' of https://github.com/watson-developer-cloud/python-sdk into unittest

germanattanasio · germanattanasio · commit 85eff0f3d56f · 2016-07-29T12:23:00.000-04:00
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.16.1
+current_version = 0.18.0
 commit = True
 tag = True
 
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,26 @@
 Change Log
 ==========
 
+## Version 0.18.0
+
+_2016-07-22_
+
+* Added: Retraining for Visual Recognition classifiers
+* Added: Using custom models for Alchemy Language entities
+
+## Version 0.17.1
+
+_2016-07-17_
+
+* Fixed: `x_watson_learning_opt_out` value
+
+## Version 0.17.0
+
+_2016-07-14_
+
+* Fixed: Conversation default url
+* Added: `x_watson_learning_opt_out` option on the WatsonDeveloperCloud service
+
 ## Version 0.16.0
 
 _2016-07-12_
diff --git a/examples/concept_insights_v2.py b/examples/concept_insights_v2.py
diff --git a/examples/conversation_v1.py b/examples/conversation_v1.py
@@ -1,7 +1,6 @@
 import json
 from watson_developer_cloud import ConversationV1
 
-
 conversation = ConversationV1(
     username='YOUR SERVICE USERNAME',
     password='YOUR SERVICE PASSWORD',
diff --git a/examples/retrieve_and_rank_v1.py b/examples/retrieve_and_rank_v1.py
@@ -38,7 +38,9 @@
     collections = retrieve_and_rank.list_collections(solr_cluster_id=solr_cluster_id)
     print(json.dumps(collections, indent=2))
 
-    pysolr_client = retrieve_and_rank.get_pysolr_client(solr_cluster_id, 'test-collection')
+    pysolr_client = retrieve_and_rank.get_pysolr_client(solr_cluster_id, collections['collections'][0])
+    # Can also refer to config by name
+
     results = pysolr_client.search('bananas')
     print('{0} documents found'.format(len(results.docs)))
 
diff --git a/examples/speech_to_text_v1.py b/examples/speech_to_text_v1.py
@@ -5,10 +5,12 @@
 
 speech_to_text = SpeechToTextV1(
     username='YOUR SERVICE USERNAME',
-    password='YOUR SERVICE PASSWORD')
+    password='YOUR SERVICE PASSWORD',
+    x_watson_learning_opt_out=False
+)
 
 print(json.dumps(speech_to_text.models(), indent=2))
 
 with open(join(dirname(__file__), '../resources/speech.wav'), 'rb') as audio_file:
     print(json.dumps(speech_to_text.recognize(
-        audio_file, content_type='audio/wav'), indent=2))
+        audio_file, content_type='audio/wav', timestamps=True), indent=2))
diff --git a/examples/text_to_speech_v1.py b/examples/text_to_speech_v1.py
@@ -6,7 +6,8 @@
 
 text_to_speech = TextToSpeechV1(
     username='YOUR SERVICE USERNAME',
-    password='YOUR SERVICE PASSWORD')
+    password='YOUR SERVICE PASSWORD',
+    x_watson_learning_opt_out=True)  # Optional flag
 
 print(json.dumps(text_to_speech.voices(), indent=2))
 
diff --git a/examples/visual_recognition_v3.py b/examples/visual_recognition_v3.py
@@ -12,12 +12,16 @@
 #     print(json.dumps(visual_recognition.create_classifier('Cars vs Trucks', cars_positive_examples=cars,
 #                                                           negative_examples=trucks), indent=2))
 
-# with open(join(dirname(__file__), '../resources/car.jpg'), 'rb') as image_file:
-#     print(json.dumps(visual_recognition.classify(images_file=image_file, threshold=0.1,
-#                                                  classifier_ids=['CarsvsTrucks_1675727418', 'default']), indent=2))
+with open(join(dirname(__file__), '../resources/car.jpg'), 'rb') as image_file:
+    print(json.dumps(visual_recognition.classify(images_file=image_file, threshold=0.1,
+                                                 classifier_ids=['CarsvsTrucks_1675727418', 'default']), indent=2))
 
 # print(json.dumps(visual_recognition.get_classifier('YOUR CLASSIFIER ID'), indent=2))
 
+# with open(join(dirname(__file__), '../resources/car.jpg'), 'rb') as image_file:
+#     print(json.dumps(visual_recognition.update_classifier('CarsvsTrucks_1479118188',
+#                                                           cars_positive_examples=image_file), indent=2))
+
 print(json.dumps(visual_recognition.classify(images_url=test_url), indent=2))
 
 print(json.dumps(visual_recognition.detect_faces(images_url=test_url), indent=2))
diff --git a/setup.py b/setup.py
@@ -19,7 +19,7 @@
 import os
 import sys
 
-__version__ = '0.16.1'
+__version__ = '0.18.0'
 
 if sys.argv[-1] == 'publish':
     # test server
diff --git a/test/test_examples.py b/test/test_examples.py
@@ -11,7 +11,8 @@
 
 # tests to exclude
 excludes = ['authorization_v1.py', 'alchemy_data_news_v1.py',
-            'alchemy_language_v1.py', 'alchemy_vision_v1.py']
+            'alchemy_language_v1.py', 'alchemy_vision_v1.py',
+            'concept_insights_v2.py']
 
 # examples path. /examples
 examples_path = join(dirname(__file__), '../', 'examples', '*.py')
diff --git a/watson_developer_cloud/alchemy_language_v1.py b/watson_developer_cloud/alchemy_language_v1.py
@@ -34,11 +34,21 @@ def authors(self, html=None, url=None, language=None):
         return self._alchemy_html_request('GetAuthors', html=html, url=url, params=params)
 
     def keywords(self, html=None, text=None, url=None, strict_extract_mode=False, sentiment=False,
-                 show_source_text=False, max_keywords=50, language=None):
+                 show_source_text=False, max_items=None, language=None, max_keywords=50):
+        """
+        :param html: HTML input
+        :param text: Text input
+        :param url: URL input
+        :param max_items: The number of results to return (default 50)
+        :param max_keywords: deprecated, use max_items instead
+        :return: A JSON object with extracted keywords from the source document
+        """
+        if not max_items:
+            max_items = max_keywords
         params = {'keywordExtractMode': 'strict' if strict_extract_mode else 'normal',
                   'sentiment': sentiment,
                   'showSourceText': show_source_text,
-                  'maxRetrieve': max_keywords,
+                  'maxRetrieve': max_items,
                   'language': language}
         return self._alchemy_html_request('GetRankedKeywords', html=html, text=text, url=url, params=params)
 
@@ -51,15 +61,16 @@ def concepts(self, html=None, text=None, url=None, max_items=8, linked_data=True
         return self._alchemy_html_request('GetRankedConcepts', html=html, text=text, url=url, params=params)
 
     def entities(self, html=None, text=None, url=None, disambiguate=True, linked_data=True, coreference=True,
-                 quotations=False, sentiment=False, show_source_text=False, max_items=50, language=None):
+                 quotations=False, sentiment=False, show_source_text=False, max_items=50, language=None, model=None):
         params = {'disambiguate': disambiguate,
                   'linkedData': linked_data,
                   'coreference': coreference,
                   'quotations': quotations,
                   'sentiment': sentiment,
                   'showSourceText': show_source_text,
                   'maxRetrieve': max_items,
-                  'language': language}
+                  'language': language,
+                  'model': model}
         return self._alchemy_html_request('GetRankedNamedEntities', html=html, text=text, url=url, params=params)
 
     def emotion(self, html=None, text=None, url=None, show_source_text=False, source_text_type=None,
diff --git a/watson_developer_cloud/concept_insights_v2.py b/watson_developer_cloud/concept_insights_v2.py
@@ -33,8 +33,7 @@ class ConceptInsightsV2(WatsonDeveloperCloudService):
     WIKIPEDIA_EN_LATEST = '/graphs/wikipedia/en-latest'
 
     def __init__(self, url=DEFAULT_URL, **kwargs):
-        WatsonDeveloperCloudService.__init__(
-            self, 'concept_insights', url, **kwargs)
+        WatsonDeveloperCloudService.__init__(self, 'concept_insights', url, **kwargs)
         self.cached_account = None
 
     def get_default_account(self):
diff --git a/watson_developer_cloud/conversation_v1.py b/watson_developer_cloud/conversation_v1.py
@@ -25,12 +25,11 @@ class ConversationV1(WatsonDeveloperCloudService):
     default_url = 'https://gateway.watsonplatform.net/conversation/api'
     latest_version = '2016-07-11'
 
-    def __init__(self, version, url=default_url, username=None, password=None, use_vcap_services=True):
-        WatsonDeveloperCloudService.__init__(
-            self, 'conversation', url, username, password, use_vcap_services)
+    def __init__(self, version, url=default_url, **kwargs):
+        WatsonDeveloperCloudService.__init__(self, 'conversation', url, **kwargs)
         self.version = version
 
-    def message(self, workspace_id, message_input, context=None):
+    def message(self, workspace_id, message_input=None, context=None):
         """
         Retrieves information about a specific classifier.
         :param workspace_id: The workspace to use
diff --git a/watson_developer_cloud/document_conversion_v1.py b/watson_developer_cloud/document_conversion_v1.py
@@ -23,9 +23,9 @@
 
 class DocumentConversionV1(WatsonDeveloperCloudService):
     DEFAULT_URL = 'https://gateway.watsonplatform.net/document-conversion/api'
-    ANSWER_UNITS = 'ANSWER_UNITS'
-    NORMALIZED_HTML = 'NORMALIZED_HTML'
-    NORMALIZED_TEXT = 'NORMALIZED_TEXT'
+    ANSWER_UNITS = 'answer_units'
+    NORMALIZED_HTML = 'normalized_html'
+    NORMALIZED_TEXT = 'normalized_text'
     latest_version = '2016-02-10'
 
     def __init__(self, version, url=DEFAULT_URL, **kwargs):
@@ -47,10 +47,10 @@ def index_document(self, config, document=None, metadata=None, media_type=None):
             raise AssertionError('Missing required parameters: document or metadata. At least one of those is required.')
         params = {'version': self.version}
         files = [('config', ('config.json', json.dumps(config), 'application/json'))]
-        if document != None:
+        if document is not None:
             filename = os.path.basename(document.name)
             file_tuple = (filename, document, media_type) if media_type else (filename, document)
             files.append(('file', file_tuple))
-        if metadata != None:
+        if metadata is not None:
             files.append(('metadata', ('metadata.json', json.dumps(metadata), 'application/json')))
         return self.request(method='POST', url='/v1/index_document', files=files, params=params, accept_json=True)
diff --git a/watson_developer_cloud/language_translation_v2.py b/watson_developer_cloud/language_translation_v2.py
@@ -25,8 +25,7 @@ class LanguageTranslationV2(WatsonDeveloperCloudService):
     default_url = "https://gateway.watsonplatform.net/language-translation/api"
 
     def __init__(self, url=default_url, **kwargs):
-        WatsonDeveloperCloudService.__init__(
-            self, 'language_translation', url, **kwargs)
+        WatsonDeveloperCloudService.__init__(self, 'language_translation', url, **kwargs)
 
     def identify(self, text):
         """
diff --git a/watson_developer_cloud/natural_language_classifier_v1.py b/watson_developer_cloud/natural_language_classifier_v1.py
@@ -24,9 +24,8 @@
 class NaturalLanguageClassifierV1(WatsonDeveloperCloudService):
     default_url = 'https://gateway.watsonplatform.net/natural-language-classifier/api'
 
-    def __init__(self, url=default_url, username=None, password=None, use_vcap_services=True):
-        WatsonDeveloperCloudService.__init__(self, 'natural_language_classifier', url, username, password,
-                                             use_vcap_services)
+    def __init__(self, url=default_url, **kwargs):
+        WatsonDeveloperCloudService.__init__(self, 'natural_language_classifier', url, **kwargs)
 
     def create(self, training_data, name=None, language='en'):
         """
diff --git a/watson_developer_cloud/personality_insights_v2.py b/watson_developer_cloud/personality_insights_v2.py
@@ -25,14 +25,14 @@ class PersonalityInsightsV2(WatsonDeveloperCloudService):
     """Wrapper of the Personality Insights service"""
     default_url = 'https://gateway.watsonplatform.net/personality-insights/api'
 
-    def __init__(self, url=default_url, username=None, password=None, use_vcap_services=True):
+    def __init__(self, url=default_url, **kwargs):
         """
         Construct an instance. Fetches service parameters from VCAP_SERVICES
         runtime variable for Bluemix, or it defaults to local URLs.
         """
 
         WatsonDeveloperCloudService.__init__(
-            self, 'personality_insights', url, username, password, use_vcap_services)
+            self, 'personality_insights', url, **kwargs)
 
     def profile(self, text, content_type='text/plain', accept='application/json', language=None, csv_headers=False):
         """
diff --git a/watson_developer_cloud/retrieve_and_rank_v1.py b/watson_developer_cloud/retrieve_and_rank_v1.py
@@ -25,9 +25,8 @@
 class RetrieveAndRankV1(WatsonDeveloperCloudService):
     default_url = 'https://gateway.watsonplatform.net/retrieve-and-rank/api'
 
-    def __init__(self, url=default_url, username=None, password=None, use_vcap_services=True):
-        WatsonDeveloperCloudService.__init__(self, 'retrieve_and_rank', url, username, password,
-                                             use_vcap_services)
+    def __init__(self, url=default_url, **kwargs):
+        WatsonDeveloperCloudService.__init__(self, 'retrieve_and_rank', url, **kwargs)
 
     def list_solr_clusters(self):
         return self.request(method='GET', url='/v1/solr_clusters', accept_json=True)
diff --git a/watson_developer_cloud/speech_to_text_v1.py b/watson_developer_cloud/speech_to_text_v1.py
diff --git a/watson_developer_cloud/text_to_speech_v1.py b/watson_developer_cloud/text_to_speech_v1.py
diff --git a/watson_developer_cloud/tone_analyzer_v3.py b/watson_developer_cloud/tone_analyzer_v3.py
diff --git a/watson_developer_cloud/tradeoff_analytics_v1.py b/watson_developer_cloud/tradeoff_analytics_v1.py
diff --git a/watson_developer_cloud/version.py b/watson_developer_cloud/version.py
diff --git a/watson_developer_cloud/visual_recognition_v3.py b/watson_developer_cloud/visual_recognition_v3.py
diff --git a/watson_developer_cloud/watson_developer_cloud_service.py b/watson_developer_cloud/watson_developer_cloud_service.py
