Skip to content

Latest commit

 

History

History
799 lines (520 loc) · 42 KB

CHANGELOG.md

File metadata and controls

799 lines (520 loc) · 42 KB

4.0.1 (2019-03-29)

Bug Fixes

  • add compare comply keyword to package.json (to trigger release) (7905445)

4.0.0 (2019-03-28)

Bug Fixes

  • icp: disabling ssl verification now works for websocket connection (f8466c8)
  • update ibm-cloud-sdk-core to 0.1.1 (29f87df)

Build System

  • remove support for node 4 (1548413)

chore

  • remove all code dealing with api_key in the base class (92d48e2)
  • conversation: remove conversation service and all associated code (c810de2)
  • dialog: remove dialog service and all associated (7d7408f)
  • language-translator-v2: remove language translator v2 service and all associated code (83d9232)
  • personality-insights: remove Personality Insights v2 (e5e5302)

Code Refactoring

  • assistant-v1: change name of variable export to _export (91ed5a4)
  • assistant-v2: parameter names changed for v4 (f6adbe9)
  • compare-comply: parameter names changed for v4 (908d8e7)
  • refactor core code to use axios instead of request for network requests (f656731)
  • discovery: remove compatibility layer for discovery (8571a1f)
  • discovery: rename model QueryResultResultMetadata to QueryResultMetadata (b1a124c)
  • natural-language-classifier: remove compatibility layer for natural language classifier (0ac087c)
  • natural-language-understanding: remove compatibility layer for natural language understanding (359cc79)
  • personality-insights-v3: remove compatibility layer for personality insights v3 (1b27685)
  • speech-to-text: remove compatibility layer for speech to text (310bdd0)
  • text-to-speech: remove compatibility layer for text to speech (6994d3c)
  • tone-analyzer: remove compatibility layer for tone analyzer (9f10898)
  • visual_recognition: v4 changes (3957e2d)
  • in query and federatedQuery, only accept string values for certain parameters. (06d7c65)
  • in discovery, rename getSourceCredentials to getCredentials (6fac701)
  • visual-recognition: remove compatibility layer for visual recognition (6377067)
  • remove index.ts file as it was deprecated starting in v3 (4ea3c27)
  • remove module for converting training_data to csv (dd534f6)
  • require filenames for createStopwordList in discovery and convertToHTML in compare comply (8f7c62f)
  • stop using cookies in requests (09e0e91)

Features

  • discovery: add new methods: createTokenizationDictionary, deleteTokenizationDictionary, and getTokenizationDictionaryStatus (d5ba660)
  • discovery: new parameters added to match updates to the service (838b044)
  • add sort query parameter to getWorkspace() (1df75ac)
  • add model MessageContextSkill (15a4c7f)
  • new error formatter, provides the same information regardless of service (c324ab0)
  • The SDK now returns a Promise for all methods if a callback is not specified. Callbacks can still be used for backwards compatibility. (fd6e20b)

BREAKING CHANGES

  • visual_recognition: For updateClassifier and createClassifier, the parameter {classname}_positive_examples is changed to a map called positive_examples with classnames as keys.

    • See the migration guide, UPGRADE-4.0.md, for more information.
  • Node 4 will no longer be supported, considered during development, or tested with.

    • To migrate your code, upgrade to a newer major version of Node.
  • assistant-v2: For updateValue, parameter new_type is changed to new_value_type. For updateDialogNode, parameter new_type is changed to new_node_type.

    • These method renames are breaking changes. Update the method names to migrate your code.
  • There is no more index.ts file, so importing with require('watson-developer-cloud') will no longer work.

    • To migrate your code, import only the services that you need, e.g. require('watson-developer-cloud/speech-to-text/v1').
  • The methods createStopwordList in discovery and convertToHTML in comply comply now have new, required parameters

    • To migrate your code, include the parameter stopword_filename for createStopwordList, and filename for convertToHTML
  • assistant-v1: The Assistant v1 parameter export is now _export is all instances.

    • To migrate your code, change any use of the export parameter to _export.
  • The SDK used to document and allow array values for these parameters, converting them to strings to be sent to the service.

    • To migrate your code, convert any array values for these parameters to comma-separated values in a string.
  • The module json-training-to-csv is no longer available.

    • To migrate your code, provide training_data to NLC as a CSV file.
  • Cookies will no longer be sent or stored in requests. This should have very little impact on usage but is techincally a breaking change.

    • This affects internal functionality but has no effect on client code.
  • Errors objects returned from service errors are now different

    • To migrate your code, see the upgrade guide for the new error structure
  • Network responses received in callback function may now have different structures (results and errors). Requests no longer return a Stream.

    • See the UPGRADE-4.0.md file for more information.
  • personality-insights: Personality Insights v2 is no longer available in the SDK

    • To migrate your code, use Personality Insights v3:
  • compare-comply: Parameter model_id has been changed to model for the following methods: convertToHtml, classifyElements, extractTables, compareDocuments, deleteFeedback, getFeedback, createBatch, and updateBatch

  • speech-to-text: Deprecated methods in Speech to Text are no longer available. Changed parameter names are no longer interally corrected.

  • text-to-speech: Deprecated methods in Text to Speech are no longer available. Changed parameter names are no longer interally corrected.

  • visual-recognition: Deprecated methods in Visual Recognition are no longer available. Changed parameter names are no longer interally corrected.

  • tone-analyzer: Deprecated methods in Tone Analyzer are no longer available. Changed parameter names are no longer interally corrected.

  • personality-insights-v3: Deprecated methods in Personality Insights v3 are no longer available. Changed parameter names are no longer interally corrected.

  • natural-language-understanding: The version_date parameter in Natural Language Understanding is no longer supported.

    • To migrate your code, use the parameter name version instead.
  • natural-language-classifier: Deprecated methods in Natural Language Classifier are no longer available. Changed parameter names are no longer interally corrected.

  • discovery: Deprecated methods in Discovery are no longer available. Changed parameter names are no longer interally corrected.

  • conversation: The Conversation service will no longer be available

    • To migrate your code, use the Assistant v1 or v2 service.
  • language-translator-v2: The Language Translator V2 service will no longer be available

    • To migrate your code, use the Language Translator V3 service.
  • dialog: The Dialog service will no longer be available

    • To migrate your code, use the Assistant v1 or v2 service.
  • Support for the api_key parameter has been removed.

    • For instances of Visual Recognition, use iam_apikey to authenticate.
  • discovery: The name of the model QueryResultResultMetadata has been changed to QueryResultMetadata

    • To migrate your code, use the model QueryResultMetadata instead of QueryResultResultMetadata:

3.18.4 (2019-03-28)

Bug Fixes

  • allow users to use iam_apikey when authenticating for icp (cdccbc1)

3.18.3 (2019-03-19)

Bug Fixes

  • expose token manager from core code as a module (4376e7c)

3.18.2 (2019-03-15)

Bug Fixes

  • make access_token an allowable query parameter in recognize / synthesize streams (a2ad09e)

3.18.1 (2019-02-14)

Bug Fixes

  • use dotenv v5 to maintain node 4.x compatibility (c311651)

3.18.0 (2019-02-06)

Features

  • compare-comply: new constants and new model properties added (d9dc7cc)
  • discovery: add method getStopwordListStatus (ea9eaf9)
  • speech-to-text: optional parameter force added to the method upgradeAcousticModel (ceaa843)

3.17.0 (2019-02-04)

Features

  • enable reading credentials from ibm-credentials.env file (ce02aa8)

3.16.1 (2019-01-19)

Bug Fixes

  • fix getTransactionId method for the RecognizeStream class (e5bbe2c)

3.16.0 (2019-01-17)

Features

  • discovery: add methods createStopwordList, deleteStopwordList, createGateway, deleteGateway, getGateway, and listGateways (8a6753e)
  • speech-to-text: new methods added: addGrammar, deleteGrammar, getGrammar, listGrammars (7ab567a)
  • visual-recognition: parameter accept_language added to method detectFaces (82190c7)

3.15.4 (2019-01-15)

Bug Fixes

  • fix bug that prevents audio from being sent as a buffer for recognize (3f97b80)

3.15.3 (2019-01-15)

Bug Fixes

  • package.json to reduce vulnerabilities (e61d1de)

3.15.2 (2019-01-14)

Bug Fixes

  • query parameters no longer cause text-to-speech over websockets to crash (775e6d2)
  • Remove the disabled property from CreateDialogNode. It is for internal use only. (4b72d0e)

3.15.1 (2019-01-07)

Bug Fixes

  • add disabled property to CreateDialogNode (41cd8dc)
  • add user_defined property to MessageOutput model (ea28bf3)

3.15.0 (2018-12-07)

Features

  • add support for Compare and Comply service (fa22ae5)
  • discovery: adds new model, RetrievalDetails (1821719)
  • natural-language-understanding: new properties added to models to match the service (3bf1e5e)

3.14.0 (2018-12-06)

Features

  • text-to-speech: add support for using synthesize over a websocket connection (94ba896)

3.13.1 (2018-11-26)

Bug Fixes

  • discovery: update mis-defined parameters to match the service (d1fb9a9)
  • speech-to-text: content_type is no longer a required parameter for recognize() or createJob() (it is now optional) (d64c06a)
  • speech-to-text: add support for language_customization_id parameter to the WebSockets method, deprecate customization_id (bf2cd68)

3.13.0 (2018-10-30)

Features

  • discovery: add new methods: createTokenizationDictionary, deleteTokenizationDictionary, and getTokenizationDictionaryStatus (d5ba660)

3.12.0 (2018-10-10)

Features

  • discovery: new parameters added to match updates to the service (838b044)

3.11.1 (2018-09-28)

Bug Fixes

  • icp: disabling ssl verification now works for websocket connection (f8466c8)

3.11.0 (2018-09-24)

Features

  • add support for assistant v2 (8a99676)

3.10.0 (2018-09-13)

Features

  • new languages models supported for speech to text (a2669dd)
  • support authenticating with ibm cloud private (0d1774c)

3.9.1 (2018-08-30)

Bug Fixes

  • add an optional filename parameter for methods accepting a file (9a6cb59)

3.9.0 (2018-08-15)

Features

  • regenerate: add methods for new discovery metrics endpoints (f396eca)

3.8.0 (2018-08-07)

Features

  • regenerate service sdks 7/30/18 (0f95a92)

Version 3.7.0

7/12/18

  • Operations added for Credentials resource (Discovery)

Version 3.6.0

7/11/18

  • Support base_model_version parameter in recognize() (Speech-to-Text)
  • Authentication service now supports returning IAM tokens

Version 3.5.1

6/25/18

  • Fixes bug retrieving Assistant credentials from VCAP services
  • Fixes bug that prevented IAM authentication with Speech to Text websockets

Version 3.5.0

6/12/18

  • Support for Language Translator V3

Version 3.4.5

6/4/18

  • Fixes bug for Visual Recognition service that caused authentication errors when reading credentials from VCAP Services or environment files

Version 3.4.3

5/31/18

Version 3.4.2

5/18/18

  • Updates dependencies to remove security vulnerability
  • Adds methods deleteUserData to Assistant, Conversation, and Discovery

Version 3.4.1

5/3/18

  • Updates dependencies to be compatible with Node v10

Version 3.4.0

4/26/18

Version 3.3.0

4/5/18

  • Visual Recognition

    • New method getCoreMlModel adds support for CoreML
    • Breaking: detectFaces no longer supports identity information in the response.
      • name, score, type_hierarchy removed from response Release notes
  • Natural Language Classifier

  • New method 'classifyCollection`

Conversation/Assistant

  • timestamp parameters created and updated are optional, not required
  • context parameter is optional in message

Version 3.2.1

3/15/18

  • Renames Assistant from v1-generated to v1

Version 3.2.0

3/15/18

  • Adds Assistant Service (Conversation has been renamed to Assistant)

Version 3.1.1

3/8/18

  • Adds warnings to methods with changed names
  • Ensures that new parameters are passed into methods when calling them using the older format used in the adapters.

Version 3.1.0

3/7/18

Breaking changes:

Speech to text

  • param audio is now required in recognize method
  • methods createSession, deleteSession, getSessionStatus deprecated

Non Breaking:

  • All code is regenerated to reflect the newest versions of all services
  • Methods with exclusively text/plain body parameters now are correctly generated
  • Fixes linting in build
    • Adds new linter, tslint for typescript files

SpeechToText:

  • addAudio method: param audio_resource is now type ReadableStream|FileObject|Buffer instead of ByteArray[]
  • transfer-encoding is removed from recognize method

Conversation

  • include_audit parameters are now supported
  • node_visited_details is now supported

Tone Analyzer

  • Adds support for content_language for tone_chat endpoint

Visual Recognition

  • Items in ‘parameters’ are now top level params
  • services use version instead of version_date and should pass in dates directly such as '2017-02-27' instead of calling date constants.
  • All .ts files are removed from the npm package
  • Fixes issue of enforcing our typescript compiler settings when other typescript projects use our package
  • All instances of ReadableStream changed to NodeJs.ReadableStream, blob type added to /lib/, both changes done to correctly link these types for typescript users
  • [User-Agent] in header is no longer overwritten but instead appended, this change only affects metrics of this SDK
  • Fixed bug in visual recognition to correctly use owners parameter
  • Fixed bug in NLU where environment variables storing credentials were not read when running locally
  • Dependencies updated to fix security vulnerabilities
  • Added support for customization_weight or acoustic_customization_id in speech-to-text/v1

Version 3.0

2017-11-29

This version contains several breaking changes.

Version 3.0 introduces automatically generated client code. The client code is generated from Swagger. 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

Services that are not affected in this release:

  • Authorization
  • Dialog

Services that are affected in this release:

  • Conversation
  • Discovery
  • Language Translator
  • Natural Language Classifier
  • Natural Language Understanding
  • Personality Insights
  • Text to Speech
  • Tone Analyzer
  • Speech to Text
  • Visual Recognition

Services that are removed in this release:

  • Alchemy Language
  • Alchemy Data News
  • Document Conversion
  • Retrieve and Rank
  • Tradeoff Analytics

Upon upgrading the SDK, follow the migration guide here.

  • Added support for highlight param in DiscoveryV1.query()
  • DiscoveryV1.VERSION_DATE_2017_08_01 = '2017-08-01';
  • ToneAnalyzerV3.tone() now accepts language parameter to specify content-language header for input.
  • Improved formatting of Alchemy Language error messages
  • Added ConversationV1.VERSION_DATE_2017_05_26
  • Added DiscoveryV1.updateJsonDocument to complimentaddJsonDocument()
  • Added DiscoveryV1.addJsonDocument() method to make uploading in-memory JSON structures easier
  • Fixed bug in DiscoveryV1.addDocument() that prevented setting custom filenames #474
  • Added support for fuzzy_match param in Conversation entities methods
  • Added support for JSON metadata when adding documents to Discovery #474
  • Discovery: fix createEnv with size 0
  • Bumped solr-client dependency to latest version
  • Added VisualRecognitionV3.VERSION_DATE_2016_05_20 constant
  • Added support for sort param on DiscoveryV1.query() (#446)
  • Added DiscoveryV1.VERSION_DATE_2017_04_27
  • Made utterances a top-level param for ToneAnalyzerV3.tone_chat() (#439)
  • Added support for Conversation entities (w/ values and synonyms) and logs
  • Added support for updating Discovery environments
  • Added tone_chat endpoint for Tone Analyzer
  • Added support for WebM and Ogg/Vorbis formats to Speech to Text
  • Fixed Visual Recognition credentials in dedicated environments (#436)
  • bumped vcap_services library version
  • Fixed bug with STT async recognition & multiple callback events
  • Moved changelog to wiki
  • Fixed issue when creating STT Async recognize job with multiple callback events (#415)
  • Add support for Conversation Counter Examples API
  • Correct name of events parameter in STT async recognize.
  • Conversation sorting and pagination for workspaces, intents, and examples
  • Natural Language Understanding: fixed credentials pulling from bluemix
  • Natural Language Understanding: new version_date and addition of listModels() and deleteModel() methods
  • STT RecognizeStream now exposes Transaction ID
  • Restored support for Node.js 4.0-4.4
  • Added support for Conversation intents and examples
  • Speech to Text createRecognitionJob() now accepts all params from .recognize()
  • Speech to Text getRecognitionJobs() accepts an optional params object in order to match the signature of the rest of the API
  • Make callback_url optional for Speech to Text createRecognitionJob()
  • Speech to Text Asychronous API support
  • Added support for sort paramater in SpeechToTextV1.getWords()
  • Added updateDocument() method to DiscoveryV1
  • Fixed up internal code to avoid using the deprecated new Buffer(...) API
  • Improved documentation
  • Conversation VersionDate 2017-02-03
  • Added support for find_preferable_options flag in Tradeoff Analytics
  • Added various methods to Conversation service to create and manage workspaces
  • Prevent docs site files from being included in npm releases
  • Fixed bug in STT getWords method (#390)
  • No API changes, but significant internal changes. Should behave exactly the same, but releasing as a standalone version out of caution.
  • Added NaturalLanguageUnderstandingV1
  • Added support for pulling SERVICE_NAME_URL from enviroment properties along with username and password (or api key)
  • stt.whenCustomizationReady() no longer incorrectly requires that a corpus be added. (#382)
  • various JSDoc corrections
  • Fix slightly-incorrect URL in Language Translator V2 example and error message
  • SDK now emits missing parameter errors on returned stream if no callback is supplied (#368 / #377)
  • Fix DocumentConversion#convert() to accept config params as documented in api ref
  • Fix param checking on various TTS customization methods
  • Fix incorrect error messages (#373)
  • Fix issue where adding a document as buffer/string fails in Discovery v1 (#370)
  • Fix issue where STT RecognizeStream could fail to emit speaker_labels event in rare circumstances
  • Update jsdoc for Speech to text
  • Expose discovery v1 in index
  • Same fix for language translation
  • Fixed DocumentConversionV1.convert() to accept config params as a seperate object, matching api ref documentation (#375)
  • Fix regression in error handler that would incorrectly overwrite error message in some cases
  • Fix isue where STT RecognizeStream could fail to emit a speaker_labels events in certain rare circumstances
  • Added Discovery add createEnvironment and deleteEnvironment methods
  • Fix Discovery addDocument when adding a Buffer
  • Update JSDOc for speech to Text
  • Expose discovery v1 in index.js
  • Fix content type for language translation (#362)
  • Fix content type for language translator (#362)
  • Added Discovery V1 (general availability release)
  • Added STT whenCorporaAnalyzed() helper, #353
  • Bumped dependencies
  • Added Speech to Text speaker_labels support, added new speaker_labels event to RecognizeStream
  • Fixed main file path in package.json
  • added a conversation example
  • Added several methods and a version_date constant to DiscoveryV1Experimental
  • Added version_date constants to ConversationV1, updated docs, examples, etc to latest version_date.
  • Added customization_id support to STT RecognizeStream
  • Allow VisualRecognitionV3.classify() to accept Buffers (with automatic content-type detection) or Objects with specified filename or content-type
  • Improve Visual Recognition error formatting
  • Document Conversion: Remove forced utf-8 charset header for html files
  • Fixed issue with formatting multiple keywords for STT recognize() - #261
  • Added getCredentials() method to base service, primarily for use with AuthorizationV1()
  • dependency fix
  • Speech to Text customization support
  • Ensure errors are always instanceof Error
  • Doc improvements
  • Added support for Personality Insights V3
  • 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.
  • Fixed bug with setting user-agent header
  • Fixed issue with send data on non-open WebSockets for STT RecognizeStream - see #322
  • Fixed credential bugs in R&R and STT
  • Fixed bug where credentials could be lost when calling certain methods in Language Translator and Dialog services
  • Doc-only changes, focused on Language Translation/Translator differences and temporary workaround
  • Fix issue with automatically loading Alchemy* credentials from the Bluemix environment
  • Revert part of credential change: Alchemy* services again use apikey while visual recognition uses api_key (Most endpoints accept either, but this split follows the documented API for each service.)
  • Added support for Visual Recognition similarity search beta
  • Refactored handling of credentials to support constraints in similarity search
  • Add support for RetrieveAndRankV1.rank() answers param
  • Added support for creating and managing TTS Customizations
  • Deprecation warning for Dialog
  • Added TTS .voice() and .pronunciation() methods
  • Added support for customization_id to existing TTS methods
  • Typo and JSDoc fixes
  • Fixed bug with pulling api key from env properties for alchemy services
  • Added profanity_filter support to STT RecognizeStream
  • Corrected some examples to use - instead of _
  • Renamed NLC folder to use - instead of _
  • Updated AlchemyLanguageV1.emotion() to support new targeted_emotion parameter & endpoint
  • Added Conversation/Tone Analyzer integration example
  • Updated Readme & Examples to use newer constructor style
  • Use actual Error instances for errors (#298)
  • Added support for the intents, entities and output parameters in ConveersationV1.message()
  • Removed sunset services: Concept Insights and Relationship Extraction
  • Dependency bump
  • Added VisualRecognitionV3.retrainClassifier() to facilitate updating of existing custom classifiers
  • Added support for alternate_intents parameter in ConversationV1.message()
  • Breaking: prefer programatic (user-supplied) credentials over bluemix-provided ones (VCAP_SERVICES)
  • New preferred method of instantiating services: new watson.PersonalityInsightsV2({/*...*/}); instead of watson.personality_insights({/*...*/});. Older method still works
  • 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.
  • Added a changelog to capture both major breaking changes and smaller

Breaking Changes for v1.0

Several breaking changes were introduced with the v1.0.0 release:

  • Experimental and Beta services now require the appropriate tag to be added to their version:
    • Concept Expansion v1 is now v1-beta
    • Question and Answer v1 is now v1-beta
    • Relationship Extraction v1 is now v1-beta
    • Tone Analyzer v3 is now v3 (latest) or v3-beta (compatibility with old Beta plan)
    • Visual Insights v1 is now v1-experimental
    • Visual Recognition v1 is now v1-beta
  • Speech to Text gained a new createRecognizeStream() method replacing the existing live streaming methods with a simpler Read/Write stream. 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. The affected methods are:
    • recognizeLive()
    • observeResult()
    • getRecognizeStatus()
  • The Document Conversion API has been reduced to a single convert() method; it no longer offers batch conversion or cloud storage of files.
  • Several deprecated services have been removed:
    • Message Resonance
    • Tone Analyzer v1 and v2 (replaced by v3)
    • Search (replaced by Retrieve and Rank)
  • 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.)