DocumentsOperationsExtensions.SuggestAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| SuggestAsync(IDocumentsOperations, String, String, SuggestParameters, SearchRequestOptions, CancellationToken) |
入力テキストと検索インデックス内の一致するドキュメントに基づいてクエリ用語を提案します。 https://docs.microsoft.com/rest/api/searchservice/Suggestions |
| SuggestAsync<T>(IDocumentsOperations, String, String, SuggestParameters, SearchRequestOptions, CancellationToken) |
入力テキストと検索インデックス内の一致するドキュメントに基づいてクエリ用語を提案します。 https://docs.microsoft.com/rest/api/searchservice/Suggestions |
SuggestAsync(IDocumentsOperations, String, String, SuggestParameters, SearchRequestOptions, CancellationToken)
入力テキストと検索インデックス内の一致するドキュメントに基づいてクエリ用語を提案します。 https://docs.microsoft.com/rest/api/searchservice/Suggestions
public static System.Threading.Tasks.Task<Microsoft.Azure.Search.Models.DocumentSuggestResult<Microsoft.Azure.Search.Models.Document>> SuggestAsync (this Microsoft.Azure.Search.IDocumentsOperations operations, string searchText, string suggesterName, Microsoft.Azure.Search.Models.SuggestParameters suggestParameters = default, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, System.Threading.CancellationToken cancellationToken = default);static member SuggestAsync : Microsoft.Azure.Search.IDocumentsOperations * string * string * Microsoft.Azure.Search.Models.SuggestParameters * Microsoft.Azure.Search.Models.SearchRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Search.Models.DocumentSuggestResult<Microsoft.Azure.Search.Models.Document>><Extension()>
Public Function SuggestAsync (operations As IDocumentsOperations, searchText As String, suggesterName As String, Optional suggestParameters As SuggestParameters = Nothing, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DocumentSuggestResult(Of Document))パラメーター
- operations
- IDocumentsOperations
この拡張メソッドの操作グループ。
- searchText
- String
候補の基にする検索テキスト。
- suggesterName
- String
インデックス定義の一部である suggesters コレクションで指定された suggester の名前。
- suggestParameters
- SuggestParameters
候補クエリをさらに絞り込むためのパラメーター。
- searchRequestOptions
- SearchRequestOptions
操作の追加パラメーター
- cancellationToken
- CancellationToken
キャンセル トークン。
戻り値
クエリに一致する候補テキストとドキュメントを含む応答。
注釈
Suggest、SuggestAsync、SuggestWithHttpMessagesAsync メソッドの非ジェネリック オーバーロードでは、応答ペイロード内の JSON 型を .NET 型にマップするためのベスト エフォート試行が行われます。 詳細については、「 GetWithHttpMessagesAsync(String, IEnumerable<String>, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken) 」を参照してください。
適用対象
SuggestAsync<T>(IDocumentsOperations, String, String, SuggestParameters, SearchRequestOptions, CancellationToken)
入力テキストと検索インデックス内の一致するドキュメントに基づいてクエリ用語を提案します。 https://docs.microsoft.com/rest/api/searchservice/Suggestions
public static System.Threading.Tasks.Task<Microsoft.Azure.Search.Models.DocumentSuggestResult<T>> SuggestAsync<T> (this Microsoft.Azure.Search.IDocumentsOperations operations, string searchText, string suggesterName, Microsoft.Azure.Search.Models.SuggestParameters suggestParameters = default, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, System.Threading.CancellationToken cancellationToken = default);static member SuggestAsync : Microsoft.Azure.Search.IDocumentsOperations * string * string * Microsoft.Azure.Search.Models.SuggestParameters * Microsoft.Azure.Search.Models.SearchRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Search.Models.DocumentSuggestResult<'T>><Extension()>
Public Function SuggestAsync(Of T) (operations As IDocumentsOperations, searchText As String, suggesterName As String, Optional suggestParameters As SuggestParameters = Nothing, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DocumentSuggestResult(Of T))型パラメーター
- T
インデックス スキーマにマッピングされる CLR タイプ。 この型のインスタンスは、インデックスからドキュメントとして取得できます。
パラメーター
- operations
- IDocumentsOperations
この拡張メソッドの操作グループ。
- searchText
- String
候補の基にする検索テキスト。
- suggesterName
- String
インデックス定義の一部である suggesters コレクションで指定された suggester の名前。
- suggestParameters
- SuggestParameters
候補クエリをさらに絞り込むためのパラメーター。
- searchRequestOptions
- SearchRequestOptions
操作の追加パラメーター
- cancellationToken
- CancellationToken
キャンセル トークン。
戻り値
クエリに一致する候補テキストとドキュメントを含む応答。
注釈
Suggest、SuggestAsync、SuggestWithHttpMessagesAsync メソッドのジェネリック オーバーロードでは、型パラメーター T を使用した .NET 型への検索フィールド型のマッピングがサポートされています。型マッピングの詳細については、以下を参照してください GetWithHttpMessagesAsync<T>(String, IEnumerable<String>, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken) 。
適用対象
Azure SDK for .NET