Skip to content

Commit 5aac8ab

Browse files
committed
docs(readme): remove references to deleted services and tests
1 parent e331bbe commit 5aac8ab

File tree

6 files changed

+0
-328
lines changed

6 files changed

+0
-328
lines changed

README.md

Lines changed: 0 additions & 195 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,6 @@ Version v6.0.0 of the SDK has been released and includes a number of breaking ch
2525
### Updating endpoint URLs from watsonplatform.net
2626
Watson API endpoint URLs at watsonplatform.net are changing and will not work after 26 May 2021. Update your calls to use the newer endpoint URLs. For more information, see https://cloud.ibm.com/docs/watson?topic=watson-endpoint-change.
2727

28-
### Personality Insights deprecation
29-
IBM Watson™ Personality Insights is discontinued. For a period of one year from 1 December 2020, you will still be able to use Watson Personality Insights. However, as of 1 December 2021, the offering will no longer be available.
30-
31-
As an alternative, we encourage you to consider migrating to IBM Watson™ [Natural Language Understanding](https://cloud.ibm.com/docs/natural-language-understanding), a service on IBM Cloud® that uses deep learning to extract data and insights from text such as keywords, categories, sentiment, emotion, and syntax to provide insights for your business or industry. For more information, see About Natural Language Understanding.
32-
33-
### Visual Recognition deprecation
34-
IBM Watson™ Visual Recognition is discontinued. Existing instances are supported until 1 December 2021, but as of 7 January 2021, you can't create instances. Any instance that is provisioned on 1 December 2021 will be deleted.
35-
36-
### Compare and Comply deprecation
37-
IBM Watson™ Compare and Comply is discontinued. Existing instances are supported until 30 November 2021, but as of 1 December 2020, you can't create instances. Any instance that exists on 30 November 2021 will be deleted. Consider migrating to Watson Discovery Premium on IBM Cloud for your Compare and Comply use cases. To start the migration process, visit https://ibm.biz/contact-wdc-premium.
38-
3928
### Supporting Node versions 10+
4029
The SDK will no longer be tested with Node versions 6 and 8. Support will be officially dropped in v5.
4130

@@ -486,39 +475,6 @@ assistant.message(
486475
});
487476
```
488477

489-
### Compare Comply
490-
**IBM Watson™ Compare and Comply is discontinued. Existing instances are supported until 30 November 2021, but as of 1 December 2020, you can't create instances. Any instance that exists on 30 November 2021 will be deleted. Consider migrating to Watson Discovery Premium on IBM Cloud for your Compare and Comply use cases. To start the migration process, visit https://ibm.biz/contact-wdc-premium.**
491-
492-
Use the Compare Comply service to compare and classify documents.
493-
494-
```js
495-
const fs = require('fs');
496-
const CompareComplyV1 = require('ibm-watson/compare-comply/v1');
497-
const { IamAuthenticator } = require('ibm-watson/auth');
498-
499-
const compareComply = new CompareComplyV1({
500-
authenticator: new IamAuthenticator({ apikey: '<apikey>' }),
501-
serviceUrl: 'https://api.us-south.compare-comply.watson.cloud.ibm.com',
502-
version: '2018-12-06'
503-
});
504-
505-
compareComply.compareDocuments(
506-
{
507-
file1: fs.createReadStream('<path-to-file-1>'),
508-
file1Filename: '<filename-1>',
509-
file1Label: 'file-1',
510-
file2: fs.createReadStream('<path-to-file-2>'),
511-
file2Filename: '<filename-2>',
512-
file2Label: 'file-2',
513-
})
514-
.then(response => {
515-
console.log(JSON.stringify(response.result, null, 2));
516-
})
517-
.catch(err => {
518-
console.log(err);
519-
});
520-
```
521-
522478
### Discovery v2
523479

524480
Use the [Discovery Service][discovery] to search and analyze structured and unstructured data.
@@ -614,34 +570,6 @@ languageTranslator.identify(
614570
});
615571
```
616572

617-
### Natural Language Classifier
618-
619-
Use [Natural Language Classifier](https://cloud.ibm.com/docs/natural-language-classifier/getting-started.html) service to create a classifier instance by providing a set of representative strings and a set of one or more correct classes for each as training. Then use the trained classifier to classify your new question for best matching answers or to retrieve next actions for your application.
620-
621-
```js
622-
const NaturalLanguageClassifierV1 = require('ibm-watson/natural-language-classifier/v1');
623-
const { IamAuthenticator } = require('ibm-watson/auth');
624-
625-
const classifier = new NaturalLanguageClassifierV1({
626-
authenticator: new IamAuthenticator({ apikey: '<apikey>' }),
627-
serviceUrl: 'https://api.us-south.natural-language-classifier.watson.cloud.ibm.com'
628-
});
629-
630-
classifier.classify(
631-
{
632-
text: 'Is it sunny?',
633-
classifierId: '<classifier-id>'
634-
})
635-
.then(response => {
636-
console.log(JSON.stringify(response.result, null, 2));
637-
})
638-
.catch(err => {
639-
console.log('error: ', err);
640-
});
641-
```
642-
643-
See this [example](https://github.com/watson-developer-cloud/node-sdk/blob/master/examples/natural_language_classifier.v1.js) to learn how to create a classifier.
644-
645573

646574
### Natural Language Understanding
647575

@@ -675,39 +603,6 @@ nlu.analyze(
675603
```
676604

677605

678-
### Personality Insights
679-
**On 1 December 2021, Personality Insights will no longer be available.
680-
Consider migrating to Watson Natural Language Understanding.
681-
For more information, see https://github.com/watson-developer-cloud/node-sdk/tree/master#personality-insights-deprecation**
682-
683-
Analyze text in English and get a personality profile by using the
684-
[Personality Insights][personality_insights] service.
685-
686-
```js
687-
const PersonalityInsightsV3 = require('ibm-watson/personality-insights/v3');
688-
const { IamAuthenticator } = require('ibm-watson/auth');
689-
690-
const personalityInsights = new PersonalityInsightsV3({
691-
authenticator: new IamAuthenticator({ apikey: '<apikey>' }),
692-
version: '2016-10-19',
693-
serviceUrl: 'https://api.us-south.personality-insights.watson.cloud.ibm.com'
694-
});
695-
696-
personalityInsights.profile(
697-
{
698-
content: 'Enter more than 100 unique words here...',
699-
contentType: 'text/plain',
700-
consumptionPreferences: true
701-
})
702-
.then(response => {
703-
console.log(JSON.stringify(response.result, null, 2));
704-
})
705-
.catch(err => {
706-
console.log('error: ', err);
707-
});
708-
```
709-
710-
711606
### Speech to Text
712607

713608
Use the [Speech to Text][speech_to_text] service to recognize the text from a `.wav` file.
@@ -788,96 +683,6 @@ synthStream.pipe(fs.createWriteStream('./audio.ogg'));
788683
// see more information in examples/text_to_speech_websocket.js
789684
```
790685

791-
792-
793-
### Tone Analyzer
794-
795-
Use the [Tone Analyzer][tone_analyzer] service to analyze the
796-
emotion, writing and social tones of a text.
797-
798-
```js
799-
const ToneAnalyzerV3 = require('ibm-watson/tone-analyzer/v3');
800-
const { IamAuthenticator } = require('ibm-watson/auth');
801-
802-
const toneAnalyzer = new ToneAnalyzerV3({
803-
authenticator: new IamAuthenticator({ apikey: '<apikey>' }),
804-
version: '2016-05-19',
805-
serviceUrl: 'https://api.us-south.tone-analyzer.watson.cloud.ibm.com'
806-
});
807-
808-
toneAnalyzer.tone(
809-
{
810-
toneInput: 'Greetings from Watson Developer Cloud!',
811-
contentType: 'text/plain'
812-
})
813-
.then(response => {
814-
console.log(JSON.stringify(response.result, null, 2));
815-
})
816-
.catch(err => {
817-
console.log(err);
818-
});
819-
```
820-
821-
### Visual Recognition v4
822-
**IBM Watson™ Visual Recognition is discontinued. Existing instances are supported until 1 December 2021, but as of 7 January 2021, you can't create instances. Any instance that is provisioned on 1 December 2021 will be deleted.**
823-
824-
Use the [Visual Recognition][visual_recognition] service to recognize the
825-
following picture.
826-
827-
```js
828-
const VisualRecognitionV4 = require('ibm-watson/visual-recognition/v4');
829-
const { IamAuthenticator } = require('ibm-watson/auth');
830-
831-
const visualRecognition = new VisualRecognitionV4({
832-
serviceUrl: 'https://api.us-south.visual-recognition.watson.cloud.ibm.com',
833-
version: '2019-02-11',
834-
authenticator: new IamAuthenticator({ apikey: '<apikey>' }),
835-
});
836-
837-
const params = {
838-
collectionIds: ['<collectionId1','collectionId2','collectionId3'],
839-
features: 'objects'
840-
};
841-
842-
visualRecognition.classify(params)
843-
.then(response => {
844-
const image = response.result.images[0]
845-
const detectedObjects = image.objects.collections[0].objects
846-
console.log(detectedObjects)
847-
})
848-
.catch(err => {
849-
console.log(err);
850-
});
851-
```
852-
### Visual Recognition v3
853-
854-
Use the [Visual Recognition][visual_recognition] service to recognize the
855-
following picture.
856-
857-
```js
858-
const fs = require('fs');
859-
const VisualRecognitionV3 = require('ibm-watson/visual-recognition/v3');
860-
const { IamAuthenticator } = require('ibm-watson/auth');
861-
862-
const visualRecognition = new VisualRecognitionV3({
863-
serviceUrl: 'https://api.us-south.visual-recognition.watson.cloud.ibm.com',
864-
version: '2018-03-19',
865-
authenticator: new IamAuthenticator({ apikey: '<apikey>' }),
866-
});
867-
868-
const params = {
869-
imagesFile: fs.createReadStream('./resources/car.png')
870-
};
871-
872-
visualRecognition.classify(params)
873-
.then(response => {
874-
console.log(JSON.stringify(response.result, null, 2));
875-
})
876-
.catch(err => {
877-
console.log(err);
878-
});
879-
```
880-
881686
## Unauthenticated requests
882687
The SDK always expects an authenticator to be passed in. To make an unautuhenticated request, use the `NoAuthAuthenticator`.
883688

examples/compare-comply.v1.js

Lines changed: 0 additions & 23 deletions
This file was deleted.

examples/natural_language_classifier.v1.js

Lines changed: 0 additions & 32 deletions
This file was deleted.

examples/personality_insights.v3.js

Lines changed: 0 additions & 19 deletions
This file was deleted.

examples/tone_analyzer.v3.js

Lines changed: 0 additions & 40 deletions
This file was deleted.

examples/visual_recognition.v3.js

Lines changed: 0 additions & 19 deletions
This file was deleted.

0 commit comments

Comments
 (0)