FormRecognizerClient.StartRecognizeCustomFormsAsync 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.
Recognizes pages from one or more forms, using a model trained with custom forms.
public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation> StartRecognizeCustomFormsAsync (string modelId, System.IO.Stream form, Azure.AI.FormRecognizer.RecognizeCustomFormsOptions recognizeCustomFormsOptions = default, System.Threading.CancellationToken cancellationToken = default);abstract member StartRecognizeCustomFormsAsync : string * System.IO.Stream * Azure.AI.FormRecognizer.RecognizeCustomFormsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation>
override this.StartRecognizeCustomFormsAsync : string * System.IO.Stream * Azure.AI.FormRecognizer.RecognizeCustomFormsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation>Public Overridable Function StartRecognizeCustomFormsAsync (modelId As String, form As Stream, Optional recognizeCustomFormsOptions As RecognizeCustomFormsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeCustomFormsOperation)Parameters
- modelId
- String
The ID of the model to use for recognizing form values.
- form
- Stream
The stream containing one or more forms to recognize elements from.
- recognizeCustomFormsOptions
- RecognizeCustomFormsOptions
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 RecognizeCustomFormsOperation to wait on this long-running operation. Its Value upon successful completion will contain recognized pages from the input document.
