SearchClient.UploadDocumentsAsync<T> Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Upload documents to the index as a batch.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>> UploadDocumentsAsync<T> (System.Collections.Generic.IEnumerable<T> documents, Azure.Search.Documents.IndexDocumentsOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member UploadDocumentsAsync : seq<'T> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>>
override this.UploadDocumentsAsync : seq<'T> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>>Public Overridable Function UploadDocumentsAsync(Of T) (documents As IEnumerable(Of T), Optional options As IndexDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IndexDocumentsResult))Type Parameters
- T
The .NET type that maps to the index schema. Instances of this type can be retrieved as documents from the index.
Parameters
- documents
- IEnumerable<T>
The documents to upload.
- options
- IndexDocumentsOptions
Options that allow specifying document indexing behavior.
- cancellationToken
- CancellationToken
Optional CancellationToken to propagate notifications that the operation should be canceled.
Returns
Response containing the status of operations for all actions in the batch of actions.
Exceptions
Thrown when a failure is returned by the Search Service.
Remarks
The generic overloads of the UploadDocuments and UploadDocumentsAsync methods support mapping of search field types to .NET types via the type parameter T. See GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) for more details on the type mapping.
By default, an exception will only be thrown if the entire request fails. Individual failures are described in the Results collection. You can set ThrowOnAnyError if you want exceptions thrown on partial failure.
Applies to
Azure SDK for .NET