ComponentDocumentModelDetails 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.ComponentDocumentModelDetails

Implements

JsonSerializable<ComponentDocumentModelDetails>

public final class ComponentDocumentModelDetails
implements JsonSerializable<ComponentDocumentModelDetails>

A component of a composed document model.

Constructor Summary

Constructor Description
ComponentDocumentModelDetails(String modelId)

Creates an instance of ComponentDocumentModelDetails class.

Method Summary

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

Reads an instance of ComponentDocumentModelDetails from the JsonReader.
String getDocType()

Get the docType property: Document type.
Integer getMaxDocumentsToAnalyze()

Get the maxDocumentsToAnalyze property: Maximum number of documents of specified type to analyze.
String getModelId()

Get the modelId property: Document model to use for analyzing documents with specified type.
ComponentDocumentModelDetails setDocType(String docType)

Set the docType property: Document type.
ComponentDocumentModelDetails setMaxDocumentsToAnalyze(Integer maxDocumentsToAnalyze)

Set the maxDocumentsToAnalyze property: Maximum number of documents of specified type to analyze.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ComponentDocumentModelDetails

public ComponentDocumentModelDetails(String modelId)

Creates an instance of ComponentDocumentModelDetails class.

Parameters:

modelId - the modelId value to set.

Method Details

fromJson

public static ComponentDocumentModelDetails fromJson(JsonReader jsonReader)

Reads an instance of ComponentDocumentModelDetails from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getDocType

public String getDocType()

Get the docType property: Document type.

Returns:

the docType value.

getMaxDocumentsToAnalyze

public Integer getMaxDocumentsToAnalyze()

Get the maxDocumentsToAnalyze property: Maximum number of documents of specified type to analyze. Default=all.

Returns:

the maxDocumentsToAnalyze value.

getModelId

public String getModelId()

Get the modelId property: Document model to use for analyzing documents with specified type.

Returns:

the modelId value.

setDocType

public ComponentDocumentModelDetails setDocType(String docType)

Set the docType property: Document type.

Parameters:

docType - the docType value to set.

Returns:

the ComponentDocumentModelDetails object itself.

setMaxDocumentsToAnalyze

public ComponentDocumentModelDetails setMaxDocumentsToAnalyze(Integer maxDocumentsToAnalyze)

Set the maxDocumentsToAnalyze property: Maximum number of documents of specified type to analyze. Default=all.

Parameters:

maxDocumentsToAnalyze - the maxDocumentsToAnalyze value to set.

Returns:

the ComponentDocumentModelDetails object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to