你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

SuggestParameters 类

定义

用于筛选、排序、模糊匹配和其他建议查询行为的参数。

public class SuggestParameters
type SuggestParameters = class
Public Class SuggestParameters
继承
SuggestParameters

构造函数

SuggestParameters()

初始化 SuggestParameters 类的新实例。

SuggestParameters(String, Boolean, String, String, Nullable<Double>, IList<String>, IList<String>, IList<String>, Nullable<Int32>)

初始化 SuggestParameters 类的新实例。

属性

Filter

获取或设置一个 OData 表达式,用于筛选考虑建议的文档。

HighlightPostTag

获取或设置追加到命中突出显示的字符串标记。 必须使用 highlightPreTag 进行设置。 如果省略,则禁用建议的点击突出显示。

HighlightPreTag

获取或设置一个字符串标记,该标记前面追加到命中突出显示。 必须使用 highlightPostTag 进行设置。 如果省略,则禁用建议的点击突出显示。

MinimumCoverage

获取或设置一个介于 0 和 100 之间的数字,指示建议查询必须涵盖的索引百分比,以便将查询报告为成功。 即使只有一个副本 (replica) 的服务,此参数也可用于确保搜索可用性。 默认值为“80”。

OrderBy

获取或设置 OData $orderby表达式的列表,用于对结果进行排序。 每个表达式可以是字段名称,也可以是对 geo.distance () 或 search.score () 函数的调用。 每个表达式后跟 asc 表示升序,desc 表示降序。 默认值为升序。 排序的依据将是文档的匹配分数。 如果未指定$orderby,则默认排序顺序为按文档匹配分数降序。 最多可以有 32 个$orderby子句。

SearchFields

获取或设置要搜索指定搜索文本的字段名称列表。 目标字段必须包含在指定的建议器中。

Select

获取或设置要检索的字段的列表。 如果未指定,则结果中仅包含键字段。

Top

获取或设置要检索的建议数。 值必须是介于 1 和 100 之间的数字。 默认值为 5。

UseFuzzyMatching

获取或设置一个值,该值指示是否对建议查询使用模糊匹配。 默认值为 false。 设置为 true 时,即使搜索文本中存在替换字符或缺失字符,查询也会查找字词。 虽然这在某些情况下提供更好的体验,但会降低性能,因为模糊建议查询速度较慢,会消耗更多资源。

方法

EnsureSelect()

如果此实例具有非 null Select 属性,则返回该实例,否则返回 Select 设置为“*”的新实例。

适用于