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

SearchParameters 类

定义

命名空间:

Microsoft.Azure.Search.Models

程序集:

Microsoft.Azure.Search.Data.dll

包:

Microsoft.Azure.Search.Data v10.1.0

用于筛选、排序、分面、分页和其他搜索查询行为的参数。

public class SearchParameters

type SearchParameters = class

Public Class SearchParameters

继承

Object

SearchParameters

构造函数

SearchParameters()	初始化 SearchParameters 类的新实例。
SearchParameters(Boolean, IList<String>, String, IList<String>, String, String, Nullable<Double>, IList<String>, QueryType, IList<ScoringParameter>, String, IList<String>, SearchMode, IList<String>, Nullable<Int32>, Nullable<Int32>)	初始化 SearchParameters 类的新实例。

属性

Facets	获取或设置要应用于搜索查询的 facet 表达式的列表。 每个分面表达式都包含一个字段名称，后跟一个逗号分隔的 name：value 对列表。
Filter	获取或设置要应用于搜索查询的 OData $filter表达式。
HighlightFields	获取或设置要用于命中突出显示的字段名称列表。 仅可搜索字段可用于命中突出显示。
HighlightPostTag	获取或设置追加到命中突出显示的字符串标记。 必须使用 highlightPreTag 进行设置。 默认值为 </em>。
HighlightPreTag	获取或设置一个字符串标记，该标记前面附加用于命中突出显示。 必须使用 highlightPostTag 进行设置。 默认值为 <em>。
IncludeTotalResultCount	获取或设置一个值，该值指定是否提取结果的总计数。 默认值为 false。 将此值设置为 true 可能会影响性能。 请注意，返回的计数是一个近似值。
MinimumCoverage	获取或设置一个介于 0 和 100 之间的数字，该数字指示搜索查询必须涵盖的索引百分比才能将查询报告为成功。 此参数可用于确保搜索可用性，即使只有一个副本 (replica) 的服务也是如此。 默认值为 100。
OrderBy	获取或设置对结果进行排序所依据的 OData $orderby表达式的列表。 每个表达式可以是字段名称，也可以是对 geo.distance () 或 search.score () 函数的调用。 每个表达式后跟 asc 表示升序，desc 表示降序。 默认值为升序。 排序的依据将是文档的匹配分数。 如果未指定 OrderBy，则默认排序顺序按文档匹配分数降序。 最多可以有 32 个$orderby子句。
QueryType	获取或设置一个值，该值指定搜索查询的语法。 默认值为“simple”。 如果查询使用 Lucene 查询语法，请使用“full”。 可能的值包括：“simple”、“full”
ScoringParameters	获取或设置用于评分函数的参数值列表， (例如，使用格式 name-values 的 referencePointParameter) 。 例如，如果评分配置文件定义了一个具有名为“mylocation”的参数的函数，则参数字符串将为“mylocation--122.2，44.8” (，而不) 引号。
ScoringProfile	获取或设置评分配置文件的名称，以评估匹配文档的匹配分数，以便对结果进行排序。
SearchFields	获取或设置将全文搜索范围限定到的字段名称列表。 在完整的 Lucene 查询中使用字段搜索 (fieldName：searchExpression) 时，每个字段搜索表达式的字段名称优先于此参数中列出的任何字段名称。
SearchMode	获取或设置一个值，该值指定是否必须匹配任何或所有搜索词才能将文档计数为匹配项。 可能的值包括：“any”、“all”
Select	获取或设置要检索的字段的列表。 如果未指定，将包含架构中标记为可检索的所有字段。
Skip	获取或设置要跳过的搜索结果数。 此值不能大于 100，000。 如果需要按顺序扫描文档，但由于此限制而无法使用$skip，请考虑对完全有序的键使用$orderby，并改用范围查询$filter。
Top	获取或设置要检索的搜索结果数。 这可以与$skip结合使用，以实现搜索结果的客户端分页。 如果结果由于服务器端分页而被截断，响应将包含一个可用于对下一页结果发出另一个搜索请求的延续标记。