Skip to content

Commit 1d2a1ba

Browse files
authored
Initial Commit
1 parent 2153585 commit 1d2a1ba

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

README.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
page_type: sample
3+
languages:
4+
- java
5+
products:
6+
- azure
7+
description: "These samples will show you how to get up and running using the Java SDKs for various Cognitive Services services."
8+
urlFragment: cognitive-services-java-sdk-samples
9+
---
10+
11+
# Cognitive Services Java SDK Samples
12+
13+
These samples will show you how to get up and running using the Java SDKs for various Cognitive Services services. They'll cover a few rudimentary use cases and express best practices for interacting with the data from these APIs.
14+
15+
## Features
16+
17+
This project framework provides examples for the following services:
18+
19+
### Language
20+
21+
* **Language Understanding (LUIS)**, using the [Language Understanding SDK](https://docs.microsoft.com/en-us/java/api/com.microsoft.azure.cognitiveservices.language.luis.authoring?view=azure-java-stable) for the [LUIS API](https://westus.dev.cognitive.microsoft.com/docs/services/5890b47c39e2bb17b84a55ff/operations/5890b47c39e2bb052c5b9c2f)
22+
* **Spell Check**, using the [Bing Spell Check SDK](https://docs.microsoft.com/en-us/java/api/overview/azure/cognitiveservices/client/bingspellcheck?view=azure-java-stable) for the [Spell Check API](https://dev.cognitive.microsoft.com/docs/services/5f7d486e04d2430193e1ca8f760cd7ed/operations/57855119bca1df1c647bc358)
23+
* **Text Analytics**, using the [Text Analytics SDK](https://docs.microsoft.com/en-us/java/api/overview/azure/cognitiveservices/client/textanalytics?view=azure-java-stable) for the [Text Analytics API](https://westcentralus.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v2-1/operations/56f30ceeeda5650db055a3c7)
24+
25+
### Search
26+
27+
* **Autosuggest Search**, using the [Bing Autosuggest SDK](https://docs.microsoft.com/en-us/java/api/overview/azure/cognitiveservices/client/bingautosuggest?view=azure-java-stable) for the [Autosuggest API](https://dev.cognitive.microsoft.com/docs/services/644e01b5a68c4fdb93e1f49b4f5c4ce1/operations/56c769a2cf5ff801a090fbd2)
28+
* **Custom Search**, using the [Bing Custom Search SDK](https://docs.microsoft.com/en-us/java/api/overview/azure/cognitiveservices/client/bingcustomsearch?view=azure-java-stable) for the [Custom Search API v7](https://docs.microsoft.com/en-us/rest/api/cognitiveservices-bingsearch/bing-custom-search-api-v7-reference)
29+
* **Image Search**, using the [Bing Custom Image Search SDK](https://docs.microsoft.com/en-us/java/api/overview/azure/cognitiveservices/client/bingcustomimagesearch?view=azure-java-stable) for the [Image Search API v7](https://docs.microsoft.com/en-us/rest/api/cognitiveservices-bingsearch/bing-images-api-v7-reference)
30+
* **Entity Search**, using the [Bing Entity Search SDK](https://docs.microsoft.com/en-us/java/api/overview/azure/cognitiveservices/client/bingentitysearchapi?view=azure-java-stable) for the [Bing Entity Search API](https://docs.microsoft.com/en-us/rest/api/cognitiveservices-bingsearch/bing-entities-api-v7-reference)
31+
* **News Search**, using the [Bing News Search SDK](https://docs.microsoft.com/en-us/java/api/overview/azure/cognitiveservices/client/bingnewssearch?view=azure-java-stable) for the [News Search v7 API](https://docs.microsoft.com/en-us/rest/api/cognitiveservices-bingsearch/bing-news-api-v7-reference)
32+
* **Video Search**, using the [Bing Video Search SDK](https://docs.microsoft.com/en-us/java/api/overview/azure/cognitiveservices/client/bingvideosearch?view=azure-java-stable) for the [Video Search API v7](https://docs.microsoft.com/en-us/rest/api/cognitiveservices-bingsearch/bing-video-api-v7-reference)
33+
* **Visual Search**, using the [Bing Visual Search SDK](https://docs.microsoft.com/en-us/java/api/com.microsoft.azure.cognitiveservices.search.visualsearch?view=azure-java-stable) for the [Bing Visual Search API](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bingvisualsearch/images)
34+
* **Web Search**, using the [Bing Web Search SDK](https://docs.microsoft.com/en-us/java/api/overview/azure/cognitiveservices/client/bingwebsearchapi?view=azure-java-stable) for the [Web Search API v7](https://docs.microsoft.com/en-us/rest/api/cognitiveservices-bingsearch/bing-web-api-v7-reference)
35+
36+
### Vision
37+
38+
* **[Face](https://github.com/Azure-Samples/cognitive-services-quickstart-code/tree/master/java/Face)**, using the [Face SDK](https://docs.microsoft.com/en-us/java/api/overview/azure/cognitiveservices/client/faceapi?view=azure-java-stable) for the [Face API](https://docs.microsoft.com/en-us/azure/cognitive-services/face/APIReference)
39+
* **Computer Vision**, using the [Computer Vision SDK](https://docs.microsoft.com/en-us/java/api/overview/azure/cognitiveservices/client/computervision?view=azure-java-stable) for the [Computer Vision API](https://westus.dev.cognitive.microsoft.com/docs/services/5cd27ec07268f6c679a3e641/operations/56f91f2e778daf14a499f21b)
40+
* **[Content Moderator](https://github.com/Azure-Samples/cognitive-services-quickstart-code/tree/master/java/ContentModerator)**, using the [Content Moderator SDK](https://docs.microsoft.com/en-us/java/api/overview/azure/cognitiveservices/client/contentmoderator?view=azure-java-stable) for the [Content Moderator API](https://docs.microsoft.com/en-us/azure/cognitive-services/content-moderator/api-reference)
41+
* **Custom Vision**, using the [Custom Vision SDK](https://docs.microsoft.com/en-us/java/api/overview/azure/cognitiveservices/client/customvision?view=azure-java-stable) for the [Custom Vision Training API](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.0/operations/5c771cdcbf6a2b18a0c3b7fa) and the [Custom Vision Prediction API](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Prediction_3.0/operations/5c82db60bf6a2b11a8247c15)
42+
* **Ink Recognizer**, using the [Ink Recognizer SDK](https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/cognitiveservices/ms-azure-cs-inkrecognizer) for the [Ink Recognizer API](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/inkrecognizer/inkrecognizer/recognize)
43+
44+
## Getting Started
45+
46+
### Prerequisites
47+
48+
1. A cognitive services API key and/or endpoint with which to authenticate the SDK's calls. If you don't have an Azure account, [Sign up here](https://azure.microsoft.com/services/cognitive-services/directory/) or follow the [Create a Cognitive Services resource using the Azure portal](https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows) guide. You can get a trial key for **free** which will expire after 30 days or create a Cognitive Services account on the Azure portal through the *Use with an Azure subscription* button.
49+
2. JDK 7 or 8
50+
51+
> Subscription keys are usually per service. For example, the subscription key for Spell Check will not be the same as it is for Custom Search.
52+
53+
### Installation
54+
55+
Copy this repository to your local machine by typing
56+
```
57+
git clone https://github.com/Azure-Samples/cognitive-services-java-sdk-samples.git
58+
```
59+
in your command line/bash. Or download and open the zip file of this repo.
60+
61+
### Quickstart
62+
63+
In each sample you will need your subscription key and/or endpoint from your Azure Portal resource for the service. In the beginning of each sample, add your subscription key/endpoint where applicable.
64+
65+
## Resources
66+
67+
- Each service stems from a [Cognitive Service client](https://docs.microsoft.com/en-us/java/api/overview/azure/cognitiveservices/client?view=azure-java-stable)
68+
- [azure-sdk-for-java](https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/cognitiveservices)

0 commit comments

Comments
 (0)