IDocumentsOperations.SearchWithHttpMessagesAsync メソッド

定義

名前空間:

Microsoft.Azure.Search

アセンブリ:

Microsoft.Azure.Search.Data.dll

パッケージ:

Microsoft.Azure.Search.Data v10.1.0

オーバーロード

SearchWithHttpMessagesAsync(String, SearchParameters, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken)	検索インデックス内のドキュメントを検索します。 https://docs.microsoft.com/rest/api/searchservice/Search-Documents
SearchWithHttpMessagesAsync<T>(String, SearchParameters, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken)	検索インデックス内のドキュメントを検索します。 https://docs.microsoft.com/rest/api/searchservice/Search-Documents

SearchWithHttpMessagesAsync(String, SearchParameters, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken)

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

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Search.Models.DocumentSearchResult<Microsoft.Azure.Search.Models.Document>>> SearchWithHttpMessagesAsync (string searchText, Microsoft.Azure.Search.Models.SearchParameters searchParameters, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member SearchWithHttpMessagesAsync : string * Microsoft.Azure.Search.Models.SearchParameters * Microsoft.Azure.Search.Models.SearchRequestOptions * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Search.Models.DocumentSearchResult<Microsoft.Azure.Search.Models.Document>>>

Public Function SearchWithHttpMessagesAsync (searchText As String, searchParameters As SearchParameters, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of DocumentSearchResult(Of Document)))

パラメーター

searchText

String

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

searchParameters

SearchParameters

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

searchRequestOptions

SearchRequestOptions

操作の追加パラメーター

customHeaders

Dictionary<String,List<String>>

要求に追加されるヘッダー。

cancellationToken

CancellationToken

キャンセル トークン。

戻り値

Task<AzureOperationResponse<DocumentSearchResult<Document>>>

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

注釈

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

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

SearchWithHttpMessagesAsync<T>(String, SearchParameters, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken)

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

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Search.Models.DocumentSearchResult<T>>> SearchWithHttpMessagesAsync<T> (string searchText, Microsoft.Azure.Search.Models.SearchParameters searchParameters, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member SearchWithHttpMessagesAsync : string * Microsoft.Azure.Search.Models.SearchParameters * Microsoft.Azure.Search.Models.SearchRequestOptions * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Search.Models.DocumentSearchResult<'T>>>

Public Function SearchWithHttpMessagesAsync(Of T) (searchText As String, searchParameters As SearchParameters, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of DocumentSearchResult(Of T)))

型パラメーター

T

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

パラメーター

searchText

String

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

searchParameters

SearchParameters

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

searchRequestOptions

SearchRequestOptions

操作の追加パラメーター

customHeaders

Dictionary<String,List<String>>

要求に追加されるヘッダー。

cancellationToken

CancellationToken

キャンセル トークン。

戻り値

Task<AzureOperationResponse<DocumentSearchResult<T>>>

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

注釈

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

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