This document should serve as a guide to breaking changes for users moving from code using the v8.x.x version of the SDK to v9.x.x.

• The version of a service can be retrieved with getVersion()
• The version of a service can be set with setVersion()

• Added function bulkClassify(): Identify intents and entities in multiple user utterances.

BulkClassifyOptions, BulkClassifyOutput, BulkClassifyResponse, BulkClassifyUtterance, DialogNodeContext, DialogNodeOutputConnectToAgentTransferInfo, DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent, DialogNodeOutputGenericDialogNodeOutputResponseTypeImage, DialogNodeOutputGenericDialogNodeOutputResponseTypeOption, DialogNodeOutputGenericDialogNodeOutputResponseTypePause, DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill, DialogNodeOutputGenericDialogNodeOutputResponseTypeText, RuntimeResponseGenericRuntimeResponseTypeConnectToAgent, RuntimeResponseGenericRuntimeResponseTypeImage, RuntimeResponseGenericRuntimeResponseTypeOption, RuntimeResponseGenericRuntimeResponseTypePause, RuntimeResponseGenericRuntimeResponseTypeSuggestion, RuntimeResponseGenericRuntimeResponseTypeText

DialogSuggestionOutput, DialogSuggestionResponseGeneric, SystemResponse

Context

• Added Builder
• System property type changed from SystemResponse to Map<String, Object>

Counterexample, CreateEntity, CreateIntent, CreateValue, Example, Synonym, Value

• created, updated properties are read only

CreateDialogNodeOptions

• context property type changed from Map<String, Object> to DialogNodeContext

DialogNode

• context property type changed from Map<String, Object> to DialogNodeContext
• disabled, created and updated properties are read only

DialogNodeOutput

• Added Builder
• Added integrations property with getter and setter

DialogNodeOutputGeneric,

• Added discriminator
• Removed Builder
• Added read only properties agentAvailable, AgentUnavailable, and transferInfo

DialogSuggestion

• output property type changed from DialogSuggestionOutput to Map<String, Object>

ListCounterExamplesOptions, ListDialogNodesOptions, ListEntitiesOptions, ListExamplesOptions, ListIntentsOptions, ListSynonymsOptions, ListValuesOptions, ListWorkspacesOptions

• includeCount property added with setter and getter

MessageInput

• Added Builder
• Changed suggestedText and originalText properties to read only

MessageRequest

• Changed actions property to read only

OutputData

• Added Builder

RuntimeResponseGeneric,

• Added discriminator
• Changed ResponseType interface use only TEXT
• Removed Builder
• Added read only properties agentAvailable, AgentUnavailable, and transferInfo

UpdateDialogNodeOptions

• Changed newContext property type from Map<String, Object> to DialogNodeContext

• Added function bulkClassify(): Identify intents and entities in multiple user utterances.

BulkClassifyOptions, BulkClassifyOutput, BulkClassifyResponse, BulkClassifyUtterance, DialogNodeOutputConnectToAgentTransferInfo, RuntimeResponseGenericRuntimeResponseTypeConnectToAgent, RuntimeResponseGenericRuntimeResponseTypeImage, RuntimeResponseGenericRuntimeResponseTypeOption, RuntimeResponseGenericRuntimeResponseTypePause, RuntimeResponseGenericRuntimeResponseTypeSearch, RuntimeResponseGenericRuntimeResponseTypeSuggestion, RuntimeResponseGenericRuntimeResponseTypeText

MessageContextSkills

MessageContext, MessageContextStateless

• Changed skills property type from MessageContextSkills to Map<String, MessageContextSkill>

MessageContextGlobal

• Changed sessionId property to read only

MessageContextSkill

• Changed system property type from Map<String, Object> to MessageContextSkillSystem

MessageContextSkillSystem

• Added Builder

RuntimeResponseGeneric

• Added discriminator
• Removed Builder
• Added read only properties agentAvailable, AgentUnavailable, and transferInfo

• No changes

Category, TypeLabel

• Added modification property

ListBatchesOptions

• Removed Builder

ListFeedbackOptions

• Removed before and after properties

OriginalLabelsOut, UpdatedLabelsOut

• Removed modification property

• No changes

NluEnrichmentCategories

Configuration

• Changed configurationId, created, and updated properties to read only

Credentials

• Changed credentialId property to read only

EventData

• Changed queryId property to read only

NluEnrichmentFeatures

• Changed categories property type from NluEnrichmentCategories to Map<String, Object>

• Added function analyzeDocument(): Process a document using the specified collection's settings and return it for realtime use. - Currently CP4D only

AnalyzedDocument, AnalyzeDocumentOptions, AnalyzedResult

QueryNoticesResult

CollectionDetails

• Changed collectionId and created properties to read only

TrainingExample

• Changed created and updated properties to read only

TrainingQuery

• Changed created, queryId and updated properties to read only

• No changes

ListDocumentsOptions, ListIdentifiableLanguagesOptions, ListLanguagesOptions

• Removed Builder

• No changes

ListClassifiersOptions

• Removed Builder

• No changes

FeaturesResultsMetadata

MetadataOptions, AnalysisResultsMetadata

AnalysisResults

• Changed metadata property type from AnalysisResultsMetadata to FeaturesResultsMetadata

Features

• Changed metadata property type from MetadataOptions to Map<String, Object>

ListModelsOptions

• Remove Builder

• Added deprecation notice

• No changes

• recognizeUsingWebSocket(): Changed recognizeOptions parameter type from RecognizeOptions to RecognizeWithWebsocketsOptions

RecognizeWithWebsocketsOptions

CheckJobsOptions, ListModelOptions

• Removed Builder

RecognizeOptions

• Removed interimResults, processingMetrics, processingMetricsInterval properties (Moved to RecognizeWithWebsocketsOptions)

• No changes

CreateCustomModelOptions, CustomModel, CustomModels, DeleteCustomModelOptions, GetCustomModelOptions, ListCustomModelsOptions, UpdateCustomModelOptions

CreateVoiceModelOptions, DeleteVoiceModelOptions, GetVoiceModelOptions, ListVoiceModelsOptions, UpdateVoiceModelOptions, VoiceModel, VoiceModels

ListVoicesOptions

• Remove Builder

Voice

• Change return type of getCustomization() from VoiceModel to CustomModel

• No changes

• No changes

• Added deprecation notice

• No changes

• Added deprecation notice

CollectionTrainingStatus, ObjectDetail

Collection

• Changed trainingStatus property type from TrainingStatus to CollectionTrainingStatus

CreateCollectionOptions, UpdateCollectionOptions

• Added trainingStatus property

GetTrainingUsageOptions

• Changed startTime and endTime property type from String to Date

ListCollectionsOptions

• Remove Builder

ObjectDetail

• Changed location property type from Location to ObjectDetailLocation

UpdateObjectMetadata

• Changed count property to read only