SuggestRequest interface

パッケージ:

@azure/search-documents

フィルター処理、並べ替え、あいまい一致、およびその他の候補のクエリ動作のパラメーター。

プロパティ

filter	候補と見なされるドキュメントをフィルター処理する OData 式。
highlightPostTag	ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。 省略すると、候補の強調表示が無効になります。
highlightPreTag	ヒットハイライトの前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。 省略すると、候補の強調表示が無効になります。
minimumCoverage	クエリを成功として報告するために候補クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の範囲の数値。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 既定値は 80 です。
orderBy	結果を並べ替える OData $orderby式の一覧。 各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。 各式の後に asc を付けて昇順を示し、降順を示す desc を指定できます。 既定値は昇順です。 結び付きは、ドキュメントの一致スコアによって切り離されます。 $orderbyが指定されていない場合、既定の並べ替え順序はドキュメント一致スコアの降順になります。 最大で 32 個の$orderby句を指定できます。
searchFields	指定した検索テキストを検索するフィールド名のコンマ区切りリスト。 ターゲット フィールドは、指定した suggester に含まれている必要があります。
select	取得するフィールドの一覧。 指定しない場合は、キー フィールドのみが結果に含まれます。
top	/** 取得する候補の数。 これは、1 ~ 100 の値である必要があります。 既定値です。
useFuzzyMatching	候補クエリにあいまい一致を使用するかどうかを示す値。 既定値は 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