UNPKG

42.9 kBMarkdownView Raw
1## [4.0.1](https://github.com/watson-developer-cloud/node-sdk/compare/v4.0.0...v4.0.1) (2019-03-29)
2
3
4### Bug Fixes
5
6* add compare comply keyword to package.json (to trigger release) ([7905445](https://github.com/watson-developer-cloud/node-sdk/commit/7905445))
7
8# [4.0.0](https://github.com/watson-developer-cloud/node-sdk/compare/v3.18.4...v4.0.0) (2019-03-28)
9
10
11### Bug Fixes
12
13* **icp:** disabling ssl verification now works for websocket connection ([f8466c8](https://github.com/watson-developer-cloud/node-sdk/commit/f8466c8))
14* update ibm-cloud-sdk-core to 0.1.1 ([29f87df](https://github.com/watson-developer-cloud/node-sdk/commit/29f87df))
15
16
17### Build System
18
19* remove support for node 4 ([1548413](https://github.com/watson-developer-cloud/node-sdk/commit/1548413))
20
21
22### chore
23
24* remove all code dealing with api_key in the base class ([92d48e2](https://github.com/watson-developer-cloud/node-sdk/commit/92d48e2))
25* **conversation:** remove conversation service and all associated code ([c810de2](https://github.com/watson-developer-cloud/node-sdk/commit/c810de2))
26* **dialog:** remove dialog service and all associated ([7d7408f](https://github.com/watson-developer-cloud/node-sdk/commit/7d7408f))
27* **language-translator-v2:** remove language translator v2 service and all associated code ([83d9232](https://github.com/watson-developer-cloud/node-sdk/commit/83d9232))
28* **personality-insights:** remove Personality Insights v2 ([e5e5302](https://github.com/watson-developer-cloud/node-sdk/commit/e5e5302))
29
30
31### Code Refactoring
32
33* **assistant-v1:** change name of variable `export` to `_export` ([91ed5a4](https://github.com/watson-developer-cloud/node-sdk/commit/91ed5a4))
34* **assistant-v2:** parameter names changed for v4 ([f6adbe9](https://github.com/watson-developer-cloud/node-sdk/commit/f6adbe9))
35* **compare-comply:** parameter names changed for v4 ([908d8e7](https://github.com/watson-developer-cloud/node-sdk/commit/908d8e7))
36* refactor core code to use `axios` instead of `request` for network requests ([f656731](https://github.com/watson-developer-cloud/node-sdk/commit/f656731))
37* **discovery:** remove compatibility layer for discovery ([8571a1f](https://github.com/watson-developer-cloud/node-sdk/commit/8571a1f))
38* **discovery:** rename model `QueryResultResultMetadata` to `QueryResultMetadata` ([b1a124c](https://github.com/watson-developer-cloud/node-sdk/commit/b1a124c))
39* **natural-language-classifier:** remove compatibility layer for natural language classifier ([0ac087c](https://github.com/watson-developer-cloud/node-sdk/commit/0ac087c))
40* **natural-language-understanding:** remove compatibility layer for natural language understanding ([359cc79](https://github.com/watson-developer-cloud/node-sdk/commit/359cc79))
41* **personality-insights-v3:** remove compatibility layer for personality insights v3 ([1b27685](https://github.com/watson-developer-cloud/node-sdk/commit/1b27685))
42* **speech-to-text:** remove compatibility layer for speech to text ([310bdd0](https://github.com/watson-developer-cloud/node-sdk/commit/310bdd0))
43* **text-to-speech:** remove compatibility layer for text to speech ([6994d3c](https://github.com/watson-developer-cloud/node-sdk/commit/6994d3c))
44* **tone-analyzer:** remove compatibility layer for tone analyzer ([9f10898](https://github.com/watson-developer-cloud/node-sdk/commit/9f10898))
45* **visual_recognition:** v4 changes ([3957e2d](https://github.com/watson-developer-cloud/node-sdk/commit/3957e2d))
46* in `query` and `federatedQuery`, only accept string values for certain parameters. ([06d7c65](https://github.com/watson-developer-cloud/node-sdk/commit/06d7c65))
47* in discovery, rename `getSourceCredentials` to `getCredentials` ([6fac701](https://github.com/watson-developer-cloud/node-sdk/commit/6fac701))
48* **visual-recognition:** remove compatibility layer for visual recognition ([6377067](https://github.com/watson-developer-cloud/node-sdk/commit/6377067))
49* remove index.ts file as it was deprecated starting in v3 ([4ea3c27](https://github.com/watson-developer-cloud/node-sdk/commit/4ea3c27))
50* remove module for converting training_data to csv ([dd534f6](https://github.com/watson-developer-cloud/node-sdk/commit/dd534f6))
51* require filenames for `createStopwordList` in discovery and `convertToHTML` in compare comply ([8f7c62f](https://github.com/watson-developer-cloud/node-sdk/commit/8f7c62f))
52* stop using cookies in requests ([09e0e91](https://github.com/watson-developer-cloud/node-sdk/commit/09e0e91))
53
54
55### Features
56
57* **discovery:** add new methods: `createTokenizationDictionary`, `deleteTokenizationDictionary`, and `getTokenizationDictionaryStatus` ([d5ba660](https://github.com/watson-developer-cloud/node-sdk/commit/d5ba660))
58* **discovery:** new parameters added to match updates to the service ([838b044](https://github.com/watson-developer-cloud/node-sdk/commit/838b044))
59* add `sort` query parameter to `getWorkspace()` ([1df75ac](https://github.com/watson-developer-cloud/node-sdk/commit/1df75ac))
60* add model `MessageContextSkill` ([15a4c7f](https://github.com/watson-developer-cloud/node-sdk/commit/15a4c7f))
61* new error formatter, provides the same information regardless of service ([c324ab0](https://github.com/watson-developer-cloud/node-sdk/commit/c324ab0))
62* The SDK now returns a Promise for all methods if a callback is not specified. Callbacks can still be used for backwards compatibility. ([fd6e20b](https://github.com/watson-developer-cloud/node-sdk/commit/fd6e20b))
63
64
65### BREAKING CHANGES
66
67* **visual_recognition:** For `updateClassifier` and `createClassifier`, the parameter `{classname}_positive_examples` is changed to a map called `positive_examples` with classnames as keys.
68
69See the migration guide, UPGRADE-4.0.md, for more information.
70* Node 4 will no longer be supported, considered during development, or tested with.
71
72To migrate your code, upgrade to a newer major version of Node.
73* **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.
75* There is no more `index.ts` file, so importing with `require('watson-developer-cloud')` will no longer work.
76
77To migrate your code, import only the services that you need, e.g. `require('watson-developer-cloud/speech-to-text/v1')`.
78
79Using the file `sdk.ts` to export all of the services for browserification
80* The methods `createStopwordList` in discovery and `convertToHTML` in comply comply now have new, required parameters
81
82To migrate your code, include the parameter `stopword_filename` for `createStopwordList`, and `filename` for `convertToHTML`
83* **assistant-v1:** The Assistant v1 parameter `export` is now `_export` is all instances.
84
85To migrate your code, change any use of the `export` parameter to `_export`.
86* The SDK used to document and allow array values for these parameters, converting them to strings to be sent to the service.
87
88To migrate your code, convert any array values for these parameters to comma-separated values in a string.
89* The module `json-training-to-csv` is no longer available.
90
91To migrate your code, provide `training_data` to NLC as a CSV file.
92* 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
94This affects internal functionality but has no effect on client code.
95* Errors objects returned from service errors are now different
96
97To migrate your code, see the upgrade guide for the new error structure:
98* Network responses received in callback function may now have different structures (results and errors). Requests no longer return a Stream.
99
100See the UPGRADE-4.0.md file for more information.
101* **personality-insights:** Personality Insights v2 is no longer available in the SDK
102
103To migrate your code, use Personality Insights v3:
104* **compare-comply:** Parameter `model_id` has been changed to `model` for the following methods: convertToHtml, classifyElements, extractTables, compareDocuments, deleteFeedback, getFeedback, createBatch, and updateBatch
105* **speech-to-text:** Deprecated methods in Speech to Text are no longer available. Changed parameter names are no longer interally corrected.
106
107To 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
108* **text-to-speech:** Deprecated methods in Text to Speech are no longer available. Changed parameter names are no longer interally corrected.
109
110To 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
111* **visual-recognition:** Deprecated methods in Visual Recognition are no longer available. Changed parameter names are no longer interally corrected.
112
113To 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
114* **tone-analyzer:** Deprecated methods in Tone Analyzer are no longer available. Changed parameter names are no longer interally corrected.
115
116To 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
117* **personality-insights-v3:** Deprecated methods in Personality Insights v3 are no longer available. Changed parameter names are no longer interally corrected.
118
119To 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
120* **natural-language-understanding:** The `version_date` parameter in Natural Language Understanding is no longer supported.
121
122To migrate your code, use the parameter name `version` instead.
123* **natural-language-classifier:** Deprecated methods in Natural Language Classifier are no longer available. Changed parameter names are no longer interally corrected.
124
125To 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
126* **discovery:** Deprecated methods in Discovery are no longer available. Changed parameter names are no longer interally corrected.
127
128To 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
129* **conversation:** The Conversation service will no longer be available
130
131To migrate your code, use the Assistant v1 or v2 service.
132* **language-translator-v2:** The Language Translator V2 service will no longer be available
133
134To migrate your code, use the Language Translator V3 service.
135* **dialog:** The Dialog service will no longer be available
136
137To migrate your code, use the Assistant v1 or v2 service.
138* Support for the `api_key` parameter has been removed.
139
140For instances of Visual Recognition, use `iam_apikey` to authenticate.
141* **discovery:** The name of the model `QueryResultResultMetadata` has been changed to `QueryResultMetadata`
142
143To migrate your code, use the model `QueryResultMetadata` instead of `QueryResultResultMetadata`:
144
145## [3.18.4](https://github.com/watson-developer-cloud/node-sdk/compare/v3.18.3...v3.18.4) (2019-03-28)
146
147
148### Bug Fixes
149
150* allow users to use `iam_apikey` when authenticating for icp ([cdccbc1](https://github.com/watson-developer-cloud/node-sdk/commit/cdccbc1))
151
152## [3.18.3](https://github.com/watson-developer-cloud/node-sdk/compare/v3.18.2...v3.18.3) (2019-03-19)
153
154
155### Bug Fixes
156
157* expose token manager from core code as a module ([4376e7c](https://github.com/watson-developer-cloud/node-sdk/commit/4376e7c))
158
159## [3.18.2](https://github.com/watson-developer-cloud/node-sdk/compare/v3.18.1...v3.18.2) (2019-03-15)
160
161
162### Bug Fixes
163
164* make `access_token` an allowable query parameter in recognize / synthesize streams ([a2ad09e](https://github.com/watson-developer-cloud/node-sdk/commit/a2ad09e))
165
166## [3.18.1](https://github.com/watson-developer-cloud/node-sdk/compare/v3.18.0...v3.18.1) (2019-02-14)
167
168
169### Bug Fixes
170
171* use dotenv v5 to maintain node 4.x compatibility ([c311651](https://github.com/watson-developer-cloud/node-sdk/commit/c311651))
172
173# [3.18.0](https://github.com/watson-developer-cloud/node-sdk/compare/v3.17.0...v3.18.0) (2019-02-06)
174
175
176### Features
177
178* **compare-comply:** new constants and new model properties added ([d9dc7cc](https://github.com/watson-developer-cloud/node-sdk/commit/d9dc7cc))
179* **discovery:** add method `getStopwordListStatus` ([ea9eaf9](https://github.com/watson-developer-cloud/node-sdk/commit/ea9eaf9))
180* **speech-to-text:** optional parameter `force` added to the method `upgradeAcousticModel` ([ceaa843](https://github.com/watson-developer-cloud/node-sdk/commit/ceaa843))
181
182# [3.17.0](https://github.com/watson-developer-cloud/node-sdk/compare/v3.16.1...v3.17.0) (2019-02-04)
183
184
185### Features
186
187* enable reading credentials from ibm-credentials.env file ([ce02aa8](https://github.com/watson-developer-cloud/node-sdk/commit/ce02aa8))
188
189## [3.16.1](https://github.com/watson-developer-cloud/node-sdk/compare/v3.16.0...v3.16.1) (2019-01-19)
190
191
192### Bug Fixes
193
194* fix `getTransactionId` method for the `RecognizeStream` class ([e5bbe2c](https://github.com/watson-developer-cloud/node-sdk/commit/e5bbe2c))
195
196# [3.16.0](https://github.com/watson-developer-cloud/node-sdk/compare/v3.15.4...v3.16.0) (2019-01-17)
197
198
199### Features
200
201* **discovery:** add methods `createStopwordList`, `deleteStopwordList`, `createGateway`, `deleteGateway`, `getGateway`, and `listGateways` ([8a6753e](https://github.com/watson-developer-cloud/node-sdk/commit/8a6753e))
202* **speech-to-text:** new methods added: addGrammar, deleteGrammar, getGrammar, listGrammars ([7ab567a](https://github.com/watson-developer-cloud/node-sdk/commit/7ab567a))
203* **visual-recognition:** parameter `accept_language` added to method `detectFaces` ([82190c7](https://github.com/watson-developer-cloud/node-sdk/commit/82190c7))
204
205## [3.15.4](https://github.com/watson-developer-cloud/node-sdk/compare/v3.15.3...v3.15.4) (2019-01-15)
206
207
208### Bug Fixes
209
210* fix bug that prevents `audio` from being sent as a buffer for `recognize` ([3f97b80](https://github.com/watson-developer-cloud/node-sdk/commit/3f97b80))
211
212## [3.15.3](https://github.com/watson-developer-cloud/node-sdk/compare/v3.15.2...v3.15.3) (2019-01-15)
213
214
215### Bug Fixes
216
217* package.json to reduce vulnerabilities ([e61d1de](https://github.com/watson-developer-cloud/node-sdk/commit/e61d1de))
218
219## [3.15.2](https://github.com/watson-developer-cloud/node-sdk/compare/v3.15.1...v3.15.2) (2019-01-14)
220
221
222### Bug Fixes
223
224* query parameters no longer cause text-to-speech over websockets to crash ([775e6d2](https://github.com/watson-developer-cloud/node-sdk/commit/775e6d2))
225* Remove the `disabled` property from `CreateDialogNode`. It is for internal use only. ([4b72d0e](https://github.com/watson-developer-cloud/node-sdk/commit/4b72d0e))
226
227## [3.15.1](https://github.com/watson-developer-cloud/node-sdk/compare/v3.15.0...v3.15.1) (2019-01-07)
228
229
230### Bug Fixes
231
232* add `disabled` property to CreateDialogNode ([41cd8dc](https://github.com/watson-developer-cloud/node-sdk/commit/41cd8dc))
233* add `user_defined` property to MessageOutput model ([ea28bf3](https://github.com/watson-developer-cloud/node-sdk/commit/ea28bf3))
234
235# [3.15.0](https://github.com/watson-developer-cloud/node-sdk/compare/v3.14.0...v3.15.0) (2018-12-07)
236
237
238### Features
239
240* add support for Compare and Comply service ([fa22ae5](https://github.com/watson-developer-cloud/node-sdk/commit/fa22ae5))
241* **discovery:** adds new model, RetrievalDetails ([1821719](https://github.com/watson-developer-cloud/node-sdk/commit/1821719))
242* **natural-language-understanding:** new properties added to models to match the service ([3bf1e5e](https://github.com/watson-developer-cloud/node-sdk/commit/3bf1e5e))
243
244# [3.14.0](https://github.com/watson-developer-cloud/node-sdk/compare/v3.13.1...v3.14.0) (2018-12-06)
245
246
247### Features
248
249* **text-to-speech:** add support for using `synthesize` over a websocket connection ([94ba896](https://github.com/watson-developer-cloud/node-sdk/commit/94ba896))
250
251## [3.13.1](https://github.com/watson-developer-cloud/node-sdk/compare/v3.13.0...v3.13.1) (2018-11-26)
252
253
254### Bug Fixes
255
256* **discovery:** update mis-defined parameters to match the service ([d1fb9a9](https://github.com/watson-developer-cloud/node-sdk/commit/d1fb9a9))
257* **speech-to-text:** `content_type` is no longer a required parameter for `recognize()` or `createJob()` (it is now optional) ([d64c06a](https://github.com/watson-developer-cloud/node-sdk/commit/d64c06a))
258* **speech-to-text:** add support for `language_customization_id` parameter to the WebSockets method, deprecate `customization_id` ([bf2cd68](https://github.com/watson-developer-cloud/node-sdk/commit/bf2cd68))
259
260# [3.13.0](https://github.com/watson-developer-cloud/node-sdk/compare/v3.12.0...v3.13.0) (2018-10-30)
261
262
263### Features
264
265* **discovery:** add new methods: `createTokenizationDictionary`, `deleteTokenizationDictionary`, and `getTokenizationDictionaryStatus` ([d5ba660](https://github.com/watson-developer-cloud/node-sdk/commit/d5ba660))
266
267# [3.12.0](https://github.com/watson-developer-cloud/node-sdk/compare/v3.11.1...v3.12.0) (2018-10-10)
268
269
270### Features
271
272* **discovery:** new parameters added to match updates to the service ([838b044](https://github.com/watson-developer-cloud/node-sdk/commit/838b044))
273
274## [3.11.1](https://github.com/watson-developer-cloud/node-sdk/compare/v3.11.0...v3.11.1) (2018-09-28)
275
276
277### Bug Fixes
278
279* **icp:** disabling ssl verification now works for websocket connection ([f8466c8](https://github.com/watson-developer-cloud/node-sdk/commit/f8466c8))
280
281# [3.11.0](https://github.com/watson-developer-cloud/node-sdk/compare/v3.10.0...v3.11.0) (2018-09-24)
282
283
284### Features
285
286* add support for assistant v2 ([8a99676](https://github.com/watson-developer-cloud/node-sdk/commit/8a99676))
287
288# [3.10.0](https://github.com/watson-developer-cloud/node-sdk/compare/v3.9.1...v3.10.0) (2018-09-13)
289
290
291### Features
292
293* new languages models supported for speech to text ([a2669dd](https://github.com/watson-developer-cloud/node-sdk/commit/a2669dd))
294* support authenticating with ibm cloud private ([0d1774c](https://github.com/watson-developer-cloud/node-sdk/commit/0d1774c))
295
296## [3.9.1](https://github.com/watson-developer-cloud/node-sdk/compare/v3.9.0...v3.9.1) (2018-08-30)
297
298
299### Bug Fixes
300
301* add an optional filename parameter for methods accepting a file ([9a6cb59](https://github.com/watson-developer-cloud/node-sdk/commit/9a6cb59))
302
303# [3.9.0](https://github.com/watson-developer-cloud/node-sdk/compare/v3.8.0...v3.9.0) (2018-08-15)
304
305
306### Features
307
308* **regenerate:** add methods for new discovery metrics endpoints ([f396eca](https://github.com/watson-developer-cloud/node-sdk/commit/f396eca))
309
310# [3.8.0](https://github.com/watson-developer-cloud/node-sdk/compare/v3.7.1...v3.8.0) (2018-08-07)
311
312
313### Features
314
315* regenerate service sdks 7/30/18 ([0f95a92](https://github.com/watson-developer-cloud/node-sdk/commit/0f95a92))
316
317## Version 3.7.0
3187/12/18
319* Operations added for `Credentials` resource (Discovery)
320
321## Version 3.6.0
3227/11/18
323* Support base_model_version parameter in `recognize()` (Speech-to-Text)
324* Authentication service now supports returning IAM tokens
325
326## Version 3.5.1
3276/25/18
328* Fixes bug retrieving Assistant credentials from VCAP services
329* Fixes bug that prevented IAM authentication with Speech to Text websockets
330
331## Version 3.5.0
3326/12/18
333* Support for Language Translator V3
334
335## Version 3.4.5
3366/4/18
337* Fixes bug for Visual Recognition service that caused authentication errors when reading credentials from VCAP Services or environment files
338
339## Version 3.4.3
3405/31/18
341* Fixes bug for Visual Recognition service that gave the incorrect URL for CF instances. Old service instances no longer have to specify the URL
342* General IAM authentication URL changed from https://iam.ng.bluemix.net/identity/token to https://iam.bluemix.net/identity/token
343* `deleteUserData()` methods in Speech to Text, Text to Speech, Visual Recognition
344
345## Version 3.4.2
3465/18/18
347* Updates dependencies to remove security vulnerability
348* Adds methods `deleteUserData` to Assistant, Conversation, and Discovery
349
350## Version 3.4.1
3515/3/18
352* Updates dependencies to be compatible with Node v10
353
354## Version 3.4.0
3554/26/18
356* Support for custom headers https://github.com/watson-developer-cloud/node-sdk#sending-request-headers
357
358* Support for retrieving HTTP response https://github.com/watson-developer-cloud/node-sdk#sending-request-headers
359
360* Support for IAM tokens, which will be supported by services in future releases.
361
362## Version 3.3.0
3634/5/18
364* Visual Recognition
365 * New method `getCoreMlModel` adds support for CoreML
366 * Breaking: `detectFaces` no longer supports identity information in the response.
367 * `name`, `score`, `type_hierarchy` removed from response [Release notes](https://console.bluemix.net/docs/services/visual-recognition/release-notes.html#2april2018)
368
369* Natural Language Classifier
370 * New method 'classifyCollection`
371
372Conversation/Assistant
373 * timestamp parameters `created` and `updated` are optional, not required
374 * `context` parameter is optional in `message`
375
376
377
378
379## Version 3.2.1
3803/15/18
381* Renames Assistant from v1-generated to v1
382
383## Version 3.2.0
3843/15/18
385* Adds Assistant Service (Conversation has been renamed to Assistant)
386
387## Version 3.1.1
3883/8/18
389* Adds warnings to methods with changed names
390* Ensures that new parameters are passed into methods when calling them using the older format used in the adapters.
391
392## Version 3.1.0
3933/7/18
394
395### **Breaking changes:**
396
397Speech to text
398- param `audio` is now required in recognize method
399- methods `createSession`, `deleteSession`, `getSessionStatus` deprecated
400
401### **Non Breaking:**
402
403- All code is regenerated to reflect the newest versions of all services
404- Methods with exclusively text/plain body parameters now are correctly generated
405- Fixes linting in build
406 - Adds new linter, tslint for typescript files
407
408SpeechToText:
409- `addAudio` method: param `audio_resource` is now type ReadableStream|FileObject|Buffer instead of ByteArray[]
410- `transfer-encoding` is removed from `recognize` method
411
412Conversation
413- `include_audit` parameters are now supported
414- `node_visited_details` is now supported
415
416Tone Analyzer
417- Adds support for `content_language` for `tone_chat` endpoint
418
419Visual Recognition
420- Items in ‘parameters’ are now top level params
421
422## [v3.0.7](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v3.0.7)
423 * services use `version` instead of `version_date` and should pass in dates directly such as `'2017-02-27'` instead of calling date constants.
424
425## [v3.0.6](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v3.0.6)
426 * All .ts files are removed from the npm package
427 * Fixes issue of enforcing our typescript compiler settings when other typescript projects use our package
428 * All instances of ReadableStream changed to NodeJs.ReadableStream, blob type added to /lib/, both changes done to correctly link these types for typescript users
429
430## [v3.0.5](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v3.0.5)
431 * [User-Agent] in header is no longer overwritten but instead appended, this change only affects metrics of this SDK
432
433## [v3.0.4](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v3.0.4)
434 * Fixed bug in visual recognition to correctly use owners parameter
435 * Fixed bug in NLU where environment variables storing credentials were not read when running locally
436 * Dependencies updated to fix security vulnerabilities
437
438## [v3.0.3](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v3.0.3)
439
440* Added support for customization_weight or acoustic_customization_id in speech-to-text/v1
441
442
443## Version 3.0
444
445_2017-11-29_
446
447_This version contains several breaking changes._
448
449Version 3.0 introduces automatically generated client code. The client code is generated from [Swagger](https://swagger.io/). Several deprecated services have been removed from this release. Furthermore, language has been changed from *NodeJS* to *TypeScript*, and file extensions have been changed from `*.js` to `*.ts`
450
451Services that are **not affected** in this release:
452
453 * Authorization
454 * Dialog
455
456Services that are **affected** in this release:
457
458 * Conversation
459 * Discovery
460 * Language Translator
461 * Natural Language Classifier
462 * Natural Language Understanding
463 * Personality Insights
464 * Text to Speech
465 * Tone Analyzer
466 * Speech to Text
467 * Visual Recognition
468
469Services that are **removed** in this release:
470
471 * Alchemy Language
472 * Alchemy Data News
473 * Document Conversion
474 * Retrieve and Rank
475 * Tradeoff Analytics
476
477Upon upgrading the SDK, follow the migration guide [here](https://github.com/watson-developer-cloud/node-sdk/wiki/Migration-Guide).
478
479## [v2.39.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.39.0)
480* Added support for `highlight` param in `DiscoveryV1.query()`
481
482## [v2.38.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.38.0)
483* DiscoveryV1.VERSION_DATE_2017_08_01 = '2017-08-01';
484
485## [v2.37.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.37.0)
486* `ToneAnalyzerV3.tone()` now accepts `language` parameter to specify `content-language` header for input.
487
488### [v2.36.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.36.1)
489* Improved formatting of Alchemy Language error messages
490
491## [v2.36.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.36.0)
492* Added `ConversationV1.VERSION_DATE_2017_05_26`
493
494## [v2.35.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.35.0)
495* Added `DiscoveryV1.updateJsonDocument` to compliment`addJsonDocument()`
496
497## [v2.34.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.34.0)
498* Added `DiscoveryV1.addJsonDocument()` method to make uploading in-memory JSON structures easier
499* Fixed bug in `DiscoveryV1.addDocument()` that prevented setting custom filenames [#474](https://github.com/watson-developer-cloud/node-sdk/issues/474)
500
501## [v2.33.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.33.0)
502* Added support for `fuzzy_match` param in Conversation entities methods
503* Added support for JSON metadata when adding documents to Discovery [#474](https://github.com/watson-developer-cloud/node-sdk/issues/474)
504
505### [v2.32.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.32.1)
506* Discovery: fix createEnv with size 0
507
508## [v2.32.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.32.0)
509* Add natural_language_query and passages parameters to Discovery.query()
510* Fix collection name param for Discovery.createCollection ([#https://github.com/watson-developer-cloud/node-sdk/issues/457](https://github.com/watson-developer-cloud/node-sdk/issues/457))
511
512### [v2.31.2](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.30.1)
513* Bumped `solr-client` dependency to latest version
514
515### [v2.31.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.30.1)
516* Added VisualRecognitionV3.VERSION_DATE_2016_05_20 constant
517
518## [v2.31.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.31.0)
519* Added support for sort param on DiscoveryV1.query() ([#446](https://github.com/watson-developer-cloud/node-sdk/pull/446))
520* Added DiscoveryV1.VERSION_DATE_2017_04_27
521* Made utterances a top-level param for ToneAnalyzerV3.tone_chat() ([#439](https://github.com/watson-developer-cloud/node-sdk/pull/439))
522
523## [v2.30.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.30.0)
524* Added support for Conversation entities (w/ values and synonyms) and logs
525* Added support for updating Discovery environments
526
527## [v2.29.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.29.0)
528* Added tone_chat endpoint for Tone Analyzer
529* Added support for WebM and Ogg/Vorbis formats to Speech to Text
530
531### [v2.28.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.28.1)
532* Fixed Visual Recognition credentials in dedicated environments ([#436](https://github.com/watson-developer-cloud/node-sdk/issues/426))
533
534## [v2.28.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.28.0)
535* bumped vcap_services library version
536* Fixed bug with STT async recognition & multiple callback events
537* Moved changelog to wiki
538
539### [v2.27.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.27.1)
540* Fixed issue when creating STT Async recognize job with multiple callback events ([#415](https://github.com/watson-developer-cloud/node-sdk/issues/415))
541
542## [v2.27.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.27.0)
543* Add support for Conversation Counter Examples API
544
545### [v2.26.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.26.1)
546* Correct name of `events` parameter in STT async recognize.
547
548## [v2.26.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.26.0)
549* Conversation sorting and pagination for workspaces, intents, and examples
550
551### [v2.25.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.25.1)
552* Natural Language Understanding: fixed credentials pulling from bluemix
553
554## [v2.25.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.25.0)
555* Natural Language Understanding: new version_date and addition of listModels() and deleteModel() methods
556
557### [v2.24.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.24.1)
558* STT RecognizeStream now exposes Transaction ID
559
560### [v2.23.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.23.1)
561* Restored support for Node.js 4.0-4.4
562
563## [v2.23.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.23.0)
564* Added support for Conversation intents and examples
565
566### [v2.22.2](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.22.2)
567* Speech to Text createRecognitionJob() now accepts all params from .recognize()
568* Speech to Text getRecognitionJobs() accepts an optional params object in order to match the signature of the rest of the API
569
570### [v2.22.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.22.1)
571* Make callback_url optional for Speech to Text createRecognitionJob()
572
573## [v2.22.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.22.0)
574* Speech to Text Asychronous API support
575
576## [v2.21.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.21.0)
577* Added support for sort paramater in SpeechToTextV1.getWords()
578* Added updateDocument() method to DiscoveryV1
579* Fixed up internal code to avoid using the deprecated `new Buffer(...)` API
580* Improved documentation
581
582## [v2.20.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.20.0)
583* Conversation VersionDate 2017-02-03
584
585## [v2.19.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.19.0)
586* Added support for find_preferable_options flag in Tradeoff Analytics
587
588## [v2.18.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.18.0)
589* Added various methods to Conversation service to create and manage workspaces
590* Prevent docs site files from being included in npm releases
591
592### [v2.17.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.17.1)
593* Fixed bug in STT getWords method (#390)
594
595## [v2.17.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.17.0)
596* No API changes, but significant internal changes. Should behave exactly the same, but releasing as a standalone version out of caution.
597
598## [v2.16.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.16.0)
599* Added NaturalLanguageUnderstandingV1
600* Added support for pulling SERVICE_NAME_URL from enviroment properties along with username and password (or api key)
601
602### [v2.15.5](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.15.5)
603* stt.whenCustomizationReady() no longer incorrectly requires that a corpus be added. (#382)
604* various JSDoc corrections
605
606### [v2.15.2](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.15.2)
607* Fix slightly-incorrect URL in Language Translator V2 example and error message
608
609## [v2.15.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.15.0)
610* SDK now emits missing parameter errors on returned stream if no callback is supplied (#368 / #377)
611
612### [v2.14.8](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.14.8)
613* Fix DocumentConversion#convert() to accept config params as documented in api ref
614* Fix param checking on various TTS customization methods
615
616### [v2.14.6](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.14.6)
617* Fix incorrect error messages (#373)
618
619### [v2.14.5](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.14.5)
620* Fix issue where adding a document as buffer/string fails in Discovery v1 (#370)
621* Fix issue where STT RecognizeStream could fail to emit speaker_labels event in rare circumstances
622
623### [v2.14.4](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.14.4)
624* Update jsdoc for Speech to text
625
626### [v2.14.3](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.14.3)
627* Expose discovery v1 in index
628
629### [v2.14.2](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.14.2)
630* Same fix for language translation
631
632### [v2.14.7](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.14.7)
633* Fixed DocumentConversionV1.convert() to accept config params as a seperate object, matching api ref documentation (#375)
634
635### [v2.14.6](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.14.6)
636* Fix regression in error handler that would incorrectly overwrite error message in some cases
637
638### [v2.14.5](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.14.5)
639* Fix isue where STT RecognizeStream could fail to emit a speaker_labels events in certain rare circumstances
640* Added Discovery add createEnvironment and deleteEnvironment methods
641* Fix Discovery addDocument when adding a Buffer
642
643### [v2.14.4](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.14.4)
644* Update JSDOc for speech to Text
645
646### [v2.14.3](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.14.3)
647* Expose discovery v1 in index.js
648
649### [v2.14.2](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.14.2)
650* Fix content type for language translation (#362)
651
652### [v2.14.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.14.1)
653* Fix content type for language translator (#362)
654
655## [v2.14.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.14.0)
656* Added Discovery V1 (general availability release)
657
658## [v2.13.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.13.0)
659* Added STT whenCorporaAnalyzed() helper, #353
660* Bumped dependencies
661
662## [v2.12.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.12.0)
663* Added Speech to Text speaker_labels support, added new speaker_labels event to RecognizeStream
664
665### [v2.11.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.11.1)
666* Fixed main file path in package.json
667* added a conversation example
668
669## [v2.11.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.11.0)
670* Added several methods and a version_date constant to DiscoveryV1Experimental
671
672### [v2.10.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.10.1)
673* Added version_date constants to ConversationV1, updated docs, examples, etc to latest version_date.
674
675### [v2.9.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.9.1)
676* Added customization_id support to STT RecognizeStream
677
678## [v2.9.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.9.0)
679* Allow VisualRecognitionV3.classify() to accept Buffers (with automatic content-type detection) or Objects with specified filename or content-type
680* Improve Visual Recognition error formatting
681* Document Conversion: Remove forced utf-8 charset header for html files
682
683### [v2.8.3](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.8.3)
684* Fixed issue with formatting multiple keywords for STT recognize() - #261
685
686### [v2.8.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.8.1)
687* Added `getCredentials()` method to base service, primarily for use with AuthorizationV1()
688
689### [v2.7.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.7.1)
690* dependency fix
691
692## [v2.7.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.7.0)
693* Speech to Text customization support
694
695### [v2.6.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.6.1)
696* Ensure errors are always instanceof Error
697* Doc improvements
698
699## [v2.6.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.6.0)
700* Added support for Personality Insights V3
701
702## [v2.5.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.5.0)
703* Split LanguageTranslationV2 into a seperate service from LanguageTranslatorV2, added a warning when translator service is used without specifying a url since the default is currently incorrect.
704* Fixed bug with setting user-agent header
705
706### [v2.4.7](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.4.7)
707* Fixed issue with send data on non-open WebSockets for STT RecognizeStream - see #322
708
709### [v2.4.6](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.4.6)
710* Fixed credential bugs in R&R and STT
711
712### [v2.4.5](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.4.5)
713* Fixed bug where credentials could be lost when calling certain methods in Language Translator and Dialog services
714
715### [v2.4.4](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.4.4)
716* Doc-only changes, focused on Language Translation/Translator differences and temporary workaround
717
718### [v2.4.3](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.4.3)
719* Fix issue with automatically loading Alchemy* credentials from the Bluemix environment
720
721### [v2.4.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.4.1)
722* Revert part of credential change: Alchemy* services again use `apikey` while visual recognition uses `api_key`
723 (Most endpoints accept either, but this split follows the documented API for each service.)
724
725## [v2.4.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.4.0)
726* Added support for Visual Recognition similarity search beta
727* Refactored handling of credentials to support constraints in similarity search
728
729## [v2.3.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.3.0)
730* Add support for RetrieveAndRankV1.rank() answers param
731
732## [v2.2.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.2.0)
733* Added support for creating and managing TTS Customizations
734
735### [v2.1.3](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.1.3)
736* Deprecation warning for Dialog
737* Added TTS .voice() and .pronunciation() methods
738* Added support for `customization_id` to existing TTS methods
739* Typo and JSDoc fixes
740* Fixed bug with pulling api key from env properties for alchemy services
741
742### [v2.1.2](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.1.2)
743* Added profanity_filter support to STT RecognizeStream
744
745### [v2.1.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.1.1)
746* Corrected some examples to use - instead of _
747* Renamed NLC folder to use - instead of _
748
749## [v2.1.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.1.0)
750* Updated AlchemyLanguageV1.emotion() to support new targeted_emotion parameter & endpoint
751* Added Conversation/Tone Analyzer integration example
752* Updated Readme & Examples to use newer constructor style
753
754### [v2.0.3](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.0.3)
755* Use actual Error instances for errors (#298)
756
757### [v2.0.2](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.0.2)
758
759* Added support for the `intents`, `entities` and `output` parameters in ConveersationV1.message()
760* Removed sunset services: Concept Insights and Relationship Extraction
761* Dependency bump
762
763
764### [v2.0.1](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.0.1)
765
766* Added VisualRecognitionV3.retrainClassifier() to facilitate updating of existing custom classifiers
767* Added support for `alternate_intents` parameter in ConversationV1.message()
768
769
770# [v2.0.0](https://github.com/watson-developer-cloud/node-sdk/releases/tag/v2.0.0)
771
772* Breaking: prefer programatic (user-supplied) credentials over bluemix-provided ones (VCAP_SERVICES)
773* New preferred method of instantiating services: `new watson.PersonalityInsightsV2({/*...*/});` instead of `watson.personality_insights({/*...*/});`. Older method still works
774* Restructured code to support client-side usage via tools such as Browserify and Webpack. Most services support CORS; this will be documented and the remaining service teams will be nagged.
775* Added a changelog to capture both major breaking changes and smaller
776
777
778# Breaking Changes for v1.0
779
780Several breaking changes were introduced with the v1.0.0 release:
781
782 * Experimental and Beta services now require the appropriate tag to be added to their version:
783 * Concept Expansion `v1` is now `v1-beta`
784 * Question and Answer `v1` is now `v1-beta`
785 * Relationship Extraction `v1` is now `v1-beta`
786 * Tone Analyzer `v3` is now `v3` (latest) or `v3-beta` (compatibility with old Beta plan)
787 * Visual Insights `v1` is now `v1-experimental`
788 * Visual Recognition `v1` is now `v1-beta`
789 * Speech to Text gained a new `createRecognizeStream()` method replacing the existing live streaming methods with a simpler Read/Write stream.
790 The older methods are still available in v1.0 but each log a deprecation warning (unless `{silent: true}` is passed in) and will be removed from a future release.
791 The affected methods are:
792 * `recognizeLive()`
793 * `observeResult()`
794 * `getRecognizeStatus()`
795 * The Document Conversion API has been reduced to a single `convert()` method; it no longer offers batch conversion or cloud storage of files.
796 * Several deprecated services have been removed:
797 * Message Resonance
798 * Tone Analyzer v1 and v2 (replaced by v3)
799 * Search (replaced by Retrieve and Rank)
800 * Dropped support for node.js v0.10.x (For reference: the WDC Node.js SDK now officially support the latest 0.12, LTS, and Stable releases of Node.js.)