Merge pull request #175 from PatrickFarley/pafarley-snippets

Pafarley snippets

Author: yangyuan

documentation-samples/quickstarts/ContentModerator/Program.cs

@@ -1,3 +1,4 @@
+// <snippet_using>
 using Microsoft.Azure.CognitiveServices.ContentModerator;
 using Microsoft.Azure.CognitiveServices.ContentModerator.Models;
 using Newtonsoft.Json;
@@ -6,6 +7,7 @@
 using System.IO;
 using System.Text;
 using System.Threading;
+// </snippet_using>
 
 /*
  * Content Moderator SDK Quickstart
@@ -43,26 +45,35 @@ namespace ContentModeratorQuickstart
 	class Program
 	{
 		// AUTHENTICATION - ALL EXAMPLES
+		// <snippet_creds>
 		// Your Content Moderator subscription key is found in your Azure portal resource on the 'Keys' page. Add to your environment variables.
 		private static readonly string SubscriptionKey = Environment.GetEnvironmentVariable("CONTENT_MODERATOR_SUBSCRIPTION_KEY");
-		// Base endpoint with your specific region, add this to your environment variables. Found on 'Overview page' in Azure resource. For example: https://westus.api.cognitive.microsoft.com
+		// Base endpoint URL. Add this to your environment variables. Found on 'Overview' page in Azure resource. For example: https://westus.api.cognitive.microsoft.com
 		private static readonly string Endpoint = Environment.GetEnvironmentVariable("CONTENT_MODERATOR_ENDPOINT");
+		// </snippet_creds>
 
+		// <snippet_image_vars>
 		// IMAGE MODERATION
 		//The name of the file that contains the image URLs to evaluate.
 		private static readonly string ImageUrlFile = "ImageFiles.txt";
 		// The name of the file to contain the output from the evaluation.
 		private static string ImageOutputFile = "ImageModerationOutput.json";
+		// </snippet_image_vars>
 
+		// <snippet_text_vars>
 		// TEXT MODERATION
 		// Name of the file that contains text
 		private static readonly string TextFile = "TextFile.txt";
 		// The name of the file to contain the output from the evaluation.
 		private static string TextOutputFile = "TextModerationOutput.txt";
+		// </snippet_text_vars>
 
 		// CREATE HUMAN REVIEWS FOR IMAGES
+		// <snippet_review_urls>
 		// The list of URLs of the images to create review jobs for.
 		private static readonly string[] IMAGE_URLS_FOR_REVIEW = new string[] { "https://moderatorsampleimages.blob.core.windows.net/samples/sample5.png" };
+		// </snippet_review_urls>
+		// <snippet_review_vars>
 		// The name of the team to assign the review to. Must be the team name used to create your Content Moderator website account. 
 		// If you do not yet have an account, follow this: https://docs.microsoft.com/en-us/azure/cognitive-services/content-moderator/quick-start
 		// Select the gear symbol (settings)-->Credentials to retrieve it. Your team name is the Id associated with your subscription.
@@ -71,23 +82,34 @@ class Program
 		// For example: https://westus.api.cognitive.microsoft.com/contentmoderator/review/v1.0
 		// As reviewers complete reviews, results are sent using an HTTP POST request.
 		private static readonly string ReviewsEndpoint = Environment.GetEnvironmentVariable("CONTENT_MODERATOR_REVIEWS_ENDPOINT");
+		// </snippet_review_vars>
 
 		static void Main(string[] args)
 		{
 			// CLIENTS - each API call needs its own client
+			// <snippet_client>
 			// Create an image review client
 			ContentModeratorClient clientImage = Authenticate(SubscriptionKey, Endpoint);
 			// Create a text review client
 			ContentModeratorClient clientText = Authenticate(SubscriptionKey, Endpoint);
 			// Create a human reviews client
 			ContentModeratorClient clientReviews = Authenticate(SubscriptionKey, Endpoint);
+			// </snippet_client>
 
+			// <snippet_imagemod_call>
 			// Moderate images from list of image URLs
 			ModerateImages(clientImage, ImageUrlFile, ImageOutputFile);
+			// </snippet_imagemod_call>
+
+			// <snippet_textmod_call>
 			// Moderate text from text in a file
 			ModerateText(clientText, TextFile, TextOutputFile);
+			// </snippet_textmod_call>
+
+			// <snippet_review_call>
 			// Create image reviews for human reviewers
 			CreateReviews(clientReviews, IMAGE_URLS_FOR_REVIEW, TEAM_NAME, ReviewsEndpoint);
+			// </snippet_review_call>
 
 			Console.WriteLine();
 			Console.WriteLine("End of the quickstart.");
@@ -108,6 +130,7 @@ public static ContentModeratorClient Authenticate(string key, string endpoint)
 			return client;
 		}
 
+		// <snippet_imagemod_iterate>
 		/*
 		 * IMAGE MODERATION
 		 * This example moderates images from URLs.
@@ -133,6 +156,8 @@ public static void ModerateImages(ContentModeratorClient client, string urlFile,
 						{
 							Console.WriteLine("Evaluating {0}...", Path.GetFileName(line));
 							var imageUrl = new BodyModel("URL", line.Trim());
+							// </snippet_imagemod_iterate>
+							// <snippet_imagemod_analyze>
 							var imageData = new EvaluationData
 							{
 								ImageUrl = imageUrl.Value,
@@ -158,6 +183,8 @@ public static void ModerateImages(ContentModeratorClient client, string urlFile,
 						}
 					}
 				}
+				// </snippet_imagemod_analyze>
+				// <snippet_imagemod_save>
 				// Save the moderation results to a file.
 				using (StreamWriter outputWriter = new StreamWriter(outputFile, false))
 				{
@@ -172,7 +199,9 @@ public static void ModerateImages(ContentModeratorClient client, string urlFile,
 				Console.WriteLine();
 			}
 		}
+		// </snippet_imagemod_save>
 
+		// <snippet_dataclass>
 		// Contains the image moderation results for an image, 
 		// including text and face detection results.
 		public class EvaluationData
@@ -189,10 +218,12 @@ public class EvaluationData
 			// The face detection results;
 			public FoundFaces FaceDetection;
 		}
+		// </snippet_dataclass>
 		/*
 		 * END - IMAGE MODERATION
 		 */
 
+		// <snippet_textmod>
 		/*
 		 * TEXT MODERATION
 		 * This example moderates text from file.
@@ -236,6 +267,7 @@ public static void ModerateText(ContentModeratorClient client, string inputFile,
 			Console.WriteLine("Results written to {0}", outputFile);
 			Console.WriteLine();
 		}
+		// </snippet_textmod>
 		/*
 		 * END - TEXT MODERATION
 		 */
@@ -247,7 +279,7 @@ public static void ModerateText(ContentModeratorClient client, string inputFile,
 		 * 
 		 * Prerequisistes: 
 		 * 1. In your Content Moderator resource go to Resource Management -> Properties, then copy your Resource ID. 
-		 * 2. Go to the Content Moderator website, https://{YOUR REGION}.contentmoderator.cognitive.microsoft.com.
+		 * 2. Go to the Content Moderator website.
 		 * 3. Click the gear sign (Settings) and go to "Credentials". 
 		 * 4. Under "Whitelisted Resource Id(s)" paste your Resource ID, then select the "+" button to add it.
 		 *    This enables the website to receive programmatic reviews from your Content Moderator resource in Azure.
@@ -257,6 +289,7 @@ public static void ModerateText(ContentModeratorClient client, string inputFile,
 		 * Use your Azure account with the review APIs:
 		 * https://docs.microsoft.com/en-us/azure/cognitive-services/content-moderator/review-tool-user-guide/configure
 		 */
+		// <snippet_review_item>
 		// Associates the review ID (assigned by the service) to the internal.
 		public class ReviewItem
 		{
@@ -269,7 +302,9 @@ public class ReviewItem
 			// The ID that the service assigned to the review.
 			public string ReviewId;
 		}
+		// </snippet_review_item>
 
+		// <snippet_createreview_fields>
 		// Create the reviews using the fixed list of images.
 		private static void CreateReviews(ContentModeratorClient client, string[] ImageUrls, string teamName, string endpoint)
 		{
@@ -303,7 +338,9 @@ private static void CreateReviews(ContentModeratorClient client, string[] ImageU
 
 			// The cached review information, associating a local content ID to the created review ID for each item.
 			List<ReviewItem> reviewItems = new List<ReviewItem>();
+			// </snippet_createreview_fields>
 
+			// <snippet_createreview_create>
 			using (TextWriter outputWriter = new StreamWriter(OutputFile, false))
 			{
 				writer = outputWriter;
@@ -340,7 +377,9 @@ private static void CreateReviews(ContentModeratorClient client, string[] ImageU
 				}
 
 				var reviewResponse = client.Reviews.CreateReviewsWithHttpMessagesAsync("application/json", teamName, requestInfo);
+				// </snippet_createreview_create>
 
+				// <snippet_createreview_ids>
 				// Update the local cache to associate the created review IDs with the associated content.
 				var reviewIds = reviewResponse.Result.Body;
 				for (int i = 0; i < reviewIds.Count; i++) { reviewItems[i].ReviewId = reviewIds[i]; }
@@ -359,7 +398,9 @@ private static void CreateReviews(ContentModeratorClient client, string[] ImageU
 					WriteLine(outputWriter, JsonConvert.SerializeObject(reviewDetail.Result.Body, Formatting.Indented));
 					Thread.Sleep(throttleRate);
 				}
+				// </snippet_createreview_ids>
 
+				// <snippet_createreview_results>
 				Console.WriteLine();
 				Console.WriteLine("Perform manual reviews on the Content Moderator site.");
 				Console.WriteLine("Then, press any key to continue.");
@@ -391,14 +432,17 @@ private static void CreateReviews(ContentModeratorClient client, string[] ImageU
 			}
 			Console.WriteLine("--------------------------------------------------------------");
 		}
+		// </snippet_createreview_results>
 
+		// <snippet_writeline>
 		// Helper function that writes a message to the log file, and optionally to the console.
 		// If echo is set to true, details will be written to the console.
 		private static void WriteLine(TextWriter writer, string message = null, bool echo = true)
 		{
 			writer.WriteLine(message ?? String.Empty);
 			if (echo) { Console.WriteLine(message ?? String.Empty); }
 		}
+		// </snippet_writeline>
 		/*
 		 * END - CREATE HUMAN IMAGE REVIEWS
 		 */