Skip to content

Commit cc493b2

Browse files
committed
docs: add migration guide
1 parent f70b42b commit cc493b2

File tree

2 files changed

+224
-230
lines changed

2 files changed

+224
-230
lines changed

MIGRATION-V5.md

Lines changed: 224 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,224 @@
1+
## .Unity SDK V5 Migration guide
2+
3+
* Added Enums classes
4+
5+
#### Assistant v1
6+
7+
* `includeCount` is now a parameter of the `ListWorkspaces()` method
8+
* `includeCount` is now a parameter of the `ListIntents()` method
9+
* `includeCount` is now a parameter of the `ListExamples()` method
10+
* `includeCount` is now a parameter of the `ListCounterexamples()` method
11+
* `includeCount` is now a parameter of the `ListEntities()` method
12+
* `includeCount` is now a parameter of the `ListValues()` method
13+
* `includeCount` is now a parameter of the `ListSynonyms()` method
14+
* `includeCount` is now a parameter of the `ListDialogNodes()` method
15+
* `context` type was changed from `Dictionary<string, object>` to `DialogNodeContext` in the `CreateDialogNode()` method
16+
* `newContext` type was changed from `Dictionary<string, object>` to `DialogNodeContext` in the `UpdateDialogNode()` method
17+
* `BulkClassify()` method was addded
18+
19+
##### Models Added
20+
21+
`BulkClassifyOutput`,
22+
`BulkClassifyResponse`,
23+
`BulkClassifyUtterance`,
24+
`DialogNodeContext`,
25+
`DialogNodeOutputConnectToAgentTransferInfo`,
26+
`DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent`,
27+
`DialogNodeOutputGenericDialogNodeOutputResponseTypeImage`,
28+
`DialogNodeOutputGenericDialogNodeOutputResponseTypeOption`,
29+
`DialogNodeOutputGenericDialogNodeOutputResponseTypePause`,
30+
`DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill`,
31+
`DialogNodeOutputGenericDialogNodeOutputResponseTypeText`,
32+
`RuntimeResponseGenericRuntimeResponseTypeConnectToAgent`,
33+
`RuntimeResponseGenericRuntimeResponseTypeImage`,
34+
`RuntimeResponseGenericRuntimeResponseTypeOption`,
35+
`RuntimeResponseGenericRuntimeResponseTypePause`,
36+
`RuntimeResponseGenericRuntimeResponseTypeSuggestion`,
37+
`RuntimeResponseGenericRuntimeResponseTypeText`
38+
39+
##### Models Removed
40+
41+
`DialogSuggestionOutput`,
42+
`DialogSuggestionResponseGeneric`,
43+
`SystemResponse`
44+
45+
##### Model Properties Changed
46+
47+
`DialogNode`
48+
* `context` property type changed from `Dictionary<string, object>` to `DialogNodeContext`
49+
50+
`DialogNodeOutput`
51+
* Added `Integrations` property with getter and setter
52+
53+
`DialogNodeOutputGeneric`, `RuntimeResponseGeneric`
54+
* Added `AgentAvailable`, `AgentUnavailable`, and `TransferInfo` properties
55+
56+
`DialogSuggestion`
57+
* `output` property type changed from `DialogSuggestionOutput` to `Dictionary<string, object>`
58+
59+
#### Assistant v2
60+
61+
* `BulkClassify()` method was addded
62+
63+
##### Models Added
64+
65+
`BulkClassifyOutput`,
66+
`BulkClassifyResponse`,
67+
`BulkClassifyUtterance`,
68+
`DialogNodeOutputConnectToAgentTransferInfo`,
69+
`RuntimeResponseGenericRuntimeResponseTypeConnectToAgent`,
70+
`RuntimeResponseGenericRuntimeResponseTypeImage`,
71+
`RuntimeResponseGenericRuntimeResponseTypeOption`,
72+
`RuntimeResponseGenericRuntimeResponseTypePause`,
73+
`RuntimeResponseGenericRuntimeResponseTypeSearch`,
74+
`RuntimeResponseGenericRuntimeResponseTypeSuggestion`,
75+
`RuntimeResponseGenericRuntimeResponseTypeText`
76+
77+
##### Models Removed
78+
79+
`MessageContextSkills`
80+
81+
##### Model Properties Changed
82+
83+
`MessageContext`, `MessageContextStateless`
84+
* `Skills` property type changed from `MessageContextSkills` to `Dictionary<string, MessageContextSkill>`
85+
86+
`MessageContextSkill`
87+
* `System` property type changed from `Dictionary<string, object>` to `MessageContextSkillSystem`
88+
89+
`RuntimeResponseGeneric`
90+
* Added `AgentAvailable`, `AgentUnavailable`, and `TransferInfo` properties
91+
92+
#### Compare Comply v1
93+
94+
* `before` and `after` parameters were removed from `ListFeedback` method
95+
96+
##### Model Properties Changed
97+
98+
`Category`, `TypeLabel`
99+
* Added `ModificationEnumValue` class
100+
* Added `Modification` property
101+
102+
`OriginalLabelsOut`, `UpdatedLabelsOut`
103+
* Removed `ModificationEnumValue` class
104+
* Removed `Modification` property
105+
106+
#### Discovery v1
107+
108+
##### Models Removed
109+
110+
`NluEnrichmentCategories`
111+
112+
##### Model Properties Changed
113+
114+
`NluEnrichmentFeatures`
115+
* Changed `Categories` property type from `NluEnrichmentCategories` to `Dictionary<string, object>`
116+
117+
#### Discovery v2
118+
119+
* `AnalyzeDocument()` method was addded
120+
121+
##### Models Added
122+
123+
`AnalyzedDocument`,
124+
`AnalyzedResult`,
125+
`QueryResponsePassage`
126+
127+
##### Models Removed
128+
129+
`QueryNoticesResult`
130+
131+
##### Model Properties Changed
132+
133+
`QueryGroupByAggregation`
134+
* Inherits `QueryAggregation`
135+
136+
`QueryResponse`
137+
* Added `Passages` property
138+
139+
#### Language Translator v3
140+
141+
No changes
142+
143+
#### Natural Language Classifier v1
144+
145+
No changes
146+
147+
#### Natural Language Understanding v1
148+
149+
##### Models Added
150+
151+
`FeaturesResultsMetadata`
152+
153+
##### Models Removed
154+
155+
`AnalysisResultsMetadata`,
156+
`MetadataOptions`
157+
158+
##### Model Properties Changed
159+
160+
`AnalysisResults`
161+
* Changed `Metadata` property type from `AnalysisResultsMetadata` to `FeaturesResultsMetadata`
162+
163+
`Features`
164+
* Changed `Metadata` property type from `MetadataOptions` to `object`
165+
166+
##### Models Removed
167+
168+
`Content`,
169+
`ContentItem`
170+
171+
#### Speech To Text v1
172+
173+
* Changed `audio` parameter type from `byte[]` to `System.IO.MemoryStream` in `Recognize()` method
174+
175+
* Changed `audio` parameter type from `byte[]` to `System.IO.MemoryStream` in `CreateJob()` method
176+
177+
* Changed `grammarFile` parameter type from `string` to `System.IO.MemoryStream` in `AddGrammar()` method
178+
179+
* Changed `audioResource` parameter type from `byte[]` to `System.IO.MemoryStream` in `AddAudio()` method
180+
181+
#### Text To Speech v1
182+
183+
* Renamed `CreateVoiceModel()` method to `CreateCustomModel()`
184+
185+
* Renamed `ListVoiceModels()` method to `ListCustomModels()`
186+
187+
* Renamed `UpdateVoiceModel()` method to `UpdateCustomModel()`
188+
189+
* Renamed `GetVoiceModel()` method to `GetCustomModel()`
190+
191+
* Renamed `DeleteVoiceModel()` method to `GetCustomModel()`
192+
193+
##### Models Added
194+
195+
`CustomModel`,
196+
`CustomModels`
197+
198+
##### Models Removed
199+
200+
`VoiceModel`,
201+
`VoiceModels`
202+
203+
##### Model Properties Changed
204+
205+
`Voice`
206+
* Change return type of `Customization` from `VoiceModel` to `CustomModel`
207+
208+
#### Visual Recognition v3
209+
210+
No changes
211+
212+
#### Visual Recognition v4
213+
214+
* Changed `startTime` and `endTime` parameter types from `string` to `DateTime` in `GetTrainingUsage()` method
215+
216+
##### Models Added
217+
218+
`CollectionTrainingStatus`,
219+
`ObjectDetailLocation`
220+
221+
##### Model Properties Changed
222+
223+
`ObjectDetail`
224+
* Changed `Location` property type from `Location` to `ObjectDetailLocation`

0 commit comments

Comments
 (0)