Inicio rápido: Envío de una solicitud de búsqueda a Bing Entity Search REST API con C#

  • Artículo

Advertencia

El 30 de octubre de 2020, las API de Bing Search se trasladaron de los servicios de Azure AI a los servicios de Bing Search. Esta documentación se proporciona solo como referencia. Para obtener documentación actualizada, consulte la documentación de Bing Search API. Para obtener instrucciones sobre cómo crear nuevos recursos de Azure para Bing Search, consulte el artículo sobre la creación de un recurso de Bing Search a través de Azure Marketplace.

Use este inicio rápido para realizar la primera llamada a Bing Entity Search API y ver la respuesta JSON. Esta sencilla aplicación de C# envía una consulta de búsqueda de noticias a la API y muestra la respuesta. El código fuente de esta aplicación está disponible en GitHub.

Aunque esta aplicación está escrita en C#, la API es un servicio web RESTful compatible con la mayoría de los lenguajes de programación.

Prerrequisitos

Creación de un recurso de Azure

Comience a usar Bing Entity Search API mediante la creación de uno de los recursos de Azure que se indican a continuación.

Recurso de Bing Entity Search

  • Disponible en Azure Portal hasta que lo elimine.
  • Use el plan de tarifa gratuito para probar el servicio y actualícelo más adelante a un nivel de pago para producción.
  • Bing Entity Search también se ofrece en los niveles de pago del recurso Bing Search, versión 7.

Recurso de varios servicios

  • Disponible en Azure Portal hasta que lo elimine.
  • Utilice la misma clave y el mismo punto de conexión para sus aplicaciones en varios servicios de Azure AI.

Creación e inicialización de un proyecto

  1. Cree una solución de consola de C# en Visual Studio.

  2. Agregue el paquete NuGet Newtonsoft.Json.

    1. En el Explorador de soluciones, haga clic con el botón derecho en el proyecto.
    2. Seleccione Administrar paquetes NuGet.
    3. Busque Newtonsoft.json y selecciónelo, a continuación instale el paquete.

  3. Después, agregue los siguientes espacios de nombres en el archivo de código principal:

    using Newtonsoft.Json;
using System;
using System.Net.Http;
using System.Text;

  4. Cree una nueva clase y agregue variables para el punto de conexión de la API, la clave de suscripción y la consulta que desea realizar. Puede usar el punto de conexión global en el código siguiente, o el punto de conexión del subdominio personalizado que se muestra en Azure Portal para el recurso.

    namespace EntitySearchSample
{
    class Program
    {
        static string host = "https://api.bing.microsoft.com";
        static string path = "/v7.0/search";

        static string market = "en-US";

        // NOTE: Replace this example key with a valid subscription key.
        static string key = "ENTER YOUR KEY HERE";

        static string query = "italian restaurant near me";
    //...
    }
}

Envío de una solicitud y obtención de la respuesta de la API

  1. Dentro de la clase, cree una función denominada Search(). Dentro de esta función cree un nuevo objeto HttpClient y agregue su clave de suscripción al encabezado Ocp-Apim-Subscription-Key.

  2. Construya el identificador URI de la solicitud mediante la combinación del host y la ruta de acceso. A continuación, agregue el mercado y codifique como URL la consulta.

  3. Espere hasta que client.GetAsync() obtenga una respuesta HTTP y, a continuación, almacene la respuesta JSON a la espera de ReadAsStringAsync().

  4. Asigne formato a la cadena JSON con JsonConvert.DeserializeObject() e imprímala en la consola.

    async static void Search()
{
 //...
 HttpClient client = new HttpClient();
 client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", key);

 string uri = host + path + "?mkt=" + market + "&q=" + System.Net.WebUtility.UrlEncode(query);

 HttpResponseMessage response = await client.GetAsync(uri);

 string contentString = await response.Content.ReadAsStringAsync();
 dynamic parsedJson = JsonConvert.DeserializeObject(contentString);
 Console.WriteLine(parsedJson);
}

  5. En el método Main() de la aplicación, llame a la función Search().

    static void Main(string[] args)
{
    Search();
    Console.ReadLine();
}

Ejemplo de respuesta JSON

Se devuelve una respuesta correcta en JSON, como se muestra en el siguiente ejemplo:

{
  "_type": "SearchResponse",
  "queryContext": {
    "originalQuery": "italian restaurant near me",
    "askUserForLocation": true
  },
  "places": {
    "value": [
      {
        "_type": "LocalBusiness",
        "webSearchUrl": "https://www.bing.com/search?q=sinful+bakery&filters=local...",
        "name": "Liberty's Delightful Sinful Bakery & Cafe",
        "url": "https://www.contoso.com/",
        "entityPresentationInfo": {
          "entityScenario": "ListItem",
          "entityTypeHints": [
            "Place",
            "LocalBusiness"
          ]
        },
        "address": {
          "addressLocality": "Seattle",
          "addressRegion": "WA",
          "postalCode": "98112",
          "addressCountry": "US",
          "neighborhood": "Madison Park"
        },
        "telephone": "(800) 555-1212"
      },

      . . .
      {
        "_type": "Restaurant",
        "webSearchUrl": "https://www.bing.com/search?q=Pickles+and+Preserves...",
        "name": "Munson's Pickles and Preserves Farm",
        "url": "https://www.princi.com/",
        "entityPresentationInfo": {
          "entityScenario": "ListItem",
          "entityTypeHints": [
            "Place",
            "LocalBusiness",
            "Restaurant"
          ]
        },
        "address": {
          "addressLocality": "Seattle",
          "addressRegion": "WA",
          "postalCode": "98101",
          "addressCountry": "US",
          "neighborhood": "Capitol Hill"
        },
        "telephone": "(800) 555-1212"
      },
      
      . . .
    ]
  }
}

Pasos siguientes

Compilar una aplicación web de una sola página