Merge pull request #714 from watson-developer-cloud/v4.1.0

v4.1.0

Author: ehdsouza

README.md

@@ -13,6 +13,7 @@ Python client library to quickly get started with the various [Watson APIs][wdc]
   * [Before you begin](#before-you-begin)
   * [Installation](#installation)
   * [Examples](#examples)
+  * [Discovery v2 only on CP4D](#discovery-v2-only-on-cp4d)
   * [Running in IBM Cloud](#running-in-ibm-cloud)
   * [Authentication](#authentication)
     * [Getting credentials](#getting-credentials)
@@ -83,6 +84,9 @@ For more details see [#405](https://github.com/watson-developer-cloud/python-sdk
 
 The [examples][examples] folder has basic and advanced examples. The examples within each service assume that you already have [service credentials](#getting-credentials).
 
+## Discovery v2 only on CP4D
+Discovery v2 is only available on Cloud Pak for Data.
+
 ## Running in IBM Cloud
 
 If you run your app in IBM Cloud, the SDK gets credentials from the [`VCAP_SERVICES`][vcap_services] environment variable.

examples/discovery_v2.py

@@ -0,0 +1,84 @@
+import json
+import os
+from ibm_watson import DiscoveryV2
+from ibm_watson.discovery_v2 import TrainingExample
+from ibm_cloud_sdk_core.authenticators import CloudPakForDataAuthenticator, BearerTokenAuthenticator
+
+## Important: Discovery v2 is only available on Cloud Pak for Data. ##
+
+## Authentication ##
+## Option 1: username/password
+authenticator = CloudPakForDataAuthenticator('<your username>',
+                                             '<your password>',
+                                             '<url for authentication>',
+                                             disable_ssl_verification=True)
+
+## Option 2: bearer token
+authenticator = BearerTokenAuthenticator('your bearer token')
+
+## Initialize discovery instance ##
+discovery = DiscoveryV2(version='2019-11-22', authenticator=authenticator)
+discovery.set_service_url(
+    '<service url>'
+)
+discovery.set_disable_ssl_verification(True)
+
+PROJECT_ID = 'your project id'
+## List Collections ##
+collections = discovery.list_collections(project_id=PROJECT_ID).get_result()
+print(json.dumps(collections, indent=2))
+
+## Component settings ##
+settings_result = discovery.get_component_settings(
+    project_id=PROJECT_ID).get_result()
+print(json.dumps(settings_result, indent=2))
+
+## Add Document ##
+COLLECTION_ID = 'your collection id'
+with open(os.path.join(os.getcwd(), '..', 'resources',
+                       'simple.html')) as fileinfo:
+    add_document_result = discovery.add_document(project_id=PROJECT_ID,
+                                                 collection_id=COLLECTION_ID,
+                                                 file=fileinfo).get_result()
+print(json.dumps(add_document_result, indent=2))
+document_id = add_document_result.get('document_id')
+
+## Create Training Data ##
+training_example = TrainingExample(document_id=document_id,
+                                   collection_id=COLLECTION_ID,
+                                   relevance=1)
+create_query = discovery.create_training_query(
+    project_id=PROJECT_ID,
+    natural_language_query='How is the weather today?',
+    examples=[training_example]).get_result()
+print(json.dumps(create_query, indent=2))
+
+training_queries = discovery.list_training_queries(
+    project_id=PROJECT_ID).get_result()
+print(json.dumps(training_queries, indent=2))
+
+## Queries ##
+query_result = discovery.query(
+    project_id=PROJECT_ID,
+    collection_ids=[COLLECTION_ID],
+    natural_language_query='How is the weather today?').get_result()
+print(json.dumps(query_result, indent=2))
+
+autocomplete_result = discovery.get_autocompletion(
+    project_id=PROJECT_ID, prefix="The content").get_result()
+print(json.dumps(autocomplete_result, indent=2))
+
+query_notices_result = discovery.query_notices(
+    project_id=PROJECT_ID, natural_language_query='warning').get_result()
+print(json.dumps(query_notices_result, indent=2))
+
+list_fields = discovery.list_fields(project_id=PROJECT_ID).get_result()
+print(json.dumps(list_fields, indent=2))
+
+## Cleanup ##
+discovery.delete_training_queries(project_id=PROJECT_ID).get_result()
+
+delete_document_result = discovery.delete_document(
+    project_id=PROJECT_ID, collection_id=COLLECTION_ID,
+    document_id=document_id).get_result()
+print(json.dumps(delete_document_result, indent=2))

examples/visual_recognition_v4.py

@@ -35,9 +35,15 @@
         TrainingDataObject(object='giraffe training data',
                            location=Location(64, 270, 755, 784))
     ]).get_result()
+print(json.dumps(training_data, indent=2))
 
 # train collection
 train_result = service.train(collection_id).get_result()
+print(json.dumps(train_result, indent=2))
+
+# training usage
+training_usage = service.get_training_usage()
+print(json.dumps(training_usage, indent=2))
 
 # analyze
 dog_path = os.path.join(os.path.dirname(__file__), '../resources/dog.jpg')
@@ -51,7 +57,7 @@
             FileWithMetadata(giraffe_files)
         ],
         image_url=['https://upload.wikimedia.org/wikipedia/commons/thumb/4/47/American_Eskimo_Dog.jpg/1280px-American_Eskimo_Dog.jpg']).get_result()
-    assert analyze_images is not None
+    print(json.dumps(analyze_images, indent=2))
 
 # delete collection
 service.delete_collection(collection_id)

ibm_watson/__init__.py

@@ -24,6 +24,7 @@
 from .text_to_speech_v1 import TextToSpeechV1
 from .tone_analyzer_v3 import ToneAnalyzerV3
 from .discovery_v1 import DiscoveryV1
+from .discovery_v2 import DiscoveryV2
 from .compare_comply_v1 import CompareComplyV1
 from .visual_recognition_v3 import VisualRecognitionV3
 from .version import __version__