ISpellCheckClient.SpellCheckerWithHttpMessagesAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
Bing Spell Check API を使用して、コンテキストに応じた文法とスペルのチェックを実行できます。 Bing では、機械学習と統計的機械翻訳を活用して、常に進化する高度にコンテキストに応じたアルゴリズムを動的にトレーニングする Web ベースのスペル チェック機能を開発しています。 このスペル チェック機能は、Web 検索とドキュメントの大規模なコーパスに基づいています。
public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Language.SpellCheck.Models.SpellCheckModel>> SpellCheckerWithHttpMessagesAsync (string text, string acceptLanguage = default, string pragma = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, string actionType = default, string appName = default, string countryCode = default, string clientMachineName = default, string docId = default, string market = default, string sessionId = default, string setLang = default, string userId = default, string mode = default, string preContextText = default, string postContextText = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);abstract member SpellCheckerWithHttpMessagesAsync : string * string * string * string * string * string * string * string * string * string * string * string * string * string * string * string * string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Language.SpellCheck.Models.SpellCheckModel>>Public Function SpellCheckerWithHttpMessagesAsync (text As String, Optional acceptLanguage As String = Nothing, Optional pragma As String = Nothing, Optional userAgent As String = Nothing, Optional clientId As String = Nothing, Optional clientIp As String = Nothing, Optional location As String = Nothing, Optional actionType As String = Nothing, Optional appName As String = Nothing, Optional countryCode As String = Nothing, Optional clientMachineName As String = Nothing, Optional docId As String = Nothing, Optional market As String = Nothing, Optional sessionId As String = Nothing, Optional setLang As String = Nothing, Optional userId As String = Nothing, Optional mode As String = Nothing, Optional preContextText As String = Nothing, Optional postContextText As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of SpellCheckModel))パラメーター
- text
- String
スペル ミスと文章校正のエラーをチェックするテキスト文字列。 テキスト文字列、preContextText 文字列、および postContextText 文字列の合計長は、10,000 文字を超えることはできません。 このパラメーターは、GET 要求のクエリ文字列または POST 要求の本文で指定できます。 クエリ文字列の長さの制限のため、短い文字列のみをチェックしない限り、通常は POST 要求を使用します。
- acceptLanguage
- String
ユーザー インターフェイス文字列に使用する 1 つ以上の言語のコンマ区切りのリスト。 リストでは優先度の高いものから順に指定します。 必要な形式などの追加情報については、 RFC2616 を参照してください。 このヘッダーと setLang クエリ パラメーターは相互に排他的です。両方を指定しないでください。 このヘッダーを設定する場合は、cc クエリ パラメーターも指定する必要があります。 Bingでは、リストから最初にサポートされている言語を使用し、その言語と cc パラメーター値を組み合わせて、結果を返す市場を決定します。 リストにサポートされている言語が含まれていない場合、Bingは要求をサポートする最も近い言語と市場を検索し、指定された言語ではなく集計または既定の市場を結果に使用できます。 このヘッダーと cc クエリ パラメーターは、複数の言語を指定する場合にのみ使用する必要があります。それ以外の場合は、mkt クエリ パラメーターと setLang クエリ パラメーターを使用する必要があります。 ユーザー インターフェイス文字列は、ユーザー インターフェイスでラベルとして使われる文字列です。 JSON 応答オブジェクトには、ユーザー インターフェイス文字列はほとんどありません。 応答オブジェクト内の Bing.com プロパティへのリンクは、指定した言語を適用します。
- pragma
- String
既定では、Bing はキャッシュされたコンテンツがある場合にそれを返します。 キャッシュされたコンテンツを Bing が返さないようにするには、Pragma ヘッダーを no-cache に設定します (例: Pragma: no-cache)。
- userAgent
- String
要求送信元のユーザー エージェント。 Bing では、モバイル ユーザーに最適なエクスペリエンスを提供するためにユーザー エージェントが使用されます。 省略可能ですが、常にこのヘッダーを指定することを強くお勧めします。 ユーザー エージェントは、一般的に使用されるブラウザーが送信する文字列と同じである必要があります。 ユーザー エージェントについては、RFC 2616 を参照してください。
- clientId
- String
このヘッダーは、Bing API の呼び出し間で一貫性のある動作をユーザーに提供するために Bing によって使用されます。 Bing によって、新しい機能と改善点が頻繁にフライト化されます。そして、トラフィックを異なるフライトに割り当てるためのキーとして、クライアント ID が使用されます。 複数の要求に対してユーザーの同じクライアント ID を使用しないと、ユーザーが複数の競合するフライトに割り当てられる可能性があります。 複数の競合するフライトに割り当てられると、ユーザー エクスペリエンスの一貫性がなくなる場合があります。 たとえば、2 番目の要求に 1 番目とは異なるフライトが割り当てられていると、エクスペリエンスが予期しないものになる可能性があります。 また、クライアント ID は、そのクライアント ID の検索履歴に合わせて Web の結果を調整し、ユーザーにリッチなエクスペリエンスを提供するために Bing によって使用される場合があります。 このヘッダーは、クライアント ID で生成されたアクティビティを分析して結果の順位付けを向上させるために Bing によって使用されることもあります。 関連性の向上は、Bing API によって提供される結果の品質向上に役立ち、API コンシューマーのクリックスルー率の向上を実現します。 重要: このヘッダーは省略可能ですが、必須であると考える必要があります。 同じエンド ユーザーとデバイスの組み合わせによる複数の要求に対してクライアント ID を保持することで、1) API コンシューマーが一貫性のあるユーザー エクスペリエンスを受け取ることができ、2) Bing API からの結果の品質向上を通じてクリックスルー率の向上が実現します。 デバイスでアプリケーションを使用する各ユーザーは、Bing によって生成された一意のクライアント ID を持っている必要があります。 このヘッダーを要求に含めない場合、Bing によって ID が生成され、それが X-MSEdge-ClientID 応答ヘッダーで返されます。 このヘッダーを要求に含めるべきでない唯一の場合は、ユーザーがそのデバイスでアプリを初めて使用するときです。 そのユーザーのためにアプリによってデバイスで実行される各 Bing API 要求で、クライアント ID を使用します。 クライアント ID を保持します。 ブラウザー アプリで ID を永続化するには、永続的な HTTP Cookie を使用して ID がすべてのセッションで確実に使用されるようにします。 セッション Cookie は使用しないようにしてください。 モバイル アプリなど、他のアプリの場合は、デバイスの永続的ストレージを使用して ID を保持します。 次にそのデバイスでユーザーがアプリを使用するときに、保持したクライアント ID を取得します。 Bing の応答には、このヘッダーが含まれる場合と含まれない場合があります。 このヘッダーが応答に含まれる場合、クライアント ID をキャプチャして、ユーザーのためにそのデバイスで実行される後続のすべての Bing 要求でそれを使用します。 X-MSEdge-ClientID を含める場合、要求には Cookie を含めないようにしてください。
- clientIp
- String
クライアント デバイスの IPv4 アドレスまたは IPv6 アドレス。 IP アドレスは、ユーザーの位置情報の検出に使用されます。 位置情報は、安全な検索動作を決定するために Bing によって使用されます。 省略可能ですが、このヘッダーと X-Search-Location ヘッダーは常に指定することをお勧めします。 (最後のオクテットを 0 に変更するなど) アドレスを難読化しないようにしてください。 アドレスを難読化すると、デバイスの実際の場所から離れた場所が検出され、Bing から誤った結果が提供される可能性があります。
- location
- String
クライアントの地理的な場所を示す、キーと値のペアのセミコロン区切りリストです。 位置情報は、安全な検索動作を決定して関連するローカル コンテンツを返すために、Bing によって使用されます。 キーと値のペアは、<キー>:<値> の形式で指定します。 ユーザーの場所の指定に使用するキーは次のとおりです。 lat (必須): クライアントの場所の緯度 (度単位)。 緯度は、-90.0 以上、+90.0 以下である必要があります。 負の値は南半球の緯度を示し、正の値は北半球の緯度を示します。 long (必須): クライアントの場所の経度 (度単位)。 経度は、-180.0 以上、+180.0 以下である必要があります。 負の値は西半球の経度を示し、正の値は東半球の経度を示します。 re (必須): 座標の水平方向の精度を指定する半径 (メートル単位)。 デバイスの位置情報サービスによって返される値を渡します。 一般的な値は、GPS/Wi-Fi の 22 m、携帯電話基地局の三角測量の 380 m、IP 逆引き参照の 18,000 m などです。 ts (省略可能): クライアントが場所にあった時の UTC UNIX タイムスタンプ。 (UNIX タイムスタンプは、1970 年 1 月 1 日以降の秒数です)。head (省略可能): クライアントの相対見出しまたは移動方向。 移動方向は、真北を基準として時計回りに 0 から 360 度で指定します。 sp キーが 0 以外の場合にのみ、このキーを指定します。 sp (省略可能): クライアント デバイスが移動している水平方向の速度 (速度)(1 秒あたりのメートル単位)。 alt (省略可能): クライアント デバイスの高度 (メートル単位)。 are (省略可能): 座標の垂直方向の精度を指定する半径 (メートル単位)。 alt キーを指定する場合にのみ、このキーを指定します。 多くのキーは省略可能ですが、提供する情報が多いほど、場所の結果の正確さが増します。 省略可能ですが、ユーザーの地理的な場所は常に指定することをお勧めします。 位置情報を提供することは、クライアントの IP アドレスがユーザーの物理的な場所を正確に反映していない場合 (たとえば、クライアントによって VPN が使用されている場合) に特に重要です。 最適な結果を得るには、このヘッダーと X-Search-ClientIP ヘッダーを含める必要がありますが、少なくともこのヘッダーを含める必要があります。
- actionType
- String
要求が対話型セッションから送信されたか、ページ読み込みから送信されたかを判断するためにログによって使用される文字列。 使用できる値を次に示します。 1) 編集—要求は対話型セッションからの 2) 読み込み—要求はページロードからのです。 使用可能な値は次のとおりです: 'Edit'、'Load'
- appName
- String
アプリの一意の名前。 名前は、Bingで認識されている必要があります。 一意のアプリ名を取得するために以前にBingに連絡していない限り、このパラメーターを含めないでください。 一意の名前を取得するには、Bing Business Development マネージャーにお問い合わせください。
- countryCode
- String
結果を取得する国の 2 文字の国番号です。 この API は、米国市場のみをサポートします。 このクエリ パラメーターを指定する場合は、 に設定する必要があります。 このパラメーターを設定する場合は、Accept-Language ヘッダーも指定する必要があります。 Bingでは、言語リストから最初にサポートされている言語を使用し、その言語と指定した国コードを組み合わせて、結果を返す市場を決定します。 言語リストにサポートされている言語が含まれていない場合は、Bing要求をサポートする最も近い言語と市場を検索するか、指定された言語ではなく集計または既定の市場を結果に使用できます。 複数の言語を指定する場合にのみ、このクエリ パラメーターと Accept-Language クエリ パラメーターを使用する必要があります。それ以外の場合は、mkt クエリ パラメーターと setLang クエリ パラメーターを使用する必要があります。 このパラメーターと mkt クエリ パラメーターは相互に排他的なので、両方指定することはできません。
- clientMachineName
- String
要求の元になっているデバイスの一意の名前。 デバイスごとに一意の値を生成します (値は重要ではありません)。 このサービスでは、ID を使用して問題をデバッグし、修正の品質を向上させます。
- docId
- String
テキストが属するドキュメントを識別する一意の ID。 ドキュメントごとに一意の値を生成します (値は重要ではありません)。 このサービスでは、ID を使用して問題をデバッグし、修正の品質を向上させます。
- market
- String
結果の取得元の市場。 既知の場合は、常に市場を指定することを強くお勧めします。 市場を指定すると、Bing が要求をルーティングして最適な応答を返すのに役立ちます。 このパラメーターと cc クエリ パラメーターは相互に排他的なので、両方指定することはできません。
- sessionId
- String
このユーザー セッションを識別する一意の ID。 ユーザー セッションごとに一意の値を生成します (値は重要ではありません)。 サービスは ID を使用して、問題のデバッグと修正の品質の向上に役立ちます
- setLang
- String
ユーザー インターフェイス文字列に使用する言語。 ISO 639-1 の 2 文字言語コードを使って言語を指定します。 たとえば、英語の言語コードは EN です。 既定値は EN (英語) です。 省略可能ですが、常に言語を指定することをお勧めします。 通常、setLang は、ユーザーが別の言語で表示するユーザー インターフェイス文字列を必要とする場合を除き、mkt で指定された同じ言語に設定します。 このパラメーターと Accept-Language ヘッダーは相互に排他的なので、両方は指定しないでください。 ユーザー インターフェイス文字列は、ユーザー インターフェイスでラベルとして使われる文字列です。 JSON 応答オブジェクトには、いくつかのユーザー インターフェイス文字列があります。 また、応答オブジェクト内の Bing.com プロパティへのリンクには、指定された言語が適用されます。
- userId
- String
ユーザーを識別する一意の ID。 ユーザーごとに一意の値を生成します (値は重要ではありません)。 このサービスでは、ID を使用して問題をデバッグし、修正の品質を向上させます。
- mode
- String
実行するスペル チェックと文章校正の種類。 使用できる値を次に示します (値では大文字と小文字が区別されません)。 既定値は Proof です。 1) 文章校正 - ほとんどのスペルミスや文章校正の間違いを見つけます。 2) スペル - スペル ミスの多くを検索しますが、Proof がキャッチする文法エラーの一部 (大文字と小文字や繰り返しの単語など) が見つかりません。 使用可能な値は次のとおりです: 'proof'、'spell'
- preContextText
- String
テキスト文字列にコンテキストを提供する文字列。 たとえば、テキスト文字列の花びらは有効です。 ただし、preContextText を bike に設定すると、コンテキストが変更され、テキスト文字列が無効になります。 この場合、API は花びらをペダルに変更することを提案します (自転車のペダルのように)。 このテキストは、文章校正やスペル ミスのチェックは行われません。 テキスト文字列、preContextText 文字列、および postContextText 文字列の合計長は、10,000 文字を超えることはできません。 このパラメーターは、GET 要求のクエリ文字列または POST 要求の本文で指定できます。
- postContextText
- String
テキスト文字列にコンテキストを提供する文字列。 たとえば、読み取られたテキスト文字列は有効です。 ただし、postContextText を carpet に設定すると、コンテキストが変更され、テキスト文字列が無効になります。 この場合、API は、読み取りを (赤いカーペットのように) 赤に変更することを提案します。 このテキストは、文章校正やスペル ミスのチェックは行われません。 テキスト文字列、preContextText 文字列、および postContextText 文字列の合計長は、10,000 文字を超えることはできません。 このパラメーターは、GET 要求のクエリ文字列または POST 要求の本文で指定できます。
- customHeaders
- Dictionary<String,List<String>>
要求に追加されるヘッダー。
- cancellationToken
- CancellationToken
キャンセル トークン。
戻り値
適用対象
Azure SDK for .NET