Package com.azure.ai.documentintelligence.models

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 Details

    • DocumentTypeDetails

      public DocumentTypeDetails()
      Creates an instance of DocumentTypeDetails class.

  • Method Details

    • getDescription

      public String getDescription()
      Get the description property: Document model description.
      Returns:
      the description value.

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

    • getBuildMode

      public DocumentBuildMode getBuildMode()
      Get the buildMode property: Custom document model build mode.
      Returns:
      the buildMode 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.

    • getFieldSchema

      public Map<String,DocumentFieldSchema> getFieldSchema()
      Get the fieldSchema property: Description of the document semantic schema using a JSON Schema style syntax.
      Returns:
      the fieldSchema value.

    • setFieldSchema

      public DocumentTypeDetails setFieldSchema(Map<String,DocumentFieldSchema> 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.

    • getFieldConfidence

      public Map<String,Double> getFieldConfidence()
      Get the fieldConfidence property: Estimated confidence for each field.
      Returns:
      the fieldConfidence value.

    • setFieldConfidence

      public DocumentTypeDetails setFieldConfidence(Map<String,Double> fieldConfidence)
      Set the fieldConfidence property: Estimated confidence for each field.
      Parameters:
      fieldConfidence - the fieldConfidence value to set.
      Returns:
      the DocumentTypeDetails object itself.

    • getModelId

      public String getModelId()
      Get the modelId property: Document model to use for analyzing documents with specified type.
      Returns:
      the modelId value.

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

    • getConfidenceThreshold

      public Double getConfidenceThreshold()
      Get the confidenceThreshold property: Only perform analysis if docType confidence is above threshold.
      Returns:
      the confidenceThreshold value.

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

    • getFeatures

      public List<DocumentAnalysisFeature> getFeatures()
      Get the features property: List of optional analysis features.
      Returns:
      the features value.

    • setFeatures

      public DocumentTypeDetails setFeatures(List<DocumentAnalysisFeature> features)
      Set the features property: List of optional analysis features.
      Parameters:
      features - the features value to set.
      Returns:
      the DocumentTypeDetails object itself.

    • getQueryFields

      public List<String> getQueryFields()
      Get the queryFields property: List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber".
      Returns:
      the queryFields value.

    • setQueryFields

      public DocumentTypeDetails setQueryFields(List<String> 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.

    • getMaxDocumentsToAnalyze

      public Integer getMaxDocumentsToAnalyze()
      Get the maxDocumentsToAnalyze property: Maximum number of documents of specified type to analyze. Default=all.
      Returns:
      the maxDocumentsToAnalyze value.

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<DocumentTypeDetails>
      Throws:
      IOException

    • fromJson

      public static DocumentTypeDetails fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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.