From e73ef5a49ee54498b1e9d56b42196170db198d42 Mon Sep 17 00:00:00 2001 From: Angelo Paparazzi Date: Fri, 11 Oct 2024 14:17:37 -0500 Subject: [PATCH] docs(readme): update readmes --- MIGRATION-V11.md | 50 ------------------------------------------------ README.md | 22 ++++++++++----------- 2 files changed, 11 insertions(+), 61 deletions(-) delete mode 100644 MIGRATION-V11.md diff --git a/MIGRATION-V11.md b/MIGRATION-V11.md deleted file mode 100644 index 98c20bc3cb..0000000000 --- a/MIGRATION-V11.md +++ /dev/null @@ -1,50 +0,0 @@ -# v11.0.0 Migration Guide - -### Breaking changes by service - -#### Assistant v2 -- Model `MessageContext` property `skills` type changed to new `MessageContextSkills` -- Model `Environment` property `language` removed -- Model `EnvironmentReleaseReference` renamed to `BaseEnvironmentReleaseReference` -- Model `EnvironmentOrchestration` renamed to `BaseEnvironmentOrchestration` -- Model `SkillReference` renamed to `EnvironmentSkill` - -#### Discovery v2 -- Parameter `smartDocumentUnderstanding` removed from `CreateCollectionOptions` -- Model `QueryResponsePassage` and `QueryResultPassage` property `confidence` removed -- QueryAggregation models restructured - -#### Natural Language Understanding -- All `sentimentModel` functions removed - -#### Speech to Text -- `AR_AR_BROADBANDMODEL` model removed in favor of `AR_MS_BROADBANDMODEL` model - - -### New Features by Service - -#### Assistant v2 -- `createAssistant` function -- `listAssistants` function -- `deleteAssistant` function -- `updateEnvironment` function -- `createRelease` function -- `deleteRelease` function -- `getSkill` function -- `updateSkill` function -- `exportSkills` function -- `importSkills` function -- `importSkillsStatus` function -- Improved typing for `message` function call -See details of these functions on IBM's documentation site [here](https://cloud.ibm.com/apidocs/assistant-v2?code=node) - -#### Discovery v2 -- Aggregation types `QueryTopicAggregation` and `QueryTrendAggregation` added - -#### Speech to Text -- added `FR_CA_MULTIMEDIA`, `JA_JP_TELEPHONY`, `NL_NL_MULTIMEDIA`, `SV_SE_TELEPHONY` models - -#### Text to Speech -- added `EN_AU_HEIDIEXPRESSIVE`, `EN_AU_JACKEXPRESSIVE`, `EN_US_ALLISONEXPRESSIVE`, `EN_US_EMMAEXPRESSIVE`, `EN_US_LISAEXPRESSIVE`, `EN_US_MICHAELEXPRESSIVE`, `KO_KR_JINV3VOICE` -- Parameters `ratePercentage` and `pitchPercentage` added to `synthesize` function -See details of these new parameters on IBM's documentation site [here](https://cloud.ibm.com/apidocs/text-to-speech?code=node#synthesize) diff --git a/README.md b/README.md index 54df8eb7f3..68fe84f197 100644 --- a/README.md +++ b/README.md @@ -106,7 +106,7 @@ The file downloaded will be called `ibm-credentials.env`. This is the name the S As long as you set that up correctly, you don't have to worry about setting any authentication options in your code. So, for example, if you created and downloaded the credential file for your Discovery instance, you just need to do the following: ```java -Discovery service = new Discovery("2019-04-30"); +Discovery service = new Discovery("2023-03-31"); ``` And that's it! @@ -144,7 +144,7 @@ Builder pattern approach: Authenticator authenticator = new IamAuthenticator.Builder() .apikey("") .build(); -Discovery service = new Discovery("2019-04-30", authenticator); +Discovery service = new Discovery("2023-03-31", authenticator); ``` Deprecated constructor approach: @@ -152,7 +152,7 @@ Deprecated constructor approach: ```java // letting the SDK manage the IAM token Authenticator authenticator = new IamAuthenticator(""); -Discovery service = new Discovery("2019-04-30", authenticator); +Discovery service = new Discovery("2023-03-31", authenticator); ``` Supplying the access token: @@ -160,7 +160,7 @@ Supplying the access token: ```java // assuming control of managing IAM token Authenticator authenticator = new BearerTokenAuthenticator(""); -Discovery service = new Discovery("2019-04-30", authenticator); +Discovery service = new Discovery("2023-03-31", authenticator); ``` #### Username and password @@ -172,14 +172,14 @@ Authenticator authenticator = new BasicAuthenticator.Builder() .username("") .password("") .build(); -Discovery service = new Discovery("2019-04-30", authenticator); +Discovery service = new Discovery("2023-03-31", authenticator); ``` Deprecated constructor approach: ```java Authenticator authenticator = new BasicAuthenticator("", ""); -Discovery service = new Discovery("2019-04-30", authenticator); +Discovery service = new Discovery("2023-03-31", authenticator); ``` #### ICP @@ -187,7 +187,7 @@ Authenticating with ICP is similar to the basic username and password method, ex ```java Authenticator authenticator = new BasicAuthenticator("", ""); -Discovery service = new Discovery("2019-04-30", authenticator); +Discovery service = new Discovery("2023-03-31", authenticator); HttpConfigOptions options = new HttpConfigOptions.Builder() .disableSslVerification(true) @@ -210,7 +210,7 @@ Authenticator authenticator = new CloudPakForDataAuthenticator.Builder() .disableSSLVerification(true) .headers(null) .build(); -Discovery service = new Discovery("2019-04-30", authenticator); +Discovery service = new Discovery("2023-03-31", authenticator); service.setServiceUrl(""); ``` @@ -225,14 +225,14 @@ Authenticator authenticator = new CloudPakForDataAuthenticator( true, // disabling SSL verification null, ); -Discovery service = new Discovery("2019-04-30", authenticator); +Discovery service = new Discovery("2023-03-31", authenticator); service.setServiceUrl(""); ``` ```java // assuming control of managing the access token Authenticator authenticator = new BearerTokenAuthenticator(""); -Discovery service = new Discovery("2019-04-30", authenticator); +Discovery service = new Discovery("2023-03-31", authenticator); service.setServiceUrl(""); ``` @@ -288,7 +288,7 @@ Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("proxyHost", 8080 IamAuthenticator authenticator = new IamAuthenticator(apiKey); authenticator.setProxy(proxy); -Discovery service = new Discovery("2019-04-30", authenticator); +Discovery service = new Discovery("2023-03-31", authenticator); // setting configuration options HttpConfigOptions options = new HttpConfigOptions.Builder()