FormRecognizerClient.StartRecognizeCustomForms Method

Definition

Namespace:

Azure.AI.FormRecognizer

Assembly:

Azure.AI.FormRecognizer.dll

Package:

Azure.AI.FormRecognizer v4.1.0

Source:

FormRecognizerClient.cs

Recognizes pages from one or more forms, using a model trained with custom forms.

public virtual Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation StartRecognizeCustomForms (string modelId, System.IO.Stream form, Azure.AI.FormRecognizer.RecognizeCustomFormsOptions recognizeCustomFormsOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member StartRecognizeCustomForms : string * System.IO.Stream * Azure.AI.FormRecognizer.RecognizeCustomFormsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation
override this.StartRecognizeCustomForms : string * System.IO.Stream * Azure.AI.FormRecognizer.RecognizeCustomFormsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation

Public Overridable Function StartRecognizeCustomForms (modelId As String, form As Stream, Optional recognizeCustomFormsOptions As RecognizeCustomFormsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

RecognizeCustomFormsOperation

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