警告
2020 年 10 月 30 日、Bing Search API は Azure AI サービスから Bing Search Services に移行されました。 このドキュメントは参考用に提供されています。 更新されたドキュメントについては、 Bing検索 API のドキュメントを参照してください。 Bing検索用の新しい Azure リソースを作成する手順については、「 Azure Marketplace を使用して Bing Search リソースを作成する」を参照してください。
このアップグレード ガイドでは、Bing Autosuggest API のバージョン 5 とバージョン 7 の間の変更について説明します。 このガイドを使用して、バージョン 7 を使用するようにアプリケーションを更新してください。
重大な変更
エンドポイント
- エンドポイントのバージョン番号が v5 から v7 に変更されました。 たとえば、https://api.cognitive.microsoft.com/bing/**v7.0**/Suggestions という例があります。
エラー応答オブジェクトとエラー コード
失敗したすべての要求に、応答本文に
ErrorResponseオブジェクトが含まれるようになりました。Errorオブジェクトに次のフィールドを追加しました。-
subCode—可能であれば、エラー コードを個別のバケットに分割します -
moreDetails—messageフィールドで説明されているエラーに関する追加情報
-
v5 エラー コードを、次の可能な
code値とsubCode値に置き換えられました。
| コード | サブコード | 説明 |
|---|---|---|
| ServerError | 予期しないエラー リソースエラー 未実装 |
Bingは、サブコード条件のいずれかが発生するたびに ServerError を返します。 HTTP 状態コードが 500 の場合、応答にはこれらのエラーが含まれます。 |
| 無効なリクエスト | パラメーターがありません パラメーター無効値 HTTP 許可されていません ブロックされました |
Bingは、要求の一部が無効な場合は常に InvalidRequest を返します。 たとえば、必須パラメーターがないか、パラメーター値が無効です。 エラーが ParameterMissing または ParameterInvalidValue の場合、HTTP 状態コードは 400 です。 エラーが HttpNotAllowed の場合、HTTP 状態コードは 410 です。 |
| レート制限を超えました | Bingは、1 秒あたりのクエリ数 (QPS) または月あたりのクエリ数 (QPM) クォータを超えるたびに RateLimitExceeded を返します。 Bingは、QPS を超えた場合は HTTP 状態コード 429、QPM を超えた場合は 403 を返します。 |
|
| 無効な認証 | 認証が見つかりません 認証冗長性 |
Bingは、呼び出し元Bing認証できない場合に InvalidAuthorization を返します。 たとえば、Ocp-Apim-Subscription-Key ヘッダーがないか、サブスクリプション キーが無効です。複数の認証方法を指定すると、冗長性が発生します。 エラーが InvalidAuthorization の場合、HTTP 状態コードは 401 です。 |
| 認証が不十分 | 認証無効 認証の有効期限が切れました |
呼び出し元がリソースにアクセスするアクセス許可を持っていない場合、Bingは InsufficientAuthorization を返します。 これは、サブスクリプション キーが無効になっているか、有効期限が切れている場合に発生する可能性があります。 エラーが InsufficientAuthorization の場合、HTTP 状態コードは 403 です。 |
- 次に、前のエラー コードを新しいコードにマップします。 v5 エラー コードに依存している場合は、それに応じてコードを更新してください。
| バージョン 5 のコード | バージョン 7 code.subCode |
|---|---|
| リクエストパラメーターがありません | 無効なリクエスト。パラメータが見つかりません。 |
| リクエストパラメータの無効な値 | 無効な要求。パラメータの無効な値 (InvalidRequest.ParameterInvalidValue) |
| リソースアクセス拒否 | 認証が不十分 |
| 許容容量超過 | レート制限を超えました |
| Qps制限を超えました | レート制限を超えました |
| 無効 | 認可不足.認可が無効 |
| 予期しないエラー | サーバーエラー.予期しないエラー |
| データソースエラー | サーバーエラー.リソースエラー |
| 認証が見つかりません | 無効な認証。認証が欠如しています。 |
| HTTP 許可されていません | 無効なリクエスト: Httpは許可されていません |
| ユーザーエージェントが見つかりません | 無効なリクエスト。パラメータが見つかりません。 |
| 未実装 | サーバーエラー.未実装 |
| 無効な認証 | 無効な認証 |
| 無効な認証方法 | 無効な認証 |
| 複数認証方法 | 無効な認証.認証の冗長性 |
| 期限切れの認証トークン | 認証不足.認証の有効期限が切れました |
| スコープ不足 | 認証が不十分 |
| ブロックされました | 無効なリクエスト。ブロックされました |