SearchClient.Suggest<T> メソッド

定義

名前空間:

Azure.Search.Documents

アセンブリ:

Azure.Search.Documents.dll

パッケージ:

Azure.Search.Documents v11.5.1

ソース:

SearchClient.cs

部分的なテキスト入力 (最小 3 文字) で構成される "型として検索" クエリを実行します。 suggester 対応フィールドで見つかった一致するテキストが返されます。 Azure Cognitive Searchは、Suggester で定義済みのフィールドで一致する値を検索します。 たとえば、都市フィールドで提案を有効にした場合、「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

インデックス定義の一部である suggesters コレクションで指定された suggester の名前。

options

SuggestOptions

フィルター処理、並べ替え、その他のクエリ動作に関するオプション。

cancellationToken

CancellationToken

操作を取り消す必要があることを示す通知を伝達する場合は省略可能 CancellationToken です。

戻り値

Response<SuggestResults<T>>

インデックスからの提案クエリ結果を含む応答。

例外

RequestFailedException

Search Service によってエラーが返されたときにスローされます。

注釈

Suggest メソッドと SuggestAsync メソッドでは、型パラメーター T を使用した .NET 型への検索フィールド型のマッピングがサポートされています。独自の型 T を指定することも、動的 SearchDocumentを使用することもできます。 型マッピングの詳細については、以下を参照してください GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) 。