SuggestRequest interface
フィルター処理、並べ替え、あいまい一致、およびその他の検索候補のクエリ動作のパラメーター。
プロパティ
| filter | 提案の対象と見なされるドキュメントをフィルター処理する OData 式。 |
| highlight |
ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。 省略すると、検索候補の強調表示が無効になります。 |
| highlight |
強調表示をヒットする前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。 省略すると、検索候補の強調表示が無効になります。 |
| minimum |
クエリが成功として報告されるように、提案クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の数値。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 既定値は 80 です。 |
| order |
結果を並べ替える OData $orderby式の一覧。 各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。 各式の後に asc を付けて昇順を示すか、降順を示す desc を指定できます。 既定値は昇順です。 同点は、ドキュメントのマッチ スコアによって分割されます。 $orderbyが指定されていない場合、既定の並べ替え順序はドキュメントの一致スコアの降順になります。 最大で 32 個の$orderby句があります。 |
| search |
指定した検索テキストを検索するフィールド名のコンマ区切りのリスト。 ターゲット フィールドは、指定した suggester に含まれている必要があります。 |
| select | 取得するフィールドの一覧。 指定しない場合は、キー フィールドのみが結果に含まれます。 |
| top | /**
|
| use |
検索候補クエリにあいまい一致を使用するかどうかを示す値。 既定値は false です。 true に設定すると、検索テキストに置換文字または不足文字がある場合でも、クエリで候補が検索されます。 一部のシナリオではエクスペリエンスが向上しますが、あいまい検索の速度が遅くなり、リソースが多く消費されるため、パフォーマンス コストがかかります。 |
プロパティの詳細
filter
提案の対象と見なされるドキュメントをフィルター処理する OData 式。
filter?: stringプロパティ値
string
highlightPostTag
ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。 省略すると、検索候補の強調表示が無効になります。
highlightPostTag?: stringプロパティ値
string
highlightPreTag
強調表示をヒットする前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。 省略すると、検索候補の強調表示が無効になります。
highlightPreTag?: stringプロパティ値
string
minimumCoverage
クエリが成功として報告されるように、提案クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の数値。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 既定値は 80 です。
minimumCoverage?: numberプロパティ値
number
orderBy
結果を並べ替える OData $orderby式の一覧。 各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。 各式の後に asc を付けて昇順を示すか、降順を示す desc を指定できます。 既定値は昇順です。 同点は、ドキュメントのマッチ スコアによって分割されます。 $orderbyが指定されていない場合、既定の並べ替え順序はドキュメントの一致スコアの降順になります。 最大で 32 個の$orderby句があります。
orderBy?: string[]プロパティ値
string[]
searchFields
指定した検索テキストを検索するフィールド名のコンマ区切りのリスト。 ターゲット フィールドは、指定した suggester に含まれている必要があります。
searchFields?: SearchFieldArray<TModel>プロパティ値
SearchFieldArray<TModel>
select
取得するフィールドの一覧。 指定しない場合は、キー フィールドのみが結果に含まれます。
select?: SelectArray<TFields>プロパティ値
SelectArray<TFields>
top
/**
- 取得する候補の数。 1 ~ 100 の値を指定する必要があります。 既定値は
-
top?: numberプロパティ値
number
useFuzzyMatching
検索候補クエリにあいまい一致を使用するかどうかを示す値。 既定値は false です。 true に設定すると、検索テキストに置換文字または不足文字がある場合でも、クエリで候補が検索されます。 一部のシナリオではエクスペリエンスが向上しますが、あいまい検索の速度が遅くなり、リソースが多く消費されるため、パフォーマンス コストがかかります。
useFuzzyMatching?: booleanプロパティ値
boolean