FormRecognizerClient.StartRecognizeCustomFormsFromUriAsync(String, Uri, RecognizeCustomFormsOptions, CancellationToken) Method

Definition

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> StartRecognizeCustomFormsFromUriAsync (string modelId, Uri formUri, Azure.AI.FormRecognizer.RecognizeCustomFormsOptions recognizeCustomFormsOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member StartRecognizeCustomFormsFromUriAsync : string * Uri * Azure.AI.FormRecognizer.RecognizeCustomFormsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation>
override this.StartRecognizeCustomFormsFromUriAsync : string * Uri * Azure.AI.FormRecognizer.RecognizeCustomFormsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation>
Public Overridable Function StartRecognizeCustomFormsFromUriAsync (modelId As String, formUri As Uri, 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.

formUri
Uri

The absolute URI of the remote file 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

Task<RecognizeCustomFormsOperation>

A RecognizeCustomFormsOperation to wait on this long-running operation. Its Value upon successful completion will contain recognized pages from the input document.

Applies to