FormRecognizerClient.StartRecognizeBusinessCardsAsync(Stream, RecognizeBusinessCardsOptions, CancellationToken) Method

Definition

Recognizes values from one or more business cards.

See business card fields for a list of available fields on a business card.

public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation> StartRecognizeBusinessCardsAsync (System.IO.Stream businessCard, Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions recognizeBusinessCardsOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member StartRecognizeBusinessCardsAsync : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation>
override this.StartRecognizeBusinessCardsAsync : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation>
Public Overridable Function StartRecognizeBusinessCardsAsync (businessCard As Stream, Optional recognizeBusinessCardsOptions As RecognizeBusinessCardsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeBusinessCardsOperation)

Parameters

businessCard
Stream

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

recognizeBusinessCardsOptions
RecognizeBusinessCardsOptions

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<RecognizeBusinessCardsOperation>

A RecognizeBusinessCardsOperation to wait on this long-running operation. Its Value upon successful completion will contain the extracted business cards.

Remarks

Method is only available for V2_1 and up.

Applies to