Class DocumentTypeDetails
java.lang.Object
com.azure.ai.documentintelligence.models.DocumentTypeDetails
- All Implemented Interfaces:
com.azure.json.JsonSerializable<DocumentTypeDetails>
public final class DocumentTypeDetails
extends Object
implements com.azure.json.JsonSerializable<DocumentTypeDetails>
Document type info.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DocumentTypeDetails
fromJson
(com.azure.json.JsonReader jsonReader) Reads an instance of DocumentTypeDetails from the JsonReader.Get the buildMode property: Custom document model build mode.Get the confidenceThreshold property: Only perform analysis if docType confidence is above threshold.Get the description property: Document model description.Get the features property: List of optional analysis features.Get the fieldConfidence property: Estimated confidence for each field.Get the fieldSchema property: Description of the document semantic schema using a JSON Schema style syntax.Get the maxDocumentsToAnalyze property: Maximum number of documents of specified type to analyze.Get the modelId property: Document model to use for analyzing documents with specified type.Get the queryFields property: List of additional fields to extract.setBuildMode
(DocumentBuildMode buildMode) Set the buildMode property: Custom document model build mode.setConfidenceThreshold
(Double confidenceThreshold) Set the confidenceThreshold property: Only perform analysis if docType confidence is above threshold.setDescription
(String description) Set the description property: Document model description.setFeatures
(List<DocumentAnalysisFeature> features) Set the features property: List of optional analysis features.setFieldConfidence
(Map<String, Double> fieldConfidence) Set the fieldConfidence property: Estimated confidence for each field.setFieldSchema
(Map<String, DocumentFieldSchema> fieldSchema) Set the fieldSchema property: Description of the document semantic schema using a JSON Schema style syntax.setMaxDocumentsToAnalyze
(Integer maxDocumentsToAnalyze) Set the maxDocumentsToAnalyze property: Maximum number of documents of specified type to analyze.setModelId
(String modelId) Set the modelId property: Document model to use for analyzing documents with specified type.setQueryFields
(List<String> queryFields) Set the queryFields property: List of additional fields to extract.com.azure.json.JsonWriter
toJson
(com.azure.json.JsonWriter jsonWriter) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.azure.json.JsonSerializable
toJson, toJson, toJsonBytes, toJsonString
-
Constructor Details
-
DocumentTypeDetails
public DocumentTypeDetails()Creates an instance of DocumentTypeDetails class.
-
-
Method Details
-
getDescription
Get the description property: Document model description.- Returns:
- the description value.
-
setDescription
Set the description property: Document model description.- Parameters:
description
- the description value to set.- Returns:
- the DocumentTypeDetails object itself.
-
getBuildMode
Get the buildMode property: Custom document model build mode.- Returns:
- the buildMode value.
-
setBuildMode
Set the buildMode property: Custom document model build mode.- Parameters:
buildMode
- the buildMode value to set.- Returns:
- the DocumentTypeDetails object itself.
-
getFieldSchema
Get the fieldSchema property: Description of the document semantic schema using a JSON Schema style syntax.- Returns:
- the fieldSchema value.
-
setFieldSchema
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.
-
getFieldConfidence
Get the fieldConfidence property: Estimated confidence for each field.- Returns:
- the fieldConfidence value.
-
setFieldConfidence
Set the fieldConfidence property: Estimated confidence for each field.- Parameters:
fieldConfidence
- the fieldConfidence value to set.- Returns:
- the DocumentTypeDetails object itself.
-
getModelId
Get the modelId property: Document model to use for analyzing documents with specified type.- Returns:
- the modelId value.
-
setModelId
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.
-
getConfidenceThreshold
Get the confidenceThreshold property: Only perform analysis if docType confidence is above threshold.- Returns:
- the confidenceThreshold value.
-
setConfidenceThreshold
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.
-
getFeatures
Get the features property: List of optional analysis features.- Returns:
- the features value.
-
setFeatures
Set the features property: List of optional analysis features.- Parameters:
features
- the features value to set.- Returns:
- the DocumentTypeDetails object itself.
-
getQueryFields
Get the queryFields property: List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber".- Returns:
- the queryFields value.
-
setQueryFields
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.
-
getMaxDocumentsToAnalyze
Get the maxDocumentsToAnalyze property: Maximum number of documents of specified type to analyze. Default=all.- Returns:
- the maxDocumentsToAnalyze value.
-
setMaxDocumentsToAnalyze
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.
-
toJson
- Specified by:
toJson
in interfacecom.azure.json.JsonSerializable<DocumentTypeDetails>
- Throws:
IOException
-
fromJson
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.
-