DocumentModelAdministrationClient.ComposeDocumentModel Method

Definition

Namespace:

Azure.AI.FormRecognizer.DocumentAnalysis

Assembly:

Azure.AI.FormRecognizer.dll

Package:

Azure.AI.FormRecognizer v4.1.0

Source:

DocumentModelAdministrationClient.cs

Composes a model from a collection of existing models. A model built by composition allows multiple models to be called with a single model ID. When a document is submitted to be analyzed with its model ID, a classification step is first performed to route it to the correct custom model.

public virtual Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation ComposeDocumentModel (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<string> componentModelIds, string modelId = default, string description = default, System.Collections.Generic.IDictionary<string,string> tags = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ComposeDocumentModel : Azure.WaitUntil * seq<string> * string * string * System.Collections.Generic.IDictionary<string, string> * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation
override this.ComposeDocumentModel : Azure.WaitUntil * seq<string> * string * string * System.Collections.Generic.IDictionary<string, string> * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation

Public Overridable Function ComposeDocumentModel (waitUntil As WaitUntil, componentModelIds As IEnumerable(Of String), Optional modelId As String = Nothing, Optional description As String = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ComposeDocumentModelOperation

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.

componentModelIds

IEnumerable<String>

List of model ids to use in the composition.

modelId

String

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

description

String

An optional description to add to the model.

tags

IDictionary<String,String>

A list of user-defined key-value tag attributes associated with the model.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

ComposeDocumentModelOperation

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