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