Package com.azure.ai.formrecognizer.administration.models

Class ComposeModelOptions

java.lang.Object

com.azure.ai.formrecognizer.administration.models.ComposeModelOptions

public final class ComposeModelOptions
extends Object

The configurable options to pass when creating a composed model.

Constructor Summary

Constructors

Constructor	Description
ComposeModelOptions()

Method Summary

Modifier and Type	Method	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.
ComposeModelOptions	setDescription(String description)	Set the optional model description defined by the user.
ComposeModelOptions	setModelId(String modelId)	Set the unique model identifier for the model.
ComposeModelOptions	setTags(Map<String,String> tags)	Set the user defined attributes associated with the model.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ComposeModelOptions

public ComposeModelOptions()

Method Details

getDescription

public String getDescription()

Get the optional model description defined by the user.

Returns:

the modelName.

setDescription

public ComposeModelOptions setDescription(String description)

Set the optional model description defined by the user.

Parameters:

description - the user defined model description to set.

Returns:

the updated ComposeModelOptions value.

getTags

public Map<String,String> getTags()

Get the user defined attributes associated with the model.

Returns:

the tags value.

setTags

public ComposeModelOptions setTags(Map<String,String> tags)

Set the user defined attributes associated with the model.

Parameters:

tags - the tags value to set.

Returns:

the ComposeModelOptions object itself.

getModelId

public String getModelId()

Get the unique model identifier for the model.

Returns:

the modelId

setModelId

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