Merge branch 'master' into patch-3

Author: v-jaswel

.gitignore

@@ -100,8 +100,5 @@ ENV/
 # mypy
 .mypy_cache/
 
-# idea files
+# idea
 .idea/
-
-#DS store
-.DS_Store

README.md

@@ -1,7 +1,11 @@
 ---
-services: cognitive-services
-platforms: python
-author: lmazuel
+page_type: sample
+languages:
+- python
+products:
+- azure
+description: "These samples will show you how to get up and running using the Python SDKs for various Cognitive Services services."
+urlFragment: cognitive-services-python-sdk-samples
 ---
 
 # Cognitive Services Python SDK Samples
@@ -15,11 +19,12 @@ This project framework provides examples for the following services:
 ### Knowledge
 * Using the **QnA SDK** [azure-cognitiveservices-knowledge-qnamaker](http://pypi.python.org/pypi/azure-cognitiveservices-knowledge-qnamaker) for the [QnA API](https://azure.microsoft.com/en-us/services/cognitive-services/qna-maker/)
 
+
 ### Language
 
 * Using the **LUIS SDK** [azure-cognitiveservices-language-luis](http://pypi.python.org/pypi/azure-cognitiveservices-language-luis) for the [LUIS API](https://azure.microsoft.com/services/cognitive-services/language-understanding-intelligent-service/)
 * Using the **Bing Spell Check SDK** [azure-cognitiveservices-language-spellcheck](http://pypi.python.org/pypi/azure-cognitiveservices-language-spellcheck) for the [Bing Spell Check API](https://azure.microsoft.com/services/cognitive-services/spell-check/)
-* Using the **Text Analytics SDK** [azure-cognitiveservices-language-textanalytics](http://pypi.python.org/pypi/azure-cognitiveservices-language-textanalytics) for the [Tet Analytics API](https://azure.microsoft.com/services/cognitive-services/text-analytics/)
+* Using the **Text Analytics SDK** [azure-cognitiveservices-language-textanalytics](http://pypi.python.org/pypi/azure-cognitiveservices-language-textanalytics) for the [Text Analytics API](https://azure.microsoft.com/services/cognitive-services/text-analytics/)
 
 ### Search
 
@@ -39,6 +44,7 @@ This project framework provides examples for the following services:
 * Using the **Computer Vision SDK** [azure-cognitiveservices-vision-computervision](http://pypi.python.org/pypi/azure-cognitiveservices-vision-computervision) for the [Computer Vision API](https://azure.microsoft.com/services/cognitive-services/computer-vision/)
 * Using the **Content Moderator SDK** [azure-cognitiveservices-vision-contentmoderator](http://pypi.python.org/pypi/azure-cognitiveservices-vision-contentmoderator) for the [Content Moderator API](https://azure.microsoft.com/services/cognitive-services/content-moderator/)
 * Using the **Custom Vision SDK** [azure-cognitiveservices-vision-customvision](http://pypi.python.org/pypi/azure-cognitiveservices-vision-customvision) for the [Custom Vision API](https://azure.microsoft.com/services/cognitive-services/custom-vision-service/)
+* Using the **Ink Recognizer SDK** [azure-cognitiveservices-inkrecognizer](https://pypi.org/project/azure-cognitiveservices-inkrecognizer/) for the [Ink Recognizer API](https://azure.microsoft.com/services/cognitive-services/ink-recognizer/)
 
 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.
 
@@ -98,8 +104,9 @@ We provide several meta-packages to help you install several packages at a time.
 4.  Set up the environment variable `WEBSEARCH_SUBSCRIPTION_KEY` with your key if you want to execute WebSearch tests.
 4.  Set up the environment variable `COMPUTERVISION_SUBSCRIPTION_KEY` with your key if you want to execute Computer Vision tests. You might override too `COMPUTERVISION_LOCATION` (westcentralus by default).
 4.  Set up the environment variable `CONTENTMODERATOR_SUBSCRIPTION_KEY` with your key if you want to execute Content Moderator tests. You might override too `CONTENTMODERATOR_LOCATION` (westcentralus by default).
-4.  Set up the environment variable `CUSTOMVISION_TRAINING_KEY` with your key if you want to execute CustomVision Training tests.
-4.  Set up the environment variable `CUSTOMVISION_PREDICTION_KEY` with your key if you want to execute CustomVision Prediction tests.
+4.  Set up the environment variable `CUSTOMVISION_TRAINING_KEY` with your key and `CUSTOMVISION_PREDICTION_ID` with a valid prediction resource id if you want to execute CustomVision Training tests.
+4.  Set up the environment variable `CUSTOMVISION_PREDICTION_KEY` with your key and `CUSTOMVISION_PREDICTION_ID` with a valid prediction resource id if you want to execute CustomVision Prediction tests.
+
 
 ## Demo
 
@@ -109,9 +116,10 @@ To run the complete demo, execute `python example.py`
 
 To run each individual demo, point directly to the file. For example (i.e. not complete list):
 
-2. `python samples/language/spellcheck_samples.py`
-1. `python samples/search/entity_search_samples.py`
-2. `python samples/search/video_search_samples.py`
+1. `python samples/language/spellcheck_samples.py`
+2. `python samples/search/entity_search_samples.py`
+3. `python samples/search/video_search_samples.py`
+4. `python samples/vision/inkrecognizer_sample.py`
 
 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.
 

example.py

@@ -12,22 +12,27 @@
 
 import samples.tools
 
+
 def run_all_samples():
     for _, section_name_name, ispkg in pkgutil.walk_packages(samples.__path__):
         if not ispkg:
             continue
         section_package_name = "samples."+section_name_name
         section_package = importlib.import_module(section_package_name)
         for _, sample_name, _ in pkgutil.iter_modules(section_package.__path__):
-            sample_module = importlib.import_module(section_package_name+"."+sample_name)
-            subkey_env_name = getattr(sample_module, "SUBSCRIPTION_KEY_ENV_NAME", None)
+            sample_module = importlib.import_module(
+                section_package_name+"."+sample_name)
+            subkey_env_name = getattr(
+                sample_module, "SUBSCRIPTION_KEY_ENV_NAME", None)
             if not subkey_env_name:
                 continue
             print("Executing sample from ", sample_name)
             try:
-                samples.tools.execute_samples(sample_module.__dict__, subkey_env_name)
+                samples.tools.execute_samples(
+                    sample_module.__dict__, subkey_env_name)
             except samples.tools.SubscriptionKeyError as err:
                 print("{}\n".format(err))
 
+
 if __name__ == "__main__":
     run_all_samples()

requirements.txt

@@ -1,13 +1,12 @@
 azure-cognitiveservices-knowledge-qnamaker
 azure-cognitiveservices-language-luis
 azure-cognitiveservices-language-spellcheck
-azure-cognitiveservices-language-textanalytics>=0.2.0  # sample won't work with previous versions
-azure-cognitiveservices-search-autosuggest
-azure-cognitiveservices-search-customimagesearch
-azure-cognitiveservices-search-customsearch>=0.2.0  # sample won't work with previous versions
+azure-cognitiveservices-language-textanalytics
+azure-cognitiveservices-search-autosuggest>=1.0
+azure-cognitiveservices-search-customsearch
 azure-cognitiveservices-search-entitysearch
 azure-cognitiveservices-search-imagesearch
-azure-cognitiveservices-search-newssearch
+azure-cognitiveservices-search-newssearch>=2.0.0
 azure-cognitiveservices-search-videosearch
 azure-cognitiveservices-search-visualsearch>=0.2.0  # sample won't work with previous versions
 azure-cognitiveservices-search-websearch
@@ -16,4 +15,5 @@ azure-cognitiveservices-vision-contentmoderator>=1.0.0  # sample won't work with
 azure-cognitiveservices-vision-customvision>=0.4.0  # sample won't work with previous versions
 azure-cognitiveservices-vision-face
 azure-cognitiveservices-anomalydetector>=0.2.0 #  sample won't work with previous versions
+azure-cognitiveservices-inkrecognizer>=1.0.0b1
 pandas

samples/anomaly_detector_samples.py

@@ -6,10 +6,12 @@
 import pandas as pd
 import os
 
-SUBSCRIPTION_KEY_ENV_NAME = "ANOMALYDETECTOR_SUBSCRIPTION_KEY"
-ANOMALYDETECTOR_LOCATION = os.environ.get("ANOMALYDETECTOR_LOCATION", "westcentralus")
+# Add your Azure Anomaly Detector subscription key to your environment variables.
+SUBSCRIPTION_KEY = os.environ.get["ANOMALY_DETECTOR_SUBSCRIPTION_KEY"]
+
+CSV_FOLDER = os.path.join(os.path.dirname(
+    os.path.realpath(__file__)), "csv_files")
 
-CSV_FOLDER = os.path.join(os.path.dirname(os.path.realpath(__file__)), "csv_files")
 
 def get_series_from_file(path):
     df = pd.read_csv(path, header=None, encoding="utf-8", parse_dates=[0])
@@ -18,16 +20,21 @@ def get_series_from_file(path):
         series.append(Point(timestamp=row[0], value=row[1]))
     return series
 
+
 def get_request():
-    series = get_series_from_file(os.path.join(CSV_FOLDER, "anomaly_detector_daily_series.csv"))
+    series = get_series_from_file(os.path.join(
+        CSV_FOLDER, "anomaly_detector_daily_series.csv"))
     return Request(series=series, granularity=Granularity.daily)
 
+
 def entire_detect(subscription_key):
     print("Sample of detecting anomalies in the entire series.")
-
-    endpoint = "https://{}.api.cognitive.microsoft.com".format(ANOMALYDETECTOR_LOCATION)
+    # Add your Azure Anomaly Detector subscription key to your environment variables.
+    endpoint = os.environ.get["ANOMALY_DETECTOR_ENDPOINT"]
+    
     try:
-        client = AnomalyDetectorClient(endpoint, CognitiveServicesCredentials(subscription_key))
+        client = AnomalyDetectorClient(
+            endpoint, CognitiveServicesCredentials(subscription_key))
         request = get_request()
         response = client.entire_detect(request)
         if True in response.is_anomaly:
@@ -44,12 +51,15 @@ def entire_detect(subscription_key):
         else:
             print(e)
 
+
 def last_detect(subscription_key):
     print("Sample of detecting whether the latest point in series is anomaly.")
-
-    endpoint = "https://{}.api.cognitive.microsoft.com".format(ANOMALYDETECTOR_LOCATION)
+    # Add your Azure Anomaly Detector subscription key to your environment variables.
+    endpoint = os.environ.get["ANOMALY_DETECTOR_ENDPOINT"]
+    
     try:
-        client = AnomalyDetectorClient(endpoint, CognitiveServicesCredentials(subscription_key))
+        client = AnomalyDetectorClient(
+            endpoint, CognitiveServicesCredentials(subscription_key))
         request = get_request()
         response = client.last_detect(request)
         if response.is_anomaly:
@@ -63,8 +73,10 @@ def last_detect(subscription_key):
         else:
             print(e)
 
+
 if __name__ == "__main__":
-    import sys, os.path
+    import sys
+    import os.path
     sys.path.append(os.path.abspath(os.path.join(__file__, "..", "..")))
     from tools import execute_samples
-    execute_samples(globals(), SUBSCRIPTION_KEY_ENV_NAME)
+    execute_samples(globals(), SUBSCRIPTION_KEY)

samples/face/identify.py

@@ -0,0 +1,82 @@
+import os
+import uuid
+import time
+
+from azure.cognitiveservices.vision.face import FaceClient
+from msrest.authentication import CognitiveServicesCredentials
+from azure.cognitiveservices.vision.face.models import TrainingStatusType, Person
+
+# NOTE: Replace this with a valid Face subscription key.
+SUBSCRIPTION_KEY = "INSERT KEY HERE"
+
+# You must use the same region as you used to get your subscription
+# keys. For example, if you got your subscription keys from westus,
+# replace "westcentralus" with "westus".
+#
+# Free trial subscription keys are generated in the westcentralus
+# region. If you use a free trial subscription key, you shouldn't
+# need to change the region.
+FACE_LOCATION = "westcentralus"
+
+face_base_url = "https://{}.api.cognitive.microsoft.com".format(FACE_LOCATION)
+face_client = FaceClient(face_base_url, CognitiveServicesCredentials(SUBSCRIPTION_KEY))
+
+# This image should contain a single face.
+remote_image_URL_1 = "https://www.biography.com/.image/t_share/MTQ1MzAyNzYzOTgxNTE0NTEz/john-f-kennedy---mini-biography.jpg"
+
+# This image should contain several faces, at least one of which is similar to the face in remote_image_URL_1.
+remote_image_URL_2 = "https://www.biography.com/.image/t_share/MTQ1NDY3OTIxMzExNzM3NjE3/john-f-kennedy---debating-richard-nixon.jpg"
+
+# Detect faces in a remote image.
+def detect_faces(face_client, image_url):
+	print ("Detecting faces...")
+	detected_faces = face_client.face.detect_with_url(url=image_url)
+	if not detected_faces:
+		raise Exception('No face detected from image {}'.format(image_url))
+	if not detected_faces[0]:
+		raise Exception("Parameter return_face_id of detect_with_stream or detect_with_url must be set to true (by default) for recognition purpose.")
+	return detected_faces
+
+# Find similar faces to @face_ID in @face_IDs.
+def find_similar_faces(face_client, face_ID, face_IDs):
+	print("Finding similar faces ...")
+	return face_client.face.find_similar(face_id=face_ID, face_ids=face_IDs)
+
+# Detect a face in the first image.
+faces_1 = detect_faces(face_client, remote_image_URL_1)
+if not faces_1[0]:
+	print("No faces detected in " + remote_image_URL_1 + ".")
+else:
+	print("Face IDs of faces detected in " + remote_image_URL_1 + ":")
+	for x in faces_1: print (x.face_id)
+
+	print("Using first face ID.")
+	face_ID = faces_1[0].face_id
+
+	# Detect a list of faces in the second image.
+	faces_2 = detect_faces(face_client, remote_image_URL_2)
+	if not faces_2[0]:
+		print("No faces detected in " + remote_image_URL_2 + ".")
+	else:
+		print("Face IDs of faces detected in " + remote_image_URL_2 + ":")
+		for x in faces_2: print (x.face_id)
+
+		# Search the faces detected in the second image to find a similar face to the first one.
+		similar_faces = find_similar_faces(face_client, face_ID, list(map(lambda x: x.face_id, faces_2)))
+		if not similar_faces[0]:
+			print("No similar faces found in " + remote_image_URL_2 + ".")
+		else:
+			print("Similar faces found in " + remote_image_URL_2 + ":")
+			for face in similar_faces:
+				face_ID = face.face_id
+				# SimilarFace only contains a Face ID, Persisted Face ID, and confidence score.
+				# So we look up the Face ID in the list of DetectedFaces found in
+				# remote_image_URL_2 to get the rest of the face information.
+				face_info = next(x for x in faces_2 if x.face_id == face_ID)
+				if face_info:
+					print("Face ID: " + face_ID)
+					print("Face rectangle:")
+					print("Left: " + str(face_info.face_rectangle.left))
+					print("Top: " + str(face_info.face_rectangle.top))
+					print("Width: " + str(face_info.face_rectangle.width))
+					print("Height: " + str(face_info.face_rectangle.height))

samples/knowledge/qna_maker_samples.py

@@ -5,8 +5,10 @@
 from azure.cognitiveservices.knowledge.qnamaker.models import QnADTO, MetadataDTO, CreateKbDTO, OperationStateType, UpdateKbOperationDTO, UpdateKbOperationDTOAdd
 from msrest.authentication import CognitiveServicesCredentials
 
-SUBSCRIPTION_KEY_ENV_NAME = "QNA_SUBSCRIPTION_KEY"
-QNA_LOCATION = os.environ.get("QNA_LOCATION", "westus")
+# Add your QnaMaker subscription key and endpoint to your environment variables.
+SUBSCRIPTION_KEY = os.environ['QNA_MAKER_SUBSCRIPTION_KEY']
+QNA_ENDPOINT = os.environ['QNA_MAKER_ENDPOINT']
+
 
 def knowledge_based_crud_sample(subscription_key):
     """KnowledgeBasedCRUDSample.
@@ -23,17 +25,18 @@ def _create_sample_kb(client):
             questions=["How do I manage my knowledgebase?"],
             metadata=[MetadataDTO(name="Category", value="api")]
         )
-        urls = ["https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs"]
+        urls = [
+            "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs"]
         create_kb_dto = CreateKbDTO(
             name="QnA Maker FAQ from quickstart",
             qna_list=[qna],
             urls=urls
         )
-        create_op = client.knowledgebase.create(create_kb_payload=create_kb_dto)
+        create_op = client.knowledgebase.create(
+            create_kb_payload=create_kb_dto)
         create_op = _monitor_operation(client=client, operation=create_op)
         return create_op.resource_location.replace("/knowledgebases/", "")
 
-
     def _monitor_operation(client, operation):
         """Helper function for knowledge_based_crud_sample.
 
@@ -42,17 +45,19 @@ def _monitor_operation(client, operation):
         """
         for i in range(20):
             if operation.operation_state in [OperationStateType.not_started, OperationStateType.running]:
-                print("Waiting for operation: {} to complete.".format(operation.operation_id))
+                print("Waiting for operation: {} to complete.".format(
+                    operation.operation_id))
                 time.sleep(5)
-                operation = client.operations.get_details(operation_id=operation.operation_id)
+                operation = client.operations.get_details(
+                    operation_id=operation.operation_id)
             else:
                 break
         if operation.operation_state != OperationStateType.succeeded:
-            raise Exception("Operation {} failed to complete.".format(operation.operation_id))
+            raise Exception("Operation {} failed to complete.".format(
+                operation.operation_id))
         return operation
 
-
-    client = QnAMakerClient(endpoint="https://{}.api.cognitive.microsoft.com".format(QNA_LOCATION), credentials=CognitiveServicesCredentials(subscription_key))
+    client = QnAMakerClient(endpoint=QNA_ENDPOINT, credentials=CognitiveServicesCredentials(subscription_key))
 
     # Create a KB
     print("Creating KB...")
@@ -68,7 +73,8 @@ def _monitor_operation(client, operation):
             ]
         )
     )
-    update_op = client.knowledgebase.update(kb_id=kb_id, update_kb=update_kb_operation_dto)
+    update_op = client.knowledgebase.update(
+        kb_id=kb_id, update_kb=update_kb_operation_dto)
     _monitor_operation(client=client, operation=update_op)
 
     # Publish the KB