FormRecognizerClient.StartRecognizeReceipts Method

  • Reference

Definition

Namespace:
Azure.AI.FormRecognizer
Assembly:
Azure.AI.FormRecognizer.dll
Package:
Azure.AI.FormRecognizer v4.1.0
Source:
FormRecognizerClient.cs

Recognizes values from one or more receipts.

See receipt fields for a list of available fields on a receipt.

public virtual Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation StartRecognizeReceipts (System.IO.Stream receipt, Azure.AI.FormRecognizer.RecognizeReceiptsOptions recognizeReceiptsOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member StartRecognizeReceipts : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeReceiptsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation
override this.StartRecognizeReceipts : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeReceiptsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation
Public Overridable Function StartRecognizeReceipts (receipt As Stream, Optional recognizeReceiptsOptions As RecognizeReceiptsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As RecognizeReceiptsOperation

Parameters

receipt
Stream

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

recognizeReceiptsOptions
RecognizeReceiptsOptions

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

RecognizeReceiptsOperation

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

Applies to