ComposeDocumentModelRequest Class

Package:
com.azure.ai.documentintelligence.models
Maven Artifact:
com.azure:azure-ai-documentintelligence:1.0.0-beta.4
  • java.lang.Object
    • com.azure.ai.documentintelligence.models.ComposeDocumentModelRequest

Implements

JsonSerializable<ComposeDocumentModelRequest>

public final class ComposeDocumentModelRequest
implements JsonSerializable<ComposeDocumentModelRequest>

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

Constructor Summary

Constructor Description
ComposeDocumentModelRequest(String modelId, String classifierId, Map<String,DocumentTypeDetails> docTypes)

Creates an instance of ComposeDocumentModelRequest class.

Method Summary

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

Reads an instance of ComposeDocumentModelRequest 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> getDocTypes()

Get the docTypes 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.
ComposeDocumentModelRequest setDescription(String description)

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

Set the split property: File splitting behavior.
ComposeDocumentModelRequest 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

ComposeDocumentModelRequest

public ComposeDocumentModelRequest(String modelId, String classifierId, Map<String,DocumentTypeDetails> docTypes)

Creates an instance of ComposeDocumentModelRequest class.

Parameters:

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

Method Details

fromJson

public static ComposeDocumentModelRequest fromJson(JsonReader jsonReader)

Reads an instance of ComposeDocumentModelRequest from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ComposeDocumentModelRequest 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.

getDocTypes

public Map<String,DocumentTypeDetails> getDocTypes()

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

Returns:

the docTypes 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 ComposeDocumentModelRequest setDescription(String description)

Set the description property: Document model description.

Parameters:

description - the description value to set.

Returns:

the ComposeDocumentModelRequest object itself.

setSplit

public ComposeDocumentModelRequest setSplit(SplitMode split)

Set the split property: File splitting behavior.

Parameters:

split - the split value to set.

Returns:

the ComposeDocumentModelRequest object itself.

setTags

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

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to