Release V2.0.0 by ehdsouza · Pull Request #554 · watson-developer-cloud/python-sdk

ehdsouza · 2018-09-07T21:50:53Z

The following would be the MIGRATION

Version 2.0.0

GENERAL CHANGES FOR ALL SERVICES:

DetailedResponse is now the default response which contains the result, headers and HTTP status code. Previously, the response only contained the direct response from the service. Use get_result() to obtain the method response.

from watson_developer_cloud import AssistantV1
 assistant = AssistantV1(
    username='xxx',
    password='yyy',
    version='2017-04-21')
 response = assistant.list_workspaces(headers={'Custom-Header': 'custom_value'})
print(response.get_result())
print(response.get_headers())
print(response.get_status_code())

iam_api_key renamed to iam_apikey
The constructor for each service now looks like:

    def __init__(
            self,
            url=default_url,
            username=None,
            password=None,
            iam_apikey=None,
            iam_access_token=None,
            iam_url=None,
    ):

PERSONALITY INSIGHTS:

profile method parameter reordering:

	    def profile(self,
                content,
                content_type,
                accept=None,
                content_language=None,
                accept_language=None,
                raw_scores=None,
                csv_headers=None,
                consumption_preferences=None,
                **kwargs):

VISUAL RECOGNITION:

classify would no longer support the parameters keyword, the new interface is:

    def classify(self,
                 images_file=None,
                 accept_language=None,
                 url=None,
                 threshold=None,
                 owners=None,
                 classifier_ids=None,
                 images_file_content_type=None,
                 images_filename=None,
                 **kwargs):

detect_faces would no longer support the parameters keyword, the new interface is:

    def detect_faces(self,
                     images_file=None,
                     url=None,
                     images_file_content_type=None,
                     images_filename=None,
                     **kwargs):

SPEECH TO TEXT:

recognize parameter reordering and version parameter renamed to base_model_version

    def recognize(self,
                  audio,
                  content_type,
                  model=None,
                  customization_id=None,
                  acoustic_customization_id=None,
                  base_model_version=None,
                  customization_weight=None,
                  inactivity_timeout=None,
                  keywords=None,
                  keywords_threshold=None,
                  max_alternatives=None,
                  word_alternatives_threshold=None,
                  word_confidence=None,
                  timestamps=None,
                  profanity_filter=None,
                  smart_formatting=None,
                  speaker_labels=None,
                  **kwargs):

create_job, parameter reordering and version parameter renamed to base_model_version

    def create_job(self,
                   audio,
                   content_type,
                   model=None,
                   callback_url=None,
                   events=None,
                   user_token=None,
                   results_ttl=None,
                   customization_id=None,
                   acoustic_customization_id=None,
                   base_model_version=None,
                   customization_weight=None,
                   inactivity_timeout=None,
                   keywords=None,
                   keywords_threshold=None,
                   max_alternatives=None,
                   word_alternatives_threshold=None,
                   word_confidence=None,
                   timestamps=None,
                   profanity_filter=None,
                   smart_formatting=None,
                   speaker_labels=None,
                   **kwargs):

add_corpus no longer supports corpus_file_content_type and corpus_filename. The corpus_file should be A TEXT file.

    def add_corpus(self,
                   customization_id,
                   corpus_name,
                   corpus_file,
                   allow_overwrite=None,
                   **kwargs):

add_word

    def add_word(self,
                 customization_id,
                 word_name,
                 word=None,
                 sounds_like=None,
                 display_as=None,
                 **kwargs):

recognize_using_websocket
- A new underlying websocket client is now used
- audio is of type AudioSource
- recognize_callback’s on_transcription () and on_hypothesis () results swapped with each other

    def recognize_using_websocket(self,
                                  audio,
                                  content_type,
                                  recognize_callback,
                                  model=None,
                                  customization_id=None,
                                  acoustic_customization_id=None,
                                  customization_weight=None,
                                  base_model_version=None,
                                  inactivity_timeout=None,
                                  interim_results=None,
                                  keywords=None,
                                  keywords_threshold=None,
                                  max_alternatives=None,
                                  word_alternatives_threshold=None,
                                  word_confidence=None,
                                  timestamps=None,
                                  profanity_filter=None,
                                  smart_formatting=None,
                                  speaker_labels=None,
                                  http_proxy_host=None,
                                  http_proxy_port=None,
                                  **kwargs):

…ll services

codecov-io · 2018-09-07T22:03:29Z

Codecov Report

Merging #554 into master will not change coverage.
The diff coverage is 0%.

@@           Coverage Diff           @@
##           master    #554    +/-   ##
=======================================
  Coverage       0%      0%            
=======================================
  Files          26      24     -2     
  Lines       16707   16251   -456     
=======================================
+ Misses      16707   16251   -456

Impacted Files	Coverage Δ
watson_developer_cloud/tone_analyzer_v3.py	`0% <ø> (ø)`	⬆️
watson_developer_cloud/__init__.py	`0% <ø> (ø)`	⬆️
watson_developer_cloud/iam_token_manager.py	`0% <ø> (ø)`	⬆️
watson_developer_cloud/text_to_speech_v1.py	`0% <0%> (ø)`	⬆️
watson_developer_cloud/websocket/__init__.py	`0% <0%> (ø)`	⬆️
watson_developer_cloud/language_translator_v3.py	`0% <0%> (ø)`	⬆️
watson_developer_cloud/discovery_v1.py	`0% <0%> (ø)`	⬆️
...on_developer_cloud/websocket/recognize_listener.py	`0% <0%> (ø)`
watson_developer_cloud/assistant_v1.py	`0% <0%> (ø)`	⬆️
watson_developer_cloud/speech_to_text_v1.py	`0% <0%> (ø)`	⬆️
... and 11 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 37ce6aa...feac01c. Read the comment docs.

BREAKING CHANGE: Response is now DetailedResponse

germanattanasio

It looks good 👍 I can't approve it because I didn't manually test it yet 😿

mediumTaj

Looks good - a few questions and there are some opportunities to remove x-python-alternate-name

mediumTaj · 2018-09-10T20:33:56Z

README.md


 ## Parsing HTTP response info
-If you would like access to some HTTP response information along with the response model, you can set the `set_detailed_response()` to `True`
+If you would like access to some HTTP response information along with the response model, you can set the `set_detailed_response()` to `True`. Since python `v2.0`, it is set to `True`


Since python v2.0 - this part reads like Python v2 not Python SDK v2

mediumTaj · 2018-09-10T20:36:48Z

appveyor.yml

+deploy: off
+
+matrix:
+  fast_finish: true


Can you add a newline at the end here?

mediumTaj · 2018-09-10T20:42:38Z

examples/conversation_v1.py

    ## 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')
+    url='https://gateway.watsonplatform.net/assistant/api',


Should this stay conversation?

mediumTaj · 2018-09-10T20:43:05Z

examples/conversation_v1.py

 #     ## url is optional, and defaults to the URL below. Use the correct URL for your region.
-#     url='https://gateway.watsonplatform.net/conversation/api',
-#     iam_api_key='your_api_key')
+#     # url='https://gateway.watsonplatform.net/assistant/api',


Should this stay conversation?

mediumTaj · 2018-09-10T20:44:33Z

examples/discovery_v1.py

-    # url='https://gateway.watsonplatform.net/discovery/api',
-    username='YOUR SERVICE USERNAME',
-    password='YOUR SERVICE PASSWORD')
+    url='https://gateway-syd.watsonplatform.net/discovery/api',


do we want this syd url in the example?

mediumTaj · 2018-09-10T20:45:48Z

examples/discovery_v1.py

 #    print(new_collection)
-    #print(discovery.get_collections(environment_id=writable_environment_id))
+    #print(discovery.get_collections(environment_id=writable_environment_id).get_result())
    #res = discovery.delete_collection(environment_id='10b733d0-1232-4924-a670-e6ffaed2e641',


Do we want this environment_id in the example?

mediumTaj · 2018-09-10T20:46:42Z

examples/language_translator_v3.py


 ## Delete model
-# print(json.dumps(language_translator.delete_model(model_id='9f8d9c6f-2123-462f-9793-f17fdcb77cd6'), indent=2))
+# print(json.dumps(language_translator.delete_model(model_id='9f8d9c6f-2123-462f-9793-f17fdcb77cd6').get_result(), indent=2))


Do we want this model_id in the example?

mediumTaj · 2018-09-10T20:46:58Z

examples/language_translator_v3.py


 ## Get model details
-# model = language_translator.get_model(model_id='fdadfc3b-0b96-4276-a6e5-f5c4a29711fc')
+# model = language_translator.get_model(model_id='fdadfc3b-0b96-4276-a6e5-f5c4a29711fc').get_result()


Do we want this model_id in the example?

mediumTaj · 2018-09-10T21:09:57Z

watson_developer_cloud/natural_language_understanding_v1.py

        return not self == other


+class InlineResponse200(object):


This needs to be called DeleteModelResults. x-python-alternate-name needs to be removed from the api def.

https://github.ibm.com/Watson/developer-cloud--api-definitions/blob/master/apis-public/natural-language-understanding-v1.json#L1042

Also it is not listed here but QueryResultResultMetadata needs to be renamed QueryResultMetadata and the api definition needs to have x-python-alternate-name removed.

https://github.ibm.com/Watson/developer-cloud--api-definitions/blob/master/apis-public/discovery-v1.json#L7654

mediumTaj · 2018-09-10T21:20:24Z

watson_developer_cloud/version.py

@@ -1 +1 @@
-__version__ = '1.7.1'
+__version__ = '1.7.0'


Will this version up?

mediumTaj

👍 looks good!

mediumTaj · 2018-09-12T20:43:53Z

watson_developer_cloud/watson_service.py

            api_key = None
+        if api_key is not None and api_key.startswith(ICP_PREFIX):
+            self.set_username_and_password(APIKEY, api_key)
+            return


@germanattanasio Should we add this to the other SDKs too? I didn't think about this but if users try to authenticate using an icp apikey the SDK does basicauth instead?

watson-github-bot · 2018-09-12T20:59:29Z

🎉 This PR is included in version 2.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

ehdsouza added 9 commits August 24, 2018 11:27

Merge branch 'ws' into v2.0

478a9c7

chore(ws): Update web socket client for 0.47.0

46ec598

test(ws): Example using threads in a non-blocking way

08b5496

fix(DetailedResponse): Add status_code to DetailedResponse

5c8da5b

refactor(DetailedResponse): Add status_code to DetailedResponse

4557044

BREAKING CHANGE: DetailedResponse is now the default response for a…

e83fed0

…ll services

chore(LTv2, PIv2): remove all deprecated services

61c84c6

BREAKING CHANGE: remove deprecated methods

95e5d58

Merge branch 'master' into v2.0.0

acb297a

ehdsouza added 4 commits September 7, 2018 18:30

BREAKING CHANGE: I made a breaking change

ad44cb2

feat(examples): Updates to example readme

4d9c4b9

BREAKING CHANGE: Response is now DetailedResponse

fix(recognize_using_websocket): Fix the final stop message

36d536f

chore(Speech To Text): Apply manual changes

1578c40

ehdsouza requested review from germanattanasio and mediumTaj September 10, 2018 18:41

ehdsouza added the Ready for review label Sep 10, 2018

ehdsouza added 2 commits September 10, 2018 14:47

chore(version): Take the correct version from master

6d80937

[skip ci]: skip CI for tag push

89cd224

germanattanasio reviewed Sep 10, 2018

View reviewed changes

mediumTaj suggested changes Sep 10, 2018

View reviewed changes

ehdsouza added 6 commits September 11, 2018 15:03

chore(all services): Indent examples and minor chores

de80344

chore(all services): Latest codegen changes

28e3902

fix(VR): Fix VR examples and test paths

a5871a9

feat(ICP): Add ICP support

c62394b

fix(ICP): Minor changes in ICM logic

1787225

fix(ICP): changes when username/password are set

feac01c

watson-developer-cloud deleted a comment Sep 12, 2018

fix(codacy): Fix codacy issues

5de0fdc

watson-developer-cloud deleted a comment Sep 12, 2018

chore(VR): Apply manual changes

4751664

watson-developer-cloud deleted a comment Sep 12, 2018

mediumTaj approved these changes Sep 12, 2018

View reviewed changes

ehdsouza merged commit e4151da into master Sep 12, 2018

ehdsouza deleted the v2.0.0 branch October 22, 2018 18:01

		@@ -1 +1 @@
		__version__ = '1.7.1'
		__version__ = '1.7.0'

Conversation

ehdsouza commented Sep 7, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Version 2.0.0

GENERAL CHANGES FOR ALL SERVICES:

PERSONALITY INSIGHTS:

VISUAL RECOGNITION:

SPEECH TO TEXT:

Uh oh!

codecov-io commented Sep 7, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

germanattanasio left a comment

Choose a reason for hiding this comment

Uh oh!

mediumTaj left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mediumTaj left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

watson-github-bot commented Sep 12, 2018

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

5 participants

ehdsouza commented Sep 7, 2018 •

edited

Loading

codecov-io commented Sep 7, 2018 •

edited

Loading