你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
SuggestOptions 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
用于筛选、排序、模糊匹配和其他建议查询行为的参数。
public class SuggestOptions
type SuggestOptions = class
Public Class SuggestOptions
- 继承
-
SuggestOptions
构造函数
SuggestOptions() |
初始化 SuggestOptions 的新实例 |
属性
Filter |
一个 OData 表达式,用于筛选考虑建议的文档。 可以使用 Create(FormattableString) 来帮助构造筛选器表达式。 |
HighlightPostTag |
追加到命中突出显示的字符串标记。 必须使用 highlightPreTag 进行设置。 如果省略,则禁用建议的点击突出显示。 |
HighlightPreTag |
一个字符串标记,在前面追加到命中突出显示。 必须使用 highlightPostTag 进行设置。 如果省略,则禁用建议的点击突出显示。 |
MinimumCoverage |
一个介于 0 和 100 之间的数字,指示建议查询必须涵盖的索引百分比,以便将查询报告为成功。 即使只有一个副本 (replica) 的服务,此参数也可用于确保搜索可用性。 默认值为“80”。 |
OrderBy |
OData 列表$orderby对结果进行排序的表达式。 每个表达式可以是字段名称,也可以是对 geo.distance () 或 search.score () 函数的调用。 每个表达式后跟 asc 表示升序,desc 表示降序。 默认值为升序。 排序的依据将是文档的匹配分数。 如果未指定$orderby,则默认排序顺序为按文档匹配分数降序。 最多可以有 32 个$orderby子句。 |
SearchFields |
要搜索指定搜索文本的字段名称列表。 目标字段必须包含在指定的建议器中。 |
Select |
要检索的字段列表。 如果未指定,则结果中仅包含键字段。 |
Size |
要检索的建议数。 此值必须是介于 1 和 100 之间的值。 默认值为 5。 |
UseFuzzyMatching |
一个 值,该值指示是否对建议查询使用模糊匹配。 默认值为 false。 设置为 true 时,即使搜索文本中存在替换字符或缺失字符,查询也会查找建议。 尽管这在某些情况下可以提供更好的体验,但会带来性能的损失,因为模糊建议搜索速度更慢,并会消耗更多的资源。 |