Skip to content

Commit 4cb8a24

Browse files
authored
Release 2.0.0 (#5)
* Release 2.0.0 common parts. * Release 2.0.0 platform specific parts.
1 parent 31dec44 commit 4cb8a24

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+20152
-21735
lines changed

Diff for: MIGRATION-V1.0.0.md

-85
This file was deleted.

Diff for: MIGRATION-V2.0.0.md

+166
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
# Upgrading to ABAP SDK version 2.0.0
2+
3+
Note: If migrating from a version less than v1.0.0, also see the
4+
[v1.0.0 migration guide
5+
wiki](https://github.com/watson-developer-cloud/abap-sdk-scp/blob/1.0.0/MIGRATION-V1.0.0.md).
6+
7+
<details>
8+
<summary>Table of Contents</summary>
9+
10+
- [Breaking changes](#breaking-changes)
11+
- [Breaking changes by service](#breaking-changes-by-service)
12+
- [Watson Assistant V1](#watson-assistant-v1)
13+
- [Watson Assistant V2](#watson-assistant-v2)
14+
- [Language Translator V3](#language-translator-v3)
15+
- [Speech to Text V1](#speech-to-text-v1)
16+
- [New features by service](#new-features-by-service)
17+
- [Watson Assistant V1](#watson-assistant-v1-1)
18+
- [Watson Assistant V2](#watson-assistant-v2-1)
19+
- [Discovery V2](#discovery-v2)
20+
- [Natural Language Understanding V1](#natural-language-understanding-v1)
21+
- [Text to Speech V1](#text-to-speech-v1)
22+
- [Speech to Text V1](#speech-to-text-v1-1)
23+
- [Discontinued services](#discontinued-services)
24+
- [Discontinued services still included in the ABAP SDK in version 2.0.0](#discontinued-services-still-included-in-the-abap-sdk-in-version-200)
25+
- [Language Translator V3](#language-translator-v3-1)
26+
- [Discontinued services removed from the ABAP SDK in version 2.0.0](#discontinued-services-removed-from-the-abap-sdk-in-version-200)
27+
- [Compare and Comply V1](#compare-and-comply-v1)
28+
- [Discovery V1](#discovery-v1)
29+
- [Natural Language Classifier V1](#natural-language-classifier-v1)
30+
- [Personality Insights V3](#personality-insights-v3)
31+
- [Tone Analyzer V3](#tone-analyzer-v3)
32+
- [Visual Recognition V3 and V4](#visual-recognition-v3-and-v4)
33+
34+
</details>
35+
36+
## Breaking changes
37+
38+
### Breaking changes by service
39+
40+
#### Watson Assistant V1
41+
42+
Component `Text` was removed from structure `t_Output_Data` for method `message`. The returned data is now available in component `Generic`, a standard table of `t_Runtime_Response_Generic`, which results in data of type `JSONOBJECT`. To convert data in a variable of type `JSONOBJECT` to data type string, you can use method `move_data_reference_to_abap`, which is provided in the service class `zcl_ibmc_service`.
43+
44+
#### Watson Assistant V2
45+
46+
Data type `t_Dialog_Nodes_Visited` was renamed to `t_Dialog_Node_Visited`.
47+
48+
#### Language Translator V3
49+
50+
The following input parameters for method `Create_Model` were renamed:
51+
52+
| Old name | New name |
53+
|:-----------------------|:---------------------------------|
54+
| `i_Forced_Glossary_ct` | `i_Forced_Glossary_Content_Type` |
55+
| `i_Parallel_Corpus_ct` | `i_Parallel_Corpus_Content_Type` |
56+
57+
Default values for these parameters are no longer provided.
58+
59+
#### Speech to Text V1
60+
61+
- Methods `Recognize` and `Create_Job`:
62+
63+
- Parameter `i_Customization_Id` was removed - use
64+
parameter `i_Language_Customization_Id` instead.
65+
66+
- Method `Add_Grammar`
67+
68+
- Type of parameter `i_Grammar_File` was changed from
69+
`String` to `File`.
70+
71+
### New features by service
72+
73+
#### Watson Assistant V1
74+
75+
- Support for asynchronous workspace operations - new methods:
76+
77+
- `Create_Workspace_Async`, `Export_Workspace_Async`, `Update_Workspace_Async`
78+
79+
#### Watson Assistant V2
80+
81+
- Support to create and modify assistants, releases, skills and environments - new methods:
82+
83+
- `Create_Assistant`, `Delete_Assistant`, `List_Assistants`
84+
- `Create_Release`, `Delete_Release`, `Deploy_Release`, `Get_Release`, `List_Releases`
85+
- `Export_Skills`, `Get_Skill`, `Import_Skills`, `Import_Skills_Status`, `Update_Skill`
86+
- `Get_Environment`, `List_Environments`, `Update_Environment`
87+
88+
#### Discovery V2
89+
90+
The ABAP SDK includes now interfaces to all Discovery V2
91+
methods. See details on IBM's documentation site
92+
[here](https://cloud.ibm.com/apidocs/discovery-data).
93+
94+
#### Natural Language Understanding V1
95+
96+
- Support to create and modify custom models - new methods:
97+
98+
- `create_categories_model`, `list_categories_models`, `get_categories_model`, `update_categories_model`, `delete_categories_model`
99+
- `create_classifications_model`, `list_classifications_models`, `get_classifications_model`, `update_classifications_model`, `delete_classifications_model`
100+
101+
#### Text to Speech V1
102+
103+
- Support for custom prompts and speaker models - new methods:
104+
105+
- `List_Custom_Prompts`, `Get_Custom_Prompt`, `Add_Custom_Prompt`, `Delete_Custom_Prompt`
106+
- `List_Speaker_Models`, `Get_Speaker_Model`, `Create_Speaker_Model`, `Delete_Speaker_Model`
107+
108+
- Method `Synthesize`:
109+
110+
- New optional parameters `i_Spell_Out_Mode`,
111+
`i_Rate_Percentage` and`i_Pitch_Percentage`.
112+
113+
See details of these new methods and parameters on IBM's
114+
documentation site [here](https://cloud.ibm.com/apidocs/text-to-speech).
115+
116+
#### Speech to Text V1
117+
118+
- Methods `Recognize` and `Create_Job`:
119+
120+
- New optional parameters `i_Low_Latency` and `i_Character_Insertion_Bias`.
121+
122+
- Methods `Train_Language_Model` and `Train_Acoustic_Model`:
123+
124+
- New optional parameter `i_strict`.
125+
126+
See details of these new parameters on IBM's documentation
127+
site [here](https://cloud.ibm.com/apidocs/speech-to-text).
128+
129+
130+
### Discontinued services
131+
132+
#### Discontinued services still included in the ABAP SDK in version 2.0.0
133+
134+
The following service is discontinued. New service instances cannot be created anymore. The ABAP SDK still includes interfaces to this service, which cannot be used anymore when IBM support of the corresponding service ends.
135+
136+
##### Language Translator V3
137+
138+
Existing instances are supported until 10 June 2024 and will be deleted afterwards.
139+
140+
#### Discontinued services removed from the ABAP SDK in version 2.0.0
141+
142+
The following services are discontinued. New service instances cannot be created anymore. Interfaces to these services have been removed from the ABAP SDK.
143+
144+
##### Compare and Comply V1
145+
146+
Discontinued since 30 November 2021.
147+
148+
##### Discovery V1
149+
150+
Discontinued since 11 July 2023. Migrate to Discovery V2.
151+
152+
##### Natural Language Classifier V1
153+
154+
Discontinued since 9 August 2021. Migrate to Natural Language Understanding V1.
155+
156+
##### Personality Insights V3
157+
158+
Discontinued since 1 December 2021.
159+
160+
##### Tone Analyzer V3
161+
162+
Discontinued since 24 February 2023. Migrate to Natural Language Understanding V1.
163+
164+
##### Visual Recognition V3 and V4
165+
166+
Discontinued since 1 December 2021.

Diff for: README.md

+24-28
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,25 @@ Additionally, as the ABAP SDK is a community release it is not updated with the
1919
<details>
2020
<summary>Table of Contents</summary>
2121

22-
* [Announcements](#announcements)
23-
* [Before you begin](#before-you-begin)
24-
* [Installation](#installation)
25-
* [SSL Certificates](#ssl-certificates)
26-
* [Credentials](#credentials)
27-
* [Configuration table](#configuration-table)
28-
* [IAM Authentication](#iam-authentication)
29-
* [Usage](#usage)
30-
* [API Reference](#api-reference)
31-
* [Questions](#questions)
32-
* [License](#license)
33-
* [Contributors](#contributors)
34-
* [Acknowledgements](#acknowledgements)
22+
- [Announcements](#announcements)
23+
- [Before you begin](#before-you-begin)
24+
- [Installation](#installation)
25+
- [SSL Certificates](#ssl-certificates)
26+
- [Credentials](#credentials)
27+
- [Configuration table](#configuration-table)
28+
- [IAM Authentication](#iam-authentication)
29+
- [Usage](#usage)
30+
- [API Reference](#api-reference)
31+
- [Questions](#questions)
32+
- [License](#license)
33+
- [Contributors](#contributors)
34+
- [Acknowledgements](#acknowledgements)
35+
3536
</details>
3637

3738
## ANNOUNCEMENTS
38-
### Major version 1.0.0 released
39-
Version v1.0.0 of the SDK has been released and includes breaking changes - see what's changed in the [migration guide](MIGRATION-V1.0.0.md).
39+
### Major version 2.0.0 released
40+
Version v2.0.0 of the SDK has been released and includes breaking changes - see what's changed in the [migration guide](MIGRATION-V2.0.0.md).
4041

4142
## Before you begin
4243
* You need an [IBM Cloud][ibm_cloud_onboarding] account.
@@ -100,17 +101,11 @@ The following Watson services are currently supported:
100101

101102
| Service | ABAP Class Name |
102103
|:------------------------------ |:----------------------------------- |
103-
| Compare and Comply | ZCL_IBMC_COMPARE_COMPLY_V1 (\*) |
104-
| Discovery | ZCL_IBMC_DISCOVERY_V1 |
105-
| Language Translator | ZCL_IBMC_LANG_TRANSLATOR_V3 |
106-
| Natural Language Classifier | ZCL_IBMC_NAT_LANG_CLASS_V1 |
104+
| Discovery | ZCL_IBMC_DISCOVERY_V2 |
105+
| Language Translator | ZCL_IBMC_LANG_TRANSLATOR_V3 (\*) |
107106
| Natural Language Understanding | ZCL_IBMC_NAT_LANG_UNDRSTND_V1 |
108-
| Personality Insights | ZCL_IBMC_PERSONAL_INSIGHTS_V3 (\*) |
109107
| Speech to Text | ZCL_IBMC_SPEECH_TO_TEXT_V1 |
110108
| Text to Speech | ZCL_IBMC_TEXT_TO_SPEECH_V1 |
111-
| Tone Analyzer | ZCL_IBMC_TONE_ANALYZER_V3 |
112-
| Visual Recognition | ZCL_IBMC_VISUAL_RECOGNITION_V3 (\*) |
113-
| | ZCL_IBMC_VISUAL_RECOGNITION_V4 (\*) |
114109
| Watson Assistant | ZCL_IBMC_ASSISTANT_V1 |
115110
| | ZCL_IBMC_ASSISTANT_V2 |
116111

@@ -128,7 +123,7 @@ Using the client library requires two steps:
128123
i_url = <url>
129124
i_apikey = <api key>
130125
...
131-
importing
126+
importing
132127
eo_instance = lo_service_class ).
133128
```
134129

@@ -156,8 +151,8 @@ Using the client library requires two steps:
156151
lv_apikey type string value '...',
157152
lo_text_to_speech type ref to zcl_ibmc_text_to_speech_v1,
158153
lo_service_exception type ref to zcx_ibmc_service_exception,
159-
ls_voice type zcl_ibmc_text_to_speech=>t_voice,
160-
lt_voices type zcl_ibmc_text_to_speech=>t_voices.
154+
ls_voice type zcl_ibmc_text_to_speech_v1=>t_voice,
155+
lt_voices type zcl_ibmc_text_to_speech_v1=>t_voices.
161156
162157
" get Watson Text-to-Speech service instance
163158
zcl_ibmc_service_ext=>get_instance(
@@ -247,7 +242,7 @@ Using the client library requires two steps:
247242
lo_service_exception type ref to zcx_ibmc_service_exception,
248243
ls_request type zcl_ibmc_lang_translator_v3=>t_translate_request,
249244
lv_text type string,
250-
ls_trans type zcl_ibmc_lang_translator_v3=>t_translation_result.
245+
ls_trans type zcl_ibmc_lang_translator_v3=>t_translation_result.
251246
252247
" get Watson Language Translator service instance
253248
zcl_ibmc_service_ext=>get_instance(
@@ -263,7 +258,7 @@ Using the client library requires two steps:
263258
append lv_text to ls_request-text.
264259
ls_request-model_id = 'en-de'.
265260
ls_request-source = 'EN'.
266-
ls_request-target = 'DE'.
261+
ls_request-target = 'DE'.
267262
268263
" call Watson Language Translator service to translate the text in ls_request
269264
try.
@@ -307,6 +302,7 @@ This library is licensed under the [Apache 2.0 license][license].
307302
* Joachim Rese
308303
* Jochen Röhrig
309304
* Aleksandar Debelic
305+
* Stefan Diederichs
310306

311307
## Acknowledgements
312308

0 commit comments

Comments
 (0)