Package com.azure.ai.documentintelligence.models

Class ComponentDocumentModelDetails

java.lang.Object
com.azure.ai.documentintelligence.models.ComponentDocumentModelDetails
All Implemented Interfaces:
com.azure.json.JsonSerializable<ComponentDocumentModelDetails>
public final class ComponentDocumentModelDetails extends Object implements com.azure.json.JsonSerializable<ComponentDocumentModelDetails>
A component of a composed document model.

  • Constructor Details

    • ComponentDocumentModelDetails

      public ComponentDocumentModelDetails(String modelId)
      Creates an instance of ComponentDocumentModelDetails class.
      Parameters:
      modelId - the modelId value to set.

  • Method Details

    • getDocType

      public String getDocType()
      Get the docType property: Document type.
      Returns:
      the docType 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.

    • getModelId

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

    • 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 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 com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ComponentDocumentModelDetails>
      Throws:
      IOException

    • fromJson

      public static ComponentDocumentModelDetails fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the ComponentDocumentModelDetails.