Autosuggest

Author: lmazuel

README.md

@@ -19,6 +19,7 @@ This project framework provides examples for the following services:
 
 ### Search
 
+* Using the **Bing Autosuggest SDK** [azure-cognitiveservices-search-customsearch](http://pypi.python.org/pypi/azure-cognitiveservices-search-autosuggest) for the [Autosuggest API](https://azure.microsoft.com/services/cognitive-services/autosuggest/)
 * Using the **Bing Custom Search SDK** [azure-cognitiveservices-search-customsearch](http://pypi.python.org/pypi/azure-cognitiveservices-search-customsearch) for the [Custom Search API](https://azure.microsoft.com/services/cognitive-services/bing-custom-search/)
 * Using the **Bing Entity Search SDK** [azure-cognitiveservices-search-entitysearch](http://pypi.python.org/pypi/azure-cognitiveservices-search-entitysearch) for the [Entity Search API](https://azure.microsoft.com/services/cognitive-services/bing-entity-search-api/)
 * Using the **Bing Image Search SDK** [azure-cognitiveservices-search-imagesearch](http://pypi.python.org/pypi/azure-cognitiveservices-search-imagesearch) for the [Image Search API](https://azure.microsoft.com/services/cognitive-services/bing-image-search-api/)
@@ -49,9 +50,9 @@ We provide several meta-packages to help you install several packages at a time.
 
     This sample (and the SDK) is compatible with Python 2.7, 3.3, 3.4, 3.5 and 3.6.
 
-2.  General recommendation for Python development is to use a Virtual Environment. 
+2.  General recommendation for Python development is to use a Virtual Environment.
     For more information, see https://docs.python.org/3/tutorial/venv.html
-    
+
     Install and initialize the virtual environment with the "venv" module on Python 3 (you must install [virtualenv](https://pypi.python.org/pypi/virtualenv) for Python 2.7):
 
     ```
@@ -79,6 +80,7 @@ We provide several meta-packages to help you install several packages at a time.
 
 4.  Set up the environment variable `SPELLCHECK_SUBSCRIPTION_KEY` with your key if you want to execute SpellCheck tests.
 4.  Set up the environment variable `TEXTANALYTICS_SUBSCRIPTION_KEY` with your key if you want to execute TextAnalytics tests. You might override too `TEXTANALYTICS_LOCATION` (westcentralus by default).
+3.  Set up the environment variable `AUTOSUGGEST_SUBSCRIPTION_KEY` with your key if you want to execute Autosuggest tests.
 3.  Set up the environment variable `CUSTOMSEARCH_SUBSCRIPTION_KEY` with your key if you want to execute CustomSearch tests.
 3.  Set up the environment variable `ENTITYSEARCH_SUBSCRIPTION_KEY` with your key if you want to execute EntitySearch tests.
 4.  Set up the environment variable `IMAGESEARCH_SUBSCRIPTION_KEY` with your key if you want to execute ImageSearch tests.

requirements.txt

@@ -1,5 +1,6 @@
 azure-cognitiveservices-language-spellcheck
 azure-cognitiveservices-language-textanalytics
+azure-cognitiveservices-search-autosuggest
 azure-cognitiveservices-search-customsearch
 azure-cognitiveservices-search-entitysearch
 azure-cognitiveservices-search-imagesearch

samples/search/autosuggest_samples.py

@@ -0,0 +1,67 @@
+from azure.cognitiveservices.search.autosuggest import AutoSuggestSearchAPI
+from azure.cognitiveservices.search.autosuggest.models import (
+    Suggestions,
+    SuggestionsSuggestionGroup,
+    SearchAction,
+    ErrorResponseException
+)
+from msrest.authentication import CognitiveServicesCredentials
+
+SUBSCRIPTION_KEY_ENV_NAME = "AUTOSUGGEST_SUBSCRIPTION_KEY"
+
+def autosuggest_lookup(subscription_key):
+    """AutoSuggestLookup.
+
+    This will look up a single query (Xbox) and print out name and url for first web result.
+    """
+    client = AutoSuggestSearchAPI(CognitiveServicesCredentials(subscription_key))
+
+    try:
+        suggestions = client.auto_suggest(query="Satya Nadella")  # type: Suggestions
+
+        if suggestions.suggestion_groups:
+            print("Searched for \"Satya Nadella\" and found suggestions:")
+            suggestion_group = suggestions.suggestion_groups[0]  # type: SuggestionsSuggestionGroup
+            for suggestion in suggestion_group.search_suggestions:  # type: SearchAction
+                print("....................................")
+                print(suggestion.query)
+                print(suggestion.display_text)
+                print(suggestion.url)
+                print(suggestion.search_kind)
+        else:
+            print("Didn't see any suggestion..")
+
+    except Exception as err:
+        print("Encountered exception. {}".format(err))
+
+def error(subscription_key):
+    """Error.
+
+    This triggers a bad request and shows how to read the error response.
+    """
+
+    # Breaking the subscription key on purpose
+    client = AutoSuggestSearchAPI(CognitiveServicesCredentials(subscription_key+"1"))
+
+    try:
+        suggestions = client.auto_suggest(query="Satya Nadella", market="no-ty")
+    except ErrorResponseException as err:
+        # The status code of the error should be a good indication of what occurred. However, if you'd like more details, you can dig into the response.
+        # Please note that depending on the type of error, the response schema might be different, so you aren't guaranteed a specific error response schema.
+
+        print("Exception occurred, status code {} with reason {}.\n".format(err.response.status_code, err))
+
+        # if you'd like more descriptive information (if available)
+        if err.error.errors:
+            print("This is the errors I have:")
+            for error in err.error.errors:
+                print("Parameter \"{}\" has an invalid value \"{}\". SubCode is \"{}\". Detailed message is \"{}\"".format(error.parameter, error.value, error.sub_code, error.message))
+        else:
+            print("There was no details on the error.")
+
+
+if __name__ == "__main__":
+    import sys, os.path
+    sys.path.append(os.path.abspath(os.path.join(__file__, "..", "..")))
+    from tools import execute_samples
+    execute_samples(globals(), SUBSCRIPTION_KEY_ENV_NAME)