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

SearchClient.Suggest<T> 方法

定义

命名空间:

Azure.Search.Documents

程序集:

Azure.Search.Documents.dll

包:

Azure.Search.Documents v11.5.1

Source:

SearchClient.cs

执行“键入时搜索”查询，该查询包含部分文本输入 (最少三个字符) 。 它返回在建议器感知字段中找到的匹配文本。 Azure 认知搜索在建议器中预定义的字段中查找匹配的值。 例如，如果对某个城市字段启用建议，则键入“sea”将生成包含“Seattle”、“Sea Tac”和“Seaside” (该字段) 的所有实际城市名称的文档。 建议

public virtual Azure.Response<Azure.Search.Documents.Models.SuggestResults<T>> Suggest<T> (string searchText, string suggesterName, Azure.Search.Documents.SuggestOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member Suggest : string * string * Azure.Search.Documents.SuggestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Models.SuggestResults<'T>>
override this.Suggest : string * string * Azure.Search.Documents.SuggestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Models.SuggestResults<'T>>

Public Overridable Function Suggest(Of T) (searchText As String, suggesterName As String, Optional options As SuggestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SuggestResults(Of T))

类型参数

T

映射到索引架构的 .NET 类型。 可以从索引中以文档的形式检索此类型的实例。

参数

searchText

String

用于建议文档的搜索文本。 必须至少为 1 个字符，并且不超过 100 个字符。

suggesterName

String

作为索引定义的一部分的建议器集合中指定的建议器的名称。

options

SuggestOptions

用于筛选、排序和其他建议查询行为的选项。

cancellationToken

CancellationToken

可选 CancellationToken ，用于传播应取消操作的通知。

返回

Response<SuggestResults<T>>

包含来自索引的建议查询结果的响应。

例外

RequestFailedException

搜索服务返回失败时引发。

注解

Suggest 和 SuggestAsync 方法支持通过类型参数 T 将搜索字段类型映射到 .NET 类型。可以提供自己的类型 T 或使用动态 SearchDocument。 有关类型映射的更多详细信息，请参阅 GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) 。