SuggestRequest interface
篩選、排序、模糊比對和其他建議查詢行為的參數。
屬性
| filter | 篩選考慮建議之檔的 OData 表達式。 |
| highlight |
附加至叫用醒目提示的字串標記。 必須使用 highlightPreTag 進行設定。 如果省略，則會停用建議的叫用醒目提示。 |
| highlight |
在叫用醒目提示前面加上的字串標記。 必須使用 highlightPostTag 進行設定。 如果省略，則會停用建議的叫用醒目提示。 |
| minimum |
介於 0 到 100 之間的數位，指出建議查詢必須涵蓋的索引百分比，以便將查詢回報為成功。 此參數對於確保搜尋可用性，即使是只有一個複本的服務，也很有用。 預設值為80。 |
| order |
要排序結果的 OData $orderby表示式清單。 每個運算式可以是功能變數名稱或對 geo.distance（） 或 search.score（） 函式的呼叫。 每個表達式後面可以接著 asc 表示遞增，或 desc 表示遞減。 預設值為遞增順序。 系結會因檔比對分數而中斷。 如果未指定任何$orderby，則預設排序順序會依檔比對分數遞減。 最多可以有 32 個$orderby子句。 |
| search |
要搜尋指定搜尋文字的功能變數名稱逗號分隔清單。 目標欄位必須包含在指定的建議工具中。 |
| select | 要擷取的欄位清單。 如果未指定，則結果中只會包含索引鍵欄位。 |
| top | /**
|
| use |
值，指出是否要針對建議查詢使用模糊比對。 默認值為 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
top
/**
- 要擷取的建議數目。 這必須是介於 1 到 100 之間的值。 預設值為
-
top?: number屬性值
number
useFuzzyMatching
值，指出是否要針對建議查詢使用模糊比對。 默認值為 false。 當設定為 true 時，即使搜尋文字中有替代字元或遺漏字元，查詢仍會尋找建議。 雖然這在某些案例中提供較佳的體驗，但因為模糊建議搜尋速度較慢，且耗用更多資源，因此會產生效能成本。
useFuzzyMatching?: boolean屬性值
boolean