DocumentsOperationsExtensions.SearchAsync メソッド

定義

オーバーロード

SearchAsync(IDocumentsOperations, String, SearchParameters, SearchRequestOptions, CancellationToken)

検索インデックス内のドキュメントを検索します。 https://docs.microsoft.com/rest/api/searchservice/Search-Documents

SearchAsync<T>(IDocumentsOperations, String, SearchParameters, SearchRequestOptions, CancellationToken)

検索インデックス内のドキュメントを検索します。 https://docs.microsoft.com/rest/api/searchservice/Search-Documents

SearchAsync(IDocumentsOperations, String, SearchParameters, SearchRequestOptions, CancellationToken)

ソース:
DocumentsOperationsExtensions.cs

検索インデックス内のドキュメントを検索します。 https://docs.microsoft.com/rest/api/searchservice/Search-Documents

public static System.Threading.Tasks.Task<Microsoft.Azure.Search.Models.DocumentSearchResult<Microsoft.Azure.Search.Models.Document>> SearchAsync (this Microsoft.Azure.Search.IDocumentsOperations operations, string searchText, Microsoft.Azure.Search.Models.SearchParameters searchParameters = default, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, System.Threading.CancellationToken cancellationToken = default);
static member SearchAsync : Microsoft.Azure.Search.IDocumentsOperations * string * Microsoft.Azure.Search.Models.SearchParameters * Microsoft.Azure.Search.Models.SearchRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Search.Models.DocumentSearchResult<Microsoft.Azure.Search.Models.Document>>
<Extension()>
Public Function SearchAsync (operations As IDocumentsOperations, searchText As String, Optional searchParameters As SearchParameters = Nothing, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DocumentSearchResult(Of Document))

パラメーター

operations
IDocumentsOperations

この拡張メソッドの操作グループ。

searchText
String

フルテキスト検索クエリ式。すべてのドキュメントを照合するには、null または "*" を使用します。 検索クエリ構文の詳細については、以下を参照してください https://docs.microsoft.com/rest/api/searchservice/Simple-query-syntax-in-Azure-Search

searchParameters
SearchParameters

検索クエリをさらに絞り込むためのパラメーター。

searchRequestOptions
SearchRequestOptions

操作の追加パラメーター

cancellationToken
CancellationToken

キャンセル トークン。

戻り値

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

注釈

Search、SearchAsync、SearchWithHttpMessagesAsync メソッドの非ジェネリック オーバーロードでは、応答ペイロード内の JSON 型を .NET 型にマップすることをベスト エフォートで試みます。 詳細については、「 GetWithHttpMessagesAsync(String, IEnumerable<String>, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken) 」を参照してください。

Azure Cognitive Searchすべての結果を 1 つの応答に含めることができない場合、返される応答には、ContinueSearch に渡してより多くの結果を取得できる継続トークンが含まれます。 詳細については、「 DocumentSearchResult.ContinuationToken 」を参照してください。

適用対象

SearchAsync<T>(IDocumentsOperations, String, SearchParameters, SearchRequestOptions, CancellationToken)

ソース:
DocumentsOperationsExtensions.cs

検索インデックス内のドキュメントを検索します。 https://docs.microsoft.com/rest/api/searchservice/Search-Documents

public static System.Threading.Tasks.Task<Microsoft.Azure.Search.Models.DocumentSearchResult<T>> SearchAsync<T> (this Microsoft.Azure.Search.IDocumentsOperations operations, string searchText, Microsoft.Azure.Search.Models.SearchParameters searchParameters = default, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, System.Threading.CancellationToken cancellationToken = default);
static member SearchAsync : Microsoft.Azure.Search.IDocumentsOperations * string * Microsoft.Azure.Search.Models.SearchParameters * Microsoft.Azure.Search.Models.SearchRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Search.Models.DocumentSearchResult<'T>>
<Extension()>
Public Function SearchAsync(Of T) (operations As IDocumentsOperations, searchText As String, Optional searchParameters As SearchParameters = Nothing, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DocumentSearchResult(Of T))

型パラメーター

T

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

パラメーター

operations
IDocumentsOperations

この拡張メソッドの操作グループ。

searchText
String

フルテキスト検索クエリ式。すべてのドキュメントを照合するには、null または "*" を使用します。 検索クエリ構文の詳細については、以下を参照してください https://docs.microsoft.com/rest/api/searchservice/Simple-query-syntax-in-Azure-Search

searchParameters
SearchParameters

検索クエリをさらに絞り込むためのパラメーター。

searchRequestOptions
SearchRequestOptions

操作の追加パラメーター

cancellationToken
CancellationToken

キャンセル トークン。

戻り値

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

注釈

Search、SearchAsync、SearchWithHttpMessagesAsync メソッドのジェネリック オーバーロードでは、型パラメーター T を使用した .NET 型への検索フィールド型のマッピングがサポートされています。型マッピングの詳細については、 を参照してください GetWithHttpMessagesAsync<T>(String, IEnumerable<String>, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken)

Azure Cognitive Searchすべての結果を 1 つの応答に含めることができない場合、返される応答には、ContinueSearch に渡してより多くの結果を取得できる継続トークンが含まれます。 詳細については、「 DocumentSearchResult.ContinuationToken 」を参照してください。

適用対象