refactor(readme/nlu): text change and param reorder

apaparazzi0329 · apaparazzi0329 · commit 49b65312546c · 2021-06-10T11:23:25.000-04:00
diff --git a/README.md b/README.md
@@ -46,7 +46,7 @@ Python client library to quickly get started with the various [Watson APIs][wdc]
 
 </details>
 
-## ANNOUNCEMENTS!
+## Announcements
 ### Updating endpoint URLs from watsonplatform.net
 Watson API endpoint URLs at watsonplatform.net are changing and will not work after 26 May 2021. Update your calls to use the newer endpoint URLs. For more information, see https://cloud.ibm.com/docs/watson?topic=watson-endpoint-change.
 
diff --git a/ibm_watson/natural_language_understanding_v1.py b/ibm_watson/natural_language_understanding_v1.py
@@ -1,6 +1,6 @@
 # coding: utf-8
 
-# (C) Copyright IBM Corp. 2019, 2021.
+# (C) Copyright IBM Corp. 2021.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -3438,10 +3438,6 @@ class Features():
     """
     Analysis features and options.
 
-    :attr CategoriesOptions categories: (optional) Returns a five-level taxonomy of
-          the content. The top three categories are returned.
-          Supported languages: Arabic, English, French, German, Italian, Japanese, Korean,
-          Portuguese, Spanish.
     :attr ClassificationsOptions classifications: (optional) Returns text
           classifications for the content.
           Supported languages: English only.
@@ -3489,13 +3485,16 @@ class Features():
     :attr SummarizationOptions summarization: (optional) (Experimental) Returns a
           summary of content.
           Supported languages: English only.
+    :attr CategoriesOptions categories: (optional) Returns a five-level taxonomy of
+          the content. The top three categories are returned.
+          Supported languages: Arabic, English, French, German, Italian, Japanese, Korean,
+          Portuguese, Spanish.
     :attr SyntaxOptions syntax: (optional) Returns tokens and sentences from the
           input text.
     """
 
     def __init__(self,
                  *,
-                 categories: 'CategoriesOptions' = None,
                  classifications: 'ClassificationsOptions' = None,
                  concepts: 'ConceptsOptions' = None,
                  emotion: 'EmotionOptions' = None,
@@ -3506,14 +3505,11 @@ def __init__(self,
                  semantic_roles: 'SemanticRolesOptions' = None,
                  sentiment: 'SentimentOptions' = None,
                  summarization: 'SummarizationOptions' = None,
+                 categories: 'CategoriesOptions' = None,
                  syntax: 'SyntaxOptions' = None) -> None:
         """
         Initialize a Features object.
 
-        :param CategoriesOptions categories: (optional) Returns a five-level
-               taxonomy of the content. The top three categories are returned.
-               Supported languages: Arabic, English, French, German, Italian, Japanese,
-               Korean, Portuguese, Spanish.
         :param ClassificationsOptions classifications: (optional) Returns text
                classifications for the content.
                Supported languages: English only.
@@ -3562,10 +3558,13 @@ def __init__(self,
         :param SummarizationOptions summarization: (optional) (Experimental)
                Returns a summary of content.
                Supported languages: English only.
+        :param CategoriesOptions categories: (optional) Returns a five-level
+               taxonomy of the content. The top three categories are returned.
+               Supported languages: Arabic, English, French, German, Italian, Japanese,
+               Korean, Portuguese, Spanish.
         :param SyntaxOptions syntax: (optional) Returns tokens and sentences from
                the input text.
         """
-        self.categories = categories
         self.classifications = classifications
         self.concepts = concepts
         self.emotion = emotion
@@ -3576,15 +3575,13 @@ def __init__(self,
         self.semantic_roles = semantic_roles
         self.sentiment = sentiment
         self.summarization = summarization
+        self.categories = categories
         self.syntax = syntax
 
     @classmethod
     def from_dict(cls, _dict: Dict) -> 'Features':
         """Initialize a Features object from a json dictionary."""
         args = {}
-        if 'categories' in _dict:
-            args['categories'] = CategoriesOptions.from_dict(
-                _dict.get('categories'))
         if 'classifications' in _dict:
             args['classifications'] = ClassificationsOptions.from_dict(
                 _dict.get('classifications'))
@@ -3610,6 +3607,9 @@ def from_dict(cls, _dict: Dict) -> 'Features':
         if 'summarization' in _dict:
             args['summarization'] = SummarizationOptions.from_dict(
                 _dict.get('summarization'))
+        if 'categories' in _dict:
+            args['categories'] = CategoriesOptions.from_dict(
+                _dict.get('categories'))
         if 'syntax' in _dict:
             args['syntax'] = SyntaxOptions.from_dict(_dict.get('syntax'))
         return cls(**args)
@@ -3622,8 +3622,6 @@ def _from_dict(cls, _dict):
     def to_dict(self) -> Dict:
         """Return a json dictionary representing this model."""
         _dict = {}
-        if hasattr(self, 'categories') and self.categories is not None:
-            _dict['categories'] = self.categories.to_dict()
         if hasattr(self,
                    'classifications') and self.classifications is not None:
             _dict['classifications'] = self.classifications.to_dict()
@@ -3645,6 +3643,8 @@ def to_dict(self) -> Dict:
             _dict['sentiment'] = self.sentiment.to_dict()
         if hasattr(self, 'summarization') and self.summarization is not None:
             _dict['summarization'] = self.summarization.to_dict()
+        if hasattr(self, 'categories') and self.categories is not None:
+            _dict['categories'] = self.categories.to_dict()
         if hasattr(self, 'syntax') and self.syntax is not None:
             _dict['syntax'] = self.syntax.to_dict()
         return _dict
diff --git a/test/unit/test_natural_language_understanding_v1.py b/test/unit/test_natural_language_understanding_v1.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (C) Copyright IBM Corp. 2019, 2021.
+# (C) Copyright IBM Corp. 2021.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -74,12 +74,6 @@ def test_analyze_all_params(self):
                       content_type='application/json',
                       status=200)
 
-        # Construct a dict representation of a CategoriesOptions model
-        categories_options_model = {}
-        categories_options_model['explanation'] = True
-        categories_options_model['limit'] = 10
-        categories_options_model['model'] = 'testString'
-
         # Construct a dict representation of a ClassificationsOptions model
         classifications_options_model = {}
         classifications_options_model['model'] = 'testString'
@@ -130,6 +124,12 @@ def test_analyze_all_params(self):
         summarization_options_model = {}
         summarization_options_model['limit'] = 10
 
+        # Construct a dict representation of a CategoriesOptions model
+        categories_options_model = {}
+        categories_options_model['explanation'] = True
+        categories_options_model['limit'] = 10
+        categories_options_model['model'] = 'testString'
+
         # Construct a dict representation of a SyntaxOptionsTokens model
         syntax_options_tokens_model = {}
         syntax_options_tokens_model['lemma'] = True
@@ -142,7 +142,6 @@ def test_analyze_all_params(self):
 
         # Construct a dict representation of a Features model
         features_model = {}
-        features_model['categories'] = categories_options_model
         features_model['classifications'] = classifications_options_model
         features_model['concepts'] = concepts_options_model
         features_model['emotion'] = emotion_options_model
@@ -153,6 +152,7 @@ def test_analyze_all_params(self):
         features_model['semantic_roles'] = semantic_roles_options_model
         features_model['sentiment'] = sentiment_options_model
         features_model['summarization'] = summarization_options_model
+        features_model['categories'] = categories_options_model
         features_model['syntax'] = syntax_options_model
 
         # Set up parameter values
@@ -213,12 +213,6 @@ def test_analyze_value_error(self):
                       content_type='application/json',
                       status=200)
 
-        # Construct a dict representation of a CategoriesOptions model
-        categories_options_model = {}
-        categories_options_model['explanation'] = True
-        categories_options_model['limit'] = 10
-        categories_options_model['model'] = 'testString'
-
         # Construct a dict representation of a ClassificationsOptions model
         classifications_options_model = {}
         classifications_options_model['model'] = 'testString'
@@ -269,6 +263,12 @@ def test_analyze_value_error(self):
         summarization_options_model = {}
         summarization_options_model['limit'] = 10
 
+        # Construct a dict representation of a CategoriesOptions model
+        categories_options_model = {}
+        categories_options_model['explanation'] = True
+        categories_options_model['limit'] = 10
+        categories_options_model['model'] = 'testString'
+
         # Construct a dict representation of a SyntaxOptionsTokens model
         syntax_options_tokens_model = {}
         syntax_options_tokens_model['lemma'] = True
@@ -281,7 +281,6 @@ def test_analyze_value_error(self):
 
         # Construct a dict representation of a Features model
         features_model = {}
-        features_model['categories'] = categories_options_model
         features_model['classifications'] = classifications_options_model
         features_model['concepts'] = concepts_options_model
         features_model['emotion'] = emotion_options_model
@@ -292,6 +291,7 @@ def test_analyze_value_error(self):
         features_model['semantic_roles'] = semantic_roles_options_model
         features_model['sentiment'] = sentiment_options_model
         features_model['summarization'] = summarization_options_model
+        features_model['categories'] = categories_options_model
         features_model['syntax'] = syntax_options_model
 
         # Set up parameter values
@@ -2922,11 +2922,6 @@ def test_features_serialization(self):
 
         # Construct dict forms of any model objects needed in order to build this model.
 
-        categories_options_model = {} # CategoriesOptions
-        categories_options_model['explanation'] = True
-        categories_options_model['limit'] = 10
-        categories_options_model['model'] = 'testString'
-
         classifications_options_model = {} # ClassificationsOptions
         classifications_options_model['model'] = 'testString'
 
@@ -2967,6 +2962,11 @@ def test_features_serialization(self):
         summarization_options_model = {} # SummarizationOptions
         summarization_options_model['limit'] = 10
 
+        categories_options_model = {} # CategoriesOptions
+        categories_options_model['explanation'] = True
+        categories_options_model['limit'] = 10
+        categories_options_model['model'] = 'testString'
+
         syntax_options_tokens_model = {} # SyntaxOptionsTokens
         syntax_options_tokens_model['lemma'] = True
         syntax_options_tokens_model['part_of_speech'] = True
@@ -2977,7 +2977,6 @@ def test_features_serialization(self):
 
         # Construct a json representation of a Features model
         features_model_json = {}
-        features_model_json['categories'] = categories_options_model
         features_model_json['classifications'] = classifications_options_model
         features_model_json['concepts'] = concepts_options_model
         features_model_json['emotion'] = emotion_options_model
@@ -2988,6 +2987,7 @@ def test_features_serialization(self):
         features_model_json['semantic_roles'] = semantic_roles_options_model
         features_model_json['sentiment'] = sentiment_options_model
         features_model_json['summarization'] = summarization_options_model
+        features_model_json['categories'] = categories_options_model
         features_model_json['syntax'] = syntax_options_model
 
         # Construct a model instance of Features by calling from_dict on the json representation
