DocumentAnalysisClient.ClassifyDocumentAsync Method

Definition

Namespace:

Azure.AI.FormRecognizer.DocumentAnalysis

Assembly:

Azure.AI.FormRecognizer.dll

Package:

Azure.AI.FormRecognizer v4.1.0

Source:

DocumentAnalysisClient.cs

Classifies one or more documents using a document classifier built with custom documents.

public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation> ClassifyDocumentAsync (Azure.WaitUntil waitUntil, string classifierId, System.IO.Stream document, System.Threading.CancellationToken cancellationToken = default);

abstract member ClassifyDocumentAsync : Azure.WaitUntil * string * System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation>
override this.ClassifyDocumentAsync : Azure.WaitUntil * string * System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation>

Public Overridable Function ClassifyDocumentAsync (waitUntil As WaitUntil, classifierId As String, document As Stream, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClassifyDocumentOperation)

Parameters

waitUntil

WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation.

classifierId

String

The ID of the document classifier to use.

document

Stream

The stream containing one or more documents to classify.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<ClassifyDocumentOperation>

A ClassifyDocumentOperation to wait on this long-running operation. Its Value upon successful completion will contain documents classified from the input.