Spell Check API のアップグレード ガイド
警告
2020 年 10 月 30 日に、Bing Search API は Azure AI サービスから Bing Search サービスに移行されました。 このドキュメントは、参考用としてのみ提供されています。 更新されたドキュメントについては、Bing search API のドキュメントを参照してください。 Bing 検索用の新しい Azure リソースを作成する手順については、「Azure Marketplace から Bing Search リソースを作成する」を参照してください。
このアップグレード ガイドでは、Bing Spell Check API のバージョン 5 とバージョン 7 の間の変更を識別します。 このガイドは、バージョン 7 を使用するために更新する必要のあるアプリケーションの部分を識別するのに役立ちます。
重大な変更
エンドポイント
- エンドポイントのバージョン番号は、v5 から v7 に変更されました。 たとえば、「
https://api.cognitive.microsoft.com/bing/v7.0/spellcheck」のように入力します。
エラー応答オブジェクトとエラー コード
すべての失敗した要求には、応答本文内に
ErrorResponseオブジェクトが含まれるようになりました。Errorオブジェクトに次のフィールドが追加されました。subCode—エラー コードを別個のバケットに分割します (可能な場合)moreDetails—messageフィールドで説明されているエラーに関する追加情報
v5 エラー コードを次の可能な
codeおよびsubCode値に置き換えました。
| コード | サブコード | 説明 |
|---|---|---|
| ServerError | UnexpectedError ResourceError NotImplemented |
サブコード条件のいずれかが発生するたびに、Bing は ServerError を返します。 HTTP 状態コードが 500 の場合、応答にはこれらのエラーが含まれます。 |
| InvalidRequest | ParameterMissing ParameterInvalidValue HttpNotAllowed Blocked |
要求の一部が有効でない場合に Bing は InvalidRequest を返します。 たとえば、必要なパラメーターが不足している場合や、パラメーター値が無効な場合です。 エラーが ParameterMissing または ParameterInvalidValue の場合、HTTP 状態コードは 400 です。 エラーが HttpNotAllowed の場合、HTTP 状態コードは 410 です。 |
| RateLimitExceeded | 1 秒あたりのクエリ数 (QPS) または 1 か月あたりのクエリ数 (QPM) のクォータを超えると、Bing は RateLimitExceeded を返します。 QPS を超えた場合、Bing は HTTP 状態コード 429 を返し、QPM を超過した場合に 403 を返します。 |
|
| InvalidAuthorization | AuthorizationMissing AuthorizationRedundancy |
Bing は、呼び出し元を認証できない場合に InvalidAuthorization を返します。 たとえば、Ocp-Apim-Subscription-Key ヘッダーがない場合や、サブスクリプション キーが無効な場合です。冗長性は、複数の認証方法を指定した場合に発生します。 エラーが InvalidAuthorization の場合、HTTP 状態コードは 401 です。 |
| InsufficientAuthorization | AuthorizationDisabled AuthorizationExpired |
呼び出し元がリソースに対するアクセス許可を備えていない場合、Bing は InsufficientAuthorization を返します。 これは、サブスクリプション キーが無効になっているか、期限が切れている場合に発生することがあります。 エラーが InsufficientAuthorization の場合、HTTP 状態コードは 403 です。 |
- 以前のエラー コードと新しいコードのマッピングを次に示します。 v5 エラー コードに依存していた場合は、コードを適宜更新してください。
| バージョン 5 コード | バージョン 7 コード.サブコード |
|---|---|
| RequestParameterMissing | InvalidRequest.ParameterMissing |
| RequestParameterInvalidValue | InvalidRequest.ParameterInvalidValue |
| ResourceAccessDenied | InsufficientAuthorization |
| ExceededVolume | RateLimitExceeded |
| ExceededQpsLimit | RateLimitExceeded |
| 無効 | InsufficientAuthorization.AuthorizationDisabled |
| UnexpectedError | ServerError.UnexpectedError |
| DataSourceErrors | ServerError.ResourceError |
| AuthorizationMissing | InvalidAuthorization.AuthorizationMissing |
| HttpNotAllowed | InvalidRequest.HttpNotAllowed |
| UserAgentMissing | InvalidRequest.ParameterMissing |
| NotImplemented | ServerError.NotImplemented |
| InvalidAuthorization | InvalidAuthorization |
| InvalidAuthorizationMethod | InvalidAuthorization |
| MultipleAuthorizationMethod | InvalidAuthorization.AuthorizationRedundancy |
| ExpiredAuthorizationToken | InsufficientAuthorization.AuthorizationExpired |
| InsufficientScope | InsufficientAuthorization |
| Blocked | InvalidRequest.Blocked |