Merge branch 'master' into patch-1

Author: germanattanasio

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 4.0.4
+current_version = 4.1.0
 commit = True
 
 [bumpversion:file:ibm_watson/version.py]

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at ehdsouza27@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

.github/issue_template.md

@@ -1,3 +1,18 @@
+# [4.1.0](https://github.com/watson-developer-cloud/python-sdk/compare/v4.0.4...v4.1.0) (2019-11-27)
+
+
+### Features
+
+* **assistantv1:** New param `new_disambiguation_opt_out ` in `create_dialog_node` ([5a5b840](https://github.com/watson-developer-cloud/python-sdk/commit/5a5b84076ff4b0d87355ed71cf7a2cbb9612c866))
+* **assistantv1:** New param `new_disambiguation_opt_out ` in `update_dialog_node() ` ([6e52e07](https://github.com/watson-developer-cloud/python-sdk/commit/6e52e07b3e3ab0a9bc2687406b8a98c5e5826e33))
+* **assistantv1:** New param `webhooks` in `create_workspace()` and `update_workspace()` ([0134b69](https://github.com/watson-developer-cloud/python-sdk/commit/0134b6981c09fc7132297aeb161eb75029bbd54d))
+* **assistantv1:** New properties `randomize` and `max_ssuggestions` in `WorkspaceSystemSettingsDisambiguation` ([27a8cd7](https://github.com/watson-developer-cloud/python-sdk/commit/27a8cd7173a48fb6aaf909598fc3eb34e1320fe4))
+* **assistantv1:** New property `off_topic` in `WorkspaceSystemSettings` ([5f93c55](https://github.com/watson-developer-cloud/python-sdk/commit/5f93c552828b539b846c9a44df4f69ed888d27b4))
+* **discoveryv1:** `title` property not part of `QueryNoticesResult` and `QueryResult` ([2ce0ad3](https://github.com/watson-developer-cloud/python-sdk/commit/2ce0ad33c91714eb6d9b2adb7ac44ff70ad378e9))
+* **discoveryv2:** Add examples for discoveryv2 ([2b54527](https://github.com/watson-developer-cloud/python-sdk/commit/2b54527725438d229e4acd80dc31d0869bdaa464))
+* **discoveryv2:** New discovery v2 available on CP4D ([73df7e4](https://github.com/watson-developer-cloud/python-sdk/commit/73df7e4a53ef83ad1271b71215ab357f7a538177))
+* **VisualRecognitionv4:** New method `get_training_usage` ([a5bec46](https://github.com/watson-developer-cloud/python-sdk/commit/a5bec467005db9340f6983654c293c94587258d9))
+
 ## [4.0.4](https://github.com/watson-developer-cloud/python-sdk/compare/v4.0.3...v4.0.4) (2019-11-22)
 
 

CHANGELOG.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.

README.md

@@ -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/discovery_v2.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)

examples/visual_recognition_v4.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__