Краткое руководство. Использование клиентской библиотеки Поиска в Интернете Bing

Статья
10/19/2020

Предупреждение

30 октября 2020 г. API-интерфейсы Поиск Bing перемещены из служб ИИ Azure в службы Поиск Bing. Эта документация приводится только для справки. Обновленную информацию см. в документации по API Поиска Bing. Инструкции по созданию ресурсов Azure для Поиска MS Bing см. в статье о том, как создать ресурс для Поиска MS Bing с помощью Azure Marketplace.

Клиентская библиотека Поиска в Интернете Bing позволяет интегрировать поиск Bing в любое приложение C#. Из этого краткого руководства вы узнаете, как создать экземпляр клиента, отправить запрос и вывести ответ.

Хотите увидеть код прямо сейчас? Примеры для клиентских библиотек Поиска Bing для .NET доступны на GitHub.

Предварительные требования

Для работы с этим кратким руководством вам потребуется следующее:

Создание ресурса Azure

Чтобы начать работу с API Поиска в Интернете Bing, создайте один из следующих ресурсов Azure.

Ресурс Поиска Bing версии 7

доступен на портале Azure до удаления.
Используйте бесплатную ценовую категорию, чтобы опробовать службу, а затем выполните обновление до платного уровня для рабочей среды.

Ресурс для нескольких служб

доступен на портале Azure до удаления.
Используйте один и тот же ключ и конечную точку для приложений в нескольких службах ИИ Azure.

Создание проекта и установка зависимостей

Совет

Получите последнюю версию кода, предоставленного в решении Visual Studio, с сайта GitHub.

Первым шагом является создание проекта консольного приложения. Если вам требуется помощь с настройкой проекта консольного приложения, см. статью Руководство по программированию на C#. Создание первой программы Hello World. Чтобы использовать в приложении SDK Поиска в Интернете Bing, необходимо установить Microsoft.Azure.CognitiveServices.Search.WebSearch с помощью диспетчера пакетов NuGet.

Пакет SDK Поиска в Интернете также устанавливает следующее:

Microsoft.Rest.ClientRuntime
Microsoft.Rest.ClientRuntime.Azure
Newtonsoft.Json.

Объявление зависимостей

Откройте проект в Visual Studio или Visual Studio Code и импортируйте эти зависимости:

using System;
using System.Collections.Generic;
using Microsoft.Azure.CognitiveServices.Search.WebSearch;
using Microsoft.Azure.CognitiveServices.Search.WebSearch.Models;
using System.Linq;
using System.Threading.Tasks;

Создание шаблонов для проекта

Для создаваемого проекта консольного приложения также нужно создать пространство имен и класс. Программа должна выглядеть, как показано в следующем примере.

namespace WebSearchSDK
{
    class YOUR_PROGRAM
    {

        // The code in the following sections goes here.

    }
}

В следующих разделах мы создадим в этом классе пример приложения.

Создание запроса

Этот код создает поисковый запрос.

public static async Task WebResults(WebSearchClient client)
{
    try
    {
        var webData = await client.Web.SearchAsync(query: "Yosemite National Park");
        Console.WriteLine("Searching for \"Yosemite National Park\"");

        // Code for handling responses is provided in the next section...

    }
    catch (Exception ex)
    {
        Console.WriteLine("Encountered exception. " + ex.Message);
    }
}

Обработка ответа

Теперь мы добавим код, который анализирует ответ и выводит результаты. Выводятся Name и Url для первых результатов в категориях веб-страниц, изображений, новостей и видео, если они присутствуют в объекте ответа.

if (webData?.WebPages?.Value?.Count > 0)
{
    // find the first web page
    var firstWebPagesResult = webData.WebPages.Value.FirstOrDefault();

    if (firstWebPagesResult != null)
    {
        Console.WriteLine("Webpage Results # {0}", webData.WebPages.Value.Count);
        Console.WriteLine("First web page name: {0} ", firstWebPagesResult.Name);
        Console.WriteLine("First web page URL: {0} ", firstWebPagesResult.Url);
    }
    else
    {
        Console.WriteLine("Didn't find any web pages...");
    }
}
else
{
    Console.WriteLine("Didn't find any web pages...");
}

/*
 * Images
 * If the search response contains images, the first result's name
 * and url are printed.
 */
if (webData?.Images?.Value?.Count > 0)
{
    // find the first image result
    var firstImageResult = webData.Images.Value.FirstOrDefault();

    if (firstImageResult != null)
    {
        Console.WriteLine("Image Results # {0}", webData.Images.Value.Count);
        Console.WriteLine("First Image result name: {0} ", firstImageResult.Name);
        Console.WriteLine("First Image result URL: {0} ", firstImageResult.ContentUrl);
    }
    else
    {
        Console.WriteLine("Didn't find any images...");
    }
}
else
{
    Console.WriteLine("Didn't find any images...");
}

/*
 * News
 * If the search response contains news articles, the first result's name
 * and url are printed.
 */
if (webData?.News?.Value?.Count > 0)
{
    // find the first news result
    var firstNewsResult = webData.News.Value.FirstOrDefault();

    if (firstNewsResult != null)
    {
        Console.WriteLine("\r\nNews Results # {0}", webData.News.Value.Count);
        Console.WriteLine("First news result name: {0} ", firstNewsResult.Name);
        Console.WriteLine("First news result URL: {0} ", firstNewsResult.Url);
    }
    else
    {
        Console.WriteLine("Didn't find any news articles...");
    }
}
else
{
    Console.WriteLine("Didn't find any news articles...");
}

/*
 * Videos
 * If the search response contains videos, the first result's name
 * and url are printed.
 */
if (webData?.Videos?.Value?.Count > 0)
{
    // find the first video result
    var firstVideoResult = webData.Videos.Value.FirstOrDefault();

    if (firstVideoResult != null)
    {
        Console.WriteLine("\r\nVideo Results # {0}", webData.Videos.Value.Count);
        Console.WriteLine("First Video result name: {0} ", firstVideoResult.Name);
        Console.WriteLine("First Video result URL: {0} ", firstVideoResult.ContentUrl);
    }
    else
    {
        Console.WriteLine("Didn't find any videos...");
    }
}
else
{
    Console.WriteLine("Didn't find any videos...");
}

Объявление метода main

В этом приложении метод main включает код, который создает экземпляр клиента, проверяет subscriptionKey и вызывает WebResults. Не забудьте ввести действующий ключ подписки Azure, прежде чем продолжить работу.

static async Task Main(string[] args)
{
    var client = new WebSearchClient(new ApiKeyServiceClientCredentials("YOUR_SUBSCRIPTION_KEY"));

    await WebResults(client);

    Console.WriteLine("Press any key to exit...");
    Console.ReadKey();
}

Запуск приложения

Теперь давайте запустим приложение.

dotnet run

Определение функций и фильтрация результатов

Теперь, когда вы выполнили первый вызов к API Bing для Поиска в Интернете, давайте изучим несколько функций, которые демонстрируют возможности пакета SDK по уточнению запросов и фильтрации результатов. Каждую из этих функций можно добавить в приложение C#, которое вы создали в предыдущем разделе.

Ограничение числа результатов, возвращаемых Bing

В этом примере используются параметры count и offset, которые позволяют ограничить число результатов, возвращаемых поиском по запросу Best restaurants in Seattle (Лучшие рестораны в Сиэтле). Для первого результата возвращаются Name и Url.

Добавьте следующий код в проект консольного приложения:

public static async Task WebResultsWithCountAndOffset(WebSearchClient client)
{
    try
    {
        var webData = await client.Web.SearchAsync(query: "Best restaurants in Seattle", offset: 10, count: 20);
        Console.WriteLine("\r\nSearching for \" Best restaurants in Seattle \"");

        if (webData?.WebPages?.Value?.Count > 0)
        {
            var firstWebPagesResult = webData.WebPages.Value.FirstOrDefault();

            if (firstWebPagesResult != null)
            {
                Console.WriteLine("Web Results #{0}", webData.WebPages.Value.Count);
                Console.WriteLine("First web page name: {0} ", firstWebPagesResult.Name);
                Console.WriteLine("First web page URL: {0} ", firstWebPagesResult.Url);
            }
            else
            {
                Console.WriteLine("Couldn't find first web result!");
            }
        }
        else
        {
            Console.WriteLine("Didn't see any Web data..");
        }
    }
    catch (Exception ex)
    {
        Console.WriteLine("Encountered exception. " + ex.Message);
    }
}

Добавьте WebResultsWithCountAndOffset в main:

static async Task Main(string[] args)
{
    var client = new WebSearchClient(new ApiKeyServiceClientCredentials("YOUR_SUBSCRIPTION_KEY"));

    await WebResults(client);
    // Search with count and offset...
    await WebResultsWithCountAndOffset(client);  

    Console.WriteLine("Press any key to exit...");
    Console.ReadKey();
}

Запустите приложение.

Фильтрация новостей

В этом примере используется параметр response_filter для фильтрации результатов поиска. В результатах поиска возвращаются только новости по запросу Microsoft. Для первого результата возвращаются Name и Url.

Добавьте следующий код в проект консольного приложения:

public static async Task WebSearchWithResponseFilter(WebSearchClient client)
{
    try
    {
        IList<string> responseFilterstrings = new List<string>() { "news" };
        var webData = await client.Web.SearchAsync(query: "Microsoft", responseFilter: responseFilterstrings);
        Console.WriteLine("\r\nSearching for \" Microsoft \" with response filter \"news\"");

        if (webData?.News?.Value?.Count > 0)
        {
            var firstNewsResult = webData.News.Value.FirstOrDefault();

            if (firstNewsResult != null)
            {
                Console.WriteLine("News Results #{0}", webData.News.Value.Count);
                Console.WriteLine("First news result name: {0} ", firstNewsResult.Name);
                Console.WriteLine("First news result URL: {0} ", firstNewsResult.Url);
            }
            else
            {
                Console.WriteLine("Couldn't find first News results!");
            }
        }
        else
        {
            Console.WriteLine("Didn't see any News data..");
        }

    }
    catch (Exception ex)
    {
        Console.WriteLine("Encountered exception. " + ex.Message);
    }
}

Добавьте WebResultsWithCountAndOffset в main:

static Task Main(string[] args)
{
    var client = new WebSearchClient(new ApiKeyServiceClientCredentials("YOUR_SUBSCRIPTION_KEY"));

    await WebResults(client);
    // Search with count and offset...
    await WebResultsWithCountAndOffset(client);  
    // Search with news filter...
    await WebSearchWithResponseFilter(client);

    Console.WriteLine("Press any key to exit...");
    Console.ReadKey();
}

Запустите приложение.

Использование безопасного поиска, счетчика ответов и фильтра повышения уровня

В этом примере используются параметры answer_count, promote и safe_search для фильтрации результатов поиска по запросу Music Videos (Музыкальные видео). Для первого результата возвращаются Name и ContentUrl.

Добавьте следующий код в проект консольного приложения:

public static async Task WebSearchWithAnswerCountPromoteAndSafeSearch(WebSearchClient client)
{
    try
    {
        IList<string> promoteAnswertypeStrings = new List<string>() { "videos" };
        var webData = await client.Web.SearchAsync(query: "Music Videos", answerCount: 2, promote: promoteAnswertypeStrings, safeSearch: SafeSearch.Strict);
        Console.WriteLine("\r\nSearching for \"Music Videos\"");

        if (webData?.Videos?.Value?.Count > 0)
        {
            var firstVideosResult = webData.Videos.Value.FirstOrDefault();

            if (firstVideosResult != null)
            {
                Console.WriteLine("Video Results # {0}", webData.Videos.Value.Count);
                Console.WriteLine("First Video result name: {0} ", firstVideosResult.Name);
                Console.WriteLine("First Video result URL: {0} ", firstVideosResult.ContentUrl);
            }
            else
            {
                Console.WriteLine("Couldn't find videos results!");
            }
        }
        else
        {
            Console.WriteLine("Didn't see any data..");
        }
    }
    catch (Exception ex)
    {
        Console.WriteLine("Encountered exception. " + ex.Message);
    }
}

Добавьте WebResultsWithCountAndOffset в main:

static async Task Main(string[] args)
{
    var client = new WebSearchClient(new ApiKeyServiceClientCredentials("YOUR_SUBSCRIPTION_KEY"));

    await WebResults(client);
    // Search with count and offset...
    await WebResultsWithCountAndOffset(client);  
    // Search with news filter...
    await WebSearchWithResponseFilter(client);
    // Search with answer count, promote, and safe search
    await WebSearchWithAnswerCountPromoteAndSafeSearch(client);

    Console.WriteLine("Press any key to exit...");
    Console.ReadKey();
}

Запустите приложение.

Очистка ресурсов

Удалите ключ подписки из кода приложения, когда завершите работу с этим проектом.

Дальнейшие действия

Примеры пакета SDK для служб ИИ Azure Node.js

Клиентская библиотека Поиска в Интернете Bing позволяет интегрировать поиск Bing в любое приложение Java. В этом кратком руководстве описано, как отправлять запрос, получать ответ в формате JSON, фильтровать и анализировать результаты.

Хотите увидеть код прямо сейчас? Примеры для клиентских библиотек Поиска Bing для Java доступны на сайте GitHub.

Предварительные требования

Для работы с этим кратким руководством вам потребуется следующее:

пакет JDK 7 или 8;
Apache Maven или другой инструмент автоматизации сборки;
ключ подписки;

Создание ресурса Azure

Чтобы начать работу с API Поиска в Интернете Bing, создайте один из следующих ресурсов Azure.

Ресурс Поиска Bing версии 7

доступен на портале Azure до удаления.
Используйте бесплатную ценовую категорию, чтобы опробовать службу, а затем выполните обновление до платного уровня для рабочей среды.

Ресурс для нескольких служб

доступен на портале Azure до удаления.
Используйте один и тот же ключ и конечную точку для приложений в нескольких службах ИИ Azure.

Создание проекта и настройка файла POM

Создайте проект Java с помощью Maven или другого инструмента автоматизации сборки. Если вы используете Maven, добавьте следующие строки в файл Объектная модель проекта (POM). Замените все экземпляры mainClass своим приложением.

<build>
    <plugins>
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>exec-maven-plugin</artifactId>
        <version>1.4.0</version>
        <configuration>
          <!--Your comment
            Replace the mainClass with the path to your Java application.
            It should begin with com and doesn't require the .java extension.
            For example: com.bingwebsearch.app.BingWebSearchSample. This maps to
            The following directory structure:
            src/main/java/com/bingwebsearch/app/BingWebSearchSample.java.
          -->
          <mainClass>com.path.to.your.app.APP_NAME</mainClass>
        </configuration>
      </plugin>
      <plugin>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.0</version>
        <configuration>
          <source>1.7</source>
          <target>1.7</target>
        </configuration>
      </plugin>
      <plugin>
        <artifactId>maven-assembly-plugin</artifactId>
        <executions>
          <execution>
            <phase>package</phase>
            <goals>
              <goal>attached</goal>
            </goals>
            <configuration>
              <descriptorRefs>
                <descriptorRef>jar-with-dependencies</descriptorRef>
              </descriptorRefs>
              <archive>
                <manifest>
                  <!--Your comment
                    Replace the mainClass with the path to your Java application.
                    For example: com.bingwebsearch.app.BingWebSearchSample.java.
                    This maps to the following directory structure:
                    src/main/java/com/bingwebsearch/app/BingWebSearchSample.java.
                  -->
                  <mainClass>com.path.to.your.app.APP_NAME.java</mainClass>
                </manifest>
              </archive>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
  <dependencies>
    <dependency>
      <groupId>com.microsoft.azure</groupId>
      <artifactId>azure</artifactId>
      <version>1.9.0</version>
    </dependency>
    <dependency>
      <groupId>commons-net</groupId>
      <artifactId>commons-net</artifactId>
      <version>3.3</version>
    </dependency>
    <dependency>
      <groupId>com.microsoft.azure.cognitiveservices</groupId>
      <artifactId>azure-cognitiveservices-websearch</artifactId>
      <version>1.0.1</version>
    </dependency>
  </dependencies>

Объявление зависимостей

Откройте проект в используемой вами интегрированной среде разработки или редакторе и импортируйте эти зависимости:

import com.microsoft.azure.cognitiveservices.search.websearch.BingWebSearchAPI;
import com.microsoft.azure.cognitiveservices.search.websearch.BingWebSearchManager;
import com.microsoft.azure.cognitiveservices.search.websearch.models.ImageObject;
import com.microsoft.azure.cognitiveservices.search.websearch.models.NewsArticle;
import com.microsoft.azure.cognitiveservices.search.websearch.models.SearchResponse;
import com.microsoft.azure.cognitiveservices.search.websearch.models.VideoObject;
import com.microsoft.azure.cognitiveservices.search.websearch.models.WebPage;

Если вы создали проект с помощью Maven, пакет будет уже объявлен. В противном случае объявите пакет. Пример:

package com.bingwebsearch.app

Объявление класса BingWebSearchSample

Объявите класс BingWebSearchSample. В нем будет содержаться большая часть кода, включая метод main.

public class BingWebSearchSample {

// The code in the following sections goes here.

}

Создание запроса

Метод runSample находится в классе BingWebSearchSample и создает запрос. Скопируйте этот код в свое приложение:

public static boolean runSample(BingWebSearchAPI client) {
    /*
     * This function performs the search.
     *
     * @param client instance of the Bing Web Search API client
     * @return true if sample runs successfully
     */
    try {
        /*
         * Performs a search based on the .withQuery and prints the name and
         * url for the first web pages, image, news, and video result
         * included in the response.
         */
        System.out.println("Searched Web for \"Xbox\"");
        // Construct the request.
        SearchResponse webData = client.bingWebs().search()
            .withQuery("Xbox")
            .withMarket("en-us")
            .withCount(10)
            .execute();

// Code continues in the next section...

Обработка ответа

Теперь мы добавим код, который анализирует ответ и выводит результаты. Выводятся name и url для первой веб-страницы, образа, новостной статьи и видео, если они включены в объект ответа.

/*
* WebPages
* If the search response has web pages, the first result's name
* and url are printed.
*/
if (webData != null && webData.webPages() != null && webData.webPages().value() != null &&
        webData.webPages().value().size() > 0) {
    // find the first web page
    WebPage firstWebPagesResult = webData.webPages().value().get(0);

    if (firstWebPagesResult != null) {
        System.out.println(String.format("Webpage Results#%d", webData.webPages().value().size()));
        System.out.println(String.format("First web page name: %s ", firstWebPagesResult.name()));
        System.out.println(String.format("First web page URL: %s ", firstWebPagesResult.url()));
    } else {
        System.out.println("Couldn't find the first web result!");
    }
} else {
    System.out.println("Didn't find any web pages...");
}
/*
 * Images
 * If the search response has images, the first result's name
 * and url are printed.
 */
if (webData != null && webData.images() != null && webData.images().value() != null &&
        webData.images().value().size() > 0) {
    // find the first image result
    ImageObject firstImageResult = webData.images().value().get(0);

    if (firstImageResult != null) {
        System.out.println(String.format("Image Results#%d", webData.images().value().size()));
        System.out.println(String.format("First Image result name: %s ", firstImageResult.name()));
        System.out.println(String.format("First Image result URL: %s ", firstImageResult.contentUrl()));
    } else {
        System.out.println("Couldn't find the first image result!");
    }
} else {
    System.out.println("Didn't find any images...");
}
/*
 * News
 * If the search response has news articles, the first result's name
 * and url are printed.
 */
if (webData != null && webData.news() != null && webData.news().value() != null &&
        webData.news().value().size() > 0) {
    // find the first news result
    NewsArticle firstNewsResult = webData.news().value().get(0);
    if (firstNewsResult != null) {
        System.out.println(String.format("News Results#%d", webData.news().value().size()));
        System.out.println(String.format("First news result name: %s ", firstNewsResult.name()));
        System.out.println(String.format("First news result URL: %s ", firstNewsResult.url()));
    } else {
        System.out.println("Couldn't find the first news result!");
    }
} else {
    System.out.println("Didn't find any news articles...");
}

/*
 * Videos
 * If the search response has videos, the first result's name
 * and url are printed.
 */
if (webData != null && webData.videos() != null && webData.videos().value() != null &&
        webData.videos().value().size() > 0) {
    // find the first video result
    VideoObject firstVideoResult = webData.videos().value().get(0);

    if (firstVideoResult != null) {
        System.out.println(String.format("Video Results#%s", webData.videos().value().size()));
        System.out.println(String.format("First Video result name: %s ", firstVideoResult.name()));
        System.out.println(String.format("First Video result URL: %s ", firstVideoResult.contentUrl()));
    } else {
        System.out.println("Couldn't find the first video result!");
    }
} else {
    System.out.println("Didn't find any videos...");
}

Объявление метода main

В этом приложении метод main включает код, который создает экземпляр клиента, проверяет subscriptionKey и вызывает runSample. Не забудьте ввести действующий ключ подписки Azure, прежде чем продолжить работу.

public static void main(String[] args) {
    try {
        // Enter a valid subscription key for your account.
        final String subscriptionKey = "YOUR_SUBSCRIPTION_KEY";
        // Instantiate the client.
        BingWebSearchAPI client = BingWebSearchManager.authenticate(subscriptionKey);
        // Make a call to the Bing Web Search API.
        runSample(client);
    } catch (Exception e) {
        System.out.println(e.getMessage());
        e.printStackTrace();
    }
}

Запуск программы

А теперь запустите программу!

mvn compile exec:java

Очистка ресурсов

Удалите ключ подписки из кода программы после завершения проекта.

Дальнейшие действия

Примеры пакета SDK для Java для служб ИИ Azure

См. также раздел

Ссылка на пакет SDK для Java в Azure

Клиентская библиотека Поиска в Интернете Bing позволяет интегрировать поиск Bing в любое приложение Node.js. Из этого краткого руководства вы узнаете, как создать экземпляр клиента, отправить запрос и вывести ответ.

Хотите увидеть код прямо сейчас? Примеры для клиентских библиотек Поиска Bing для JavaScript доступны на сайте GitHub.

предварительные требования

Для работы с этим кратким руководством вам потребуется следующее:

Node.js 6 или более поздней версии;
ключ подписки;

Создание ресурса Azure

Чтобы начать работу с API Поиска в Интернете Bing, создайте один из следующих ресурсов Azure.

Ресурс Поиска Bing версии 7

доступен на портале Azure до удаления.
Используйте бесплатную ценовую категорию, чтобы опробовать службу, а затем выполните обновление до платного уровня для рабочей среды.

Ресурс для нескольких служб

доступен на портале Azure до удаления.
Используйте один и тот же ключ и конечную точку для приложений в нескольких службах ИИ Azure.

Настройка среды разработки

Давайте начнем с настройки среды разработки для проекта Node.js.

Создайте каталог для своего проекта:
```
mkdir YOUR_PROJECT
```
Создайте файл пакета:
```
cd YOUR_PROJECT
npm init
```
Теперь установите несколько модулей Azure и добавьте их в package.json:
```
npm install --save @azure/cognitiveservices-websearch
npm install --save @azure/ms-rest-azure-js
```

Создание проекта и объявление обязательных модулей

В том же каталоге, где находится package.json, создайте проект Node.js с помощью любой среды IDE или редактора. Например: sample.js.

Скопируйте в приложение следующий код: Он загружает модули, установленные в предыдущем разделе.

const CognitiveServicesCredentials = require('@azure/ms-rest-azure-js').CognitiveServicesCredentials;
const WebSearchAPIClient = require('@azure/cognitiveservices-websearch');

Создание экземпляра клиента

Этот код создает экземпляр клиента с помощью модуля @azure/cognitiveservices-websearch. Не забудьте ввести действующий ключ подписки Azure, прежде чем продолжить работу.

let credentials = new CognitiveServicesCredentials('YOUR-ACCESS-KEY');
let webSearchApiClient = new WebSearchAPIClient(credentials);

Выполнение запроса и вывод результатов

Используйте клиент для отправки запроса в Поиск в Интернете Bing. Если ответ содержит результаты для любого из элементов массива properties, в консоль выводится result.value.

webSearchApiClient.web.search('seahawks').then((result) => {
    let properties = ["images", "webPages", "news", "videos"];
    for (let i = 0; i < properties.length; i++) {
        if (result[properties[i]]) {
            console.log(result[properties[i]].value);
        } else {
            console.log(`No ${properties[i]} data`);
        }
    }
}).catch((err) => {
    throw err;
})

Запуск программы

А теперь запустите программу!

Очистка ресурсов

Удалите ключ подписки из кода программы после завершения проекта.

Дальнейшие действия

Примеры пакета SDK для служб ИИ Azure Node.js

См. также раздел

Справочник по пакету SDK Azure для Node

Клиентская библиотека Поиска в Интернете Bing позволяет интегрировать поиск Bing в любое приложение Python. В этом кратком руководстве описано, как отправлять запрос, получать ответ в формате JSON, фильтровать и анализировать результаты.

Хотите увидеть код прямо сейчас? Примеры для клиентских библиотек Поиска Bing для Python доступны на сайте GitHub.

Предварительные требования

Пакет SDK для поиска в Интернете Bing совместим с Python версии 2.7 или 3.6 и выше. Мы рекомендуем использовать для этого руководства виртуальное окружение.

Python версии 2.7 или 3.6 и выше
virtualenv для Python 2.7
venv для Python 3.x

Создание ресурса Azure

Чтобы начать работу с API Поиска в Интернете Bing, создайте один из следующих ресурсов Azure.

Ресурс Поиска Bing версии 7

доступен на портале Azure до удаления.
Используйте бесплатную ценовую категорию, чтобы опробовать службу, а затем выполните обновление до платного уровня для рабочей среды.

Ресурс для нескольких служб

доступен на портале Azure до удаления.
Используйте один и тот же ключ и конечную точку для приложений в нескольких службах ИИ Azure.

Создание и настройка виртуального окружения

Инструкции по установке и настройке виртуального окружения будут разными для версий Python 2.x и Python 3.x. Выполните описанные ниже шаги, чтобы создать и инициализировать виртуальное окружение.

Python 2.x

Создайте виртуальное окружение с virtualenv для Python 2.7:

virtualenv mytestenv

Активируйте созданное окружение:

cd mytestenv
source bin/activate

Установите зависимости пакета SDK Bing для поиска в Интернете:

python -m pip install azure-cognitiveservices-search-websearch

Python 3.x

Создайте виртуальное окружение с venv для Python 3.x:

python -m venv mytestenv

Активируйте созданное окружение:

mytestenv\Scripts\activate.bat

Установите зависимости пакета SDK Bing для поиска в Интернете:

cd mytestenv
python -m pip install azure-cognitiveservices-search-websearch

Создание клиента и вывод первых результатов

Итак, вы настроили виртуальное окружение и установили зависимости. Теперь давайте создадим клиент. Этот клиент будет обрабатывать запросы и ответы для API Поиска в Интернете Bing.

Если ответ содержит веб-страницы, изображения, новости или видео, будет выведен первый результат в каждой категории.

Создайте проект Python, используя любую IDE или любой текстовый редактор.

Скопируйте в проект приведенный ниже пример кода. В качестве endpoint может быть глобальная конечная точка, приведенная ниже, или конечная точка пользовательского поддомена, отображаемая на портале Azure для вашего ресурса.

# Import required modules.
from azure.cognitiveservices.search.websearch import WebSearchClient
from azure.cognitiveservices.search.websearch.models import SafeSearch
from msrest.authentication import CognitiveServicesCredentials

# Replace with your subscription key.
subscription_key = "YOUR_SUBSCRIPTION_KEY"

# Instantiate the client and replace with your endpoint.
client = WebSearchClient(endpoint="YOUR_ENDPOINT", credentials=CognitiveServicesCredentials(subscription_key))

# Make a request. Replace Yosemite if you'd like.
web_data = client.web.search(query="Yosemite")
print("\r\nSearched for Query# \" Yosemite \"")

'''
Web pages
If the search response contains web pages, the first result's name and url
are printed.
'''
if hasattr(web_data.web_pages, 'value'):

    print("\r\nWebpage Results#{}".format(len(web_data.web_pages.value)))

    first_web_page = web_data.web_pages.value[0]
    print("First web page name: {} ".format(first_web_page.name))
    print("First web page URL: {} ".format(first_web_page.url))

else:
    print("Didn't find any web pages...")

'''
Images
If the search response contains images, the first result's name and url
are printed.
'''
if hasattr(web_data.images, 'value'):

    print("\r\nImage Results#{}".format(len(web_data.images.value)))

    first_image = web_data.images.value[0]
    print("First Image name: {} ".format(first_image.name))
    print("First Image URL: {} ".format(first_image.url))

else:
    print("Didn't find any images...")

'''
News
If the search response contains news, the first result's name and url
are printed.
'''
if hasattr(web_data.news, 'value'):

    print("\r\nNews Results#{}".format(len(web_data.news.value)))

    first_news = web_data.news.value[0]
    print("First News name: {} ".format(first_news.name))
    print("First News URL: {} ".format(first_news.url))

else:
    print("Didn't find any news...")

'''
If the search response contains videos, the first result's name and url
are printed.
'''
if hasattr(web_data.videos, 'value'):

    print("\r\nVideos Results#{}".format(len(web_data.videos.value)))

    first_video = web_data.videos.value[0]
    print("First Videos name: {} ".format(first_video.name))
    print("First Videos URL: {} ".format(first_video.url))

else:
    print("Didn't find any videos...")

Замените значение SUBSCRIPTION_KEY действительным ключом подписки.
Замените YOUR_ENDPOINT URL-адресом конечной точки на портале и удалите фрагмент bing/v7.0 из конечной точки.
Запустите программу. Например: python your_program.py.

Определение функций и фильтрация результатов

Теперь, когда вы выполнили первый вызов к API поиска в Интернете Bing, давайте изучим несколько функций. В следующем разделе демонстрируются возможности пакета SDK по уточнению запросов и фильтрации результатов. Каждую из этих функций можно добавить в программу Python, созданную в предыдущем разделе.

Ограничение числа результатов, возвращаемых Bing

В этом примере используются параметры count и offset, которые позволяют ограничить число результатов, возвращаемых методом search пакета SDK. Для первого результата возвращаются name и url.

Добавьте следующий код в проект Python:

 # Declare the function.
 def web_results_with_count_and_offset(subscription_key):
     client = WebSearchAPI(CognitiveServicesCredentials(subscription_key))

     try:
         '''
         Set the query, offset, and count using the SDK's search method. See:
         https://learn.microsoft.com/python/api/azure-cognitiveservices-search-websearch/azure.cognitiveservices.search.websearch.operations.weboperations?view=azure-python.
         '''
         web_data = client.web.search(query="Best restaurants in Seattle", offset=10, count=20)
         print("\r\nSearching for \"Best restaurants in Seattle\"")

         if web_data.web_pages.value:
             '''
             If web pages are available, print the # of responses, and the first and second
             web pages returned.
             '''
             print("Webpage Results#{}".format(len(web_data.web_pages.value)))

             first_web_page = web_data.web_pages.value[0]
             print("First web page name: {} ".format(first_web_page.name))
             print("First web page URL: {} ".format(first_web_page.url))

         else:
             print("Didn't find any web pages...")

     except Exception as err:
         print("Encountered exception. {}".format(err))

Запустите программу.

Фильтрация по новостям и актуальности

В этом примере используются параметры response_filter и freshness для фильтрации результатов поиска в методе search пакета SDK. Будут возвращаться только те результаты поиска, которые соответствуют новостям и страницам, обнаруженным Bing за последние 24 часа. Для первого результата возвращаются name и url.

Добавьте следующий код в проект Python:

# Declare the function.
def web_search_with_response_filter(subscription_key):
    client = WebSearchAPI(CognitiveServicesCredentials(subscription_key))
    try:
        '''
        Set the query, response_filter, and freshness using the SDK's search method. See:
        https://learn.microsoft.com/python/api/azure-cognitiveservices-search-websearch/azure.cognitiveservices.search.websearch.operations.weboperations?view=azure-python.
        '''
        web_data = client.web.search(query="xbox",
            response_filter=["News"],
            freshness="Day")
        print("\r\nSearching for \"xbox\" with the response filter set to \"News\" and freshness filter set to \"Day\".")

        '''
        If news articles are available, print the # of responses, and the first and second
        articles returned.
        '''
        if web_data.news.value:

            print("# of news results: {}".format(len(web_data.news.value)))

            first_web_page = web_data.news.value[0]
            print("First article name: {} ".format(first_web_page.name))
            print("First article URL: {} ".format(first_web_page.url))

            print("")

            second_web_page = web_data.news.value[1]
            print("\nSecond article name: {} ".format(second_web_page.name))
            print("Second article URL: {} ".format(second_web_page.url))

        else:
            print("Didn't find any news articles...")

    except Exception as err:
        print("Encountered exception. {}".format(err))

# Call the function.
web_search_with_response_filter(subscription_key)

Запустите программу.

Использование безопасного поиска, счетчика ответов и фильтра повышения уровня

В этом примере используются параметры answer_count, promote и safe_search для фильтрации результатов поиска в методе search пакета SDK. Для первого результата возвращаются name и url.

Добавьте следующий код в проект Python:

# Declare the function.
def web_search_with_answer_count_promote_and_safe_search(subscription_key):

    client = WebSearchAPI(CognitiveServicesCredentials(subscription_key))

    try:
        '''
        Set the query, answer_count, promote, and safe_search parameters using the SDK's search method. See:
        https://learn.microsoft.com/python/api/azure-cognitiveservices-search-websearch/azure.cognitiveservices.search.websearch.operations.weboperations?view=azure-python.
        '''
        web_data = client.web.search(
            query="Niagara Falls",
            answer_count=2,
            promote=["videos"],
            safe_search=SafeSearch.strict  # or directly "Strict"
        )
        print("\r\nSearching for \"Niagara Falls\"")

        '''
        If results are available, print the # of responses, and the first result returned.
        '''
        if web_data.web_pages.value:

            print("Webpage Results#{}".format(len(web_data.web_pages.value)))

            first_web_page = web_data.web_pages.value[0]
            print("First web page name: {} ".format(first_web_page.name))
            print("First web page URL: {} ".format(first_web_page.url))

        else:
            print("Didn't see any Web data..")

    except Exception as err:
        print("Encountered exception. {}".format(err))

Запустите программу.

Очистка ресурсов

Удалите ключ подписки из кода программы и отключите виртуальное окружение, когда завершите работу с этим проектом.

Дальнейшие действия

Примеры пакета SDK для Python для служб ИИ Azure

См. также раздел

Справочник по пакету SDK Azure для Python

Краткое руководство. Использование клиентской библиотеки Поиска в Интернете Bing

Предварительные требования

Создание ресурса Azure

Создание проекта и установка зависимостей

Объявление зависимостей

Создание шаблонов для проекта

Создание запроса

Обработка ответа

Объявление метода main

Запуск приложения

Определение функций и фильтрация результатов

Ограничение числа результатов, возвращаемых Bing

Фильтрация новостей

Использование безопасного поиска, счетчика ответов и фильтра повышения уровня

Очистка ресурсов

Дальнейшие действия

Предварительные требования

Создание ресурса Azure

Создание проекта и настройка файла POM

Объявление зависимостей

Объявление класса BingWebSearchSample

Создание запроса

Обработка ответа

Объявление метода main

Запуск программы

Очистка ресурсов

Дальнейшие действия

См. также раздел

предварительные требования

Создание ресурса Azure

Настройка среды разработки

Создание проекта и объявление обязательных модулей

Создание экземпляра клиента

Выполнение запроса и вывод результатов

Запуск программы

Очистка ресурсов

Дальнейшие действия

См. также раздел

Предварительные требования

Создание ресурса Azure

Создание и настройка виртуального окружения

Python 2.x

Python 3.x

Создание клиента и вывод первых результатов

Определение функций и фильтрация результатов

Ограничение числа результатов, возвращаемых Bing

Фильтрация по новостям и актуальности

Использование безопасного поиска, счетчика ответов и фильтра повышения уровня

Очистка ресурсов

Дальнейшие действия

См. также раздел

Дополнительные ресурсы