Rychlý start: Hledání zpráv pomocí jazyka C# a rozhraní REST API Bingu pro vyhledávání zpráv

Článek
05/22/2020

Upozornění

30. října 2020 se rozhraní API Vyhledávání Bingu přesunula ze služeb Azure AI na Vyhledávání Bingu Services. Tato dokumentace je k dispozici pouze pro referenci. Aktualizovanou dokumentaci najdete v dokumentaci k rozhraní API bingu pro vyhledávání. Pokyny k vytváření nových prostředků Azure pro vyhledávání Bingem najdete v tématu Vytvoření prostředku Vyhledávání Bingu prostřednictvím Azure Marketplace.

Pomocí tohoto rychlého startu můžete provést první volání rozhraní API Bingu pro vyhledávání zpráv. Tato jednoduchá aplikace jazyka C# odešle do rozhraní API dotaz pro vyhledávání zpráv a zobrazí odpověď JSON.

I když je tato aplikace napsaná v jazyce C#, rozhraní API je webová služba RESTful kompatibilní s většinou programovacích jazyků.

Úplný kód této ukázky najdete na GitHubu.

Požadavky

Libovolná edice sady Visual Studio 2017 nebo novější.
Rozhraní Json.NET, k dispozici jako balíček NuGet.
Pokud používáte Linux nebo MacOS, můžete tuto aplikaci spustit pomocí mono.

Vytvoření prostředku Azure

Začněte používat rozhraní API Bingu pro vyhledávání zpráv vytvořením jednoho z následujících prostředků Azure:

prostředek Vyhledávání Bingu v7

Dostupné prostřednictvím Azure Portal, dokud prostředek neodstraníte.
K vyzkoušení služby použijte bezplatnou cenovou úroveň a později upgradujte na placenou úroveň pro produkční prostředí.

Prostředek s více službami

Dostupné prostřednictvím Azure Portal, dokud prostředek neodstraníte.
Pro aplikace používejte stejný klíč a koncový bod napříč několika službami Azure AI.

Vytvoření a inicializace projektu

Vytvořte nové řešení konzoly jazyka C# v sadě Visual Studio. Pak do hlavního souboru kódu přidejte následující obory názvů:
```
using System;
using System.Text;
using System.Net;
using System.IO;
using System.Collections.Generic;
```
Vytvořte proměnné pro koncový bod rozhraní API, klíč předplatného a hledaný výraz. Globální koncový bod můžete použít v následujícím kódu nebo vlastní koncový bod subdomény zobrazený v Azure Portal pro váš prostředek.
```
const string accessKey = "enter key here";
const string uriBase = "https://api.cognitive.microsoft.com/bing/v7.0/news/search";
const string searchTerm = "Microsoft";
```

Vytvoření struktury pro formátování odpovědi Bingu pro vyhledávání zpráv

SearchResult Definujte strukturu, která bude obsahovat výsledky hledání zpráv a informace o hlavičce JSON.

struct SearchResult
{
    public String jsonResult;
    public Dictionary<String, String> relevantHeaders;
}

Vytvoření a zpracování žádosti o vyhledávání zpráv

Vytvořte metodu s názvem BingNewsSearch() pro volání rozhraní API a nastavte návratový typ na strukturu vytvořenou SearchResult dříve.

Přidejte kód do této metody v následujících krocích.

Sestavte URI pro žádost o vyhledávání. Hledaný toSearch termín musí být před připojením k řetězci naformátovaný.

static SearchResult BingNewsSearch(string toSearch){

    var uriQuery = uriBase + "?q=" + Uri.EscapeDataString(toSearch);
//...

Proveďte webový požadavek a získejte odpověď jako řetězec JSON.

WebRequest request = WebRequest.Create(uriQuery);
request.Headers["Ocp-Apim-Subscription-Key"] = subscriptionKey;
HttpWebResponse response = (HttpWebResponse)request.GetResponseAsync().Result;
string json = new StreamReader(response.GetResponseStream()).ReadToEnd();

Vytvořte objekt výsledků hledání a extrahujte hlavičky HTTP Bingu. Pak vraťte searchResult.

// Create the result object for return
var searchResult = new SearchResult()
{
    jsonResult = json,
    relevantHeaders = new Dictionary<String, String>()
};

// Extract Bing HTTP headers
foreach (String header in response.Headers)
{
    if (header.StartsWith("BingAPIs-") || header.StartsWith("X-MSEdge-"))
        searchResult.relevantHeaders[header] = response.Headers[header];
}
return searchResult;

Zpracování odpovědi

V hlavní metodě volejte BingNewsSearch() a uložte vrácenou odpověď. Potom deserializujte JSON do objektu, kde můžete zobrazit hodnoty odpovědi.

SearchResult result = BingNewsSearch(searchTerm);
//deserialize the JSON response
dynamic jsonObj = Newtonsoft.Json.JsonConvert.DeserializeObject(result.jsonResult);
Console.WriteLine(jsonObj["value"][0])

Příklad odpovědi JSON

Úspěšná odpověď se vrátí ve formátu JSON, jak je znázorněno v následujícím příkladu:

{
   "_type": "News",
   "readLink": "https:\/\/api.cognitive.microsoft.com\/api\/v7\/news\/search?q=Microsoft",
   "totalEstimatedMatches": 36,
   "sort": [
      {
         "name": "Best match",
         "id": "relevance",
         "isSelected": true,
         "url": "https:\/\/api.cognitive.microsoft.com\/api\/v7\/news\/search?q=Microsoft"
      },
      {
         "name": "Most recent",
         "id": "date",
         "isSelected": false,
         "url": "https:\/\/api.cognitive.microsoft.com\/api\/v7\/news\/search?q=Microsoft&sortby=date"
      }
   ],
   "value": [
      {
         "name": "Microsoft to open flagship London brick-and-mortar retail store",
         "url": "http:\/\/www.contoso.com\/article\/microsoft-to-open-flagshi...",
         "image": {
            "thumbnail": {
               "contentUrl": "https:\/\/www.bing.com\/th?id=ON.F9E4A49EC010417...",
               "width": 220,
               "height": 146
            }
         },
         "description": "After years of rumors about Microsoft opening a brick-and-mortar...", 
         "about": [
           {
             "readLink": "https:\/\/api.cognitive.microsoft.com\/api\/v7\/entiti...", 
             "name": "Microsoft"
           }, 
           {
             "readLink": "https:\/\/api.cognitive.microsoft.com\/api\/v7\/entit...", 
             "name": "London"
           }
         ], 
         "provider": [
           {
             "_type": "Organization", 
             "name": "Contoso"
           }
         ], 
          "datePublished": "2017-09-21T21:16:00.0000000Z", 
          "category": "ScienceAndTechnology"
      }, 

      . . .

      {
         "name": "Microsoft adds Availability Zones to its Azure cloud platform",
         "url": "https:\/\/contoso.com\/2017\/09\/21\/microsoft-adds-availability...",
         "image": {
            "thumbnail": {
               "contentUrl": "https:\/\/www.bing.com\/th?id=ON.0AE7595B9720...",
               "width": 700,
               "height": 466
            }
         },
         "description": "Microsoft has begun adding Availability Zones to its...",
         "about": [
            {
               "readLink": "https:\/\/api.cognitive.microsoft.com\/api\/v7\/entities\/a093e9b...",
               "name": "Microsoft"
            },
            {
               "readLink": "https:\/\/api.cognitive.microsoft.com\/api\/v7\/entities\/cf3abf7d-e379-...",
               "name": "Windows Azure"
            },
            {
               "readLink": "https:\/\/api.cognitive.microsoft.com\/api\/v7\/entities\/9cdd061c-1fae-d0...",
               "name": "Cloud"
            }
         ],
         "provider": [
            {
               "_type": "Organization",
               "name": "Contoso"
            }
         ],
         "datePublished": "2017-09-21T09:01:00.0000000Z",
         "category": "ScienceAndTechnology"
      }
   ]
}

Další kroky

Vytvoření jednostránkové webové aplikace