AutocompleteRequest interface
模糊比對和其他自動完成查詢行為的參數。
屬性
autocomplete |
指定自動完成的模式。 預設值為 'oneTerm'。 使用 'twoTerms' 取得隨機和 'oneTermWithCoNtext' 以在產生自動完成字詞時使用目前的內容。 可能的值包括:'oneTerm'、'twoTerms'、'oneTermWithCoNtext' |
filter | OData 運算式,篩選用來產生自動完成結果之已完成詞彙的檔。 |
highlight |
附加至點擊醒目提示的字串標籤。 必須使用 highlightPreTag 進行設定。 如果省略,則會停用點擊醒目提示。 |
highlight |
前面加上叫用醒目提示的字串標記。 必須使用 highlightPostTag 來設定。 如果省略,則會停用點擊醒目提示。 |
minimum |
介於 0 到 100 之間的數位,表示自動完成查詢必須涵蓋的索引百分比,以便將查詢回報為成功。 即使只有一個複本的服務,此參數也有助於確保搜尋可用性。 預設值為 80。 |
search |
查詢自動完成字詞時要考慮的功能變數名稱逗號分隔清單。 目標欄位必須包含在指定的建議工具中。 |
top | 要擷取的自動完成字詞數目。 這必須是介於 1 到 100 之間的值。 預設值為 5。 |
use |
值,指出是否要使用自動完成查詢的模糊比對。 預設值為 false。 當設定為 true 時,即使搜尋文字中有替代或遺漏字元,查詢還是會自動完成字詞。 雖然這在某些案例中提供較佳的體驗,但因為模糊自動完成查詢速度較慢,且耗用更多資源,因此會產生效能成本。 |
屬性詳細資料
autocompleteMode
指定自動完成的模式。 預設值為 'oneTerm'。 使用 'twoTerms' 取得隨機和 'oneTermWithCoNtext' 以在產生自動完成字詞時使用目前的內容。 可能的值包括:'oneTerm'、'twoTerms'、'oneTermWithCoNtext'
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