SearchClient.Search<T>(String, SearchOptions, CancellationToken) メソッド

定義

名前空間:

Azure.Search.Documents

アセンブリ:

Azure.Search.Documents.dll

パッケージ:

Azure.Search.Documents v11.4.0

検索インデックス内のドキュメントを検索します。 ドキュメントの検索

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

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

Public Overridable Function Search(Of T) (searchText As String, Optional options As SearchOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SearchResults(Of T))

型パラメーター

T

インデックス スキーマにマップされる .NET 型。 この型のインスタンスは、インデックスからドキュメントとして取得できます。

パラメーター

searchText

String

フルテキスト検索クエリ式。すべてのドキュメントに一致するには、"*" を使用するか、このパラメーターを省略します。 検索クエリ構文の詳細については、「Azure Cognitive Searchの単純なクエリ構文」を参照してください。

options

SearchOptions

フィルター処理、並べ替え、ファセット、ページング、その他の検索クエリ動作を指定できるオプション。

cancellationToken

CancellationToken

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

戻り値

Response<SearchResults<T>>

クエリに一致するドキュメントを含む応答。

例外

RequestFailedException

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

注釈

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

Azure Cognitive Searchは、すべての結果を 1 つの応答に含めることができない場合があります。その場合GetResults()、結果を列挙すると、自動的に追加の要求が行われます。 メソッドを使用して、一度にページの結果を AsPages(String, Nullable<Int32>) 処理することもできます。