Content moderator samples update (#29)

* fixed image review sample

* fixed team name value to prompt user for value input

* fixed video review sample

* code reformatting in image and video review samples

* fixed text moderation sample

* fixed image job samples

* fixed image list samples

* fixed image moderation sample

* fixed term list samples and renamed text moderation sample text file

* fixed video transcript sample

* Update requirements.txt

Author: iscai-msft

.gitignore

@@ -105,4 +105,4 @@ ENV/
 
 #DS store
 .DS_Store
-samples/DS_Store
+samples/DS_Store

requirements.txt

@@ -12,6 +12,6 @@ azure-cognitiveservices-search-videosearch
 azure-cognitiveservices-search-visualsearch>=0.2.0  # sample won't work with previous versions
 azure-cognitiveservices-search-websearch
 azure-cognitiveservices-vision-computervision>=0.2.0  # sample won't work with previous versions
-azure-cognitiveservices-vision-contentmoderator
+azure-cognitiveservices-vision-contentmoderator>=1.0.0  # sample won't work with previous versions
 azure-cognitiveservices-vision-customvision>=0.4.0  # sample won't work with previous versions
 azure-cognitiveservices-vision-face

samples/vision/content_moderator_image_job_samples.py

@@ -2,7 +2,6 @@
 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"
@@ -17,13 +16,13 @@ def image_review_jobs(subscription_key):
     # 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"
+    workflow_name = "insert your workflow name here"
 
     # 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"
+    team_name = "insert your team name here"
 
     # An image with this text:
     # IF WE DID ALL THE THINGS WE ARE CAPABLE OF DOING, WE WOULD LITERALLY ASTOUND OURSELVE 
@@ -34,54 +33,71 @@ def image_review_jobs(subscription_key):
     call_back_endpoint = "https://requestb.in/1l64pe71"
 
     client = ContentModeratorClient(
-        CONTENTMODERATOR_LOCATION+'.api.cognitive.microsoft.com',
-        CognitiveServicesCredentials(subscription_key)
+        endpoint='https://'+CONTENTMODERATOR_LOCATION+'.api.cognitive.microsoft.com',
+        credentials=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,
+        team_name=team_name,
+        content_type="Image",     # Possible values include: 'Image', 'Text', 'Video'
+        content_id="ContentID", # Id/Name to identify the content submitted.
+        workflow_name=workflow_name,
+        job_content_type="application/json", # Possible values include: 'application/json', 'image/jpeg'
+        content_value=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,
+        team_name=team_name,
+        job_id=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,
+        team_name=team_name,
+        job_id=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"
-    #   }
-    # }    
+    # {'call_back_endpoint': 'https://requestb.in/1l64pe71',
+    #  'id': '201901d49ee1a417ae45a991c5c1d6af25cace',
+    #  'job_execution_report': [{'msg': 'Posted results to the Callbackendpoint: '
+    #                                   'https://requestb.in/1l64pe71',
+    #                            'ts': '2019-01-11T00:00:15.738452'},
+    #                           {'msg': 'Job marked completed and job content has '
+    #                                   'been removed',
+    #                            'ts': '2019-01-11T00:00:15.6583757'},
+    #                           {'msg': 'Execution Complete',
+    #                            'ts': '2019-01-11T00:00:15.4872128'},
+    #                           {'msg': 'Successfully got hasText response from '
+    #                                   'Moderator',
+    #                            'ts': '2019-01-11T00:00:14.1389317'},
+    #                           {'msg': 'Getting hasText from Moderator',
+    #                            'ts': '2019-01-11T00:00:13.0689178'},
+    #                           {'msg': 'Starting Execution - Try 1',
+    #                            'ts': '2019-01-11T00:00:12.1120066'}],
+    #  'result_meta_data': [{'key': 'hasText', 'value': 'True'},
+    #                       {'key': 'ocrText',
+    #                        'value': 'IF WE DID \r\n'
+    #                                 'ALL \r\n'
+    #                                 'THE THINGS \r\n'
+    #                                 'WE ARE \r\n'
+    #                                 'CAPABLE \r\n'
+    #                                 'OF DOING, \r\n'
+    #                                 'WE WOULD \r\n'
+    #                                 'LITERALLY \r\n'
+    #                                 'ASTOUND \r\n'
+    #                                 'OURSELVE \r\n'}],
+    #  'review_id': '201901i6e4de824b0cf4aa587ac37f922f584c2',
+    #  'status': 'Complete',
+    #  'team_name': 'cspythonsdk',
+    #  'type': 'Image',
+    #  # 'workflow_id': 'textdetection'}
 
 
 if __name__ == "__main__":

samples/vision/content_moderator_image_list_samples.py

@@ -48,14 +48,14 @@ def image_lists(subscription_key):
     """
 
     client = ContentModeratorClient(
-        CONTENTMODERATOR_LOCATION+'.api.cognitive.microsoft.com',
-        CognitiveServicesCredentials(subscription_key)
+        endpoint='https://'+CONTENTMODERATOR_LOCATION+'.api.cognitive.microsoft.com',
+        credentials=CognitiveServicesCredentials(subscription_key)
     )
 
     print("Creating list MyList\n")
     custom_list = client.list_management_image_lists.create(
-        "application/json",
-        {
+        content_type="application/json",
+        body={
             "name": "MyList",
             "description": "A sample list",
             "metadata": {
@@ -78,8 +78,8 @@ def add_images(list_id, image_url, label):
         print("\nAdding image {} to list {} with label {}.".format(image_url, list_id, label))
         try:
             added_image = client.list_management_image.add_image_url_input(
-                list_id,
-                "application/json",
+                list_id=list_id,
+                content_type="application/json",
                 data_representation="URL",
                 value=image_url,
                 label=label
@@ -104,7 +104,7 @@ def add_images(list_id, image_url, label):
     # Get all images ids
     #
     print("\nGetting all image IDs for list {}".format(list_id))
-    image_ids = client.list_management_image.get_all_image_ids(list_id)
+    image_ids = client.list_management_image.get_all_image_ids(list_id=list_id)
     assert isinstance(image_ids, ImageIds)
     pprint(image_ids.as_dict())
 
@@ -113,9 +113,9 @@ def add_images(list_id, image_url, label):
     #
     print("\nUpdating details for list {}".format(list_id))
     updated_list = client.list_management_image_lists.update(
-        list_id,
-        "application/json",
-        {
+        list_id=list_id,
+        content_type="application/json",
+        body={
             "name": "Swimsuits and sports"
         }
     )
@@ -126,15 +126,15 @@ def add_images(list_id, image_url, label):
     # Get list details
     #
     print("\nGetting details for list {}".format(list_id))
-    list_details = client.list_management_image_lists.get_details(list_id)
+    list_details = client.list_management_image_lists.get_details(list_id=list_id)
     assert isinstance(list_details, ImageList)
     pprint(list_details.as_dict())
 
     #
     # Refresh the index
     #
     print("\nRefreshing the search index for list {}".format(list_id))
-    refresh_index = client.list_management_image_lists.refresh_index_method(list_id)
+    refresh_index = client.list_management_image_lists.refresh_index_method(list_id=list_id)
     assert isinstance(refresh_index, RefreshIndex)
     pprint(refresh_index.as_dict())
 
@@ -147,8 +147,8 @@ def add_images(list_id, image_url, label):
     for image_url in IMAGES_TO_MATCH:
         print("\nMatching image {} against list {}".format(image_url, list_id))
         match_result = client.image_moderation.match_url_input(
-            "application/json",
-            list_id,
+            content_type="application/json",
+            list_id=list_id,
             data_representation="URL",
             value=image_url,            
         )
@@ -163,15 +163,15 @@ def add_images(list_id, image_url, label):
     correction = "https://moderatorsampleimages.blob.core.windows.net/samples/sample16.png"
     print("\nRemove image {} from list {}".format(correction, list_id))
     client.list_management_image.delete_image(
-        list_id,
-        index[correction]
+        list_id=list_id,
+        image_id=index[correction]
     )
 
     #
     # Refresh the index
     #
     print("\nRefreshing the search index for list {}".format(list_id))
-    client.list_management_image_lists.refresh_index_method(list_id)
+    client.list_management_image_lists.refresh_index_method(list_id=list_id)
 
     print("\nWaiting {} minutes to allow the server time to propagate the index changes.".format(LATENCY_DELAY))
     time.sleep(LATENCY_DELAY * 60)
@@ -183,8 +183,8 @@ def add_images(list_id, image_url, label):
     for image_url in IMAGES_TO_MATCH:
         print("\nMatching image {} against list {}".format(image_url, list_id))
         match_result = client.image_moderation.match_url_input(
-            "application/json",
-            list_id,
+            content_type="application/json",
+            list_id=list_id,
             data_representation="URL",
             value=image_url,            
         )
@@ -197,13 +197,13 @@ def add_images(list_id, image_url, label):
     # Delete all images
     #
     print("\nDelete all images in the image list {}".format(list_id))
-    client.list_management_image.delete_all_images(list_id)
+    client.list_management_image.delete_all_images(list_id=list_id)
 
     #
     # Delete list
     #
     print("\nDelete the image list {}".format(list_id))
-    client.list_management_image_lists.delete(list_id)
+    client.list_management_image_lists.delete(list_id=list_id)
 
     #
     # Get all list ids

samples/vision/content_moderator_image_moderation_samples.py

@@ -1,10 +1,8 @@
 import os.path
 from pprint import pprint
-import time
 
 from azure.cognitiveservices.vision.contentmoderator import ContentModeratorClient
 from azure.cognitiveservices.vision.contentmoderator.models import (
-    APIErrorException,
     Evaluate,
     OCR,
     FoundFaces
@@ -26,27 +24,27 @@ def image_moderation(subscription_key):
     """
 
     client = ContentModeratorClient(
-        CONTENTMODERATOR_LOCATION+'.api.cognitive.microsoft.com',
-        CognitiveServicesCredentials(subscription_key)
+        endpoint='https://'+CONTENTMODERATOR_LOCATION+'.api.cognitive.microsoft.com',
+        credentials=CognitiveServicesCredentials(subscription_key)
     )
 
     for image_url in IMAGE_LIST:
         print("\nEvaluate image {}".format(image_url))
 
         print("\nEvaluate for adult and racy content.")
         evaluation = client.image_moderation.evaluate_url_input(
-            "application/json",
-            data_representation="URL",
-            value=image_url,
+            content_type="application/json",
             cache_image=True,
+            data_representation="URL",
+            value=image_url
         )
         assert isinstance(evaluation, Evaluate)
         pprint(evaluation.as_dict())
 
         print("\nDetect and extract text.")
         evaluation = client.image_moderation.ocr_url_input(
-            "eng",
-            "application/json",
+            language="eng",
+            content_type="application/json",
             data_representation="URL",
             value=image_url,
             cache_image=True,
@@ -56,10 +54,10 @@ def image_moderation(subscription_key):
 
         print("\nDetect faces.")
         evaluation = client.image_moderation.find_faces_url_input(
-            "application/json",
-            data_representation="URL",
-            value=image_url,
+            content_type="application/json",
             cache_image=True,
+            data_representation="URL",
+            value=image_url
         )
         assert isinstance(evaluation, FoundFaces)
         pprint(evaluation.as_dict())