BuildDocumentModelOptions Class

Package:

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

Maven Artifact:

com.azure:azure-ai-formrecognizer:4.1.7

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

public final class BuildDocumentModelOptions

The configurable options to pass when building document models.

Constructor Summary

Constructor	Description
BuildDocumentModelOptions()	Create a BuildDocumentModelOptions instance.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Get the model description.
String	getModelId() Get the unique model identifier for the model.
Map<String,String>	getTags() Get the user defined attributes associated with the model.
BuildDocumentModelOptions	setDescription(String description) Set the model description.
BuildDocumentModelOptions	setModelId(String modelId) Set the unique model identifier for the model.
BuildDocumentModelOptions	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

BuildDocumentModelOptions

public BuildDocumentModelOptions()

Create a BuildDocumentModelOptions instance.

Method Details

getDescription

public String getDescription()

Get the model description.

Returns:

the model description value.

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 BuildDocumentModelOptions setDescription(String description)

Set the model description.

Parameters:

description - the model description value to set.

Returns:

the BuildDocumentModelOptions object itself.

setModelId

public BuildDocumentModelOptions 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 BuildDocumentModelOptions object itself.

setTags

public BuildDocumentModelOptions setTags(Map tags)

Set the user defined attributes associated with the model.

Parameters:

tags - the tags value to set.

Returns:

the BuildDocumentModelOptions object itself.