DocumentTypeDetails Class

Package:

com.azure.ai.documentintelligence.models

Maven Artifact:

com.azure:azure-ai-documentintelligence:1.0.0

• java.lang.Object
• • com.azure.ai.documentintelligence.models.DocumentTypeDetails

Implements

JsonSerializable<DocumentTypeDetails>

public final class DocumentTypeDetails
implements JsonSerializable<DocumentTypeDetails>

Document type info.

Constructor Summary

Constructor	Description
DocumentTypeDetails()	Creates an instance of DocumentTypeDetails class.

Method Summary

Modifier and Type	Method and Description
static DocumentTypeDetails	fromJson(JsonReader jsonReader) Reads an instance of DocumentTypeDetails from the JsonReader.
DocumentBuildMode	getBuildMode() Get the buildMode property: Custom document model build mode.
Double	getConfidenceThreshold() Get the confidenceThreshold property: Only perform analysis if docType confidence is above threshold.
String	getDescription() Get the description property: Document model description.
List<DocumentAnalysisFeature>	getFeatures() Get the features property: List of optional analysis features.
Map<String,Double>	getFieldConfidence() Get the fieldConfidence property: Estimated confidence for each field.
Map<String,DocumentFieldSchema>	getFieldSchema() Get the fieldSchema property: Description of the document semantic schema using a JSON Schema style syntax.
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.
List<String>	getQueryFields() Get the queryFields property: List of additional fields to extract.
DocumentTypeDetails	setBuildMode(DocumentBuildMode buildMode) Set the buildMode property: Custom document model build mode.
DocumentTypeDetails	setConfidenceThreshold(Double confidenceThreshold) Set the confidenceThreshold property: Only perform analysis if docType confidence is above threshold.
DocumentTypeDetails	setDescription(String description) Set the description property: Document model description.
DocumentTypeDetails	setFeatures(List<DocumentAnalysisFeature> features) Set the features property: List of optional analysis features.
DocumentTypeDetails	setFieldConfidence(Map<String,Double> fieldConfidence) Set the fieldConfidence property: Estimated confidence for each field.
DocumentTypeDetails	setFieldSchema(Map<String,DocumentFieldSchema> fieldSchema) Set the fieldSchema property: Description of the document semantic schema using a JSON Schema style syntax.
DocumentTypeDetails	setMaxDocumentsToAnalyze(Integer maxDocumentsToAnalyze) Set the maxDocumentsToAnalyze property: Maximum number of documents of specified type to analyze.
DocumentTypeDetails	setModelId(String modelId) Set the modelId property: Document model to use for analyzing documents with specified type.
DocumentTypeDetails	setQueryFields(List<String> queryFields) Set the queryFields property: List of additional fields to extract.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DocumentTypeDetails

public DocumentTypeDetails()

Creates an instance of DocumentTypeDetails class.

Method Details

fromJson

public static DocumentTypeDetails fromJson(JsonReader jsonReader)

Reads an instance of DocumentTypeDetails from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If an error occurs while reading the DocumentTypeDetails.

getBuildMode

public DocumentBuildMode getBuildMode()

Get the buildMode property: Custom document model build mode.

Returns:

the buildMode value.

getConfidenceThreshold

public Double getConfidenceThreshold()

Get the confidenceThreshold property: Only perform analysis if docType confidence is above threshold.

Returns:

the confidenceThreshold value.

getDescription

public String getDescription()

Get the description property: Document model description.

Returns:

the description value.

getFeatures

public List getFeatures()

Get the features property: List of optional analysis features.

Returns:

the features value.

getFieldConfidence

public Map getFieldConfidence()

Get the fieldConfidence property: Estimated confidence for each field.

Returns:

the fieldConfidence value.

getFieldSchema

public Map getFieldSchema()

Get the fieldSchema property: Description of the document semantic schema using a JSON Schema style syntax.

Returns:

the fieldSchema 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.

getQueryFields

public List getQueryFields()

Get the queryFields property: List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber".

Returns:

the queryFields value.

setBuildMode

public DocumentTypeDetails setBuildMode(DocumentBuildMode buildMode)

Set the buildMode property: Custom document model build mode.

Parameters:

buildMode - the buildMode value to set.

Returns:

the DocumentTypeDetails object itself.

setConfidenceThreshold

public DocumentTypeDetails setConfidenceThreshold(Double confidenceThreshold)

Set the confidenceThreshold property: Only perform analysis if docType confidence is above threshold.

Parameters:

confidenceThreshold - the confidenceThreshold value to set.

Returns:

the DocumentTypeDetails object itself.

setDescription

public DocumentTypeDetails setDescription(String description)

Set the description property: Document model description.

Parameters:

description - the description value to set.

Returns:

the DocumentTypeDetails object itself.

setFeatures

public DocumentTypeDetails setFeatures(List features)

Set the features property: List of optional analysis features.

Parameters:

features - the features value to set.

Returns:

the DocumentTypeDetails object itself.

setFieldConfidence

public DocumentTypeDetails setFieldConfidence(Map fieldConfidence)

Set the fieldConfidence property: Estimated confidence for each field.

Parameters:

fieldConfidence - the fieldConfidence value to set.

Returns:

the DocumentTypeDetails object itself.

setFieldSchema

public DocumentTypeDetails setFieldSchema(Map fieldSchema)

Set the fieldSchema property: Description of the document semantic schema using a JSON Schema style syntax.

Parameters:

fieldSchema - the fieldSchema value to set.

Returns:

the DocumentTypeDetails object itself.

setMaxDocumentsToAnalyze

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

setModelId

public DocumentTypeDetails setModelId(String modelId)

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

Parameters:

modelId - the modelId value to set.

Returns:

the DocumentTypeDetails object itself.

setQueryFields

public DocumentTypeDetails setQueryFields(List queryFields)

Set the queryFields property: List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber".

Parameters:

queryFields - the queryFields value to set.

Returns:

the DocumentTypeDetails object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException