Skip to content

Commit e818abb

Browse files
committedNov 18, 2020
docs: add migration guide
1 parent e84a0cb commit e818abb

File tree

1 file changed

+175
-0
lines changed

1 file changed

+175
-0
lines changed
 

‎MIGRATION-V5.md

+175
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
## Python SDK V5 Migration guide
2+
3+
### Service changes
4+
5+
#### Assistant v1
6+
7+
* `include_count` is now a parameter of the `list_workspaces()` method
8+
* `include_count` is now a parameter of the `list_intents()` method
9+
* `include_count` is now a parameter of the `list_examples()` method
10+
* `include_count` is now a parameter of the `list_counterexamples()` method
11+
* `include_count` is now a parameter of the `list_entities()` method
12+
* `include_count` is now a parameter of the `list_values()` method
13+
* `include_count` is now a parameter of the `list_synonyms()` method
14+
* `include_count` is now a parameter of the `list_dialogNodes()` method
15+
* `context` type was changed from `dict` to `DialogNodeContext` in the `create_dialog_node()` method
16+
* `new_context` type was changed from `dict` to `DialogNodeContext` in the `update_dialog_node()` method
17+
* `bulk_classify()` 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+
44+
##### Model Properties Changed
45+
46+
`DialogNode`
47+
* `context` property type changed from `Dictionary<string, object>` to `DialogNodeContext`
48+
49+
`DialogNodeOutput`
50+
* Added `Integrations` property with getter and setter
51+
52+
`DialogNodeOutputGeneric`, `RuntimeResponseGeneric`
53+
* Added `agent_available`, `agent_unavailable`, and `transfer_info` properties
54+
55+
`DialogSuggestion`
56+
* `output` property type changed from `DialogSuggestionOutput` to `Dictionary<string, object>`
57+
58+
#### Assistant v2
59+
60+
* `bulk_classify()` method was addded
61+
62+
##### Models Added
63+
64+
`BulkClassifyOutput`,
65+
`BulkClassifyResponse`,
66+
`BulkClassifyUtterance`,
67+
`DialogNodeOutputConnectToAgentTransferInfo`,
68+
`RuntimeResponseGenericRuntimeResponseTypeConnectToAgent`,
69+
`RuntimeResponseGenericRuntimeResponseTypeImage`,
70+
`RuntimeResponseGenericRuntimeResponseTypeOption`,
71+
`RuntimeResponseGenericRuntimeResponseTypePause`,
72+
`RuntimeResponseGenericRuntimeResponseTypeSearch`,
73+
`RuntimeResponseGenericRuntimeResponseTypeSuggestion`,
74+
`RuntimeResponseGenericRuntimeResponseTypeText`
75+
76+
##### Model Properties Changed
77+
78+
`MessageContext`, `MessageContextStateless`
79+
* `Skills` property type changed from `MessageContextSkills` to `Dictionary<string, MessageContextSkill>`
80+
81+
`MessageContextSkill`
82+
* `System` property type changed from `Dictionary<string, object>` to `MessageContextSkillSystem`
83+
84+
`RuntimeResponseGeneric`
85+
* Added `agent_available`, `agent_unavailable`, and `transfer_info` properties
86+
87+
#### Compare Comply v1
88+
89+
* `before` and `after` parameters were removed from `list_feedback` method
90+
91+
##### Model Properties Changed
92+
93+
`Category`, `TypeLabel`
94+
* Added `modification` property
95+
96+
`OriginalLabelsOut`, `UpdatedLabelsOut`
97+
* Removed `modification` property
98+
99+
#### Discovery v1
100+
101+
No changes
102+
103+
#### Discovery v2
104+
105+
##### Models Added
106+
107+
`QueryResponsePassage`
108+
109+
##### Models Removed
110+
111+
`QueryNoticesResult`
112+
113+
##### Model Properties Changed
114+
115+
`QueryResponse`
116+
* Added `Passages` property
117+
118+
#### Language Translator v3
119+
120+
No changes
121+
122+
#### Natural Language Classifier v1
123+
124+
No changes
125+
126+
#### Natural Language Understanding v1
127+
128+
No changes
129+
130+
#### Personality Insights
131+
132+
No changes
133+
134+
#### Speech To Text v1
135+
136+
No changes
137+
138+
#### Text To Speech v1
139+
140+
* Renamed `CreateVoiceModel()` method to `CreateCustomModel()`
141+
142+
* Renamed `ListVoiceModels()` method to `ListCustomModels()`
143+
144+
* Renamed `UpdateVoiceModel()` method to `UpdateCustomModel()`
145+
146+
* Renamed `GetVoiceModel()` method to `GetCustomModel()`
147+
148+
* Renamed `DeleteVoiceModel()` method to `GetCustomModel()`
149+
150+
##### Models Added
151+
152+
`CustomModel`,
153+
`CustomModels`
154+
155+
##### Models Removed
156+
157+
`VoiceModel`,
158+
`VoiceModels`
159+
160+
##### Model Properties Changed
161+
162+
`Voice`
163+
* Change return type of `customization` from `VoiceModel` to `CustomModel`
164+
165+
#### Tone Analyzer v3
166+
167+
No changes
168+
169+
#### Visual Recognition v3
170+
171+
No changes
172+
173+
#### Visual Recognition v4
174+
175+
* Changed `start_time` and `end_time` parameter types from `string` to `date` in `get_training_usage()` method

0 commit comments

Comments
 (0)
Please sign in to comment.