使用 Search REST 服务检索查询建议

了解如何在客户端和移动应用中使用搜索 REST 服务,从 SharePoint 搜索功能检索查询建议。 查询建议(亦称为“搜索建议”)是用户已经搜索过的短语,用户会在键入查询的同时看到这些建议。 可以使用 SharePoint 中的搜索功能,启用查询前和查询后建议。 这些建议在用户键入查询的同时显示在搜索框下面的列表中。 有关查询建议以及如何启用它们的详细信息,请参阅 在 SharePoint 中管理查询建议

搜索 REST 服务中的建议终结点

搜索 REST 服务包括可用于任何技术的 Suggest 端点,只要该技术支持从客户端或移动应用程序使用 REST Web 请求以检索搜索系统针对查询生成的查询建议。

针对搜索 REST 服务 Suggest 端点的 GET 请求的 URI 为:

/_api/search/suggest

查询建议参数在 URL 中指定。 您可以通过两种方式构建请求 URL:

http://server/_api/search/suggest?parameter=value&parameter=value

http://server/_api/search/suggest(parameter=value&parameter=value)

注意

搜索 REST 服务不支持向建议终结点发出匿名请求。

查询建议参数

以下几节介绍了可用于 Suggest 端点的参数。

Querytext

一个包含搜索查询文本的字符串。

示例 GET 请求

http:// server/_api/search/suggest?querytext='sharepoint'

iNumberOfQuerySuggestions

要检索的查询建议数量。 必须大于零 (0)。 默认值为 5。

示例 GET 请求

http:// server/_api/search/suggest?querytext='sharepoint'&inumberofquerysuggestions=3

iNumberOfResultSuggestions

要检索的个人搜索结果数量。 必须大于零 (0)。 默认值为 5。

示例 GET 请求

http:// server/_api/search/suggest?querytext='sharepoint'&inumberofresultsuggestions=4

fPreQuerySuggestions

一个指定是否检索查询前或查询后建议的布尔值。 若要返回查询前建议,则选择 true;否则,选择 false。 默认值为 false

示例 GET 请求

http:// server/_api/search/suggest?querytext='sharepoint'&fprequerysuggestions=true

fHitHighlighting

一个指定是否突出显示或加粗显示查询建议的布尔值。 若要加粗显示返回的查询建议中与指定查询中的字词匹配的字词,则选择 true;否则,选择 false。 默认值为 true

示例 GET 请求

http:// server/_api/search/suggest?querytext='sharepoint'&fhithighlighting=false

fCapitalizeFirstLetters

一个指定是否将返回的查询建议中每个字词的首字母大写的布尔值。 若要将每个字词的首字母大写,则选择 true;否则,选择 false。 默认值为 false

示例 GET 请求

http:// server/_api/search/suggest?querytext='sharepoint'&fcapitalizefirstletters=false

Culture

查询的区域设置 ID (LCID) (请参阅 Microsoft) 分配的区域设置 ID

示例 GET 请求

http:// server/_api/search/suggest?querytext='sharepoint'&culture=1044

EnableStemming

一个布尔值,它指定是否启用词干。 若要启用词干分解,则选择 true;否则,选择 false。 默认值为 true

示例 GET 请求

http:// server/_api/search/suggest?querytext='sharepoint'&enablestemming=false

ShowPeopleNameSuggestions

一个指定是否在返回的查询建议中包含人员姓名的布尔值。 若要在返回的查询建议中包含人员姓名,则选择 true;否则,选择 false。 默认值为 true

示例 GET 请求

http:// server/_api/search/suggest?querytext='sharepoint'&showpeoplenamesuggestions=false

EnableQueryRules

一个指定是否对此查询启用查询规则的布尔值。 若要启用查询规则,则选择 true;否则,选择 false。 默认值为 true

示例 GET 请求

http:// server/_api/search/suggest?querytext='sharepoint'&enablequeryrules=false

fPrefixMatchAllTerms

一个指定是否针对前缀匹配返回查询建议的布尔值。 若要根据前缀匹配返回查询建议,则选择 true;否则,选择 false(查询建议应与网站查询字词匹配)。

示例 GET 请求

http:// server/_api/search/suggest?querytext='sharepoint'&fprefixmatchallterms=false

另请参阅