AutocompleteRequest interface

パッケージ:

@azure/search-documents

あいまい一致のパラメーター、およびその他のオートコンプリート クエリの動作。

プロパティ

autocompleteMode	オートコンプリートのモードを指定します。 既定値は 'oneTerm' です。 'twoTerms' を使用してシングルを取得し、'oneTermWithContext' を使用して、オートコンプリートの用語を生成するときに現在のコンテキストを使用します。 指定できる値は、'oneTerm'、'twoTerms'、'oneTermWithContext' です。
filter	オートコンプリート結果の完成した用語を生成するために使用されるドキュメントをフィルター処理する OData 式。
highlightPostTag	ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。 省略すると、ヒット強調表示は無効になります。
highlightPreTag	ヒットハイライトの前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。 省略すると、ヒット強調表示は無効になります。
minimumCoverage	クエリを成功として報告するためにオートコンプリート クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の範囲の数値。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 既定値は 80 です。
searchFields	オートコンプリート用語のクエリを実行するときに考慮するフィールド名のコンマ区切りのリスト。 ターゲット フィールドは、指定した suggester に含まれている必要があります。
top	取得する自動完了の用語の数。 これは 1 ~ 100 の値である必要があります。 既定値は 5 です。
useFuzzyMatching	オートコンプリート クエリにあいまい一致を使用するかどうかを示す値。 既定値は false です。 true に設定すると、検索テキストに置換文字または欠落文字がある場合でも、クエリは用語をオートコンプリートします。 これにより、一部のシナリオではエクスペリエンスが向上しますが、あいまいオートコンプリート クエリの速度が低下し、リソースが多く消費されるため、パフォーマンス コストがかかります。

プロパティの詳細

autocompleteMode

オートコンプリートのモードを指定します。 既定値は 'oneTerm' です。 'twoTerms' を使用してシングルを取得し、'oneTermWithContext' を使用して、オートコンプリートの用語を生成するときに現在のコンテキストを使用します。 指定できる値は、'oneTerm'、'twoTerms'、'oneTermWithContext' です。

autocompleteMode?: AutocompleteMode

プロパティ値

AutocompleteMode

filter

オートコンプリート結果の完成した用語を生成するために使用されるドキュメントをフィルター処理する OData 式。

filter?: string

プロパティ値

string

highlightPostTag

ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。 省略すると、ヒット強調表示は無効になります。

highlightPostTag?: string

プロパティ値

string

highlightPreTag

ヒットハイライトの前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。 省略すると、ヒット強調表示は無効になります。

highlightPreTag?: string

プロパティ値

string

minimumCoverage

クエリを成功として報告するためにオートコンプリート クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の範囲の数値。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 既定値は 80 です。

minimumCoverage?: number

プロパティ値

number

searchFields

オートコンプリート用語のクエリを実行するときに考慮するフィールド名のコンマ区切りのリスト。 ターゲット フィールドは、指定した suggester に含まれている必要があります。

searchFields?: SearchFieldArray<TModel>

プロパティ値

SearchFieldArray<TModel>

top

取得する自動完了の用語の数。 これは 1 ~ 100 の値である必要があります。 既定値は 5 です。

top?: number

プロパティ値

number

useFuzzyMatching

オートコンプリート クエリにあいまい一致を使用するかどうかを示す値。 既定値は false です。 true に設定すると、検索テキストに置換文字または欠落文字がある場合でも、クエリは用語をオートコンプリートします。 これにより、一部のシナリオではエクスペリエンスが向上しますが、あいまいオートコンプリート クエリの速度が低下し、リソースが多く消費されるため、パフォーマンス コストがかかります。

useFuzzyMatching?: boolean

プロパティ値

boolean