7.0.0

7.0.0 (2019-03-28)

Breaking changes

General

• Some big things in the migration guide
• All properties of the type Map have been changed to Map<String, Object>

Assistant v1

Model changes

• CreateCounterexample renamed to Counterexample
• CreateDialogNode renamed to DialogNode
• CreateExample renamed to Example
• EntityExport renamed to Entity
• InputData renamed to MessageInput
• IntentExport renamed to Intent
• LogExport renamed to Log
• Mentions renamed to Mention
• ValueExport renamed to Value
• WorkspaceExport renamed to Workspace

Property changes

• DialogNode
  • dialogNodeId renamed to dialogNode
• Entity
  • entityName renamed to entity
• EntityMention
  • exampleText renamed to text
  • intentName renamed to intent
• Example
  • exampleText renamed to text
• Intent
  • intentName renamed to intent
• Synonym
  • synonymText renamed to synonym
• Value
  • valueText renamed to value

Other

• Counterexample getters have been renamed (e.g. getText() -> text())
• MessageInput is now dynamic
• addValue() method in CreateEntityOptions.Builder renamed to addValues()

Assistant v2

Model changes

• MessageContextSkill has been deleted

Compare and Comply

Model changes

• Category renamed to CategoryComparison
• TypeLabel renamed to TypeLabelComparison

Property changes

• Attribute
  • ADDRESS constant removed from Type interface
• BodyCells
  • rowHeaderIds type changed from List<String> to List<RowHeaderIds>
  • rowHeaderTexts type changed from List<String> to List<RowHeaderTexts>
  • rowHeaderTextsNormalized type changed from List<String> to List<RowHeaderTextsNormalized>
  • columnHeaderIds type changed from List<String> to List<ColumnHeaderIds>
  • columnHeaderTexts type changed from List<String> to List<ColumnHeaderTexts>
  • columnHeaderTextsNormalized type changed from List<String> to List<ColumnHeaderTextsNormalized>
• ClassifyElementsOptions
  • modelId renamed to model
  • filename has been deleted
  • ModelId interface renamed to Model
• CompareDocumentsOptions
  • modelId renamed to model
  • file1Filename has been deleted
  • file2Filename has been deleted
  • ModelId interface renamed to Model
• ConvertToHtmlOptions
  • modelId renamed to model
  • ModelId interface renamed to Model
• CreateBatchOptions
  • modelId renamed to model
  • inputCredentialsFilename has been deleted
  • outputCredentialsFilename has been deleted
  • ModelId interface renamed to Model
• DeleteFeedbackOptions
  • modelId renamed to model
  • ModelId interface renamed to Model
• ExtractTablesOptions
  • modelId renamed to model
  • filename has been deleted
  • ModelId interface renamed to Model
• GetFeedbackOptions
  • modelId renamed to model
  • ModelId interface renamed to Model
• UpdateBatchOptions
  • modelId renamed to model
  • ModelId interface renamed to Model

Discovery

Model changes

• QueryResultResultMetadata renamed to QueryResultMetadata

Property changes

• CreateConfigurationOptions
  • name is now required
• CreateExpansionsOptions
  • expansions is now required
• DiskUsage
  • percentUsed has been deleted
  • total has been deleted
  • totalBytes has been deleted
  • used has been deleted
• DocumentStatus
  • created has been deleted
  • updated has been deleted
• FederatedQueryOptions
  • collectionIds type changed from List<String> to String
  • passagesFields type changed from List<String> to String
  • returnFields type changed from List<String> to String
  • similarDocumentIds type changed from List<String> to String
  • similarFields type changed from List<String> to String
  • sort type changed from List<String> to String
• Field
  • BOOLEAN constant renamed to XBOOLEAN in FieldType interface
  • BYTE constant renamed to XBYTE in FieldType interface
  • DOUBLE constant renamed to XDOUBLE in FieldType interface
  • FLOAT constant renamed to XFLOAT in FieldType interface
  • LONG constant renamed to XLONG in FieldType interface
  • SHORT constant renamed to XSHORT in FieldType interface
• IndexCapacity
  • memoryUsage has been deleted
• QueryResult
  • score has been deleted
• QueryNoticesResult
  • score has been deleted
• QueryOptions
  • collectionIds type changed from List<String> to String
  • passagesFields type changed from List<String> to String
  • returnFields type changed from List<String> to String
  • similarDocumentIds type changed from List<String> to String
  • similarFields type changed from List<String> to String
  • sort type changed from List<String> to String
• SourceStatus
  • COMPLETE_WITH_NOTICES constant removed from Status interface
  • STOPPED constant removed from Status interface
• UpdateConfigurationOptions
  • name is now required

Other

• CreateConfigurationOptions
  • Builder(String environmentId) changed to Builder(String environmentId, String name)
  • addEnrichments() renamed to addEnrichment()
  • addNormalizations() renamed to addNormalization()
• CreateExpansionsOptions
  • Builder(String environmentId, String collectionId) changed to Builder(String environmentId, String collectionId, List<Expansion> expansions)
• UpdateConfigurationOptions
  • Builder(String environmentId, String configurationId) changed to Builder(String environmentId, String configurationId, String name)
  • addEnrichments() renamed to addEnrichment()
  • addNormalizations() renamed to addNormalization()

Language Translator

Property changes

• CreateModelOptions
  • forcedGlossaryFilename has been deleted
  • parallelCorpusFilename has been deleted

Natural Language Classifier

Property changes

• CreateClassifierOptions
  • metadataFilename has been deleted
  • trainingDataFilename has been deleted

Other

• Old versions of classify(), createClassifier(), deleteClassifier(), getClassifier(), and getClassifiers() without options model parameters have been removed

Natural Language Understanding

Model changes

• CategoriesOptions is no longer dynamic
• MetadataOptions is no longer dynamic
• MetadataResult renamed to AnalysisResultsMetadata
• SemanticRolesAction renamed to SemanticRolesResultAction
• SemanticRolesObject renamed to SemanticRolesResultObject
• SemanticRolesSubject renamed to SemanticRolesResultSubject
• Usage renamed to AnalysisResultsUsage

Other

• CategoriesOptions
  • getLimit() has been renamed to limit()

Personality Insights

Other

• profileAsCsv() now just accepts a single ProfileOptions profileOptions parameter

Speech to Text

Property changes

• AddCorpusOptions
  • corpusFilename has been deleted
• AudioListing
  • duration type changed from Double to Long
• AudioResource
  • duration type changed from Double to Long

Other

• CreateJobOptions.Builder constructor with InputStream audio and String contentType parameters removed
• RecognizeOptions.Builder constructor with InputStream audio and String contentType parameters removed

Text to Speech

Property changes

• AddWordOptions
  • translation is now required
• AddWordsOptions
  • words is now required

Visual Recognition

Property changes

• ClassifyOptions
  • parameters property has been deleted
  • imagesFilename now required if imagesFile is specified
• CreateClassifierOptions
  • positiveExamplesFilename property has been deleted
• DetectFacesOptions
  • parameters property has been deleted
  • imagesFilename now required if imagesFile is specified
• UpdateClassifierOptions
  • positiveExamplesFilename property has been deleted

Other

• Old API key authentication is no longer supported
• CreateClassifierOptions
  • addClass() method renamed to addPositiveExamples()
• UpdateClassifierOptions
  • addClass() method renamed to addPositiveExamples()

Non-breaking changes

General

• The core portion of the SDK has been moved to its own repo
• Added reactiveRequest() execution method (see README section and migration guide)
  • Thanks for the suggestion @msogrin!
• Null values are returned from the APIs (#959)
• com.ibm.jsse2.overrideDefaultTLS is no longer changed (#1020)
• IAM authentication is done on a separate thread to play better with Android (#1041)

Assistant v1

Model changes

• Counterexample
  • Now has a builder
• CreateCounterexampleOptions
  • Allows for setting a Counterexample object in the builder
• CreateDialogNodeOptions
  • Allows for setting a DialogNode object in the builder
• CreateSynonymOptions
  • Allows for setting a Synonym object in the builder
• CreateValueOptions
  • Allows for setting a CreateValue object in the builder
• DialogNode
  • Now has a builder
• Example
  • Now has a builder
• Synonym
  • Now has a builder
• Value
  • Now has a builder

Property changes

• CreateEntity
  • created has been added
  • updated has been added
• CreateIntent
  • created has been added
  • updated has been added
• DialogRuntimeResponseGeneric
  • dialogNode has been added
• DialogSuggestion
  • dialogNode has been added
• Entity
  • values has been added
• Intent
  • examples has been added
• MessageRequest
  • actions has been added
• Workspace
  • counterexamples has been added
  • dialogNodes has been added
  • entities has been added
  • intents has been added
  • status property has been added
  • Status interface has been added

Compare and Comply

Model changes

• ColumnHeaderIds added
• ColumnHeaderTexts added
• ColumnHeaderTextsNormalized added
• ContractType added
• Key added
• KeyValuePair added
• RowHeaderIds added
• RowHeaderTexts added
• RowHeaderTextsNormalized added
• Value added

Property changes

• Attribute
  • DURATION constant added to Type interface
  • PERCENTAGE constant added to Type interface
• ClassifyReturn
  • contractType added
• Tables
  • keyValuePairs added

Discovery

Model changes

• SourceOptionsBuckets added

Property changes

• CreateCollectionOptions
  • ZH_CN constant added to Language interface
• CreateCredentialsOptions
  • CLOUD_OBJECT_STORAGE constant added to SourceType interface
• Credentials
  • CLOUD_OBJECT_STORAGE constant added to SourceType interface
• CredentialDetails
  • AWS4_HMAC constant added to CredentialType interface
  • accessKeyId added
  • endpoint added
  • secretAccessKey added
• QueryNoticesResult
  • title added
• QueryResult
  • title added
• Source
  • CLOUD_OBJECT_STORAGE constant added to SourceType interface
• SourceOptions
  • buckets added
  • crawlAllBuckets added
• SourceStatus
  • QUEUED constant added to Status interface
• UpdateCredentialsOptions
  • CLOUD_OBJECT_STORAGE constant added to SourceType interface

Natural Language Understanding

Model changes

• CategoriesOptions
  • Now has a builder
• SentenceResult added
• SyntaxOptions added
• SyntaxOptionsToken added
• SyntaxOptionsResult added
• TokenResult added

Property changes

• AnalysisResults
  • syntax added
• CategoriesOptions
  • model added
• Features
  • syntax added

Personality Insights

Property changes

• ProfileOptions
  • csvHeaders added

Speech to Text

Property changes

• AddAudioOptions
  • AUDIO_ALAW constant added to ContentType interface
  • AUDIO_ALAW constant added to ContainedContentType interface
• CreateJobOptions
  • AUDIO_ALAW constant added to ContentType interface
• RecognizeOptions
  • AUDIO_ALAW constant added to ContentType interface

Text to Speech

Property changes

• GetPronunciationOptions
  • EN_US_ALLISONV2VOICE constant added to Voice interface
  • EN_US_LISAV2VOICE constant added to Voice interface
  • EN_US_MICHAELV2VOICE constant added to Voice interface
  • DE_DE_BIRGITV2VOICE constant added to Voice interface
  • DE_DE_DIETERV2VOICE constant added to Voice interface
  • IT_IT_FRANCESCAV2VOICE constant added to Voice interface
• GetVoiceOptions
  • EN_US_ALLISONV2VOICE constant added to Voice interface
  • EN_US_LISAV2VOICE constant added to Voice interface
  • EN_US_MICHAELV2VOICE constant added to Voice interface
  • DE_DE_BIRGITV2VOICE constant added to Voice interface
  • DE_DE_DIETERV2VOICE constant added to Voice interface
  • IT_IT_FRANCESCAV2VOICE constant added to Voice interface
• SynthesizeOptions
  • EN_US_ALLISONV2VOICE constant added to Voice interface
  • EN_US_LISAV2VOICE constant added to Voice interface
  • EN_US_MICHAELV2VOICE constant added to Voice interface
  • DE_DE_BIRGITV2VOICE constant added to Voice interface
  • DE_DE_DIETERV2VOICE constant added to Voice interface
  • IT_IT_FRANCESCAV2VOICE constant added to Voice interface