FormRecognizerClient.StartRecognizeIdentityDocumentsAsync 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.
Analyze identity documents using optical character recognition (OCR) and a prebuilt model trained on identity documents to extract key information from passports and US driver licenses.
See identity document fields for a list of available fields on an identity document.
public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation> StartRecognizeIdentityDocumentsAsync (System.IO.Stream identityDocument, Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions recognizeIdentityDocumentsOptions = default, System.Threading.CancellationToken cancellationToken = default);abstract member StartRecognizeIdentityDocumentsAsync : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation>
override this.StartRecognizeIdentityDocumentsAsync : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation>Public Overridable Function StartRecognizeIdentityDocumentsAsync (identityDocument As Stream, Optional recognizeIdentityDocumentsOptions As RecognizeIdentityDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeIdentityDocumentsOperation)Parameters
- identityDocument
- Stream
The stream containing the one or more identity documents to recognize values from.
- recognizeIdentityDocumentsOptions
- RecognizeIdentityDocumentsOptions
A set of options available for configuring the recognize request. For example, specify the content type of the form, or whether or not to include form elements.
- cancellationToken
- CancellationToken
A CancellationToken controlling the request lifetime.
Returns
A RecognizeIdentityDocumentsOperation to wait on this long-running operation. Its Value upon successful completion will contain the extracted identity document information.
Remarks
Method is only available for V2_1.
