Skip to content

Commit

Permalink
Release 2.0.0 (#9)
Browse files Browse the repository at this point in the history
* Release 2.0.0 common parts.

* Release 2.0.0 platform specific parts.

* Release 2.0.0 docs.
  • Loading branch information
jridfe committed Dec 14, 2023
1 parent cdf28b2 commit 12d34e4
Show file tree
Hide file tree
Showing 63 changed files with 24,228 additions and 25,325 deletions.
85 changes: 0 additions & 85 deletions MIGRATION-V1.0.0.md

This file was deleted.

166 changes: 166 additions & 0 deletions MIGRATION-V2.0.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
# Upgrading to ABAP SDK version 2.0.0

Note: If migrating from a version less than v1.0.0, also see the
[v1.0.0 migration guide
wiki](https://github.com/watson-developer-cloud/abap-sdk-nwas/blob/1.0.0/MIGRATION-V1.0.0.md).

<details>
<summary>Table of Contents</summary>

- [Breaking changes](#breaking-changes)
- [Breaking changes by service](#breaking-changes-by-service)
- [Watson Assistant V1](#watson-assistant-v1)
- [Watson Assistant V2](#watson-assistant-v2)
- [Language Translator V3](#language-translator-v3)
- [Speech to Text V1](#speech-to-text-v1)
- [New features by service](#new-features-by-service)
- [Watson Assistant V1](#watson-assistant-v1-1)
- [Watson Assistant V2](#watson-assistant-v2-1)
- [Discovery V2](#discovery-v2)
- [Natural Language Understanding V1](#natural-language-understanding-v1)
- [Text to Speech V1](#text-to-speech-v1)
- [Speech to Text V1](#speech-to-text-v1-1)
- [Discontinued services](#discontinued-services)
- [Discontinued services still included in the ABAP SDK in version 2.0.0](#discontinued-services-still-included-in-the-abap-sdk-in-version-200)
- [Language Translator V3](#language-translator-v3-1)
- [Discontinued services removed from the ABAP SDK in version 2.0.0](#discontinued-services-removed-from-the-abap-sdk-in-version-200)
- [Compare and Comply V1](#compare-and-comply-v1)
- [Discovery V1](#discovery-v1)
- [Natural Language Classifier V1](#natural-language-classifier-v1)
- [Personality Insights V3](#personality-insights-v3)
- [Tone Analyzer V3](#tone-analyzer-v3)
- [Visual Recognition V3 and V4](#visual-recognition-v3-and-v4)

</details>

## Breaking changes

### Breaking changes by service

#### Watson Assistant V1

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`.

#### Watson Assistant V2

Data type `t_Dialog_Nodes_Visited` was renamed to `t_Dialog_Node_Visited`.

#### Language Translator V3

The following input parameters for method `Create_Model` were renamed:

| Old name | New name |
|:-----------------------|:---------------------------------|
| `i_Forced_Glossary_ct` | `i_Forced_Glossary_Content_Type` |
| `i_Parallel_Corpus_ct` | `i_Parallel_Corpus_Content_Type` |

Default values for these parameters are no longer provided.

#### Speech to Text V1

- Methods `Recognize` and `Create_Job`:

- Parameter `i_Customization_Id` was removed - use
parameter `i_Language_Customization_Id` instead.

- Method `Add_Grammar`

- Type of parameter `i_Grammar_File` was changed from
`String` to `File`.

### New features by service

#### Watson Assistant V1

- Support for asynchronous workspace operations - new methods:

- `Create_Workspace_Async`, `Export_Workspace_Async`, `Update_Workspace_Async`

#### Watson Assistant V2

- Support to create and modify assistants, releases, skills and environments - new methods:

- `Create_Assistant`, `Delete_Assistant`, `List_Assistants`
- `Create_Release`, `Delete_Release`, `Deploy_Release`, `Get_Release`, `List_Releases`
- `Export_Skills`, `Get_Skill`, `Import_Skills`, `Import_Skills_Status`, `Update_Skill`
- `Get_Environment`, `List_Environments`, `Update_Environment`

#### Discovery V2

The ABAP SDK includes now interfaces to all Discovery V2
methods. See details on IBM's documentation site
[here](https://cloud.ibm.com/apidocs/discovery-data).

#### Natural Language Understanding V1

- Support to create and modify custom models - new methods:

- `create_categories_model`, `list_categories_models`, `get_categories_model`, `update_categories_model`, `delete_categories_model`
- `create_classifications_model`, `list_classifications_models`, `get_classifications_model`, `update_classifications_model`, `delete_classifications_model`

#### Text to Speech V1

- Support for custom prompts and speaker models - new methods:

- `List_Custom_Prompts`, `Get_Custom_Prompt`, `Add_Custom_Prompt`, `Delete_Custom_Prompt`
- `List_Speaker_Models`, `Get_Speaker_Model`, `Create_Speaker_Model`, `Delete_Speaker_Model`

- Method `Synthesize`:

- New optional parameters `i_Spell_Out_Mode`,
`i_Rate_Percentage` and`i_Pitch_Percentage`.

See details of these new methods and parameters on IBM's
documentation site [here](https://cloud.ibm.com/apidocs/text-to-speech).

#### Speech to Text V1

- Methods `Recognize` and `Create_Job`:

- New optional parameters `i_Low_Latency` and `i_Character_Insertion_Bias`.

- Methods `Train_Language_Model` and `Train_Acoustic_Model`:

- New optional parameter `i_strict`.

See details of these new parameters on IBM's documentation
site [here](https://cloud.ibm.com/apidocs/speech-to-text).


### Discontinued services

#### Discontinued services still included in the ABAP SDK in version 2.0.0

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.

##### Language Translator V3

Existing instances are supported until 10 June 2024 and will be deleted afterwards.

#### Discontinued services removed from the ABAP SDK in version 2.0.0

The following services are discontinued. New service instances cannot be created anymore. Interfaces to these services have been removed from the ABAP SDK.

##### Compare and Comply V1

Discontinued since 30 November 2021.

##### Discovery V1

Discontinued since 11 July 2023. Migrate to Discovery V2.

##### Natural Language Classifier V1

Discontinued since 9 August 2021. Migrate to Natural Language Understanding V1.

##### Personality Insights V3

Discontinued since 1 December 2021.

##### Tone Analyzer V3

Discontinued since 24 February 2023. Migrate to Natural Language Understanding V1.

##### Visual Recognition V3 and V4

Discontinued since 1 December 2021.
65 changes: 32 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,27 +19,31 @@ Additionally, as the ABAP SDK is a community release it is not updated with the
<details>
<summary>Table of Contents</summary>

* [Announcements](#announcements)
* [Before you begin](#before-you-begin)
* [Installation](#installation)
* [SAP System Configuration](#sap-system-configuration)
* [SAP Profile Parameters](#sap-profile-parameters)
* [Proxy configuration](#proxy-configuration)
* [SSL Certificates](#ssl-certificates)
* [Credentials](#credentials)
* [Configuration table](#configuration-table)
* [IAM Authentication](#iam-authentication)
* [Usage](#usage)
* [API Reference](#api-reference)
* [Questions](#questions)
* [License](#license)
* [Contributors](#contributors)
* [Acknowledgements](#acknowledgements)
- [Announcements](#announcements)
- [Before you begin](#before-you-begin)
- [Installation](#installation)
- [SAP System Configuration](#sap-system-configuration)
- [SAP Profile Parameters](#sap-profile-parameters)
- [Proxy configuration](#proxy-configuration)
- [SSL Certificates](#ssl-certificates)
- [Determine required certificate](#determine-required-certificate)
- [Add an SSL certificate to the PSE](#add-an-ssl-certificate-to-the-pse)
- [Restart the ICM (Internet Communication Manager)](#restart-the-icm-internet-communication-manager)
- [Credentials](#credentials)
- [Configuration table](#configuration-table)
- [IAM Authentication](#iam-authentication)
- [Usage](#usage)
- [API Reference](#api-reference)
- [Questions](#questions)
- [License](#license)
- [Contributors](#contributors)
- [Acknowledgements](#acknowledgements)

</details>

## ANNOUNCEMENTS
### Major version 1.0.0 released
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).
### Major version 2.0.0 released
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).

## Before you begin
* You need an [IBM Cloud][ibm_cloud_onboarding] account.
Expand All @@ -59,7 +63,7 @@ The following SAP profile parameter settings are recommended.
icm/HTTPS/client_sni_enabled = TRUE
ssl/ciphersuites = 135:PFS:HIGH::EC_P256:EC_HIGH
ssl/client_ciphersuites = 150:PFS:HIGH::EC_P256:EC_HIGH
wdisp/ssl_ignore_host_mismatch = TRUE
wdisp/ssl_ignore_host_mismatch = TRUE
```

### Proxy configuration
Expand All @@ -68,7 +72,7 @@ The client library respects the ABAP proxy settings. If you are using a central
2. Click *Execute* (or press F8).
3. Select menu item *Client* &rarr; *Proxy Settings*.
4. On tab *Global Settings*: Select *Proxy Setting is Active* and *No Proxy Setting for Local Server*.
5. On tabs *HTTP Log* and *HTTPS Log* specify the proxy *Host Name* and *Port*. If the proxy server requires logon credentials, also specify *User Name* and *Password*.
5. On tabs *HTTP Protocol* and *HTTPS Protocol* specify the proxy *Host Name* and *Port*. If the proxy server requires logon credentials, also specify *User Name* and *Password*.
6. Click *Execute (F8)* and *OK*.


Expand Down Expand Up @@ -186,17 +190,11 @@ The following Watson services are currently supported:

| Service | ABAP Class Name |
|:------------------------------ |:----------------------------------- |
| Compare and Comply | ZCL_IBMC_COMPARE_COMPLY_V1 (\*) |
| Discovery | ZCL_IBMC_DISCOVERY_V1 |
| Language Translator | ZCL_IBMC_LANG_TRANSLATOR_V3 |
| Natural Language Classifier | ZCL_IBMC_NAT_LANG_CLASS_V1 |
| Discovery | ZCL_IBMC_DISCOVERY_V2 |
| Language Translator | ZCL_IBMC_LANG_TRANSLATOR_V3 (\*) |
| Natural Language Understanding | ZCL_IBMC_NAT_LANG_UNDRSTND_V1 |
| Personality Insights | ZCL_IBMC_PERSONAL_INSIGHTS_V3 (\*) |
| Speech to Text | ZCL_IBMC_SPEECH_TO_TEXT_V1 |
| Text to Speech | ZCL_IBMC_TEXT_TO_SPEECH_V1 |
| Tone Analyzer | ZCL_IBMC_TONE_ANALYZER_V3 |
| Visual Recognition | ZCL_IBMC_VISUAL_RECOGNITION_V3 (\*) |
| | ZCL_IBMC_VISUAL_RECOGNITION_V4 (\*) |
| Watson Assistant | ZCL_IBMC_ASSISTANT_V1 |
| | ZCL_IBMC_ASSISTANT_V2 |

Expand All @@ -214,7 +212,7 @@ Using the client library requires two steps:
i_url = <url>
i_apikey = <api key>
...
importing
importing
eo_instance = lo_service_class ).
```

Expand Down Expand Up @@ -242,8 +240,8 @@ Using the client library requires two steps:
lv_apikey type string value '...',
lo_text_to_speech type ref to zcl_ibmc_text_to_speech_v1,
lo_service_exception type ref to zcx_ibmc_service_exception,
ls_voice type zcl_ibmc_text_to_speech=>t_voice,
lt_voices type zcl_ibmc_text_to_speech=>t_voices.
ls_voice type zcl_ibmc_text_to_speech_v1=>t_voice,
lt_voices type zcl_ibmc_text_to_speech_v1=>t_voices.
" get Watson Text-to-Speech service instance
zcl_ibmc_service_ext=>get_instance(
Expand Down Expand Up @@ -333,7 +331,7 @@ Using the client library requires two steps:
lo_service_exception type ref to zcx_ibmc_service_exception,
ls_request type zcl_ibmc_lang_translator_v3=>t_translate_request,
lv_text type string,
ls_trans type zcl_ibmc_lang_translator_v3=>t_translation_result.
ls_trans type zcl_ibmc_lang_translator_v3=>t_translation_result.
" get Watson Language Translator service instance
zcl_ibmc_service_ext=>get_instance(
Expand All @@ -349,7 +347,7 @@ Using the client library requires two steps:
append lv_text to ls_request-text.
ls_request-model_id = 'en-de'.
ls_request-source = 'EN'.
ls_request-target = 'DE'.
ls_request-target = 'DE'.
" call Watson Language Translator service to translate the text in ls_request
try.
Expand Down Expand Up @@ -393,6 +391,7 @@ This library is licensed under the [Apache 2.0 license][license].
* Joachim Rese
* Jochen Röhrig
* Aleksandar Debelic
* Stefan Diederichs

## Acknowledgements

Expand Down
Loading

0 comments on commit 12d34e4

Please sign in to comment.