Rövid útmutató: Hírek keresése a C# és a Bing News Search REST API használatával

Cikk
05/22/2020

Figyelmeztetés

2020. október 30-án a Bing Search API-k átkerültek az Azure AI-szolgáltatásokból a Bing Search-szolgáltatásokba. Ez a dokumentáció csak referenciaként érhető el. A frissített dokumentációt a Bing search API dokumentációjában találja. Az új Azure-erőforrások Bing-kereséshez való létrehozásával kapcsolatos utasításokért lásd: Bing Search-erőforrás létrehozása a Azure Marketplace keresztül.

Ezzel a rövid útmutatóval kezdeményezheti első hívását a Bing News Search API-hoz. Ez az egyszerű C#-alkalmazás hírkeresési lekérdezést küld az API-nak, és megjeleníti a JSON-választ.

Bár ez az alkalmazás C# nyelven van megírva, az API egy RESTful webszolgáltatás, amely a legtöbb programozási nyelvvel kompatibilis.

A minta teljes kódja megtalálható a GitHubon.

Előfeltételek

A Visual Studio 2017 vagy újabb verzióinak bármely kiadása.
A Json.NET keretrendszer, amely NuGet-csomagként letölthető.
Linux/MacOS használata esetén az alkalmazást a Mono használatával futtathatja.

Azure-erőforrás létrehozása

Kezdje el használni a Bing News Search API-t az alábbi Azure-erőforrások egyikének létrehozásával:

Bing Search v7-erőforrás

A Azure Portal keresztül érhető el, amíg el nem törli az erőforrást.
Az ingyenes tarifacsomag használatával próbálja ki a szolgáltatást, és frissítsen később egy fizetős tarifacsomagra éles környezetben.

Többszolgáltatásos erőforrás

A Azure Portal keresztül érhető el, amíg el nem törli az erőforrást.
Használja ugyanazt a kulcsot és végpontot az alkalmazásokhoz több Azure AI-szolgáltatásban.

Projekt létrehozása és inicializálása

Hozzon létre egy új C#-konzolmegoldást a Visual Studióban. Ezután adja hozzá a következő névtereket a fő kódfájlhoz:
```
using System;
using System.Text;
using System.Net;
using System.IO;
using System.Collections.Generic;
```
Hozza létre az API-végpont, az előfizetési kulcsot és a kerőkifejezést. Használhatja a globális végpontot a következő kódban, vagy használhatja az erőforráshoz tartozó Azure Portal megjelenített egyéni altartományvégpontot.
```
const string accessKey = "enter key here";
const string uriBase = "https://api.cognitive.microsoft.com/bing/v7.0/news/search";
const string searchTerm = "Microsoft";
```

Szerkezet létrehozása a Bing News Search-válasz formázásához

Adjon meg egy struktúrát SearchResult , amely tartalmazza a hírek keresési eredményeit és a JSON fejlécadatait.

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

Hírkeresési kérés létrehozása és kezelése

Hozzon létre egy nevű BingNewsSearch() metódust az API meghívásához, és állítsa a visszatérési típust a SearchResult korábban létrehozott struktúrára.

Az alábbi lépésekben adjon hozzá kódot ehhez a metódushoz.

Hozza létre a keresési kérés URI-ját. A toSearch keresési kifejezést formázni kell, mielőtt hozzáfűzné a sztringhez.

static SearchResult BingNewsSearch(string toSearch){

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

Hajtsa végre a webes kérést, és kérje le a JSON-sztringként kapott választ.

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();

Hozza létre a keresési eredmény objektumát, és nyerje ki a Bing HTTP-fejléceit. Ezután adja vissza a következőt 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;

A válasz feldolgozása

A fő metódusban hívja meg a BingNewsSearch() elemet, és tárolja a kapott választ. Ezután deszerializálja a JSON-t egy objektumba, ahol megtekintheti a válasz értékeit.

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

Példa JSON-válaszra

A rendszer JSON formátumban ad vissza egy sikeres választ a következő példában látható módon:

{
   "_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"
      }
   ]
}

Következő lépések

Egyoldalas webalkalmazás létrehozása