Skip to content

Commit 530d90e

Browse files
authored
Updated, added new references
1 parent 29ea921 commit 530d90e

File tree

1 file changed

+24
-26
lines changed

1 file changed

+24
-26
lines changed

README.md

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -15,38 +15,36 @@ urlFragment: cognitive-services-REST-api-samples
1515

1616
# Samples for REST APIs in Cognitive Services
1717

18-
This repo provides code samples for cognitive services APIs. There are sections for Language, Search, and Vision APIs using various progamming languages. Note that these are just simple wrappers to the APIs. For SDKs and SDK samples there are separate repos. You can check out all cognitive services APIs here: https://azure.microsoft.com/en-us/services/cognitive-services/. You can check out detailed documentation of these APIs here: https://docs.microsoft.com/en-us/azure/#pivot=products&panel=cognitive.
19-
20-
## Features
21-
22-
Code samples (aka API wrappers) in multiple languages. Check out https://azure.microsoft.com/en-us/services/cognitive-services/ for the latest and greatest version of the APIs.
18+
This repo provides code samples for Azure Cognitive Services APIs. There are sections for Language, Search, and Vision, using various progamming languages. Note that these are just simple wrappers to the APIs. For SDKs and SDK samples there are separate repos. You can check out all Cognitive Services here: https://azure.microsoft.com/en-us/services/cognitive-services/. You can check out detailed documentation of these APIs here: https://docs.microsoft.com/en-us/azure/cognitive-services/.
2319

2420
## Getting Started
2521

26-
All wrappers require at least two steps:
27-
1. Copy the sample in your favorite IDE.
28-
2. Get access key of your API and insert in the code. Build/Compile/Run your code.
29-
30-
You can get free access keys from here: https://azure.microsoft.com/en-us/try/cognitive-services/?api=bing-web-search-api. You can buy access keys from here: https://portal.azure.com/#create/Microsoft.CognitiveServicesBingSearch-v7.
22+
These REST samples require some steps:
23+
1. Copy the sample into your favorite IDE or text editor.
24+
1. Get a subscription key and endpoint from your API service (for example, Computer Vision or Bing Search, etc.) If you have not created the Azure service you need, go here to get a free (or paid) account: https://azure.microsoft.com/en-us/free/?WT.mc_id=A261C142F
25+
1. Add your key and endpoint to your environment variables with the naming as shown in the code sample.
26+
1. Install libraries if needed (instructions on the ones needed are in the sample).
27+
1. Compile and run the sample through your IDE or the command line.
28+
1. (Optional) You may want to download the whole repo first:
29+
`git clone https://github.com/Azure-Samples/cognitive-services-REST-api-samples`
3130

32-
### Prerequisites
31+
## Resources
3332

34-
1. Your favorite IDE.
35-
2. Node.js samples are for Node.js 6 version.
36-
3. Java samples will need JDK 7 or 8 and will require gson library in some cases.
37-
4. For python, you will need 3.x version.
33+
- Cognitive Services REST APIs: https://westus.dev.cognitive.microsoft.com/docs/services/
34+
- Cognitive Services introduction: https://azure.microsoft.com/en-us/services/cognitive-services/
35+
- Documentation for Cognitive Services: https://docs.microsoft.com/en-us/azure/cognitive-services/
36+
- The Microsoft Azure portal: https://portal.azure.com/#home
37+
- Maven: https://mvnrepository.com/artifact/com.microsoft.azure.cognitiveservices
3838

39-
### Quickstart
39+
## SDK Samples
4040

41-
1. git clone https://github.com/Azure-Samples/cognitive-services-REST-api-samples
42-
2. cd cognitive-services-REST-api-samples
43-
3. Choose your language and sample and open in your favorite IDE.
44-
3. Insert Access Key (and other parameters as required). See Getting Started section above for info on how to get keys.
45-
4. Build and Run.
41+
- Dotnet: https://github.com/Azure-Samples/cognitive-services-dotnet-sdk-samples
42+
- Java: https://github.com/Azure-Samples/cognitive-services-java-sdk-samples
43+
- Node: https://github.com/Azure-Samples/cognitive-services-node-sdk-samples
44+
- Python: https://github.com/Azure-Samples/cognitive-services-python-sdk-samples
4645

47-
## Resources
46+
### Service-specific SDK Samples
4847

49-
- Project page: https://azure.microsoft.com/en-us/services/cognitive-services/
50-
- Documentation page cognitive services APIs: https://docs.microsoft.com/en-us/azure/#pivot=products&panel=cognitive
51-
- SDKs in different languages: For C# https://github.com/Azure/azure-sdk-for-net/ and similar folders for other languages.
52-
- Samples for SDKs: For C# https://github.com/Azure-Samples/cognitive-services-dotnet-sdk-samples and similar for other languages.
48+
- Speech: https://github.com/Azure-Samples/cognitive-services-speech-sdk
49+
- Personalizer: https://github.com/Azure-Samples/cognitive-services-personalizer-samples
50+
- Content Moderator: https://github.com/Azure-Samples/cognitive-services-content-moderator-samples

0 commit comments

Comments
 (0)