SearchClient.SearchAsync<T> メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
検索インデックス内のドキュメントを検索します。 ドキュメントの検索
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.SearchResults<T>>> SearchAsync<T> (string searchText, Azure.Search.Documents.SearchOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member SearchAsync : string * Azure.Search.Documents.SearchOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.SearchResults<'T>>>
override this.SearchAsync : string * Azure.Search.Documents.SearchOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.SearchResults<'T>>>Public Overridable Function SearchAsync(Of T) (searchText As String, Optional options As SearchOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SearchResults(Of T)))型パラメーター
- T
インデックス スキーマにマップされる .NET 型。 この型のインスタンスは、インデックスからドキュメントとして取得できます。
パラメーター
- searchText
- String
フルテキスト検索クエリ式。すべてのドキュメントに一致するには、"*" を使用するか、このパラメーターを省略します。 検索クエリ構文の詳細については、「Azure Cognitive Searchの単純なクエリ構文」を参照してください。
- options
- SearchOptions
フィルター処理、並べ替え、ファセット、ページング、およびその他の検索クエリの動作を指定できるオプション。
- cancellationToken
- CancellationToken
操作を取り消す必要がある通知を伝達する場合は省略可能 CancellationToken です。
戻り値
クエリに一致するドキュメントを含む応答。
例外
Search Service によってエラーが返されたときにスローされます。
注釈
Search メソッドと SearchAsync メソッドでは、型パラメーター T を使用した .NET 型への検索フィールド型のマッピングがサポートされています。独自の型 T を指定することも、動的 SearchDocumentを使用することもできます。 型マッピングの詳細については、 を参照してください GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) 。
Azure Cognitive Search、すべての結果を 1 つの応答に含めることができない場合があります。その場合GetResultsAsync()、結果を列挙すると、追加の要求が自動的に続行されます。 メソッドを使用して、一度に 1 ページずつ結果を AsPages(String, Nullable<Int32>) 処理することもできます。