Skip to content

Commit 0bff462

Browse files
committed
Updated Readme
1 parent 17d4d65 commit 0bff462

File tree

2 files changed

+35
-16
lines changed

2 files changed

+35
-16
lines changed

README.md

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,33 @@
1-
# Bing Search Python SDK Samples
1+
# Cognitive Services Python SDK Samples
22

3-
These samples will show you how to get up and running using the Python SDKs for various Bing Search services. They'll cover a few rudimentary use cases and hopefully express best practices for interacting with the data from these APIs.
3+
These samples will show you how to get up and running using the Python SDKs for various Cognitive Services services. They'll cover a few rudimentary use cases and hopefully express best practices for interacting with the data from these APIs.
44

55
## Features
66

77
This project framework provides examples for the following services:
88

9-
* Using the **Bing Entity Search SDK** [azure-cognititiveservices-search-entitysearch](http://pypi.python.org/pypi/azure-cognititiveservices-search-entitysearch) for the [Entity Search API](https://azure.microsoft.com/en-us/services/cognitive-services/bing-entity-search-api/)
10-
* Using the **Bing Web Search SDK** [azure-cognititiveservices-search-websearch](http://pypi.python.org/pypi/azure-cognititiveservices-search-websearch) for the [Web Search API](https://azure.microsoft.com/en-us/services/cognitive-services/bing-web-search-api/)
11-
* Using the **Bing Video Search SDK** [azure-cognititiveservices-search-videosearch](http://pypi.python.org/pypi/azure-cognititiveservices-search-videosearch) for the [Video Search API](https://azure.microsoft.com/en-us/services/cognitive-services/bing-video-search-api/)
9+
### Language
10+
11+
* Using the **Bing Spell Check SDK** [azure-cognititiveservices-language-spellcheck](http://pypi.python.org/pypi/azure-cognititiveservices-language-spellcheck) for the [Bing Spell Check API](https://azure.microsoft.com/services/cognitive-services/spell-check/)
12+
13+
### Search
14+
15+
* Using the **Bing Custom Search SDK** [azure-cognititiveservices-search-customsearch](http://pypi.python.org/pypi/azure-cognititiveservices-search-customsearch) for the [Custom Search API](https://azure.microsoft.com/services/cognitive-services/bing-custom-search//)
16+
* Using the **Bing Entity Search SDK** [azure-cognititiveservices-search-entitysearch](http://pypi.python.org/pypi/azure-cognititiveservices-search-entitysearch) for the [Entity Search API](https://azure.microsoft.com/services/cognitive-services/bing-entity-search-api/)
17+
* Using the **Bing Image Search SDK** [azure-cognititiveservices-search-imagesearch](http://pypi.python.org/pypi/azure-cognititiveservices-search-imagesearch) for the [Image Search API](https://azure.microsoft.com/services/cognitive-services/bing-image-search-api/
18+
* Using the **Bing News Search SDK** [azure-cognititiveservices-search-newssearch](http://pypi.python.org/pypi/azure-cognititiveservices-search-newssearch) for the [News Search API](https://azure.microsoft.com/services/cognitive-services/bing-news-search-api/
19+
* Using the **Bing Video Search SDK** [azure-cognititiveservices-search-videosearch](http://pypi.python.org/pypi/azure-cognititiveservices-search-videosearch) for the [Video Search API](https://azure.microsoft.com/services/cognitive-services/bing-video-search-api/)
20+
* Using the **Bing Web Search SDK** [azure-cognititiveservices-search-websearch](http://pypi.python.org/pypi/azure-cognititiveservices-search-websearch) for the [Web Search API](https://azure.microsoft.com/services/cognitive-services/bing-web-search-api/)
1221

1322
We provide several meta-packages to help you install several packages at a time. Please note that meta-packages are only recommended for development purpose. It's recommended in production to always pin specific version of individual packages.
1423

1524
## Getting Started
1625

1726
### Prerequisites
1827

19-
1. A cognitive services API key with which to authenticate the SDK's calls. [Sign up here](https://azure.microsoft.com/en-us/services/cognitive-services/directory/) by navigating to the **Search** services and acquiring an API key. You can get a trial key for **free** which will expire after 30 days. To execute both samples, you need an EntitySearch key and a Bing WebSearch key.
28+
1. A cognitive services API key with which to authenticate the SDK's calls. [Sign up here](https://azure.microsoft.com/services/cognitive-services/directory/) by navigating to the **Language** or **Search** services and acquiring an API key. 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.
29+
30+
> Subscription keys are usually per service. For example, the subscription key for Spell Check will not be the same than Custom Search. Read the previous *sign up* link or the Azure portal for details on subscription keys.
2031
2132
### Installation
2233

@@ -41,31 +52,35 @@ We provide several meta-packages to help you install several packages at a time.
4152
1. Clone the repository.
4253
4354
```
44-
git clone https://github.com/Azure-Samples/bing-search-python.git
55+
git clone https://github.com/Azure-Samples/cognitive-services-python-sdk-samples.git
4556
```
4657
4758
2. Install the dependencies using pip.
4859
4960
```
50-
cd bing-search-python
61+
cd cognitive-services-python-sdk-samples
5162
pip install -r requirements.txt
5263
```
5364
54-
3. Set up the environment variable `ENTITYSEARCH_SUBSCRIPTION_KEY` with your CS key if you want to execute EntitySearch tests.
55-
4. Set up the environment variable `WEBSEARCH_SUBSCRIPTION_KEY` with your CS key if you want to execute WebSearch tests.
56-
4. Set up the environment variable `VIDEOSEARCH_SUBSCRIPTION_KEY` with your CS key if you want to execute VideoSearch tests.
65+
4. Set up the environment variable `SPELLCHECK_SUBSCRIPTION_KEY` with your key if you want to execute SpellCheck tests.
66+
3. Set up the environment variable `CUSTOMSEARCH_SUBSCRIPTION_KEY` with your key if you want to execute CustomSearch tests.
67+
3. Set up the environment variable `ENTITYSEARCH_SUBSCRIPTION_KEY` with your key if you want to execute EntitySearch tests.
68+
4. Set up the environment variable `IMAGESEARCH_SUBSCRIPTION_KEY` with your key if you want to execute ImageSearch tests.
69+
4. Set up the environment variable `NEWSSEARCH_SUBSCRIPTION_KEY` with your key if you want to execute NewsSearch tests.
70+
4. Set up the environment variable `VIDEOSEARCH_SUBSCRIPTION_KEY` with your key if you want to execute VideoSearch tests.
71+
4. Set up the environment variable `WEBSEARCH_SUBSCRIPTION_KEY` with your key if you want to execute WebSearch tests.
5772
5873
## Demo
5974
6075
A demo app is included to show how to use the project.
6176
6277
To run the complete demo, execute `python example.py`
6378
64-
To run each individual demo, point directly to the file:
79+
To run each individual demo, point directly to the file. For example (i.e. not complete list):
6580
66-
1. `python samples/entity_search_samples.py`
67-
2. `python samples/web_search_samples.py`
68-
2. `python samples/video_search_samples.py`
81+
2. `python samples/language/spellchack_samples.py`
82+
1. `python samples/search/entity_search_samples.py`
83+
2. `python samples/search/video_search_samples.py`
6984
7085
To see the code of each example, simply look at the examples in the Samples folder. They are written to be isolated in scope so that you can see only what you're interested in.
7186

requirements.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
git+https://github.com/Azure/azure-sdk-for-python#egg=azure-cognitiveservices-language-spellcheck&subdirectory=azure-cognitiveservices-language-spellcheck
2+
git+https://github.com/Azure/azure-sdk-for-python#egg=azure-cognitiveservices-search-customsearch&subdirectory=azure-cognitiveservices-search-customsearch
13
git+https://github.com/Azure/azure-sdk-for-python#egg=azure-cognitiveservices-search-entitysearch&subdirectory=azure-cognitiveservices-search-entitysearch
4+
git+https://github.com/Azure/azure-sdk-for-python#egg=azure-cognitiveservices-search-imagesearch&subdirectory=azure-cognitiveservices-search-imagesearch
5+
git+https://github.com/Azure/azure-sdk-for-python#egg=azure-cognitiveservices-search-newssearch&subdirectory=azure-cognitiveservices-search-newssearch
6+
git+https://github.com/Azure/azure-sdk-for-python#egg=azure-cognitiveservices-search-videosearch&subdirectory=azure-cognitiveservices-search-videosearch
27
git+https://github.com/Azure/azure-sdk-for-python#egg=azure-cognitiveservices-search-websearch&subdirectory=azure-cognitiveservices-search-websearch
3-
git+https://github.com/Azure/azure-sdk-for-python#egg=azure-cognitiveservices-search-videosearch&subdirectory=azure-cognitiveservices-search-videosearch

0 commit comments

Comments
 (0)