Skip to content

Commit 989a77d

Browse files
committed
Remove service specific authentication instructions
1 parent 11935d3 commit 989a77d

File tree

12 files changed

+0
-312
lines changed

12 files changed

+0
-312
lines changed

Scripts/Services/Assistant/v1/README.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,6 @@ You complete these steps to implement your application:
99

1010
* Develop your application. You code your application to connect to the Assistant workspace through API calls. You then integrate your app with other systems that you need, including back-end systems and third-party services such as chat services or social media.
1111

12-
### Instantiating and authenticating the service
13-
Before you can send requests to the service it must be instantiated and credentials must be set.
14-
```cs
15-
using IBM.Watson.DeveloperCloud.Services.Assistant.v1;
16-
using IBM.Watson.DeveloperCloud.Utilities;
17-
18-
void Start()
19-
{
20-
Credentials credentials = new Credentials(<username>, <password>, <url>);
21-
Assistant _assistant = new Assistant(credentials);
22-
}
23-
```
24-
25-
### Fail handler
26-
These examples use a common fail handler.
27-
```cs
28-
private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
29-
{
30-
Log.Error("ExampleAssistant.OnFail()", "Error received: {0}", error.ToString());
31-
}
32-
```
33-
3412
### Message
3513
Send a message to the Assistant instance
3614
```cs

Scripts/Services/Conversation/v1/README.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,6 @@ You complete these steps to implement your application:
99

1010
* Develop your application. You code your application to connect to the Conversation workspace through API calls. You then integrate your app with other systems that you need, including back-end systems and third-party services such as chat services or social media.
1111

12-
### Instantiating and authenticating the service
13-
Before you can send requests to the service it must be instantiated and credentials must be set.
14-
```cs
15-
using IBM.Watson.DeveloperCloud.Services.Conversation.v1;
16-
using IBM.Watson.DeveloperCloud.Utilities;
17-
18-
void Start()
19-
{
20-
Credentials credentials = new Credentials(<username>, <password>, <url>);
21-
Conversation _conversation = new Conversation(credentials);
22-
}
23-
```
24-
25-
### Fail handler
26-
These examples use a common fail handler.
27-
```cs
28-
private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
29-
{
30-
Log.Error("ExampleConversation.OnFail()", "Error received: {0}", error.ToString());
31-
}
32-
```
33-
3412
### Message
3513
Send a message to the Conversation instance
3614
```cs

Scripts/Services/Discovery/v1/README.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,6 @@ The IBM Watson™ [Discovery][discovery] service makes it possible to rapidly bu
44
## Usage
55
The IBM Watson™ [Discovery][discovery] Service uses data analysis combined with cognitive intuition in order to take your unstructured data and enrich it so that you can query it to return the information that you need from it.
66

7-
### Instantiating and authenticating the service
8-
Before you can send requests to the service it must be instantiated and credentials must be set.
9-
```cs
10-
using IBM.Watson.DeveloperCloud.Services.Discovery.v1;
11-
using IBM.Watson.DeveloperCloud.Utilities;
12-
13-
void Start()
14-
{
15-
Credentials credentials = new Credentials(<username>, <password>, <url>);
16-
Discovery _discovery = new Discovery(credentials);
17-
}
18-
```
19-
20-
### Fail handler
21-
These examples use a common fail handler.
22-
```cs
23-
private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
24-
{
25-
Log.Error("ExampleDiscovery.OnFail()", "Error received: {0}", error.ToString());
26-
}
27-
```
28-
29-
30-
317
### Create an environment
328
Creates an environment for the service instance. Note: You can create only one environment per service instance. Attempting to create another environment for the same service instance results in an error. See the [Discovery service home page][discovery-sizing] for additional information about sizing and pricing. To create a free trial environment, specify the value of size as 0 (zero).
339
```cs

Scripts/Services/LanguageTranslator/v2/README.md

Lines changed: 0 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -7,59 +7,6 @@
77
## Usage
88
Select a domain, then identify or select the language of text, and then translate the text from one supported language to another.
99

10-
### Instantiating and authenticating the service
11-
Before you can send requests to the service it must be instantiated and credentials must be set.
12-
```cs
13-
using IBM.Watson.DeveloperCloud.Services.LanguageTranslator.v2;
14-
using IBM.Watson.DeveloperCloud.Utilities;
15-
16-
void Start()
17-
{
18-
Credentials credentials = new Credentials(<username>, <password>, <url>);
19-
LanguageTranslator _languageTranslator = new LanguageTranslator(credentials);
20-
}
21-
```
22-
23-
24-
You can also authenticate the service with an IAM apikey
25-
```cs
26-
using IBM.Watson.DeveloperCloud.Services.LanguageTranslator.v2;
27-
using IBM.Watson.DeveloperCloud.Utilities;
28-
29-
void Start()
30-
{
31-
Runnable.Run(CreateService());
32-
}
33-
34-
IEnumerator CreateService()
35-
{
36-
TokenOptions tokenOptions = new TokenOptions()
37-
{
38-
IamApiKey = _iamApikey
39-
};
40-
41-
Credentials credentials = new Credentials(tokenOptions);
42-
43-
// Wait for tokendata
44-
while (!credentials.HasIamTokenData())
45-
yield return null;
46-
47-
LanguageTranslator _languageTranslator = new LanguageTranslator(credentials);
48-
}
49-
```
50-
51-
52-
### Fail handler
53-
These examples use a common fail handler.
54-
```cs
55-
private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
56-
{
57-
Log.Error("ExampleLanguageTranslatorV2.OnFail()", "Error received: {0}", error.ToString());
58-
}
59-
```
60-
61-
62-
6310
### List models
6411
Lists available models for language translation with option to filter by source or by target language.
6512
```cs

Scripts/Services/LanguageTranslator/v3/README.md

Lines changed: 0 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -5,54 +5,6 @@
55
## Usage
66
Select a domain, then identify or select the language of text, and then translate the text from one supported language to another.
77

8-
### Instantiating and authenticating the service
9-
Before you can send requests to the service it must be instantiated and credentials must be set.
10-
```cs
11-
using IBM.Watson.DeveloperCloud.Services.LanguageTranslator.v3;
12-
using IBM.Watson.DeveloperCloud.Utilities;
13-
14-
void Start()
15-
{
16-
Credentials credentials = new Credentials(<username>, <password>, <url>);
17-
LanguageTranslator _languageTranslator = new LanguageTranslator(credentials);
18-
}
19-
```
20-
21-
22-
You can also authenticate the service with an IAM apikey
23-
```cs
24-
using IBM.Watson.DeveloperCloud.Services.LanguageTranslator.v3;
25-
using IBM.Watson.DeveloperCloud.Utilities;
26-
27-
IEnumerator CreateService()
28-
{
29-
TokenOptions tokenOptions = new TokenOptions()
30-
{
31-
IamApiKey = _iamApikey
32-
};
33-
34-
Credentials credentials = new Credentials(tokenOptions);
35-
36-
// Wait for tokendata
37-
while (!credentials.HasIamTokenData())
38-
yield return null;
39-
40-
LanguageTranslator _languageTranslator = new LanguageTranslator("<versionDate>", credentials);
41-
}
42-
```
43-
44-
45-
### Fail handler
46-
These examples use a common fail handler.
47-
```cs
48-
private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
49-
{
50-
Log.Error("ExampleLanguageTranslatorV3V3.OnFail()", "Error received: {0}", error.ToString());
51-
}
52-
```
53-
54-
55-
568
### List models
579
Lists available models for language translation with option to filter by source or by target language.
5810
```cs

Scripts/Services/NaturalLanguageClassifier/v2/README.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,6 @@ Use [Natural Language Classifier][natural_language_classifier] service to create
55
## Usage
66
Classify intents in natural language.
77

8-
### Instantiating and authenticating the service
9-
Before you can send requests to the service it must be instantiated and credentials must be set.
10-
```cs
11-
using IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v2;
12-
using IBM.Watson.DeveloperCloud.Utilities;
13-
14-
void Start()
15-
{
16-
Credentials credentials = new Credentials(<username>, <password>, <url>);
17-
NaturalLanguageClassifier _naturalLanguageClassifier = new NaturalLanguageClassifier(credentials);
18-
}
19-
```
20-
21-
22-
### Fail handler
23-
These examples use a common fail handler.
24-
```cs
25-
private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
26-
{
27-
Log.Error("ExampleNaturalLanguageClassifier.OnFail()", "Error received: {0}", error.ToString());
28-
}
29-
```
30-
31-
328
### Listing Classifiers
339
Returns an empty array if no classifiers are available.
3410
```cs

Scripts/Services/NaturalLanguageUnderstanding/v1/README.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,6 @@ Natural Language Understanding uses natural language processing to analyze seman
77

88
You can create [custom models][custom_models] with Watson Knowledge Studio that can be used to detect custom [entities][entities] and [relations][relations] in Natural Language Understanding.
99

10-
### Instantiating and authenticating the service
11-
Before you can send requests to the service it must be instantiated and credentials must be set.
12-
```cs
13-
using IBM.Watson.DeveloperCloud.Services.NaturalLanguageUnderstanding.v2;
14-
using IBM.Watson.DeveloperCloud.Utilities;
15-
16-
void Start()
17-
{
18-
Credentials credentials = new Credentials(<username>, <password>, <url>);
19-
NaturalLanguageUnderstanding _naturalLanguageUnderstanding = new NaturalLanguageUnderstanding(credentials);
20-
}
21-
```
22-
23-
### Fail handler
24-
These examples use a common fail handler.
25-
```cs
26-
private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
27-
{
28-
Log.Error("ExampleNaturalLanguageUnderstanding.OnFail()", "Error received: {0}", error.ToString());
29-
}
30-
```
31-
3210
### Analyze
3311
Analyze features of natural language content.
3412
```cs

Scripts/Services/PersonalityInsights/v3/README.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,6 @@ For information about the meaning of the models that the service uses to describ
99
## Usage
1010
The service offers a single `profile` method that accepts up to 20 MB of input data and produces results in JSON or CSV format. The service accepts input in Arabic, English, Japanese, or Spanish and can produce output in a variety of languages.
1111

12-
### Instantiating and authenticating the service
13-
Before you can send requests to the service it must be instantiated and credentials must be set.
14-
```cs
15-
using IBM.Watson.DeveloperCloud.Services.PersonalityInsights.v3;
16-
using IBM.Watson.DeveloperCloud.Utilities;
17-
18-
void Start()
19-
{
20-
Credentials credentials = new Credentials(<username>, <password>, <url>);
21-
PersonalityInsights _personalityInsights = new PersonalityInsights(credentials);
22-
}
23-
```
24-
2512
### Profile
2613
Extract personality characteristics based on how a person writes.
2714
```cs

Scripts/Services/SpeechToText/v1/README.md

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -21,29 +21,6 @@ The Speech to Text API consists of the following groups of related calls:
2121

2222
* Custom words provides an HTTP interface for managing individual words in a custom language model. You can add, list, and delete words from a custom model.
2323

24-
### Instantiating and authenticating the service
25-
Before you can send requests to the service it must be instantiated and credentials must be set.
26-
```cs
27-
using IBM.Watson.DeveloperCloud.Services.SpeechToText.v1;
28-
using IBM.Watson.DeveloperCloud.Utilities;
29-
30-
void Start()
31-
{
32-
Credentials credentials = new Credentials(<username>, <password>, <url>);
33-
SpeechToText _speechToText = new SpeechToText(credentials);
34-
}
35-
```
36-
37-
### Fail handler
38-
These examples use a common fail handler.
39-
```cs
40-
private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
41-
{
42-
Log.Error("ExampleSpeechToText.OnFail()", "Error received: {0}", error.ToString());
43-
}
44-
```
45-
46-
4724
### Get models
4825
Retrieves a list of all models available for use with the service. The information includes the name of the model and its minimum sampling rate in Hertz, among other things.
4926
```cs

Scripts/Services/TextToSpeech/v1/README.md

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -40,31 +40,6 @@ or the proprietary IBM Symbolic Phonetic Representation (SPR), for example
4040

4141
For more information about customization and about sounds-like and phonetic translations, see [Understanding customization][understanding-customization] and [Using customization][using-customization].
4242

43-
### Instantiating and authenticating the service
44-
Before you can send requests to the service it must be instantiated and credentials must be set.
45-
```cs
46-
using IBM.Watson.DeveloperCloud.Services.TextToSpeech.v1;
47-
using IBM.Watson.DeveloperCloud.Utilities;
48-
49-
void Start()
50-
{
51-
Credentials credentials = new Credentials(<username>, <password>, <url>);
52-
TextToSpeech _textToSpeech = new TextToSpeech(credentials);
53-
}
54-
```
55-
56-
### Fail handler
57-
These examples use a common fail handler.
58-
```cs
59-
private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
60-
{
61-
Log.Error("ExampleTextToSpeech.OnFail()", "Error received: {0}", error.ToString());
62-
}
63-
```
64-
65-
66-
67-
6843
### Get voices
6944
Retrieves a list of all voices available for use with the service. The information includes the voice's name, language, and gender, among other things. To see information about a specific voice, use the Get a voice method.
7045
```cs

Scripts/Services/ToneAnalyzer/v3/README.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,6 @@ The IBM Watson™ [Tone Analyzer Service][tone-analyzer] uses linguistic analysi
55
## Usage
66
Use [Tone Analyzer][tone-analyzer] to detect three types of tones from written text: emotions, social tendencies, and language style. Emotions identified include things like anger, cheerfulness and sadness. Identified social tendencies include things from the Big Five personality traits used by some psychologists. These include openness, conscientiousness, extraversion, agreeableness, and neuroticism. Identified language styles include things like confident, analytical, and tentative. Input email and other written media into the [Tone Analyzer][tone-analyzer] service, and use the results to determine if your writing comes across with the tone, personality traits, and writing style that you want for your intended audience.
77

8-
### Instantiating and authenticating the service
9-
Before you can send requests to the service it must be instantiated and credentials must be set.
10-
```cs
11-
using IBM.Watson.DeveloperCloud.Services.ToneAnalyzer.v1;
12-
using IBM.Watson.DeveloperCloud.Utilities;
13-
14-
void Start()
15-
{
16-
Credentials credentials = new Credentials(<username>, <password>, <url>);
17-
ToneAnalyzer _toneAnalyzer = new ToneAnalyzer(credentials);
18-
}
19-
```
20-
21-
228
### Analyze tone
239
Analyzes the tone of a piece of text. The message is analyzed for several tones - social, emotional, and language. For each tone, various traits are derived. For example, conscientiousness, agreeableness, and openness.
2410
```cs

Scripts/Services/VisualRecognition/v3/README.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,6 @@ The IBM Watson™ [Visual Recognition][visual-recognition] service uses deep lea
44
## Usage
55
The IBM Watson™ [Visual Recognition][visual-recognition] service uses deep learning algorithms to identify scenes, objects, and faces in images you upload to the service. You can create and train a custom classifier to identify subjects that suit your needs. You can create and add images to a collection and then search that collection with your own image to find similar images. A valid API Key from Bluemix is required for all calls.
66

7-
### Instantiating and authenticating the service
8-
Before you can send requests to the service it must be instantiated and api key must be set.
9-
```cs
10-
using IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3;
11-
using IBM.Watson.DeveloperCloud.Utilities;
12-
13-
void Start()
14-
{
15-
Credentials credentials = new Credentials("<apikey>", "<url>");
16-
VisualRecognition _visualRecognition = new VisualRecognition(credentials);
17-
}
18-
```
19-
20-
### Fail handler
21-
These examples use a common fail handler.
22-
```cs
23-
private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
24-
{
25-
Log.Error("ExampleVisualRecognition.OnFail()", "Error received: {0}", error.ToString());
26-
}
27-
```
28-
297
### Classify an image
308
Upload images or URLs to identify classes by default. To identify custom classifiers, include the classifier_ids or owners parameters. Images must be in .jpeg, or .png format.
319

0 commit comments

Comments
 (0)