CustomInstance.SearchWithHttpMessagesAsync メソッド

リファレンス

定義

名前空間:: Microsoft.Azure.CognitiveServices.Search.CustomSearch

アセンブリ:: Microsoft.Azure.CognitiveServices.Search.CustomSearch.dll

パッケージ:: Microsoft.Azure.CognitiveServices.Search.CustomSearch v2.0.0

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

カスタム検索 API を使用すると、Bingに検索クエリを送信し、Web のカスタムビューで見つかった Web ページを取得できます。

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.SearchResponse>> SearchWithHttpMessagesAsync (string customConfig, string query, string acceptLanguage = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, string countryCode = default, int? count = default, string market = "en-us", int? offset = default, string safeSearch = default, string setLang = default, bool? textDecorations = default, string textFormat = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member SearchWithHttpMessagesAsync : string * string * string * string * string * string * string * string * Nullable<int> * string * Nullable<int> * string * string * Nullable<bool> * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.SearchResponse>>
override this.SearchWithHttpMessagesAsync : string * string * string * string * string * string * string * string * Nullable<int> * string * Nullable<int> * string * string * Nullable<bool> * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.SearchResponse>>

Public Function SearchWithHttpMessagesAsync (customConfig As String, query As String, Optional acceptLanguage As String = Nothing, Optional userAgent As String = Nothing, Optional clientId As String = Nothing, Optional clientIp As String = Nothing, Optional location As String = Nothing, Optional countryCode As String = Nothing, Optional count As Nullable(Of Integer) = Nothing, Optional market As String = "en-us", Optional offset As Nullable(Of Integer) = Nothing, Optional safeSearch As String = Nothing, Optional setLang As String = Nothing, Optional textDecorations As Nullable(Of Boolean) = Nothing, Optional textFormat As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of SearchResponse))

パラメーター

customConfig: String

カスタム検索構成の識別子

query: String

ユーザーの検索クエリ用語。用語が空ではない可能性があります。この用語には、高度な演算子Bing含まれる場合があります。たとえば、結果を特定のドメインに制限するには、site: 演算子を使用します。

acceptLanguage: String

ユーザーインターフェイス文字列に使用する 1 つ以上の言語のコンマ区切りのリスト。リストでは優先度の高いものから順に指定します。必要な形式などの追加情報については、 RFC2616 を参照してください。このヘッダーと setLang クエリパラメーターは相互に排他的です。両方を指定しないでください。このヘッダーを設定する場合は、cc クエリパラメーターも指定する必要があります。 Bingでは、リストから最初にサポートされている言語を使用し、その言語と cc パラメーター値を組み合わせて、結果を返す市場を決定します。リストにサポートされている言語が含まれていない場合、Bingは要求をサポートする最も近い言語と市場を検索し、指定された言語ではなく集計または既定の市場を結果に使用できます。このヘッダーと cc クエリパラメーターは、複数の言語を指定する場合にのみ使用する必要があります。それ以外の場合は、mkt クエリパラメーターと setLang クエリパラメーターを使用する必要があります。ユーザーインターフェイス文字列は、ユーザーインターフェイスでラベルとして使われる文字列です。 JSON 応答オブジェクトには、ユーザーインターフェイス文字列はほとんどありません。応答オブジェクト内の Bing.com プロパティへのリンクは、指定した言語を適用します。

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-MSEdge-ClientIP ヘッダーを含める必要がありますが、最低限、このヘッダーを含めることをお勧めします。

countryCode: String

結果を取得する国の 2 文字の国番号です。この API は、米国市場のみをサポートします。このクエリパラメーターを指定する場合は、に設定する必要があります。このパラメーターを設定する場合は、Accept-Language ヘッダーも指定する必要があります。 Bingでは、言語リストから最初にサポートされている言語を使用し、その言語と指定した国コードを組み合わせて、結果を返す市場を決定します。言語リストにサポートされている言語が含まれていない場合は、Bing要求をサポートする最も近い言語と市場を検索するか、指定された言語ではなく集計または既定の市場を結果に使用できます。複数の言語を指定する場合にのみ、このクエリパラメーターと Accept-Language クエリパラメーターを使用する必要があります。それ以外の場合は、mkt クエリパラメーターと setLang クエリパラメーターを使用する必要があります。このパラメーターと mkt クエリパラメーターは相互に排他的なので、両方指定することはできません。

count: Nullable<Int32>

応答で返される検索結果の数。既定値は 10 で、最大値は 50 です。実際に配信される数は、要求された数より少ない場合があります。このパラメーターをオフセットパラメーターと共に使用して、結果をページ化します。たとえば、ユーザーインターフェイスに 1 ページあたり 10 件の検索結果が表示される場合は、count を 10 に、オフセットを 0 に設定して結果の最初のページを取得します。後続のページごとに、オフセットを 10 ずつ増やします (0、10、20 など)。複数のページで結果に重複を含めることができます。

market: String

結果の取得元の市場。通常、mkt はユーザーが要求を行っている国です。ただし、ユーザーが結果を提供する国にいない場合は、別の国Bing可能性があります。マーケットは、言語コードと国コード><>の形式<である必要があります。たとえば、en-US などです。文字列では大文字と小文字が区別されません。既知の場合は、常に市場を指定することをお勧めします。市場を指定すると、Bing が要求をルーティングして最適な応答を返すのに役立ちます。市場コードに記載されていない市場を指定した場合、Bingは、変更される可能性がある内部マッピングに基づいて最適な市場コードを使用します。このパラメーターと cc クエリパラメーターは相互に排他的なので、両方指定することはできません。

offset: Nullable<Int32>

結果を返す前にスキップする検索結果の数を示す 0 から始まるオフセット。既定値は 0 です。オフセットは (totalEstimatedMatches - count) 未満にする必要があります。このパラメーターを count パラメーターと共に使用して、結果をページングします。たとえば、ユーザーインターフェイスに 1 ページあたり 10 件の検索結果が表示される場合は、count を 10 に、オフセットを 0 に設定して結果の最初のページを取得します。後続のページごとに、オフセットを 10 ずつ増やします (0、10、20 など)。複数のページで結果に重複を含めることができます。

safeSearch: String

成人向けコンテンツのフィルター処理に使用されるフィルター。オフ: 成人向けのテキスト、画像、またはビデオを含む Web ページを返します。中: 成人向けテキストを含む Web ページを返しますが、成人向けの画像やビデオは返しません。 Strict: 成人向けテキスト、画像、またはビデオを含む Web ページは返さないでください。既定値は Moderate です。 Bingの成人向けポリシーで safeSearch が Strict に設定されている必要がある市場からの要求の場合、Bingは safeSearch 値を無視し、Strict を使用します。 site: クエリ演算子を使用する場合、safeSearch クエリパラメーターの設定に関係なく、応答に成人向けコンテンツが含まれる可能性があります。サイトを使用する: サイト上のコンテンツを認識していて、シナリオが成人コンテンツの可能性をサポートしている場合にのみ使用します。使用可能な値は、'Off'、'Moderate'、'Strict' です。

setLang: String

ユーザーインターフェイス文字列に使用する言語。 ISO 639-1 の 2 文字言語コードを使って言語を指定します。たとえば、英語の言語コードは EN です。既定値は EN (英語) です。省略可能ですが、常に言語を指定することをお勧めします。通常、setLang は、ユーザーが別の言語で表示するユーザーインターフェイス文字列を必要とする場合を除き、mkt で指定された同じ言語に設定します。このパラメーターとAccept-Language ヘッダーは相互に排他的です。両方を指定しないでください。ユーザーインターフェイス文字列は、ユーザーインターフェイスでラベルとして使われる文字列です。 JSON 応答オブジェクトには、いくつかのユーザーインターフェイス文字列があります。また、応答オブジェクト内の Bing.com プロパティへのリンクには、指定された言語が適用されます。

textDecorations: Nullable<Boolean>

表示文字列に、ヒット強調表示文字などの装飾マーカーを含めるかどうかを決定するブール値。 true の場合、文字列にマーカーを含めることができます。既定値は false です。マーカーとして Unicode 文字または HTML タグを使用するかどうかを指定するには、textFormat クエリパラメーターを参照してください。

textFormat: String

テキスト装飾に使用するマーカーの種類 (textDecorations クエリパラメーターを参照)。使用できる値は Raw です。Unicode 文字を使用して、特別な書式設定が必要なコンテンツをマークします。 Unicode 文字の範囲は E000 から E019 です。たとえば、Bingは E000 と E001 を使用して、クエリ用語の先頭と末尾にヒット強調表示のマークを付けます。 HTML — HTML タグを使用して、特別な書式設定が必要なコンテンツをマークします。たとえば、b> タグを使用して<、表示文字列内のクエリ用語を強調表示します。既定値は Raw です。 textFormat が HTML に設定されている場合、、>、、 &などの<エスケープ可能な HTML 文字を含む表示文字列の場合、Bingは文字を適切にエスケープします (たとえば、 < は lt に&エスケープされます)。使用可能な値は次のとおりです: 'Raw'、'Html'