DocumentsOperationsExtensions.ContinueSearchAsync Method

Definition

Namespace:

Microsoft.Azure.Search

Assembly:

Microsoft.Azure.Search.Data.dll

Package:

Microsoft.Azure.Search.Data v10.1.0

Overloads

ContinueSearchAsync(IDocumentsOperations, SearchContinuationToken, SearchRequestOptions, CancellationToken)	Retrieves the next page of search results from the search index. https://docs.microsoft.com/rest/api/searchservice/Search-Documents
ContinueSearchAsync<T>(IDocumentsOperations, SearchContinuationToken, SearchRequestOptions, CancellationToken)	Retrieves the next page of search results from the search index. https://docs.microsoft.com/rest/api/searchservice/Search-Documents

ContinueSearchAsync(IDocumentsOperations, SearchContinuationToken, SearchRequestOptions, CancellationToken)

Source:

DocumentsOperationsExtensions.cs

Retrieves the next page of search results from the search index. 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>> ContinueSearchAsync (this Microsoft.Azure.Search.IDocumentsOperations operations, Microsoft.Azure.Search.Models.SearchContinuationToken continuationToken, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member ContinueSearchAsync : Microsoft.Azure.Search.IDocumentsOperations * Microsoft.Azure.Search.Models.SearchContinuationToken * 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 ContinueSearchAsync (operations As IDocumentsOperations, continuationToken As SearchContinuationToken, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DocumentSearchResult(Of Document))

Parameters

operations

IDocumentsOperations

The operations group for this extension method.

continuationToken

SearchContinuationToken

Encapsulates the state required to fetch the next page of search results from the index.

searchRequestOptions

SearchRequestOptions

Additional parameters for the operation

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<DocumentSearchResult<Document>>

Response containing the documents matching the query.

Remarks

The non-generic overloads of the ContinueSearch, ContinueSearchAsync, and ContinueSearchWithHttpMessagesAsync methods make a best-effort attempt to map JSON types in the response payload to .NET types. See GetWithHttpMessagesAsync(String, IEnumerable<String>, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken) for more information.

If Azure Cognitive Search can't include all results in a single response, the response returned will include a continuation token that can be passed to ContinueSearch to retrieve more results. See DocumentSearchResult.ContinuationToken for more information.

Note that this method is not meant to help you implement paging of search results. You can implement paging using the Top and Skip parameters to the Search method.

ContinueSearchAsync<T>(IDocumentsOperations, SearchContinuationToken, SearchRequestOptions, CancellationToken)

Source:

DocumentsOperationsExtensions.cs

Retrieves the next page of search results from the search index. https://docs.microsoft.com/rest/api/searchservice/Search-Documents

public static System.Threading.Tasks.Task<Microsoft.Azure.Search.Models.DocumentSearchResult<T>> ContinueSearchAsync<T> (this Microsoft.Azure.Search.IDocumentsOperations operations, Microsoft.Azure.Search.Models.SearchContinuationToken continuationToken, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member ContinueSearchAsync : Microsoft.Azure.Search.IDocumentsOperations * Microsoft.Azure.Search.Models.SearchContinuationToken * Microsoft.Azure.Search.Models.SearchRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Search.Models.DocumentSearchResult<'T>>

<Extension()>
Public Function ContinueSearchAsync(Of T) (operations As IDocumentsOperations, continuationToken As SearchContinuationToken, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DocumentSearchResult(Of T))

Type Parameters

T

The CLR type that maps to the index schema. Instances of this type can be retrieved as documents from the index.

Parameters

operations

IDocumentsOperations

The operations group for this extension method.

continuationToken

SearchContinuationToken

Encapsulates the state required to fetch the next page of search results from the index.

searchRequestOptions

SearchRequestOptions

Additional parameters for the operation

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<DocumentSearchResult<T>>

Response containing the documents matching the query.

Remarks

The generic overloads of the ContinueSearch, ContinueSearchAsync, and ContinueSearchWithHttpMessagesAsync methods support mapping of search field types to .NET types via the type parameter T. See GetWithHttpMessagesAsync<T>(String, IEnumerable<String>, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken) for more details on the type mapping.

If Azure Cognitive Search can't include all results in a single response, the response returned will include a continuation token that can be passed to ContinueSearch to retrieve more results. See DocumentSearchResult.ContinuationToken for more information.

Note that this method is not meant to help you implement paging of search results. You can implement paging using the Top and Skip parameters to the Search method.