ComposeDocumentModelOptions Class

Package:
com.azure.ai.documentintelligence.models
Maven Artifact:
com.azure:azure-ai-documentintelligence:1.0.7
  • java.lang.Object
    • com.azure.ai.documentintelligence.models.ComposeDocumentModelOptions

Implements

JsonSerializable<ComposeDocumentModelOptions>

public final class ComposeDocumentModelOptions
implements JsonSerializable<ComposeDocumentModelOptions>

Request body to create a composed document model from component document models.

Constructor Summary

Constructor Description
ComposeDocumentModelOptions(String modelId, String classifierId, Map<String,DocumentTypeDetails> documentTypes)

Creates an instance of ComposeDocumentModelOptions class.

Method Summary

Modifier and Type Method and Description
static ComposeDocumentModelOptions fromJson(JsonReader jsonReader)

Reads an instance of ComposeDocumentModelOptions from the JsonReader.
String getClassifierId()

Get the classifierId property: Custom classifier to split and classify the input file.
String getDescription()

Get the description property: Document model description.
Map<String,DocumentTypeDetails> getDocumentTypes()

Get the documentTypes property: Dictionary mapping supported docTypes to the corresponding document models.
String getModelId()

Get the modelId property: Unique document model name.
SplitMode getSplit()

Get the split property: File splitting behavior.
Map<String,String> getTags()

Get the tags property: List of key-value tag attributes associated with the document model.
ComposeDocumentModelOptions setDescription(String description)

Set the description property: Document model description.
ComposeDocumentModelOptions setSplit(SplitMode split)

Set the split property: File splitting behavior.
ComposeDocumentModelOptions setTags(Map<String,String> tags)

Set the tags property: List of key-value tag attributes associated with the document model.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ComposeDocumentModelOptions

public ComposeDocumentModelOptions(String modelId, String classifierId, Map<String,DocumentTypeDetails> documentTypes)

Creates an instance of ComposeDocumentModelOptions class.

Parameters:

modelId - the modelId value to set.
classifierId - the classifierId value to set.
documentTypes - the documentTypes value to set.

Method Details

fromJson

public static ComposeDocumentModelOptions fromJson(JsonReader jsonReader)

Reads an instance of ComposeDocumentModelOptions from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ComposeDocumentModelOptions if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getClassifierId

public String getClassifierId()

Get the classifierId property: Custom classifier to split and classify the input file.

Returns:

the classifierId value.

getDescription

public String getDescription()

Get the description property: Document model description.

Returns:

the description value.

getDocumentTypes

public Map<String,DocumentTypeDetails> getDocumentTypes()

Get the documentTypes property: Dictionary mapping supported docTypes to the corresponding document models.

Returns:

the documentTypes value.

getModelId

public String getModelId()

Get the modelId property: Unique document model name.

Returns:

the modelId value.

getSplit

public SplitMode getSplit()

Get the split property: File splitting behavior.

Returns:

the split value.

getTags

public Map<String,String> getTags()

Get the tags property: List of key-value tag attributes associated with the document model.

Returns:

the tags value.

setDescription

public ComposeDocumentModelOptions setDescription(String description)

Set the description property: Document model description.

Parameters:

description - the description value to set.

Returns:

the ComposeDocumentModelOptions object itself.

setSplit

public ComposeDocumentModelOptions setSplit(SplitMode split)

Set the split property: File splitting behavior.

Parameters:

split - the split value to set.

Returns:

the ComposeDocumentModelOptions object itself.

setTags

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

Set the tags property: List of key-value tag attributes associated with the document model.

Parameters:

tags - the tags value to set.

Returns:

the ComposeDocumentModelOptions object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to