DocumentModelAdministrationClient.BuildDocumentModel Method

Definition

Namespace:

Azure.AI.FormRecognizer.DocumentAnalysis

Assembly:

Azure.AI.FormRecognizer.dll

Package:

Azure.AI.FormRecognizer v4.1.0

Overloads

BuildDocumentModel(WaitUntil, Uri, DocumentBuildMode, String, String, BuildDocumentModelOptions, CancellationToken)	Build a custom document analysis model from a collection of documents in an Azure Blob Storage container.
BuildDocumentModel(WaitUntil, DocumentContentSource, DocumentBuildMode, String, BuildDocumentModelOptions, CancellationToken)	Build a custom model from a collection of documents in an Azure Blob Storage container.

BuildDocumentModel(WaitUntil, Uri, DocumentBuildMode, String, String, BuildDocumentModelOptions, CancellationToken)

Source:

DocumentModelAdministrationClient.cs

Build a custom document analysis model from a collection of documents in an Azure Blob Storage container.

public virtual Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOperation BuildDocumentModel (Azure.WaitUntil waitUntil, Uri blobContainerUri, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentBuildMode buildMode, string modelId = default, string prefix = default, Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member BuildDocumentModel : Azure.WaitUntil * Uri * Azure.AI.FormRecognizer.DocumentAnalysis.DocumentBuildMode * string * string * Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOperation
override this.BuildDocumentModel : Azure.WaitUntil * Uri * Azure.AI.FormRecognizer.DocumentAnalysis.DocumentBuildMode * string * string * Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOperation

Public Overridable Function BuildDocumentModel (waitUntil As WaitUntil, blobContainerUri As Uri, buildMode As DocumentBuildMode, Optional modelId As String = Nothing, Optional prefix As String = Nothing, Optional options As BuildDocumentModelOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As BuildDocumentModelOperation

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.

blobContainerUri

Uri

An externally accessible Azure Blob Storage container URI pointing to the container that has your training files. Note that a container URI without SAS is accepted only when the container is public or has a managed identity configured. For more information on setting up a training data set, see this article.

buildMode

DocumentBuildMode

The technique to use to build the model. Use:

• Template: When the custom documents all have the same layout. Fields are expected to be in the same place across documents. Build time tends to be considerably shorter than Neural mode.
• Neural: Recommended mode when custom documents have different layouts. Fields are expected to be the same but they can be placed in different positions across documents.

For more information see here.

modelId

String

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

prefix

String

A case-sensitive prefix string to filter documents in the source path for building a model. For example, you may use the prefix to restrict subfolders.

options

BuildDocumentModelOptions

A set of options available for configuring the request. For example, set a model description or set a filter to apply to the documents in the source path.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

BuildDocumentModelOperation

A BuildDocumentModelOperation to wait on this long-running operation. Its Value upon successful completion will contain meta-data about the created custom model.

BuildDocumentModel(WaitUntil, DocumentContentSource, DocumentBuildMode, String, BuildDocumentModelOptions, CancellationToken)

Source:

DocumentModelAdministrationClient.cs

Build a custom model from a collection of documents in an Azure Blob Storage container.

public virtual Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOperation BuildDocumentModel (Azure.WaitUntil waitUntil, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentContentSource trainingDataSource, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentBuildMode buildMode, string modelId = default, Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member BuildDocumentModel : Azure.WaitUntil * Azure.AI.FormRecognizer.DocumentAnalysis.DocumentContentSource * Azure.AI.FormRecognizer.DocumentAnalysis.DocumentBuildMode * string * Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOperation
override this.BuildDocumentModel : Azure.WaitUntil * Azure.AI.FormRecognizer.DocumentAnalysis.DocumentContentSource * Azure.AI.FormRecognizer.DocumentAnalysis.DocumentBuildMode * string * Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOperation

Public Overridable Function BuildDocumentModel (waitUntil As WaitUntil, trainingDataSource As DocumentContentSource, buildMode As DocumentBuildMode, Optional modelId As String = Nothing, Optional options As BuildDocumentModelOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As BuildDocumentModelOperation

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.

trainingDataSource

DocumentContentSource

An externally accessible location that has your training files. See DocumentContentSource for an exhaustive list of source options. For more information on setting up a training data set, see this article.

buildMode

DocumentBuildMode

The technique to use to build the model. Use:

• Template: When the custom documents all have the same layout. Fields are expected to be in the same place across documents. Build time tends to be considerably shorter than Neural mode.
• Neural: Recommended mode when custom documents have different layouts. Fields are expected to be the same but they can be placed in different positions across documents.

For more information see here.

modelId

String

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

options

BuildDocumentModelOptions

A set of options available for configuring the request. For example, set a model description or set a filter to apply to the documents in the source path.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

BuildDocumentModelOperation

A BuildDocumentModelOperation to wait on this long-running operation. Its Value upon successful completion will contain meta-data about the created custom model.