Skip to content

Commit

Permalink
changelog and xcode project file changes
Browse files Browse the repository at this point in the history
  • Loading branch information
apaparazzi0329 committed Nov 2, 2020
1 parent 554ad9f commit 3abba3c
Showing 2 changed files with 1,026 additions and 757 deletions.
234 changes: 234 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,238 @@

# 4.0.0 (Preview) (https://github.com/watson-developer-cloud/swift-sdk/compare/3.6.0...4.0.0) (2020-10-29)

## Breaking Changes

### All Services
* `init` now accepts a `serviceName` parameter to set the default service name of the instance

### AssistantV1 Instance

* Now Accepts `includeCount` Parameter: `listWorkspaces()`, `listIntents()`, `listExamples()`, `listCounterexamples()`, `listEntities()`, `listValues()`, `listSynonyms()`, `listDialogNodes()`,
* `createWorkspace()`: function parameter reordering
* `updateWorkspace()`: function parameter reordering
* `createDialogNode()`: parameter `context` type change from `[Sting: JSON]?` to `DialogNodeContext?`
* `updateDialogNode()`: parameter `newContext` type change from `[Sting: JSON]?` to `DialogNodeContext?`
* `bulkClassify()`: function added - Identify intents and entities in multiple user utterances.


### AssistantV1 Models

#### Models Added
`BulkClassifyOutput`, `BulkClassifyResponse`, `BulkClassifyUtterance`, `DialogNodeContext`, `DialogNodeOutputConnectToAgentTransferInfo`, `DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent`, `DialogNodeOutputGenericDialogNodeOutputResponseTypeImage`, `DialogNodeOutputGenericDialogNodeOutputResponseTypeOption`, `DialogNodeOutputGenericDialogNodeOutputResponseTypePause`, `DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill`, `DialogNodeOutputGenericDialogNodeOutputResponseTypeText`, `RuntimeResponseGenericRuntimeResponseTypeConnectToAgent`, `RuntimeResponseGenericRuntimeResponseTypeImage`, `RuntimeResponseGenericRuntimeResponseTypeOption`, `RuntimeResponseGenericRuntimeResponseTypePause`, `RuntimeResponseGenericRuntimeResponseTypeSuggestion`, `RuntimeResponseGenericRuntimeResponseTypeText`

#### Models Removed
`CreateWorkspace`, `DialogNodeSuggestionOutput`, `DialogSuggestionResponseGeneric`, `SystemResponse`, `UpdateCounterexample`, `UpdateDialogNode`, `UpdateEntity`, `UpdateExample`, `UpdateIntent`, `UpdateSynonym`, `UpdateValue`, `UpdateWorkspace`, `WorkspaceSystemSettings`, `WorkspaceSystemSettingsDisambiguation`, `WorkspaceSystemSettingsOffTopic`, `WorkspaceSystemSettingsSystemEntities`, `WorkspaceSystemSettingsTooling`, `WorkspaceSystemSettings`,

#### Model Properties Changed
`Context`
* `system` type changed from `SystemResponse?` to `[String: JSON]?`
`DialogSuggestion`
* `output` type changed from `DialogSuggestionOutput?` to `[String: JSON]?`
`Counterexample`, `CreateEntity`, `CreateIntent`, `CreateValue`, `Example`, `Synonym`
* `created` read only
* `updated` read only
`DialogNodeOutput`
* `integrations` added
`MessageInput`
* `suggestedText` read only
* `originalText` read only
`MessageRequest`
* `actions` read only
`Webhook`
* `headers` renamed to `xheaders`

#### Multiple/Unique Changes
`DialogNode`
* `context` type changed from `[String: JSON]?` to `DialogNodeContext?`
* `disabled` parameter removed
* `created` parameter removed
* `updated` parameter removed

`DialogNodeOutputGeneric`
* Changed from struct to enum to discriminate between response types
`RuntimeResponseGeneric`
* Changed from struct to enum to discriminate between response types


### AssistantV2 Instance

* `bulkClassify()`: function added - Identify intents and entities in multiple user utterances.

### AssistantV2 Models

#### Models Added
`BulkClassifyOutput`, `BulkClassifyResponse`, `BulkClassifyUtterance`, `DialogNodeOutputConnectToAgentTransferInfo`, `RuntimeResponseGenericRuntimeResponseTypeConnectToAgent`, `RuntimeResponseGenericRuntimeResponseTypeImage`, `RuntimeResponseGenericRuntimeResponseTypeOption`, `RuntimeResponseGenericRuntimeResponseTypePause`, `RuntimeResponseGenericRuntimeResponseTypeSuggestion`, `RuntimeResponseGenericRuntimeResponseTypeText`
#### Models Removed
`MessageContextSkills`, `MessageRequestStateless`
#### Model Properties Changed
`MessageContextGlobal`
* `system` read only
`MessageContext`, `MessageContextStateless`
* `skills` type changed from `MessageContextSkills?` to `[String: MessageContextSkill]?`
`MessageInputOptions`
* model parameters repositioned
#### Multiple/Unique Changes
`RuntimeResponseGeneric`
* Changed from struct to enum to discriminate between response types

### CompareComplyV1 Instance

`listFeedback()`: `before` and `after` parameters removed

### CompareComplyV1 Models

#### Models Removed
`FeedbackInput`

#### Model Properties Changed
`Category`, `TypeLabel`
* `modification` added
`OriginalLabelsOut`, `UpdatedLabelsOut`
* `modification` removed

### DiscoveryV1 Instance

* No changes

### DiscoveryV1 Models

#### Models Removed
`CollQueryLarge`, `CreateCollectionRequest`, `CreateEnvironmentRequest`, `CreateEventObject`, `FedQueryLarge`, `GatewayName`, `GenericQueryAggregation`, `NewTrainingQuery`, `NluEnrichmentCategories`, `QueryLarge`, `TokenDict`, `TrainingExamplePatch`, `UpdateCollectionRequest`, `UpdateEnvironmentRequest`
#### Model Prroperties Changed
`Configuration`
* `created` read only
* `updated` read only
* `configurationID` read only
`Credentials`
* `credentialID` read only
`EventData`
* `queryID` read only
`NluEnrichmentFeatures`
* `categories` type changed from `NluEnrichmentCategories?` to `[String: JSON]?`

### DiscoveryV2 Instance

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

### DiscoveryV2 Models

#### Models Added
`AnalyzedDocument`, `AnalyzedResult`, `QueryResponsePassage`, `
#### Models Removed
`GenericQueryAggregation`, `ProjectCreation`, `ProjectName`, `QueryLarge`, `QueryNoticesResult`, `UpdateCollection`, `UpdateEnrichment`
#### Model Properties Changed
`CollectionDetails`
* `collectionID` read only
* `created` read only
`QueryResponse`
* `passages` added
`TrainingExample`
* `created` read only
* `updated` read only
`TraningQuery`
* `created` read only
* `updated` read only
* `queryID` read only

### LanguageTranslator Instance
* No changes

### LanguageTranslatorV3 Models

#### Models Removed
`TranslateRequest`

### NaturalLanguageClassifierV1 Instance
* No changes

### NaturalLanguageClassifierV1 Models

#### Models Removed
`ClassifyCollectionInput`

### NaturalLanguageUnderstanding Instance
* No changes

### NaturalLanguageUnderstandingV1 Models

#### Models Added
`FeaturesResultsMetadata`
#### Models Removed
`AnalysisResultsMetadata`, `MetadataOptions`, `Parameters`
#### Model Properties Changed
`AnalysisResults`
* `metadata` type changed from `AnalysisResultsMetadata?` to `FeaturesResultsMetadata?`
`Features`
* `metadata` type changed from `MetadataOptions?` to `[String: JSON]?`

### PersonalityInsights Instance
* `profile()`: csvHeaders parameter added
* `profileAsCSV()`: return type changed from `WatsonResponse<String>?` to `WatsonResponse<Data>?`

### PersonalityInightsV3 Models
* No changes

### SpeechToTextV1 Instance
`trainLanguageModel()`: return type changed from `WatsonResponse<Void>?` to `WatsonResponse<TrainingResponse>?`
`trainAcousticModel()`: return type changed from `WatsonResponse<Void>?` to `WatsonResponse<TrainingResponse>?`

### SpeechToTextV1 Models
* No changes

#### Models Removed
`CreateAcousticModel`, `CreateLanguageModel`, `CustomWords`

### TextToSpeechV1 Instance
* `createVoiceModel()`: function changed to `createCustomModel()` now returning `WatsonResponse<CustomModel>?`
* `listVoiceModels()`: function changed to `listCustomModels()` now returning `WatsonResponse<CustomModels>?`
* `updateVoiceModel()`: function changed to `updateCustomModel()`
* `getVoiceModel()`: function changed to `getCustomModel()` now returning `WatsonResponse<CustomModel>?`
* `deleteVoiceModel()`: function changed to `deleteCustomModel()`

### TextToSpeechV1 Models

#### Models Added
`CustomModel`, `CustomModels`
#### Models Removed
`CreateVoiceModel`, `Text`, `UpdateVoiceModel`, `VoiceModel`, `VoiceModels`
#### Model Properties Changed
`Voice`
* customization type changed from `VoiceModel?` to `CustomModel?`

### ToneAnalyzer Instance
* `tone()`: `tones` parameter added

### ToneAnalyzerV3 Models

#### Models Removed
`ToneChatInput`

### VisualRecognitionV3 Instance
* No changes

### VisualRecognitionV3 Models
* No changes

### VisualRecognitionV4 Instance
* `createCollection()`: `trainingStatus` parameter added
* `updateCollection()`: `trainingStatus` parameter added
* `getTrainingUsage()`: `startTime` and `endTime` parameter types changed from `String?` to `Date?`

### VisualRecognitionV4 Models

#### Models Added
`CollectionTrainingStatus`, `ObjectDetailLocation`
#### Models Removed
`BaseCollection`, `BaseTrainingDataObjects`
#### Model Properties Changed
`Collection`
* `trainingStatus` type changed from `TrainingStatus` to `CollectionTrainingStatus`
`ObjectDetail`
* `location` type changed from `Location` to `ObjectDetailLocation`
`UpdateObjectMetadata`
* `count` read only

## 3.0.0 (Preview) (https://github.com/watson-developer-cloud/swift-sdk/compare/2.3.0...3.0.0) (2019-10-04)

### Breaking Changes
Loading

0 comments on commit 3abba3c

Please sign in to comment.