Skip to content

Commit fa67e59

Browse files
authored
Update CHANGELOG.md
1 parent c09f01b commit fa67e59

File tree

1 file changed

+34
-35
lines changed

1 file changed

+34
-35
lines changed

CHANGELOG.md

Lines changed: 34 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -65,82 +65,81 @@
6565
### BREAKING CHANGES
6666

6767
* **visual_recognition:** For `updateClassifier` and `createClassifier`, the parameter `{classname}_positive_examples` is changed to a map called `positive_examples` with classnames as keys.
68-
69-
See the migration guide, UPGRADE-4.0.md, for more information.
68+
* See the migration guide, UPGRADE-4.0.md, for more information.
69+
7070
* Node 4 will no longer be supported, considered during development, or tested with.
71-
72-
To migrate your code, upgrade to a newer major version of Node.
71+
* To migrate your code, upgrade to a newer major version of Node.
72+
7373
* **assistant-v2:** For `updateValue`, parameter `new_type` is changed to `new_value_type`. For `updateDialogNode`, parameter `new_type` is changed to `new_node_type`.
74-
* These method renames are breaking changes. Update the method names to migrate your code.
74+
* These method renames are breaking changes. Update the method names to migrate your code.
75+
7576
* There is no more `index.ts` file, so importing with `require('watson-developer-cloud')` will no longer work.
77+
* To migrate your code, import only the services that you need, e.g. `require('watson-developer-cloud/speech-to-text/v1')`.
7678

77-
To migrate your code, import only the services that you need, e.g. `require('watson-developer-cloud/speech-to-text/v1')`.
78-
79-
Using the file `sdk.ts` to export all of the services for browserification
8079
* The methods `createStopwordList` in discovery and `convertToHTML` in comply comply now have new, required parameters
81-
82-
To migrate your code, include the parameter `stopword_filename` for `createStopwordList`, and `filename` for `convertToHTML`
80+
* To migrate your code, include the parameter `stopword_filename` for `createStopwordList`, and `filename` for `convertToHTML`
81+
8382
* **assistant-v1:** The Assistant v1 parameter `export` is now `_export` is all instances.
84-
85-
To migrate your code, change any use of the `export` parameter to `_export`.
83+
* To migrate your code, change any use of the `export` parameter to `_export`.
84+
8685
* The SDK used to document and allow array values for these parameters, converting them to strings to be sent to the service.
86+
* To migrate your code, convert any array values for these parameters to comma-separated values in a string.
8787

88-
To migrate your code, convert any array values for these parameters to comma-separated values in a string.
8988
* The module `json-training-to-csv` is no longer available.
89+
* To migrate your code, provide `training_data` to NLC as a CSV file.
9090

91-
To migrate your code, provide `training_data` to NLC as a CSV file.
9291
* Cookies will no longer be sent or stored in requests. This should have very little impact on usage but is techincally a breaking change.
93-
94-
This affects internal functionality but has no effect on client code.
92+
* This affects internal functionality but has no effect on client code.
93+
9594
* Errors objects returned from service errors are now different
95+
* To migrate your code, see the upgrade guide for the new error structure
9696

97-
To migrate your code, see the upgrade guide for the new error structure:
9897
* Network responses received in callback function may now have different structures (results and errors). Requests no longer return a Stream.
99-
100-
See the UPGRADE-4.0.md file for more information.
98+
* See the UPGRADE-4.0.md file for more information.
99+
101100
* **personality-insights:** Personality Insights v2 is no longer available in the SDK
102-
103-
To migrate your code, use Personality Insights v3:
101+
* To migrate your code, use Personality Insights v3:
102+
104103
* **compare-comply:** Parameter `model_id` has been changed to `model` for the following methods: convertToHtml, classifyElements, extractTables, compareDocuments, deleteFeedback, getFeedback, createBatch, and updateBatch
104+
105105
* **speech-to-text:** Deprecated methods in Speech to Text are no longer available. Changed parameter names are no longer interally corrected.
106+
* To migrate your code, use the methods and parameters currently available with the service as documented here: https://www.ibm.com/watson/developercloud/speech-to-text/api/v1/node.html?node
106107

107-
To migrate your code, use the methods and parameters currently available with the service as documented here: https://www.ibm.com/watson/developercloud/speech-to-text/api/v1/node.html?node
108108
* **text-to-speech:** Deprecated methods in Text to Speech are no longer available. Changed parameter names are no longer interally corrected.
109+
* To migrate your code, use the methods and parameters currently available with the service as documented here: https://www.ibm.com/watson/developercloud/text-to-speech/api/v1/node.html?node
109110

110-
To migrate your code, use the methods and parameters currently available with the service as documented here: https://www.ibm.com/watson/developercloud/text-to-speech/api/v1/node.html?node
111111
* **visual-recognition:** Deprecated methods in Visual Recognition are no longer available. Changed parameter names are no longer interally corrected.
112+
* To migrate your code, use the methods and parameters currently available with the service as documented here: https://www.ibm.com/watson/developercloud/visual-recognition/api/v3/node.html?node
112113

113-
To migrate your code, use the methods and parameters currently available with the service as documented here: https://www.ibm.com/watson/developercloud/visual-recognition/api/v3/node.html?node
114114
* **tone-analyzer:** Deprecated methods in Tone Analyzer are no longer available. Changed parameter names are no longer interally corrected.
115+
* To migrate your code, use the methods and parameters currently available with the service as documented here: https://www.ibm.com/watson/developercloud/tone-analyzer/api/v3/node.html?node
115116

116-
To migrate your code, use the methods and parameters currently available with the service as documented here: https://www.ibm.com/watson/developercloud/tone-analyzer/api/v3/node.html?node
117117
* **personality-insights-v3:** Deprecated methods in Personality Insights v3 are no longer available. Changed parameter names are no longer interally corrected.
118+
* To migrate your code, use the methods and parameters currently available with the service as documented here: https://www.ibm.com/watson/developercloud/personality-insights/api/v3/node.html?node
118119

119-
To migrate your code, use the methods and parameters currently available with the service as documented here: https://www.ibm.com/watson/developercloud/personality-insights/api/v3/node.html?node
120120
* **natural-language-understanding:** The `version_date` parameter in Natural Language Understanding is no longer supported.
121+
* To migrate your code, use the parameter name `version` instead.
121122

122-
To migrate your code, use the parameter name `version` instead.
123123
* **natural-language-classifier:** Deprecated methods in Natural Language Classifier are no longer available. Changed parameter names are no longer interally corrected.
124+
* To migrate your code, use the methods and parameters currently available with the service as documented here: https://www.ibm.com/watson/developercloud/natural-language-classifier/api/v1/node.html?node
124125

125-
To migrate your code, use the methods and parameters currently available with the service as documented here: https://www.ibm.com/watson/developercloud/natural-language-classifier/api/v1/node.html?node
126126
* **discovery:** Deprecated methods in Discovery are no longer available. Changed parameter names are no longer interally corrected.
127+
* To migrate your code, use the methods and parameters currently available with the service as documented here: https://www.ibm.com/watson/developercloud/discovery/api/v1/node.html?node
127128

128-
To migrate your code, use the methods and parameters currently available with the service as documented here: https://www.ibm.com/watson/developercloud/discovery/api/v1/node.html?node
129129
* **conversation:** The Conversation service will no longer be available
130+
* To migrate your code, use the Assistant v1 or v2 service.
130131

131-
To migrate your code, use the Assistant v1 or v2 service.
132132
* **language-translator-v2:** The Language Translator V2 service will no longer be available
133+
* To migrate your code, use the Language Translator V3 service.
133134

134-
To migrate your code, use the Language Translator V3 service.
135135
* **dialog:** The Dialog service will no longer be available
136+
* To migrate your code, use the Assistant v1 or v2 service.
136137

137-
To migrate your code, use the Assistant v1 or v2 service.
138138
* Support for the `api_key` parameter has been removed.
139+
* For instances of Visual Recognition, use `iam_apikey` to authenticate.
139140

140-
For instances of Visual Recognition, use `iam_apikey` to authenticate.
141141
* **discovery:** The name of the model `QueryResultResultMetadata` has been changed to `QueryResultMetadata`
142-
143-
To migrate your code, use the model `QueryResultMetadata` instead of `QueryResultResultMetadata`:
142+
* To migrate your code, use the model `QueryResultMetadata` instead of `QueryResultResultMetadata`:
144143

145144
## [3.18.4](https://github.com/watson-developer-cloud/node-sdk/compare/v3.18.3...v3.18.4) (2019-03-28)
146145

0 commit comments

Comments
 (0)