Content moderator (#3)

* Content Moderator samples

* Image Review

* More samples

* Fix Readme

Author: lmazuel

README.md

@@ -23,6 +23,7 @@ This project framework provides examples for the following services:
 ### Vision
 
 * Using the **Computer Vision SDK** [azure-cognititiveservices-vision-computervision](http://pypi.python.org/pypi/azure-cognititiveservices-vision-computervision) for the [Computer Vision API](https://azure.microsoft.com/services/cognitive-services/computer-vision/)
+* Using the **Content Moderator SDK** [azure-cognititiveservices-vision-contentmoderator](http://pypi.python.org/pypi/azure-cognititiveservices-vision-contentmoderator) for the [Content Moderator API](https://azure.microsoft.com/services/cognitive-services/content-moderator/)
 
 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.
 
@@ -76,7 +77,8 @@ We provide several meta-packages to help you install several packages at a time.
 4.  Set up the environment variable `NEWSSEARCH_SUBSCRIPTION_KEY` with your key if you want to execute NewsSearch tests.
 4.  Set up the environment variable `VIDEOSEARCH_SUBSCRIPTION_KEY` with your key if you want to execute VideoSearch tests.
 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 SpellCheck tests. You might override too `COMPUTERVISION_LOCATION` (westcentralus by default).
+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).
 
 ## Demo
 

requirements.txt

@@ -6,4 +6,5 @@ azure-cognitiveservices-search-imagesearch
 azure-cognitiveservices-search-newssearch
 azure-cognitiveservices-search-videosearch
 azure-cognitiveservices-search-websearch
-azure-cognitiveservices-vision-computervision
+azure-cognitiveservices-vision-computervision
+azure-cognitiveservices-vision-contentmoderator

samples/vision/content_moderator_image_job_samples.py

@@ -0,0 +1,91 @@
+import os.path
+from pprint import pprint
+
+from azure.cognitiveservices.vision.contentmoderator import ContentModeratorClient
+from azure.cognitiveservices.vision.contentmoderator.models import Content
+from msrest.authentication import CognitiveServicesCredentials
+
+SUBSCRIPTION_KEY_ENV_NAME = "CONTENTMODERATOR_SUBSCRIPTION_KEY"
+CONTENTMODERATOR_LOCATION = os.environ.get("CONTENTMODERATOR_LOCATION", "westcentralus")
+
+def image_review_jobs(subscription_key):
+    """ImageReviewJobs.
+
+    This will review an image using workflow and job.
+    """
+
+    # The moderation job will use this workflow that you defined earlier.
+    # See the quickstart article to learn how to setup custom workflows.
+    # https://docs.microsoft.com/azure/cognitive-services/content-moderator/review-tool-user-guide/workflows
+    workflow_name = "OCR"
+
+    # The name of the team to assign the job to.
+    # This must be the team name you used to create your Content Moderator account. You can 
+    # retrieve your team name from the Content Moderator web site. Your team name is the Id 
+    # associated with your subscription.
+    team_name = "pysdktesting"
+
+    # An image with this text:
+    # IF WE DID ALL THE THINGS WE ARE CAPABLE OF DOING, WE WOULD LITERALLY ASTOUND OURSELVE 
+    # Be sure your workflow create a review for this (e.g. OCR contains some words).
+    image_url = "https://moderatorsampleimages.blob.core.windows.net/samples/sample2.jpg"
+
+    # Where you want to receive the approval/refuse event. This is the only way to get this information.
+    call_back_endpoint = "https://requestb.in/1l64pe71"
+
+    client = ContentModeratorClient(
+        CONTENTMODERATOR_LOCATION+'.api.cognitive.microsoft.com',
+        CognitiveServicesCredentials(subscription_key)
+    )
+
+    print("Create moderation job for an image.\n")
+    job_result = client.reviews.create_job(
+        team_name,
+        "Image",     # Possible values include: 'Image', 'Text', 'Video'
+        "ContentID", # Id/Name to identify the content submitted.
+        workflow_name,
+        "application/json", # Possible values include: 'application/json', 'image/jpeg'
+        image_url,
+        call_back_endpoint=call_back_endpoint
+    )
+    job_id = job_result.job_id
+
+    print("Get job status before review.")
+    job_details = client.reviews.get_job_details(
+        team_name,
+        job_id,
+    )
+    pprint(job_details.as_dict())    
+
+    input("\nPerform manual reviews on the Content Moderator Review Site, and hit enter here.")
+    job_details = client.reviews.get_job_details(
+        team_name,
+        job_id,
+    )
+    pprint(job_details.as_dict())
+
+    # Your call back endpoint should have received an event like this:
+    # {
+    #   "ReviewId": "201802i2957280730e04578aefe678ba6e5ea24",
+    #   "ModifiedOn": "2018-02-06T23:46:26.3121698Z",
+    #   "ModifiedBy": "unknown",
+    #   "CallBackType": "Review",
+    #   "ContentId": "ContentID",
+    #   "ContentType": "Image",
+    #   "Metadata": {
+    #     "hastext": "True",
+    #     "ocrtext": "IF WE DID \r\nALL \r\nTHE THINGS \r\nWE ARE \r\nCAPABLE \r\nOF DOING, \r\nWE WOULD \r\nLITERALLY \r\nASTOUND \r\nOURSELVE \r\n",
+    #     "imagename": "ContentID"
+    #   },
+    #   "ReviewerResultTags": {
+    #     "a": "True",
+    #     "r": "False"
+    #   }
+    # }    
+
+
+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)

samples/vision/content_moderator_image_list_samples.py

@@ -0,0 +1,53 @@
+import os.path
+from pprint import pprint
+
+from azure.cognitiveservices.vision.contentmoderator import ContentModeratorClient
+from msrest.authentication import CognitiveServicesCredentials
+
+SUBSCRIPTION_KEY_ENV_NAME = "CONTENTMODERATOR_SUBSCRIPTION_KEY"
+CONTENTMODERATOR_LOCATION = os.environ.get("CONTENTMODERATOR_LOCATION", "westcentralus")
+
+
+def image_lists(subscription_key):
+    """ImageList.
+
+    This will review an image using workflow and job.
+    """
+    
+    client = ContentModeratorClient(
+        CONTENTMODERATOR_LOCATION+'.api.cognitive.microsoft.com',
+        CognitiveServicesCredentials(subscription_key)
+    )
+
+    print("Creating list MyList\n")
+    custom_list = client.list_management_image_lists.create(
+        "application/json",
+        {
+            "name": "MyList",
+            "description": "A sample list",
+            "metadata": {
+                "key_one": "Acceptable",
+                "key_two": "Potentially racy"
+            }
+        }
+    )
+    print("Item created:")
+    pprint(custom_list.as_dict())
+    list_id = custom_list.id
+
+    def add_images(list_id, image_url, label):
+        print("Adding image {} to list {} with label {}.".format(image_url, list_id, label))
+        added_image = client.list_management_image.add_image_url_input(
+            list_id,
+            "application/json",
+            data_representation="URL",
+            value=image_url,
+            label=label
+        )
+        pprint(added_image.as_dict())
+
+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)