Skip to content

Commit d126426

Browse files
[si skip] 😒 Update README
1 parent c4cb108 commit d126426

File tree

2 files changed

+44
-59
lines changed

2 files changed

+44
-59
lines changed

README.md

Lines changed: 44 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,43 @@
1-
# Watson Developer Cloud Java SDK
1+
# Watson APIs Java SDK
22

33
[![Build Status](https://travis-ci.org/watson-developer-cloud/java-sdk.svg?branch=master)](https://travis-ci.org/watson-developer-cloud/java-sdk)
4+
[![Slack](https://wdc-slack-inviter.mybluemix.net/badge.svg)](https://wdc-slack-inviter.mybluemix.net)
45
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.ibm.watson.developer_cloud/java-sdk/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.ibm.watson.developer_cloud/java-sdk)
56
[![CLA assistant](https://cla-assistant.io/readme/badge/watson-developer-cloud/java-sdk)](https://cla-assistant.io/watson-developer-cloud/java-sdk)
67

7-
The Java SDK uses the [Watson Developer Cloud][wdc] services, a collection of REST
8-
APIs and SDKs that use cognitive computing to solve complex problems.
9-
10-
## Table of Contents
11-
12-
* [Installation](#installation)
13-
* [Maven](#maven)
14-
* [Gradle](#gradle)
15-
* [Usage](#usage)
16-
* [Getting the Service Credentials](#getting-the-service-credentials)
17-
* IBM Watson Services
18-
* [Alchemy Language](alchemy)
19-
* [Alchemy Vision](alchemy)
20-
* [Alchemy Data News](alchemy)
21-
* [Concept Insights](alchemy)
22-
* [Conversation](conversation)
23-
* [Dialog](dialog)
24-
* [Discovery](discovery)
25-
* [Language Translation](language-translation)
26-
* [Language Translator](language-translator)
27-
* [Natural Language Classifier](natural-language-classifier)
28-
* [Natural Language Understanding](natural-language-understanding)
29-
* [Personality Insights](personality-insights)
30-
* [Retrieve and Rank](retrieve-and-rank)
31-
* [Speech to Text](speech-to-text)
32-
* [Text to Speech](text-to-speech)
33-
* [Tone Analyzer](tone-analyzer)
34-
* [Tradeoff Analytics](tradeoff-analytics)
35-
* [Visual Recognition](visual-recognition)
36-
* [Changes for v4.0](#changes-for-v40)
37-
* [Using a Proxy](#using-a-proxy)
38-
* [Android](#android)
39-
* [Running in IBM Cloud](#running-in-ibm-cloud)
40-
* [Default Headers](#default-headers)
41-
* [Debug](#debug)
42-
* [Eclipse and Intellij](#working-with-eclipse-and-intellij-idea)
43-
* [License](#license)
44-
* [Contributing](#contributing)
8+
Node.js client library to use the [Watson APIs][wdc].
9+
10+
<details>
11+
<summary>Table of Contents</summary>
12+
13+
* [Installation](#installation)
14+
* [Maven](#maven)
15+
* [Gradle](#gradle)
16+
* [Usage](#usage)
17+
* [Getting the Service Credentials](#getting-the-service-credentials)
18+
* IBM Watson Services
19+
* [Conversation](conversation)
20+
* [Discovery](discovery)
21+
* [Language Translator](language-translator)
22+
* [Natural Language Classifier](natural-language-classifier)
23+
* [Natural Language Understanding](natural-language-understanding)
24+
* [Personality Insights](personality-insights)
25+
* [Speech to Text](speech-to-text)
26+
* [Text to Speech](text-to-speech)
27+
* [Tone Analyzer](tone-analyzer)
28+
* [Tradeoff Analytics](tradeoff-analytics)
29+
* [Visual Recognition](visual-recognition)
30+
* [Changes for v4.0](#changes-for-v40)
31+
* [Using a Proxy](#using-a-proxy)
32+
* [Android](#android)
33+
* [Running in IBM Cloud](#running-in-ibm-cloud)
34+
* [Default Headers](#default-headers)
35+
* [Debug](#debug)
36+
* [Eclipse and Intellij](#working-with-eclipse-and-intellij-idea)
37+
* [License](#license)
38+
* [Contributing](#contributing)
39+
40+
</details>
4541

4642
## Installation
4743

@@ -75,16 +71,10 @@ All the services:
7571
'com.ibm.watson.developer_cloud:java-sdk:4.2.1'
7672
```
7773

78-
Only Retrieve and Rank:
74+
Only Conversation:
7975

8076
```gradle
81-
'com.ibm.watson.developer_cloud:retrieve-and-rank:4.2.1'
82-
```
83-
84-
Only Visual Recognition:
85-
86-
```gradle
87-
'com.ibm.watson.developer_cloud:visual-recognition:4.2.1'
77+
'com.ibm.watson.developer_cloud:conversation:4.2.1'
8878
```
8979

9080
##### Development Snapshots
@@ -126,19 +116,15 @@ credentials; the library will get them for you by looking at the [`VCAP_SERVICES
126116

127117
## Getting the Service Credentials
128118

129-
You will need the `username` and `password` (`api_key` for AlchemyAPI) credentials, and the API endpoint for each service. Service credentials are different from your IBM Cloud account username and password.
119+
You will need the `username` and `password` (`api_key` for Visual Recognition) credentials, and the API endpoint for each service. Service credentials are different from your IBM Cloud account username and password.
130120

131121
To get your service credentials, follow these steps:
132122

133123
1. Log in to [IBM Cloud](https://console.bluemix.net/catalog?category=watson)
134-
135-
1. Create an instance of the service:
136-
1. In the IBM Cloud **Catalog**, select the service you want to use.
137-
1. Click **Create**.
138-
139-
1. Copy your credentials:
140-
1. On the left side of the page, click **Service Credentials**, and then **View credentials** to view your service credentials.
141-
1. Copy `url`, `username` and `password`(`api_key` for AlchemyAPI or Visual Recognition).
124+
1. In the IBM Cloud **Catalog**, select the service you want to use.
125+
1. Click **Create**.
126+
1. On the left side of the page, click **Service Credentials**, and then **View credentials** to view your service credentials.
127+
1. Copy `url`, `username` and `password`(`api_key` for AlchemyAPI or Visual Recognition).
142128

143129
## Changes for v4.0
144130
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.
@@ -205,7 +191,7 @@ service.setDefaultHeaders(headers);
205191

206192
You can set the correct API Endpoint for your service calling `setEndPoint()`.
207193

208-
For example, if you have the conversation service in Germany, the Endpoint may be `https://gateway-fra.watsonplatform.net/conversation/api`.
194+
For example, if you have the conversation service in Germany, the Endpoint may be `https://gateway-fra.watsonplatform.net/conversation/api`.
209195

210196
You will need to call
211197

@@ -300,7 +286,7 @@ Watson Services, please ask a question on
300286
or [Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-watson).
301287

302288

303-
[wdc]: http://www.ibm.com/watson/developercloud/
289+
[wdc]: https://www.ibm.com/watson/developer/
304290
[ibm_cloud]: https://console.bluemix.net
305291
[Gradle]: http://www.gradle.org/
306292
[OkHttp]: http://square.github.io/okhttp/

language-translator/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Language Translator
2-
Formerly called Language Translation. No code changes are required to migrate.
32

43
## Installation
54

0 commit comments

Comments
 (0)