SearchParameters クラス

定義

名前空間:

Microsoft.Azure.Search.Models

アセンブリ:

Microsoft.Azure.Search.Data.dll

パッケージ:

Microsoft.Azure.Search.Data v10.1.0

フィルター処理、並べ替え、ファセット、ページング、およびその他の検索クエリ動作のパラメーター。

public class SearchParameters

type SearchParameters = class

Public Class SearchParameters

継承

Object

SearchParameters

コンストラクター

SearchParameters()	SearchParameters クラスの新しいインスタンスを初期化します。
SearchParameters(Boolean, IList<String>, String, IList<String>, String, String, Nullable<Double>, IList<String>, QueryType, IList<ScoringParameter>, String, IList<String>, SearchMode, IList<String>, Nullable<Int32>, Nullable<Int32>)	SearchParameters クラスの新しいインスタンスを初期化します。

プロパティ

Facets	検索クエリに適用するファセット式の一覧を取得または設定します。 各ファセット式にはフィールド名が含まれます。必要に応じて、name:value ペアのコンマ区切りのリストが続きます。
Filter	検索クエリに適用する OData $filter式を取得または設定します。
HighlightFields	ヒット ハイライトに使用するフィールド名の一覧を取得または設定します。 検索可能なフィールドのみを、ヒット強調表示に使用できます。
HighlightPostTag	ヒットハイライトに追加される文字列タグを取得または設定します。 highlightPreTag を使用して設定する必要があります。 既定値は </em> です。
HighlightPreTag	ヒットハイライトの前に付加される文字列タグを取得または設定します。 highlightPostTag を使用して設定する必要があります。 既定値は <em> です。
IncludeTotalResultCount	結果の合計数をフェッチするかどうかを指定する値を取得または設定します。 既定値は false です。 この値を true に設定すると、パフォーマンスに影響する可能性があります。 返されるカウントは概数であることに注意してください。
MinimumCoverage	クエリを成功として報告するために検索クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の数値を取得または設定します。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 既定値は、100 です。
OrderBy	結果を並べ替える OData $orderby式の一覧を取得または設定します。 各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。 各式の後に asc を付けて昇順を示し、降順を示す desc を指定できます。 既定値は昇順です。 結び付きは、ドキュメントの一致スコアによって切り離されます。 OrderBy が指定されていない場合、既定の並べ替え順序はドキュメント一致スコアの降順になります。 最大で 32 個の$orderby句を指定できます。
QueryType	検索クエリの構文を指定する値を取得または設定します。 既定値は 'simple' です。 クエリで Lucene クエリ構文が使用されている場合は、'full' を使用します。 使用可能な値は次のとおりです: 'simple'、'full'
ScoringParameters	name-values の形式を使用して、スコアリング関数で使用されるパラメーター値の一覧 (referencePointParameter など) を取得または設定します。 たとえば、スコアリング プロファイルで "mylocation" というパラメーターを持つ関数が定義されている場合、パラメーター文字列は "mylocation---122.2,44.8" になります (引用符は使用しません)。
ScoringProfile	結果を並べ替えるために、一致するドキュメントの一致スコアを評価するスコアリング プロファイルの名前を取得または設定します。
SearchFields	フルテキスト検索の範囲を指定するフィールド名の一覧を取得または設定します。 完全な Lucene クエリでフィールド検索 (fieldName:searchExpression) を使用する場合、各フィールド検索式のフィールド名は、このパラメーターにリストされているフィールド名よりも優先されます。
SearchMode	ドキュメントを一致としてカウントするために、検索語句の一部またはすべてを照合する必要があるかどうかを指定する値を取得または設定します。 使用可能な値は次のとおりです: 'any'、'all'
Select	取得するフィールドの一覧を取得または設定します。 指定しないと、スキーマで取得可能とマークされているすべてのフィールドが含まれます。
Skip	スキップする検索結果の数を取得または設定します。 この値は 100,000 を超えることはできません。 ドキュメントを順番にスキャンする必要があるが、この制限により$skipを使用できない場合は、完全に順序付けられたキーに対して$orderbyを使用し、代わりに範囲クエリで$filterすることを検討してください。
Top	取得する検索結果の数を取得または設定します。 これは、$skipと組み合わせて使用して、検索結果のクライアント側ページングを実装できます。 サーバー側のページングによって結果が切り捨てられた場合、応答には継続トークンが含まれます。このトークンを使用して、結果の次のページに対して別の検索要求を発行できます。