Skip to content

Commit 1529635

Browse files
authored
Merge pull request #993 from watson-developer-cloud/codegen-updates
Release v6.8.0
2 parents 2a907aa + e6c1ce2 commit 1529635

File tree

40 files changed

+1217
-891
lines changed

40 files changed

+1217
-891
lines changed

.bumpversion.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[bumpversion]
2-
current_version = 6.7.0
2+
current_version = 6.8.0
33
commit = True
44
message = docs: Update version numbers from {current_version} -> {new_version}
55

README.md

Lines changed: 8 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ All the services:
6060
<dependency>
6161
<groupId>com.ibm.watson.developer_cloud</groupId>
6262
<artifactId>java-sdk</artifactId>
63-
<version>6.7.0</version>
63+
<version>6.8.0</version>
6464
</dependency>
6565
```
6666

@@ -70,7 +70,7 @@ Only Discovery:
7070
<dependency>
7171
<groupId>com.ibm.watson.developer_cloud</groupId>
7272
<artifactId>discovery</artifactId>
73-
<version>6.7.0</version>
73+
<version>6.8.0</version>
7474
</dependency>
7575
```
7676

@@ -79,13 +79,13 @@ Only Discovery:
7979
All the services:
8080

8181
```gradle
82-
'com.ibm.watson.developer_cloud:java-sdk:6.7.0'
82+
'com.ibm.watson.developer_cloud:java-sdk:6.8.0'
8383
```
8484

8585
Only Assistant:
8686

8787
```gradle
88-
'com.ibm.watson.developer_cloud:assistant:6.7.0'
88+
'com.ibm.watson.developer_cloud:assistant:6.8.0'
8989
```
9090

9191
##### Development snapshots
@@ -108,7 +108,7 @@ And then reference the snapshot version on your app module gradle
108108
Only Speech to Text:
109109

110110
```gradle
111-
'com.ibm.watson.developer_cloud:speech-to-text:6.7.1-SNAPSHOT'
111+
'com.ibm.watson.developer_cloud:speech-to-text:6.8.1-SNAPSHOT'
112112
```
113113

114114
##### JAR
@@ -136,7 +136,6 @@ Watson services are migrating to token-based Identity and Access Management (IAM
136136

137137
- With some service instances, you authenticate to the API by using **[IAM](#iam)**.
138138
- In other instances, you authenticate by providing the **[username and password](#username-and-password)** for the service instance.
139-
- Visual Recognition uses a form of [API key](#api-key) only with instances created before May 23, 2018. Newer instances of Visual Recognition use [IAM](#iam).
140139

141140
**Note:** Previously, it was possible to authenticate using a token in a header called `X-Watson-Authorization-Token`. This method is deprecated. The token continues to work with Cloud Foundry services, but is not supported for services that use Identity and Access Management (IAM) authentication. See [here](#iam) for details.
142141

@@ -145,7 +144,7 @@ To find out which authentication to use, view the service credentials. You find
145144

146145
1. Go to the IBM Cloud [Dashboard](https://console.bluemix.net/dashboard/apps?category=ai) page.
147146
1. Either click an existing Watson service instance or click [**Create resource > AI**](https://console.bluemix.net/catalog/?category=ai) and create a service instance.
148-
1. Copy the `url` and either `apikey` or `username` and `password`. Click **Show** if the credentials are masked.
147+
1. Copy the credentials you need for authentication. Click **Show** if the credentials are masked.
149148

150149
In your code, you can use these values in the service constructor or with a method call after instantiating your service.
151150

@@ -209,21 +208,6 @@ Discovery service = new Discovery("2017-11-07");
209208
service.setUsernameAndPassword("<username>", "<password>");
210209
```
211210

212-
### API key
213-
214-
**Important**: This type of authentication works only with Visual Recognition instances created before May 23, 2018. Newer instances of Visual Recognition use [IAM](#iam).
215-
216-
```java
217-
// in the constructor
218-
VisualRecognition service = new VisualRecognition("2016-05-20", "<api_key>");
219-
```
220-
221-
```java
222-
// after instantiation
223-
VisualRecognition service = new VisualRecognition("2016-05-20");
224-
service.setApiKey("<api_key>");
225-
```
226-
227211
## Android
228212

229213
The Android SDK utilizes the Java SDK while making some Android-specific additions. This repository can be found [here](https://github.com/watson-developer-cloud/android-sdk). It depends on [OkHttp][] and [gson][].
@@ -324,9 +308,6 @@ service.sentEndPoint("https://gateway-fra.watsonplatform.net/discovery/api")
324308
Make sure you are using the service credentials and not your IBM Cloud account/password.
325309
Check the API endpoint, you may need to update the default using `setEndPoint()`.
326310

327-
## Changes for v4.0
328-
Version 4.0 focuses on the move to programmatically-generated code for many of the services. See the [changelog](https://github.com/watson-developer-cloud/java-sdk/wiki/Changelog) for the details. This version also includes many breaking changes as a result of standardizing behavior across the new generated services. Full details on migration from previous versions can be found [here](https://github.com/watson-developer-cloud/java-sdk/wiki/Migration).
329-
330311
## Debug
331312

332313
HTTP requests can be logged by adding a `logging.properties` file to your classpath.
@@ -366,7 +347,7 @@ Gradle:
366347

367348
```sh
368349
cd java-sdk
369-
gradle jar # build jar file (build/libs/watson-developer-cloud-6.7.0.jar)
350+
gradle jar # build jar file (build/libs/watson-developer-cloud-6.8.0.jar)
370351
gradle test # run tests
371352
gradle check # performs quality checks on source files and generates reports
372353
gradle testReport # run tests and generate the aggregated test report (build/reports/allTests)
@@ -419,4 +400,4 @@ or [Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-watson).
419400
[ibm-cloud-onboarding]: http://console.bluemix.net/registration?target=/developer/watson&cm_sp=WatsonPlatform-WatsonServices-_-OnPageNavLink-IBMWatson_SDKs-_-Java
420401

421402

422-
[jar]: https://github.com/watson-developer-cloud/java-sdk/releases/download/java-sdk-6.7.0/java-sdk-6.7.0-jar-with-dependencies.jar
403+
[jar]: https://github.com/watson-developer-cloud/java-sdk/releases/download/java-sdk-6.8.0/java-sdk-6.8.0-jar-with-dependencies.jar

assistant/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ Check it out in the `assistant/v2` folder.
1010
<dependency>
1111
<groupId>com.ibm.watson.developer_cloud</groupId>
1212
<artifactId>assistant</artifactId>
13-
<version>6.7.0</version>
13+
<version>6.8.0</version>
1414
</dependency>
1515
```
1616

1717
##### Gradle
1818
```gradle
19-
'com.ibm.watson.developer_cloud:assistant:6.7.0'
19+
'com.ibm.watson.developer_cloud:assistant:6.8.0'
2020
```
2121

2222
## Usage

assistant/src/main/java/com/ibm/watson/developer_cloud/assistant/v2/model/MessageContextGlobalSystem.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,9 @@ public String getTimezone() {
4040
/**
4141
* Gets the userId.
4242
*
43-
* String value provided by the API client that should be unique per each distinct end user of the service powered by
44-
* Assistant.
43+
* A string value that identifies the user who is interacting with the assistant. The client must provide a unique
44+
* identifier for each individual end user who accesses the application. This user ID may be used for billing and
45+
* other purposes.
4546
*
4647
* @return the userId
4748
*/
@@ -52,10 +53,8 @@ public String getUserId() {
5253
/**
5354
* Gets the turnCount.
5455
*
55-
* This property is normally set by the Assistant which sets this to 1 during the first conversation turn and then
56-
* increments it by 1 with every subsequent turn. A turn count equal to 0 (or > 0) informs the Assistant that this is
57-
* (or is not) the first turn in a conversation which influences the behavior of some skills. The Conversation skill
58-
* uses this to evaluate its `welcome` and `conversation_start` conditions.
56+
* A counter that is automatically incremented with each turn of the conversation. A value of 1 indicates that this is
57+
* the the first turn of a new conversation, which can affect the behavior of some skills.
5958
*
6059
* @return the turnCount
6160
*/

config.properties.enc

-160 Bytes
Binary file not shown.

conversation/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
# Conversation
22

3+
## Deprecation notice
4+
Conversation will be removed in the next major release. Please migrate to Assistant v1 or v2.
5+
36
## Installation
47

58
##### Maven
69
```xml
710
<dependency>
811
<groupId>com.ibm.watson.developer_cloud</groupId>
912
<artifactId>conversation</artifactId>
10-
<version>6.7.0</version>
13+
<version>6.8.0</version>
1114
</dependency>
1215
```
1316

1417
##### Gradle
1518
```gradle
16-
'com.ibm.watson.developer_cloud:conversation:6.7.0'
19+
'com.ibm.watson.developer_cloud:conversation:6.8.0'
1720
```
1821

1922
## Usage

conversation/src/main/java/com/ibm/watson/developer_cloud/conversation/v1/Conversation.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,9 @@
9595
*
9696
* @version v1
9797
* @see <a href="http://www.ibm.com/watson/developercloud/conversation.html">Conversation</a>
98+
* @deprecated Conversation will be removed in the next major release. Please migrate to Assistant v1 or v2.
9899
*/
100+
@Deprecated
99101
public class Conversation extends WatsonService {
100102

101103
private static final String SERVICE_NAME = "conversation";

discovery/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
<dependency>
88
<groupId>com.ibm.watson.developer_cloud</groupId>
99
<artifactId>discovery</artifactId>
10-
<version>6.7.0</version>
10+
<version>6.8.0</version>
1111
</dependency>
1212
```
1313

1414
##### Gradle
1515
```gradle
16-
'com.ibm.watson.developer_cloud:discovery:6.7.0'
16+
'com.ibm.watson.developer_cloud:discovery:6.8.0'
1717
```
1818

1919
## Usage

0 commit comments

Comments
 (0)