DocumentModelAdministrationClient.BuildDocumentClassifierAsync Method

Definition

Namespace:

Azure.AI.FormRecognizer.DocumentAnalysis

Assembly:

Azure.AI.FormRecognizer.dll

Package:

Azure.AI.FormRecognizer v4.1.0

Source:

DocumentModelAdministrationClient.cs

Builds a document classifier from training data stored in an Azure Blob Storage container.

public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentClassifierOperation> BuildDocumentClassifierAsync (Azure.WaitUntil waitUntil, System.Collections.Generic.IDictionary<string,Azure.AI.FormRecognizer.DocumentAnalysis.ClassifierDocumentTypeDetails> documentTypes, string classifierId = default, string description = default, System.Threading.CancellationToken cancellationToken = default);

abstract member BuildDocumentClassifierAsync : Azure.WaitUntil * System.Collections.Generic.IDictionary<string, Azure.AI.FormRecognizer.DocumentAnalysis.ClassifierDocumentTypeDetails> * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentClassifierOperation>
override this.BuildDocumentClassifierAsync : Azure.WaitUntil * System.Collections.Generic.IDictionary<string, Azure.AI.FormRecognizer.DocumentAnalysis.ClassifierDocumentTypeDetails> * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentClassifierOperation>

Public Overridable Function BuildDocumentClassifierAsync (waitUntil As WaitUntil, documentTypes As IDictionary(Of String, ClassifierDocumentTypeDetails), Optional classifierId As String = Nothing, Optional description As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of BuildDocumentClassifierOperation)

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.

documentTypes

IDictionary<String,ClassifierDocumentTypeDetails>

A mapping to the training data of each document type supported by the classifier. Keys are the names of the document types, and values are used to locate the training files stored in an Azure Blob Storage container.

classifierId

String

A unique ID for your classifier. If not specified, a classifier ID will be created for you.

description

String

An optional classifier description.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<BuildDocumentClassifierOperation>

A BuildDocumentClassifierOperation to wait on this long-running operation. Its Value upon successful completion will contain meta-data about the created document classifier.

Remarks

This method is only available for V2023_07_31 and newer.