AutocompleteRequest interface

套件:

@azure/search-documents

模糊比對和其他自動完成查詢行為的參數。

屬性

autocompleteMode	指定自動完成的模式。 預設值為 『oneTerm』。 使用 'twoTerms' 取得 shingles 和 'oneTermWithContext'，以在產生自動完成的字詞時使用目前的內容。 可能的值包括：'oneTerm'、'twoTerms'、'oneTermWithContext'
filter	OData 表達式，篩選用來為自動完成結果產生已完成字詞的檔。
highlightPostTag	附加至叫用醒目提示的字串標記。 必須使用 highlightPreTag 進行設定。 如果省略，叫用醒目提示會停用。
highlightPreTag	在叫用醒目提示前面加上的字串標記。 必須使用 highlightPostTag 進行設定。 如果省略，叫用醒目提示會停用。
minimumCoverage	介於 0 到 100 之間的數位，表示自動完成查詢必須涵蓋的索引百分比，以便將查詢回報為成功。 此參數對於確保搜尋可用性，即使是只有一個複本的服務，也很有用。 預設值為80。
searchFields	查詢自動完成字詞時要考慮的功能變數名稱逗號分隔清單。 目標欄位必須包含在指定的建議工具中。
top	要擷取的自動完成字詞數目。 這必須是介於 1 到 100 之間的值。 預設值為 5。
useFuzzyMatching	值，指出是否要使用自動完成查詢的模糊比對。 默認值為 false。 當設定為 true 時，即使搜尋文字中有替代字元或遺漏字元，查詢也會自動完成字詞。 雖然這在某些案例中提供較佳的體驗，但效能成本會因為模糊自動完成查詢速度較慢且耗用更多資源。

屬性詳細資料

autocompleteMode

指定自動完成的模式。 預設值為 『oneTerm』。 使用 'twoTerms' 取得 shingles 和 '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 之間的數位，表示自動完成查詢必須涵蓋的索引百分比，以便將查詢回報為成功。 此參數對於確保搜尋可用性，即使是只有一個複本的服務，也很有用。 預設值為80。

minimumCoverage?: number

屬性值

number

searchFields

查詢自動完成字詞時要考慮的功能變數名稱逗號分隔清單。 目標欄位必須包含在指定的建議工具中。

searchFields?: SearchFieldArray<TModel>

屬性值

SearchFieldArray<TModel>

top

要擷取的自動完成字詞數目。 這必須是介於 1 到 100 之間的值。 預設值為 5。

top?: number

屬性值

number

useFuzzyMatching

值，指出是否要使用自動完成查詢的模糊比對。 默認值為 false。 當設定為 true 時，即使搜尋文字中有替代字元或遺漏字元，查詢也會自動完成字詞。 雖然這在某些案例中提供較佳的體驗，但效能成本會因為模糊自動完成查詢速度較慢且耗用更多資源。

useFuzzyMatching?: boolean

屬性值

boolean