Package com.azure.ai.documentintelligence.models

Class DocumentClassifierDetails

java.lang.Object
com.azure.ai.documentintelligence.models.DocumentClassifierDetails
All Implemented Interfaces:
com.azure.json.JsonSerializable<DocumentClassifierDetails>
public final class DocumentClassifierDetails extends Object implements com.azure.json.JsonSerializable<DocumentClassifierDetails>
Document classifier info.

  • Method Details

    • getClassifierId

      public String getClassifierId()
      Get the classifierId property: Unique document classifier name.
      Returns:
      the classifierId value.

    • getDescription

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

    • getCreatedOn

      public OffsetDateTime getCreatedOn()
      Get the createdOn property: Date and time (UTC) when the document classifier was created.
      Returns:
      the createdOn value.

    • getExpiresOn

      public OffsetDateTime getExpiresOn()
      Get the expiresOn property: Date and time (UTC) when the document classifier will expire.
      Returns:
      the expiresOn value.

    • getModifiedOn

      public OffsetDateTime getModifiedOn()
      Get the modifiedOn property: Date and time (UTC) when the document model was last modified.
      Returns:
      the modifiedOn value.

    • getApiVersion

      public String getApiVersion()
      Get the apiVersion property: API version used to create this document classifier.
      Returns:
      the apiVersion value.

    • getBaseClassifierId

      public String getBaseClassifierId()
      Get the baseClassifierId property: Base classifierId on top of which the classifier was trained.
      Returns:
      the baseClassifierId value.

    • getDocumentTypes

      public Map<String,ClassifierDocumentTypeDetails> getDocumentTypes()
      Get the documentTypes property: List of document types to classify against.
      Returns:
      the documentTypes value.

    • getWarnings

      public List<DocumentIntelligenceWarning> getWarnings()
      Get the warnings property: List of warnings encountered while building the classifier.
      Returns:
      the warnings value.

    • toJson

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

    • fromJson

      public static DocumentClassifierDetails fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of DocumentClassifierDetails from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of DocumentClassifierDetails 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 DocumentClassifierDetails.