SuggestRequest interface

套件:

@azure/search-documents

篩選、排序、模糊比對和其他建議查詢行為的參數。

屬性

filter	OData 運算式，可篩選考慮建議的檔。
highlightPostTag	附加至點擊醒目提示的字串標籤。 必須使用 highlightPreTag 進行設定。 如果省略，則會停用建議的點擊醒目提示。
highlightPreTag	前面加上叫用醒目提示的字串標記。 必須使用 highlightPostTag 來設定。 如果省略，則會停用建議的點擊醒目提示。
minimumCoverage	介於 0 到 100 之間的數位，表示建議查詢必須涵蓋的索引百分比，以便將查詢回報為成功。 即使只有一個複本的服務，此參數也有助於確保搜尋可用性。 預設值為 80。
orderBy	要排序結果的 OData $orderby運算式清單。 每個運算式可以是功能變數名稱或 geo.distance () 或 search.score () 函式的呼叫。 每個運算式後面可以接著 asc 來表示遞增，或 desc 表示遞減。 預設值為遞增排序。 繫結將透過文件的相符分數來中斷。 如果未指定任何$orderby，預設排序次序會依檔比對分數遞減。 最多可以有 32 個$orderby子句。
searchFields	要搜尋指定搜尋文字的功能變數名稱逗號分隔清單。 目標欄位必須包含在指定的建議工具中。
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 之間的數位，表示建議查詢必須涵蓋的索引百分比，以便將查詢回報為成功。 即使只有一個複本的服務，此參數也有助於確保搜尋可用性。 預設值為 80。

minimumCoverage?: number

屬性值

number

orderBy

要排序結果的 OData $orderby運算式清單。 每個運算式可以是功能變數名稱或 geo.distance () 或 search.score () 函式的呼叫。 每個運算式後面可以接著 asc 來表示遞增，或 desc 表示遞減。 預設值為遞增排序。 繫結將透過文件的相符分數來中斷。 如果未指定任何$orderby，預設排序次序會依檔比對分數遞減。 最多可以有 32 個$orderby子句。

orderBy?: string[]

屬性值

string[]

searchFields

要搜尋指定搜尋文字的功能變數名稱逗號分隔清單。 目標欄位必須包含在指定的建議工具中。

searchFields?: SearchFieldArray<TModel>

屬性值

SearchFieldArray<TModel>

select

要擷取的欄位清單。 如果未指定，則結果中只會包含索引鍵欄位。

select?: SelectArray<TFields>

屬性值

SelectArray<TFields>

top

/**

• 要擷取的建議數目。 這必須是介於 1 到 100 之間的值。 預設值為

top?: number

屬性值

number

useFuzzyMatching

值，指出是否要對建議查詢使用模糊比對。 預設值為 false。 當設定為 true 時，即使搜尋文字中有替代字元或遺漏字元，查詢還是會找到建議。 此設定有時雖可提供較佳的使用經驗，但效能卻會因此受影響，因為模糊建議搜尋的速度較慢，且耗用較多資源。

useFuzzyMatching?: boolean

屬性值

boolean