ComposeDocumentModelOptions Class

Package:

com.azure.ai.formrecognizer.documentanalysis.administration.models

Maven Artifact:

com.azure:azure-ai-formrecognizer:4.1.12

• java.lang.Object
• • com.azure.ai.formrecognizer.documentanalysis.administration.models.ComposeDocumentModelOptions

public final class ComposeDocumentModelOptions

The configurable options to pass when creating a composed document model.

Constructor Summary

Constructor	Description
ComposeDocumentModelOptions()	Create a ComposeDocumentModelOptions instance.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Get the optional model description defined by the user.
String	getModelId() Get the unique model identifier for the model.
Map<String,String>	getTags() Get the user defined attributes associated with the model.
ComposeDocumentModelOptions	setDescription(String description) Set the optional model description defined by the user.
ComposeDocumentModelOptions	setModelId(String modelId) Set the unique model identifier for the model.
ComposeDocumentModelOptions	setTags(Map<String,String> tags) Set the user defined attributes associated with the model.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ComposeDocumentModelOptions

public ComposeDocumentModelOptions()

Create a ComposeDocumentModelOptions instance.

Method Details

getDescription

public String getDescription()

Get the optional model description defined by the user.

Returns:

the modelName.

getModelId

public String getModelId()

Get the unique model identifier for the model.

Returns:

the modelId

getTags

public Map getTags()

Get the user defined attributes associated with the model.

Returns:

the tags value.

setDescription

public ComposeDocumentModelOptions setDescription(String description)

Set the optional model description defined by the user.

Parameters:

description - the user defined model description to set.

Returns:

the updated ComposeDocumentModelOptions value.

setModelId

public ComposeDocumentModelOptions setModelId(String modelId)

Set the unique model identifier for the model. If not specified, a model ID will be created for you.

Parameters:

modelId - a unique model identifier

Returns:

the ComposeDocumentModelOptions object itself.

setTags

public ComposeDocumentModelOptions setTags(Map tags)

Set the user defined attributes associated with the model.

Parameters:

tags - the tags value to set.

Returns:

the ComposeDocumentModelOptions object itself.