FormRecognizerClient.StartRecognizeInvoicesAsync(Stream, RecognizeInvoicesOptions, CancellationToken) Method

Definition

Recognizes values from one or more invoices.

See invoice fields for a list of available fields on an invoice.

public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation> StartRecognizeInvoicesAsync (System.IO.Stream invoice, Azure.AI.FormRecognizer.RecognizeInvoicesOptions recognizeInvoicesOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member StartRecognizeInvoicesAsync : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeInvoicesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation>
override this.StartRecognizeInvoicesAsync : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeInvoicesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation>
Public Overridable Function StartRecognizeInvoicesAsync (invoice As Stream, Optional recognizeInvoicesOptions As RecognizeInvoicesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeInvoicesOperation)

Parameters

invoice
Stream

The stream containing the one or more invoices to recognize values from.

recognizeInvoicesOptions
RecognizeInvoicesOptions

A set of options available for configuring the recognize request. For example, specify the content type of the form, the locale of the form, or whether or not to include form elements.

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<RecognizeInvoicesOperation>

A RecognizeInvoicesOperation to wait on this long-running operation. Its Value upon successful completion will contain the extracted invoices.

Remarks

Method is only available for V2_1 and up.

Applies to