Changelog

Version 6.1.0

2018-06-12

Language Translator

• Language Translator v3 released! This can be accessed in the new com.ibm.watson.developer_cloud.language_translator.v3 package.

Version 6.0.0

2018-05-30

General

• Default IAM authentication URL changed from https://iam.ng.bluemix.net/identity/token to https://iam.bluemix.net/identity/token

Assistant/Conversation

• cursor property in LogPagination model replaced with nextCursor
• cursor property in Pagination model replaced with refreshCursor and nextCursor

Personality Insights

• getProfileAsCSV method renamed to profileAsCsv
• profileAsCsv return type changed from String to InputStream

Speech to Text

• version property in CreateJobOptions and RecognizeOptions renamed to baseModelVersion
• deleteUserData() method added, along with associated options model

Text to Speech

• deleteUserData() method added, along with associated options model

Visual Recognition

• Old service instances work properly again without having to explicitly set the endpoint
• deleteUserData() method added, along with associated options model

Version 5.5.0

2018-05-18

General

• New: Report showing API difference between last and newest release (@chohanbin)

Assistant

• New: deleteUserData() method added, along with associated options model
• New: DIGRESSION_RETURN_PROMPT constant added to CreateDialogNode, CreateDialogNodeOptions, DialogNode, UpdateDialogNodeOptions models

Conversation

• New: deleteUserData() method added, along with associated options model
• New: DIGRESSION_RETURN_PROMPT constant added to CreateDialogNode, CreateDialogNodeOptions, DialogNode, UpdateDialogNodeOptions models

Discovery

• New: deleteUserData() method added, along with associated options model

Speech to Text

• New: BaseModelName constants added to CreateAcousticModelOptions, CreateLanguageModelOptions model

Version 5.4.0

2018-04-23

General (see main README for instructions)

• New: Add support for authentication through IAM

Assistant

• New: conditions property added to DialogNodeVisitedDetails model

Conversation

• New: DialogNode adds digressIn, digressOut, and digressOutSlots properties
• New: conditions property added to DialogNodeVisitedDetails model

Speech to Text

• New: ko-KR_BroadbandModel and ko-KR_NarrowbandModel added as constants in GetModelOptions model

Version 5.3.0

2018-04-13

General (See main README for instructions)

• New: Ability to send custom headers in requests
• New: Ability to read response headers

Discovery

• Fix: Use of unsupported query aggregations no longer throws StackOverflowError
• New: Support for remaining query aggregations added (filter, nested, timeslice, top_hits, unique_count)
• New: evidenceCount property added to queryEntities() and queryRelations() methods
• New: segment property added to Conversions model
• Change: entities property of the QueryEntitiesResponse model changed from type QueryEntitiesEntity to QueryEntitiesResponseItem
• New: QueryEntitiesResponseItem model added
• New: QueryEvidence model added
• New: QueryEvidenceEntity model added
• New: FileType enum as well as code, filename, fileType, sha1, and notices properties added to the QueryNoticesResult model
• New: evidence property added to QueryRelationsRelationship model
• New: SegmentSettings model added

Speech to Text

• Fix: Bug in microphone example of Speech to Text README

Version 5.2.0

2018-04-05

General

• Fix: Documentation and examples updated to reflect current state of SDK

Natural Language Classifier

• New: classifyCollection() method added

Visual Recognition

• New: getCoreMlModel() method added
• Change: DetectFacesBetaOptions, FaceFaceLocation, and FaceIdentity models removed
• Change: identity property removed from Face model

Version 5.1.1

2018-03-19

• Fix: The Watson Assistant service is now available in the JAR file or Maven/Gradle dependencies
• Fix: URLs are now properly encoded before being sent to the Watson services

Version 5.1.0

2018-03-15

Rebranded Service: Conversation -> Assistant

The Conversation service is rebranding to Assistant, and the Assistant service is included in this release. Since it's just a rebrand, functionality is equal between them and migrating should just involve renaming class references. However, both will be available in the SDK for this release.

Assistant

• New: DialogNode adds digressIn, digressOut, and digressOutSlots properties

Speech to Text

• Fix: recognizeUsingWebSocket() has been fixed to allow proper passing of parameters from the SDK to the API | #895

Version 5.0.1

2018-03-07

General

• Change: Remove version date constants from service classes
• Change: Remove setters for various models where they should not be necessary
• Fix: Resolve SSLHandshakeExceptions when calling the Visual Recognition service with the Oracle JDK 7

Conversation

• New: append parameter added to updateWorkspace()
• New: nodesVisitedDetails parameter added to message()
• New: CaptureGroup model
• New: DialogNodeVisitedDetails model
• New: Add behavior constants to DialogNodeNextStep: get_user_input, skip_user_input, reprompt, skip_slot, skip_all_slots
• New: includeAudit parameter added to the following methods: getWorkspace(), listWorkspaces(), getIntent(), listIntents(), getExample(), listExamples(), getEntity(), listEntities(), getValue(), listValues(), getSynonym(), listSynonyms(), getDialogNode(), listDialogNodes(), getCounterexample(), listCounterexamples()

Discovery

• New: createExpansions() method added, along with the associated CreateExpansionsOptions model
• New: deleteExpansions() method added, along with the associated DeleteExpansionsOptions model
• New: listExpansions() method added, along with the associated ListExpansionsOptions model
• New: Expansion and Expansions models
• Change: pt-br language in CreateCollectionOptions changed to pt
• New: model property added to EnrichmentOptions model
• Change: Builder removed in NluEnrichmentRelations model
• New: similar, similarDocumentIds, and similarFields parameters added to federatedQuery(), federatedQueryNotices(), query(), and queryNotices()

Natural Language Classifier

• Change: id property in Classification model renamed to classifierId
• Change: name property in ClassifiedClass model renamed to className
• Change: id property in Classifier model renamed to classifierId
• Change: Rename Classifiers model to ClassifierList

Overall, all method signatures have changes with the introduction of Options models. The experience should now be the same as other services

Natural Language Understanding

• Change: DBpediaResource model removed
• Change: ErrorResponse model removed
• Change: FeaturesResults model removed
• Change: InlineResponse200 model removed
• Change: LinkedDataResult model removed
• Change: Parameters model removed
• Change: FeaturesResults model removed

The above models were not used anyway and were erroneously added to the SDK before.

Speech to Text

• Change: createCustomization() renamed to createLanguageModel()
• Change: createRecognitionJob() renamed to createJob()
• Change: deleteCustomization() renamed to deleteLanguageModel()
• Change: deleteRecognitionJob() renamed to deleteJob()
• Change: getCorpora() renamed to listCorpora()
• Change: getCustomization() renamed to getLanguageModel()
• Change: getCustomizations() renamed to listLanguageModels()
• Change: getModels() renamed to listModels()
• Change: getRecognitionJob() renamed to checkJob()
• Change: getRecognitionJobs() renamed to checkJobs()
• Change: getRecognizeStatus() renamed to getSessionStatus()
• Change: getWords() renamed to listWords()
• Change: resetCustomization() renamed to resetLanguageModel()
• Change: trainCustomization() renamed to trainLanguageModel()
• New: upgradeLanguageModel() method added, along with the associated UpgradeLanguageModelOptions model
• New: unregisterCallback() method added, along with the associated UnregisterCallbackOptions model
• New: createAcousticModel() method added, along with the associated CreateAcousticModelOptions model
• New: deleteAcousticModel() method added, along with the associated DeleteAcousticModelOptions model
• New: getAcousticModel() method added, along with the associated GetAcousticModelOptions model
• New: listAcousticModels() method added, along with the associated ListAcousticModelsOptions model
• New: resetAcousticModel() method added, along with the associated ResetAcousticModelOptions model
• New: trainAcousticModel() method added, along with the associated TrainAcousticModelOptions model
• New: upgradeAcousticModel() method added, along with the associated UpgradeAcousticModelOptions model
• New: addAudio() method added, along with the associated AddAudioOptions model
• New: deleteAudio() method added, along with the associated DeleteAudioOptions model
• New: getAudio() method added, along with the associated GetAudioOptions model
• New: listAudio() method added, along with the associated ListAudioOptions model

Overall, all method signatures have changes with the introduction of Options models. The experience should now be the same as other services

Text to Speech

• Change: getVoices() renamed to listVoices()
• Change: createCustomVoiceModel() renamed to createVoiceModel()
• Change: updateCustomVoiceModel() renamed to updateVoiceModel()
• Change: getCustomVoiceModels() renamed to listVoiceModels()
• Change: getCustomVoiceModel() renamed to getVoiceModel()
• Change: createCustomVoiceModel() renamed to createVoiceModel()
• Change: deleteCustomVoiceModel() renamed to deleteVoiceModel()
• Change: getWords() renamed to listWords()
• Change: Can no longer use getVoiceModel() by passing in the model you want

Overall, all method signatures have changes with the introduction of Options models. The experience should now be the same as other services

Tone Analyzer

• Change: utteranceId property in UtteranceAnalysis model changed from a String type to Long

Visual Recognition

• New: retrained property added to Classifier model
• New: code property added to ErrorInfo model
• Change: parameters property of the ClassifyOptions model replaced with the following properties: url, threshold, owners, and classifierIds
• Change: parameters property of the DetectFacesOptions model replaced with url

Version 4.2.1

2017-12-15

Discovery

• Fix: Adding/updating configuration parsing problems noted here
• New: Enrichments have been changed. EnrichmentOptions now has parameters of new model types, namely:
  • NluEnrichmentCategories
  • NluEnrichmentEmotion
  • NluEnrichmentEntities
  • NluEnrichmentFeatures
  • NluEnrichmentKeywords
  • NluEnrichmentRelations
  • NluEnrichmentSemanticRoles
  • NluEnrichmentSentiment

Personality Insights

• Fix: Add getProfileAsCSV() method which had been mistakenly deleted back in v4.0.0

Version 4.1.0

2017-12-06

General

• Fix: Getting/setting dynamic properties now works properly
• New: Service URL is now set through JDNI automatically

Conversation

• New: listAllLogs() method added, along with the associated ListAllLogsOptions model
• New: language and workspaceId properties added to LogExport model
• New: credentials property added to DialogNodeAction model
• New: valueType and patterns properties added to Value, CreateValue, and ValueExport models

Discovery

• New: federatedQuery() method added, along with the associated FederatedQueryOptions model
• New: federatedQueryNotices() method added, along with the associated FederatedQueryNoticesOptions model
• New: listFields() method added, along with the associated ListFieldsOptions model
• New: listTrainingExamples() method added, along with the associated ListTrainingExamplesOptions model
• New: queryEntities() method added
• New: queryRelations() method added
• New: CollectionUsage model
• New: MemoryUsage model
• New: QueryEntities model
• New: QueryEntitiesEntity model
• New: QueryEntitiesContext model
• New: QueryEntitiesResponse model
• New: QueryRelations model
• New: QueryRelationsEntity model
• New: QueryRelationsFilter model
• New: QueryFilterType model
• New: QueryRelationsResponse model
• New: QueryRelationsRelationship model
• New: QueryRelationsArgument model
• New: percentUsed, total, used, and totalBytes properties added to DiskUsage model
• New: collections and memoryUsage properties added to IndexCapacity model
• New: collectionId and resultMetadata properties added to QueryResult model

Natural Language Understanding

• New: EntityMention model
• New: DisambiguationResult model
• New: Feed model
• New: textCharacters and textUnits properties added to Usage model
• New: mentions property added to EntitiesOptions model
• New: mentions and disambiguation properties added to EntitiesResult model
• New: target property added to SentimentOptions model
• New: target property added to EmotionOptions model
• New: modelId property added to DeleteModelOptions model
• New: feeds and image properties added to MetadataResult model

Personality Insights

• New: children and significant properties added to Trait model

Tone Analyzer

• New: tones and warning properties added to DocumentAnalysis model
• New: tones property added to SentenceAnalysis model
• New: warning property added to UtteranceAnalyses model
• New: error property added to UtteranceAnalysis model

Visual Recognition

• Fix: Erroneously named FaceFaceLocation renamed to FaceLocation

Version 4.0.0

2017-09-21

Version 4.0 introduces automatically generated service classes for several services.

Services that are not affected in this release:

• Speech to Text
• Text to Speech
• Retrieve and Rank
• Document Conversion
• Tradeoff Analytics

Services that are affected in this release:

• Discovery
• Conversation
• Natural Language Understanding
• Tone Analyzer
• Language Translator
• Personality Insights
• Visual Recognition

Breaking changes in these notes will be labeled accordingly. Upon upgrading the SDK, follow the migration guide here.

SDK Generation

Most changes in this release broadly affect all of the newly-generated services. Those general changes, as well as any service-specific changes, are as follows:

General Changes Related to Auto-Generation

• (breaking) Options classes have been added services to handle request customization
• Some classes now support arbitrary reponse that can be accessed on the object as a HashMap<String, Object>
• (breaking depending on method) Add support for InputStream parameters when dealing with files. Content-Type or filename can be specified along with InputStream
• Parameters and properties defined as enums in the API definition are declared with the underlying datatype in the SDK, for better forward compatibility. Where appropriate, the enum values are declared as constants to provide guidance to the developer and reduce the opportunity for typos.
• (breaking) Completely removed deprecated Dialog, Language Translation, and Personality Insights v2 services

Discovery

• (breaking) Delete methods no longer return response objects
• Add support for the passages parameter when making queries
• (breaking) Various classes have had reponse properties set to read-only

Conversation

• (breaking) Rename service class from "ConversationService" to "Conversation"
• Add Dialog Node support

Natural Language Understanding

• Add support for the limitTextCharacters parameter when making a GET or POST request to the analyze endpoint

Version 3.9.1

2017-08-29

• Fix: [visual-recognition] Adding an image does not return the added image #764
• Fix: [visual-recognition] Metadata not added to images #763
• Fix: Language Translator readme example is outdated #756
• Fix: [speech-to-text] websockets - Getting 500 Server Error while trying to recognize using custom model and websockets #754
• Fix: [speech-to-text] Getting RuntimeException: Malformed GUID: 'en-US_BroadbandModel' when using STT in Frankfurt and customizationID #752
• Fix: Integration test testUserAgent failing #736
• Fix: wrong code example #733
• Fix: [Speech-to-Text] Stops in seconds for websocket transcription #727

Version 3.9.0

2017-08-27

• Fix: okHttp error when running in an IBM-JDK

Version 3.8.0

2017-04-24

• New: Add support for workspaces in Conversation 1b291a5
• New: Update okhttp version to 3.7.0 7912344
• New: Change WAV to WebM in comments in test-to-speech 4535c70
• New: Add support for Customer Care API endpoint for Tone Analyzer 7a5fcfe
• New: Add new audio format to text-to-speech 07a375e
• New: Add new audio format to speech-to-text 1c93196
• Fix: Enable cipher suites 4b51aee
• Fix: Enable all TLS protocols 842383b
• Fix: Use target in language translator Fixes #655 999f04c
• Fix: Date deserialization for ISO 8601 dates with Z timezone 6c870dc
• Fix: SerializedName annotation for configuration id and test dd0ec53
• Fix: Fix NLU example 8c33f2b

Version 3.7.2

2017-04-07

• New: Provide a specific document Id when creating a document d581c3f
• New: NLU: Add model for disambiguation and property in EntitiesResults 8acb411
• New: Add test for disambiguation info 9328c5f
• Fix: Discovery: create or update a document from an InputStream and optionally spec… … ab2f413
• Fix: Add README.md for Natural Language Understanding 4e53c8f
• Fix: 👕 Checkstyle Verified a95c68d
• Fix: TTS Synthesize using POST, fixes #635 and #602 Verified 5ae0d24
• Fix: Language translator, update service name Verified 37abc86

Version 3.7.1

2017-03-31

• Fix: Enable all cipher suites cf58894 74cae1b
• Fix: afterEvaluate source for docs task 0f93ec3
• Fix: Disable HTML escaping, #532 c6497ed
• Fix: CheckStyle d5ccc68 9a7654b 9a7654b
• Fix: Examples link in README.md 430f3a6 by @rborer
• Doc: Exclude tests from javadoc generation 60e80de
• Doc: Update HTTP logging information #496 85e2424
• New: Add aggregate Javadocs plugin b6d1123
• New: Add tradeoff analytics test case for #306 9f40779
• New: Adds an HTTPLogging interceptor #496 620d8d9
• New: Unit tests for Natural Language Understanding 5e89f3a

Version 3.7.0

2017-03-19

• New: Added Natural Language Understanding
• Fix: Text-to-Speech failed with combine of special characters, e.g Spanish + ";" bug text-to-speech #602
• Fix: Alchemy Language - CombinedResults missing Emotion #545

Version 3.6.0

2017-03-07

• New: Automatic releases
• Change: Update OkHttp to v3.6.0
• New: Speech to Text: Add addCorpus() method, deprecate addTextToCustomizationCorpus() method
• New: Speech to Text: Add getCorpus() method
• New: Speech to Text: Add sort parameter to getWords() method
• New: Speech to Text: Add SupportedFeatures for SpeechModel object
• New: Speech to Text: Add and fix constructors for Word object
• New: Speech to Text: Add count to WordData object
• New: Speech to Text: Add confidence to SpeakerLabel object
• New: Speech to Text: Add warnings to RecognitionJob object
• Fix: Speech to Text: Enable customization_id for recognizeUsingWebSocket() method
• Fix: Speech to Text: Fix allowOverwrite parameter of addTextToCustomizationCorpus() method
• Fix: Speech to Text: Fix error field for WordData object
• New: Text to Speech: Add createCustomVoiceModel() and updateCustomVoiceModel() methods, deprecate saveCustomVoiceModel() method
• New: Text to Speech: Add addWords() and addWord() methods, deprecate saveWords() method
• New: Text to Speech: Add getWord() method
• New: Text to Speech: Add getCustomVoiceModel() method with CustomVoiceModel argument
• New: Text to Speech: Add deleteWord() method with String argument
• New: Text to Speech: Add words to CustomVoiceModel object
• New: Text to Speech: Add part_of_speech to CustomTranslation object
• Fix: Text to Speech: Enable customization results for getVoice() method
• New: Tradeoff Analytics: Add findPreferableOptions parameter to dilemmas() method
• New: Tradeoff Analytics: Add PreferableSolutions object to Resolution object
• New: Tradeoff Analytics: Add DominatingOption object to Solution object

Version 3.5.3

2016-12-15

• New: Added Discovery v1

Version 3.5.2

2016-12-08

• New: Added Speaker Labeling (diarization) added
• New: Added Conversation + Tone Analyzer example
• New: Added byte array support to classify an in memory image
• Fix: Text to Speech: getPronunciation() and getVoice now accept a customizationId parameter.

Version 3.5.1

2016-11-01

• Fix: Remove limitation when creating a Solr cluster

Version 3.5.0

2016-10-19

• New: Personality Insights v3
• New: Speech to Text Customizations
• New: Conversation version date 2016-09-19
• Fix: Calling synthesize in Text to Speech now accepts a rate for PCM. #454
• Fix: READMEs now point to the right maven dependency #459
• Fix: AlchemyLanguage now has anchor dates for combine calls
• Fix: Retrieve and Rank topAnswer bug #456

Version 3.4.1

2016-09-30

• New: Add Language Translator

Version 3.4.0

2016-09-29

The SDK 3.4.0 is the first step into moving from one maven module into a multi-module project. This change will allow users to specify the service they want to use skipping the other services. For example, in order to use Retrieve and Rank in Gradle you need:

'com.ibm.watson.developer_cloud:retrieve-and-rank:3.4.0'

• New: Move to a maven multi-module project
• Fix: Send default headers in WebSocket connections #422
• Fix: Skip token creation if skipAuthentication=true #440

Version 3.3.1

2016-09-07

• New: AlchemyLanguage now returns the sourceText in the combined call.
• New: Add french broadband model to Speech to Text
• Fix: Add extracted dates to Alchemy Language combined call #436
• Fix: Speech to text example close the connection when finish the extracted dates to Alchemy Language combined call #436
• Fix: removed deprecated services: Concept Insights and Relationship Extraction.
• Fix: Add missing parameter in document conversation. #428
• Fix: Add smart_formatting to Speech to Text

Version 3.3.0

2016-08-08

• New: Tests are ignored if config.properties doesn't have valid credentials
• New: Document Conversion can index documents directly into Retrieve and Rank
• New: Visual Recognition Re-training
• New: Conversation v1: MessageRequest now supports entities and intents
• New: AlchemyLanguage typedRelations entities and intents
• New: Speech to Text keyword_spotting
• Fix: Remove Relationship extraction v1 Beta
• Fix: Remove Tone Analyzer v3 Beta
• Fix: 🔥 update version_date for Visual Recognition to be 2016-05-20
• Fix: Remove warning when JDNI can't find credentials

Version 3.2.0

2016-08-02

• New: Conversation v1
• New: Text To Speech now supports audio/basic, audio/i16 and ogg/vorgis
• New: AlchemyLanguage now has a TypedRelation method that extract relationships and entities from text
• Fix: Speech to Text now returns the voice description when calling getVoices()
• Fix: url from VCAP_SERVICES take precedence over the default url
• Fix: Removed Relationship Extraction v1-beta
• Fix: Removed Tone Analyzer v3-beta

Version 3.0.1

2016-06-08

The SDK 3.0.1 introduced support for react( use rx()). Services can now be combined using react in a synchronous or asynchronous calls and calls more efficiently.

• New: The User-Agent can be customized
• New: Services added:
  • Visual Recognition v3
  • Conversation v1-experimental
  • Tone Analyzer v3
• New: profanity_filter added to Speech to Text
• New: Introduce reactive API calls (use rx())
• New: Added new voices to Speech to Text
• New: getVoice() in Speech to Text and Text to Speech
• New: keyword_spotting in Speech to Text
• New: AlchemyLanguage now provides typedRelations() from Relationship Extraction
• Fix: Error when running in Android and using JDNI
• Fix: Error when loading ContentItems from a file in Personality Insights
• Fix: Conceptual search in Concept Insights now return the user_fields
• Fix: Content-Type in Speech to text when using flac files
• Fix: Warning when calling Alchemy services regarding connections being leaked
• Fix: Added missing fields in AlchemyDataNews
• Fix: SSL certificate issues when running in Bluemix and using the IBM JDK

Version 3.0.0-RC1

2016-04-22

The SDK 3.0 is designed around a new API that offers asynchronous callbacks in addition to synchronous blocking calls. It uses modern Java patterns like immutability and chained builders.

• New: Deprecated methods were removed
• Fix: Websockets issues during a recognition using Speech to Text
• New: Automatic snapshot deployments to Sonatype
• New: Chained builders for Speech to text and Tradeoff Analytics

Version 2.10.0

2016-04-18

• Fix: Switch from String to Integer in AlchemyVision face recognition
• New: Enumerations for Languages in Language Translation
• Fix: Error in AlchemyLanguage when language wasn't specified