Merge pull request #107 from aahill/code-updates

[Bing Custom Search] REST API Code updates

Author: aahill

dotnet/Search/BingCustomSearchv7.cs

@@ -1,33 +1,41 @@
 //Copyright (c) Microsoft Corporation. All rights reserved.
 //Licensed under the MIT License.
-
+// <using>
 using System;
 using System.Net.Http;
 using System.Web;
 using Newtonsoft.Json;
+// </using>
 
 namespace bing_custom_search_example_dotnet
 {
     class Program
     {
         static void Main(string[] args)
         {
-            // Add your Azure Bing Custom Search subscription key to your environment variables.
+            // <vars>
+            // Add your Azure Bing Custom Search subscription key and endpoint to your environment variables.
+            // Your endpoint will have the form: https://<your-custom-subdomain>.cognitiveservices.azure.com/bingcustomsearch/v7.0
             var subscriptionKey = Environment.GetEnvironmentVariable("BING_CUSTOM_SEARCH_SUBSCRIPTION_KEY");
-            var customConfigId = "YOUR-CUSTOM-CONFIG-ID";
-            var searchTerm = args.Length > 0 ? args[0]: "microsoft";            
-            
-            // Add your Azure Bing Custom Search endpoint to your environment variables.
-            var url = Environment.GetEnvironmentVariable("BING_CUSTOM_SEARCH_ENDPOINT") + "/bingcustomsearch/v7.0/search?" +
-                "q=" + searchTerm +
-                "&customconfig=" + customConfigId;
+            var endpoint = Environment.GetEnvironmentVariable("BING_CUSTOM_SEARCH_ENDPOINT");
 
+            var customConfigId = "YOUR-CUSTOM-CONFIG-ID"; // you can also use "1"
+            var searchTerm = args.Length > 0 ? args[0]: "microsoft";            
+            // </vars>
+            // </url>
+            // Use your Azure Bing Custom Search endpoint to create the full request URL.
+            var url = endpoint + "/search?" + "q=" + searchTerm + "&customconfig=" + customConfigId;
+            // </url>
+            // <client>
             var client = new HttpClient();
             client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", subscriptionKey);
+            // </client>
+            // <sendRequest>
             var httpResponseMessage = client.GetAsync(url).Result;
             var responseContent = httpResponseMessage.Content.ReadAsStringAsync().Result;
             BingCustomSearchResponse response = JsonConvert.DeserializeObject<BingCustomSearchResponse>(responseContent);
-
+            // </sendRequest>
+            // <iterateResponse>
             for(int i = 0; i < response.webPages.value.Length; i++)
             {                
                 var webPage = response.webPages.value[i];
@@ -38,10 +46,11 @@ static void Main(string[] args)
                 Console.WriteLine("snippet: " + webPage.snippet);
                 Console.WriteLine("dateLastCrawled: " + webPage.dateLastCrawled);
                 Console.WriteLine();
-            }            
+            } 
+            //</iterateResponse>           
         }
     }
-
+    // <repsonseClasses>
     public class BingCustomSearchResponse
     {        
         public string _type{ get; set; }            
@@ -72,4 +81,5 @@ public class OpenGraphImage
         public int width { get; set; }
         public int height { get; set; }
     }
+    // <repsonseClasses>
 }

java/Search/BingCustomSearchv7.java

@@ -1,6 +1,7 @@
 /*Copyright (c) Microsoft Corporation. All rights reserved.
 Licensed under the MIT License.*/
-
+// <imports>
+import javax.net.ssl.HttpsURLConnection;
 import java.io.InputStream;
 import java.net.URL;
 import java.net.URLEncoder;
@@ -9,25 +10,27 @@
 import java.util.Map;
 import java.util.Scanner;
 
-import javax.net.ssl.HttpsURLConnection;
-
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;
+// </imports>
 
-public class CustomSrchJava {
+public class BingCustomSearchv7 {
 
-    // Add your Bing Custom Search endpoint to your environment variables.
+    // <vars>
+    // Add your Bing Custom Search endpoint and key to your environment variables.
+    // Your endpoint will have the form: 
+    //   https://<your-custom-subdomain>.cognitiveservices.azure.com/bingcustomsearch/v7.0
     static String host = System.getenv("BING_CUSTOM_SEARCH_ENDPOINT");
-    static String path = "/bingcustomsearch/v7.0/search";
-    // Add your Bing Custom Search subscription key to your environment variables.
     static String subscriptionKey = System.getenv("BING_CUSTOM_SEARCH_SUBSCRIPTION_KEY");
-    static String customConfigId = "YOUR-CUSTOM-CONFIG-ID";  
-
+    
+    static String path = "/search";
+    static String customConfigId = "YOUR-CUSTOM-CONFIG-ID"; //you can also use "1"
     static String searchTerm = "Microsoft";  // Replace with search term specific to your defined sources.
-
-    public static SearchResults SearchImages (String searchQuery) throws Exception {
+    // </vars>
+    // <searchWeb>
+    public static SearchResults SearchWeb(String searchQuery) throws Exception {
         // construct URL of search request (endpoint + query string)
         URL url = new URL(host + path + "?q=" +  URLEncoder.encode(searchTerm, "UTF-8") + "&CustomConfig=" + customConfigId);
         HttpsURLConnection connection = (HttpsURLConnection)url.openConnection();
@@ -52,15 +55,17 @@ public static SearchResults SearchImages (String searchQuery) throws Exception {
         stream.close();
         return results;
     }
-
+    // </searchWeb>
+    // <prettify>
     // pretty-printer for JSON; uses GSON parser to parse and re-serialize
     public static String prettify(String json_text) {
         JsonParser parser = new JsonParser();
         JsonObject json = parser.parse(json_text).getAsJsonObject();
         Gson gson = new GsonBuilder().setPrettyPrinting().create();
         return gson.toJson(json);
     }
-
+    // </prettify>
+    // <main>
     public static void main (String[] args) {
         if (subscriptionKey.length() != 32) {
             System.out.println("Invalid Bing Search API subscription key!");
@@ -71,7 +76,7 @@ public static void main (String[] args) {
         try {
             System.out.println("Searching the Web for: " + searchTerm);
 
-            SearchResults result = SearchImages(searchTerm);
+            SearchResults result = SearchWeb(searchTerm);
 
             System.out.println("\nRelevant HTTP Headers:\n");
             for (String header : result.relevantHeaders.keySet())
@@ -85,8 +90,13 @@ public static void main (String[] args) {
             System.exit(1);
         }
     }
+    // </main>
 }
 
+// <searchResultsClass>
+// put this in a seperate .java file.
+import java.util.HashMap;
+
 // Container class for search results encapsulates relevant headers and JSON data
 class SearchResults{
     HashMap<String, String> relevantHeaders;
@@ -97,3 +107,5 @@ class SearchResults{
     }
 
 }
+// </searchResultsClass>
+

nodejs/Search/BingCustomSearchv7.js

@@ -1,21 +1,26 @@
 //Copyright (c) Microsoft Corporation. All rights reserved.
 //Licensed under the MIT License.
-
+// <vars>
 var request = require("request");
-
-var subscriptionKey = process.env['BING_CUSTOM_SEARCH_SUBSCRIPTION_KEY']
-var customConfigId = 'YOUR-CUSTOM-CONFIG-ID';
+// Add your Bing Custom Search subscription key to your environment variables.
+// Your endpoint will have the form: 
+//   https://<your-custom-subdomain>.cognitiveservices.azure.com/bingcustomsearch/v7.0
+var subscriptionKey = process.env['BING_CUSTOM_SEARCH_SUBSCRIPTION_KEY'];
+var endpoint = process.env['BING_CUSTOM_SEARCH_ENDPOINT'];
+var customConfigId = 'YOUR-CUSTOM-CONFIG-ID'; //you can also use "1"
 var searchTerm = 'microsoft';
-
+// </vars>
+// <requestOptions>
 var options = {
-    url: process.env['BING_CUSTOM_SEARCH_ENDPOINT'] + "/bingcustomsearch/v7.0/search?' + 
+    url: endpoint + "/search?" + 
       'q=' + searchTerm + 
       '&customconfig=' + customConfigId,
     headers: {
         'Ocp-Apim-Subscription-Key' : subscriptionKey
     }
 }
-
+// </requestOptions>
+// <requestMethod>
 request(options, function(error, response, body){
     var searchResponse = JSON.parse(body);
     for(var i = 0; i < searchResponse.webPages.value.length; ++i){
@@ -28,3 +33,4 @@ request(options, function(error, response, body){
         console.log();
     }
 })
+// </requestMethod>

python/Search/BingCustomSearchv7.py

@@ -4,16 +4,23 @@
 # You may need the below as well
 #pip install pipenv
 #pipenv install requests
-
+# <importsAndVars>
 import json
 import requests
+import os
 
 # Add your Bing Custom Search subscription key to your environment variables.
+# Your endpoint will have the form: https://<your-custom-subdomain>.cognitiveservices.azure.com/bingcustomsearch/v7.0
 subscriptionKey = os.environ['BING_CUSTOM_SEARCH_SUBSCRIPTION_KEY']
-customConfigId = "YOUR-CUSTOM-CONFIG-ID"
+endpoint = os.environ['BING_CUSTOM_SEARCH_ENDPOINT']
+customConfigId = "1" #you can also use "1"
 searchTerm = "microsoft"
-
+# </importsAndVars>
+# <url>
 # Add your Bing Custom Search endpoint to your environment variables.
-url = os.environ['BING_CUSTOM_SEARCH_ENDPOINT'] + "/bingcustomsearch/v7.0/search?q=' + searchTerm + '&customconfig=' + customConfigId
+url = endpoint + "/search?q=" + searchTerm + "&customconfig=" + customConfigId
+# </url>
+# <request>
 r = requests.get(url, headers={'Ocp-Apim-Subscription-Key': subscriptionKey})
 print(r.text)
+# </request>