クイックスタート:Bing Web Search REST API と Node.js を使用して Web を検索する

[アーティクル]
05/22/2020

警告

2020 年 10 月 30 日に、Bing Search API は Azure AI サービスから Bing Search サービスに移行されました。このドキュメントは、参考用としてのみ提供されています。更新されたドキュメントについては、Bing search API のドキュメントを参照してください。 Bing 検索用の新しい Azure リソースを作成する手順については、「Azure Marketplace から Bing Search リソースを作成する」を参照してください。

このクイックスタートを使用して、Bing Web Search API を初めて呼び出してみましょう。この Node.js アプリケーションは、API に検索要求を送信して、JSON 応答を表示します。このアプリケーションは JavaScript で記述されていますが、この API はほとんどのプログラミング言語と互換性のある RESTful Web サービスです。

前提条件

このクイックスタートを実行するには、以下のものが必要です。

Node.js 6 以降
サブスクリプションキー

Azure リソースを作成する

次のいずれかの Azure リソースを作成して、Bing Web Search API の使用を開始します。

Bing Search v7 リソース

ご自身でリソースを削除するまでは Azure portal からご利用いただけます。
Free 価格レベルを使ってサービスを試用し、後から運用環境用の有料レベルにアップグレードします。

マルチサービスリソース

ご自身でリソースを削除するまでは Azure portal からご利用いただけます。
複数の Azure AI サービス全体で同じキーとエンドポイントをアプリケーションに使用します。

プロジェクトの作成と必要なモジュールの宣言

お気に入りの IDE またはエディターで新しい Node.js プロジェクトを作成します。次のコードスニペットを、ご自分のプロジェクトの search.js という名前のファイルにコピーします。

// Use this simple app to query the Bing Web Search API and get a JSON response.
// Usage: node search.js "your query".
const https = require('https')

サブスクリプションキーの設定

このコードスニペットでは、AZURE_SUBSCRIPTION_KEY 環境変数を使用してお使いのサブスクリプションキーを格納します。これは、お使いのコードをデプロイするときに、キーが誤って露出されてしまうのを防ぐ優れたやり方です。

環境変数を使用について詳しくない場合や、このアプリをできるだけ早く実行したい場合は、文字列として設定されたご自分のサブスクリプションキーを、process.env['AZURE_SUBSCRIPTION_KEY'] に置き換えます。

const SUBSCRIPTION_KEY = process.env['AZURE_SUBSCRIPTION_KEY']
if (!SUBSCRIPTION_KEY) {
  throw new Error('AZURE_SUBSCRIPTION_KEY is not set.')
}

要求を行う関数の作成

この関数は、セキュリティで保護された GET 要求を作成し、検索クエリをクエリパラメーターとしてパスに保存します。

hostname 値には、次のコードのグローバルエンドポイントを使用するか、Azure portal に表示される、お使いのリソースのカスタムサブドメインエンドポイントを使用できます。
無効な文字をエスケープするには、encodeURIComponent を使用します。サブスクリプションキーはヘッダーに渡されます。
コールバックは、JSON 本文を集約する data イベント、問題があればログに記録する error イベント、およびメッセージが完了したと見なす必要があるタイミングを知るための end イベントにサブスクライブしている応答を受け取ります。
アプリが完成すると、該当するヘッダーとメッセージ本文が出力されます。ご自分の好みに合わせて、その色を調整し、深さを設定することができます。 1 の深さでは、応答の概要がわかります。

function bingWebSearch(query) {
  https.get({
    hostname: 'api.cognitive.microsoft.com',
    path:     '/bing/v7.0/search?q=' + encodeURIComponent(query),
    headers:  { 'Ocp-Apim-Subscription-Key': SUBSCRIPTION_KEY },
  }, res => {
    let body = ''
    res.on('data', part => body += part)
    res.on('end', () => {
      for (var header in res.headers) {
        if (header.startsWith("bingapis-") || header.startsWith("x-msedge-")) {
          console.log(header + ": " + res.headers[header])
        }
      }
      console.log('\nJSON Response:\n')
      console.dir(JSON.parse(body), { colors: false, depth: null })
    })
    res.on('error', e => {
      console.log('Error: ' + e.message)
      throw e
    })
  })
}

クエリの取得

クエリを見つけるためのプログラムの引数を確認してみましょう。最初の引数はノードへのパスで、2 つ目がファイル名、3 つ目がご自分のクエリです。クエリがない場合は、"Microsoft Azure AI Services" の既定のクエリが使用されます。

const query = process.argv[2] || 'Microsoft Cognitive Services'

要求の実行と応答の出力

これですべてが定義されたので、関数を呼び出しましょう。

bingWebSearch(query)

すべてをまとめた配置

最後の手順は、ご自分のコードを node search.js "<your query>" のコマンドで実行することです。

作成したコードを完全なプログラムと比較したい場合は、以下を参照してください。

const https = require('https')
const SUBSCRIPTION_KEY = process.env['AZURE_SUBSCRIPTION_KEY']
if (!SUBSCRIPTION_KEY) {
  throw new Error('Missing the AZURE_SUBSCRIPTION_KEY environment variable')
}
function bingWebSearch(query) {
  https.get({
    hostname: 'api.cognitive.microsoft.com',
    path:     '/bing/v7.0/search?q=' + encodeURIComponent(query),
    headers:  { 'Ocp-Apim-Subscription-Key': SUBSCRIPTION_KEY },
  }, res => {
    let body = ''
    res.on('data', part => body += part)
    res.on('end', () => {
      for (var header in res.headers) {
        if (header.startsWith("bingapis-") || header.startsWith("x-msedge-")) {
          console.log(header + ": " + res.headers[header])
        }
      }
      console.log('\nJSON Response:\n')
      console.dir(JSON.parse(body), { colors: false, depth: null })
    })
    res.on('error', e => {
      console.log('Error: ' + e.message)
      throw e
    })
  })
}
const query = process.argv[2] || 'Microsoft Cognitive Services'
bingWebSearch(query)

JSON の応答例

Bing Web Search API からの応答は、JSON として返されます。このサンプル応答は、1 つの結果だけを表示するように切り詰められています。

{
  "_type": "SearchResponse",
  "queryContext": {
    "originalQuery": "Microsoft Cognitive Services"
  },
  "webPages": {
    "webSearchUrl": "https://www.bing.com/search?q=Microsoft+cognitive+services",
    "totalEstimatedMatches": 22300000,
    "value": [
      {
        "id": "https://api.cognitive.microsoft.com/api/v7/#WebPages.0",
        "name": "Microsoft Cognitive Services",
        "url": "https://www.microsoft.com/cognitive-services",
        "displayUrl": "https://www.microsoft.com/cognitive-services",
        "snippet": "Knock down barriers between you and your ideas. Enable natural and contextual interaction with tools that augment users' experiences via the power of machine-based AI. Plug them in and bring your ideas to life.",
        "deepLinks": [
          {
            "name": "Face",
            "url": "https://azure.microsoft.com/services/cognitive-services/face/",
            "snippet": "Add facial recognition to your applications to detect, identify, and verify faces using a Face service from Microsoft Azure. ... Cognitive Services; Face service;"
          },
          {
            "name": "Text Analytics",
            "url": "https://azure.microsoft.com/services/cognitive-services/text-analytics/",
            "snippet": "Cognitive Services; Text Analytics API; Text Analytics API . Detect sentiment, ... you agree that Microsoft may store it and use it to improve Microsoft services, ..."
          },
          {
            "name": "Computer Vision API",
            "url": "https://azure.microsoft.com/products/ai-services?activetab=pivot:visiontab",
            "snippet": "Extract the data you need from images using optical character recognition and image analytics with Computer Vision APIs from Microsoft Azure."
          },
          {
            "name": "Emotion",
            "url": "https://www.microsoft.com/cognitive-services/emotion-api",
            "snippet": "Cognitive Services Emotion API - microsoft.com"
          },
          {
            "name": "Bing Speech API",
            "url": "https://azure.microsoft.com/services/cognitive-services/speech/",
            "snippet": "Add speech recognition to your applications, including text to speech, with a speech API from Microsoft Azure. ... Cognitive Services; Bing Speech API;"
          },
          {
            "name": "Get Started for Free",
            "url": "https://azure.microsoft.com/services/cognitive-services/",
            "snippet": "Add vision, speech, language, and knowledge capabilities to your applications using intelligence APIs and SDKs from Cognitive Services."
          }
        ]
      }
    ]
  },
  "relatedSearches": {
    "id": "https://api.cognitive.microsoft.com/api/v7/#RelatedSearches",
    "value": [
      {
        "text": "microsoft bot framework",
        "displayText": "microsoft bot framework",
        "webSearchUrl": "https://www.bing.com/search?q=microsoft+bot+framework"
      },
      {
        "text": "microsoft cognitive services youtube",
        "displayText": "microsoft cognitive services youtube",
        "webSearchUrl": "https://www.bing.com/search?q=microsoft+cognitive+services+youtube"
      },
      {
        "text": "microsoft cognitive services search api",
        "displayText": "microsoft cognitive services search api",
        "webSearchUrl": "https://www.bing.com/search?q=microsoft+cognitive+services+search+api"
      },
      {
        "text": "microsoft cognitive services news",
        "displayText": "microsoft cognitive services news",
        "webSearchUrl": "https://www.bing.com/search?q=microsoft+cognitive+services+news"
      },
      {
        "text": "ms cognitive service",
        "displayText": "ms cognitive service",
        "webSearchUrl": "https://www.bing.com/search?q=ms+cognitive+service"
      },
      {
        "text": "microsoft cognitive services text analytics",
        "displayText": "microsoft cognitive services text analytics",
        "webSearchUrl": "https://www.bing.com/search?q=microsoft+cognitive+services+text+analytics"
      },
      {
        "text": "microsoft cognitive services toolkit",
        "displayText": "microsoft cognitive services toolkit",
        "webSearchUrl": "https://www.bing.com/search?q=microsoft+cognitive+services+toolkit"
      },
      {
        "text": "microsoft cognitive services api",
        "displayText": "microsoft cognitive services api",
        "webSearchUrl": "https://www.bing.com/search?q=microsoft+cognitive+services+api"
      }
    ]
  },
  "rankingResponse": {
    "mainline": {
      "items": [
        {
          "answerType": "WebPages",
          "resultIndex": 0,
          "value": {
            "id": "https://api.cognitive.microsoft.com/api/v7/#WebPages.0"
          }
        }
      ]
    },
    "sidebar": {
      "items": [
        {
          "answerType": "RelatedSearches",
          "value": {
            "id": "https://api.cognitive.microsoft.com/api/v7/#RelatedSearches"
          }
        }
      ]
    }
  }
}

次のステップ

Bing Web Search API 単一ページアプリのチュートリアル

クイックスタート:Bing Web Search REST API と Node.js を使用して Web を検索する

前提条件

Azure リソースを作成する

プロジェクトの作成と必要なモジュールの宣言

サブスクリプションキーの設定

要求を行う関数の作成

クエリの取得

要求の実行と応答の出力

すべてをまとめた配置

JSON の応答例

次のステップ

関連項目

その他のリソース

クイック スタート:Bing Web Search REST API と Node.js を使用して Web を検索する

前提条件

Azure リソースを作成する

プロジェクトの作成と必要なモジュールの宣言

サブスクリプション キーの設定

要求を行う関数の作成

クエリの取得

要求の実行と応答の出力

すべてをまとめた配置

JSON の応答例

次のステップ

関連項目

その他のリソース

クイックスタート:Bing Web Search REST API と Node.js を使用して Web を検索する

サブスクリプションキーの設定