Package com.azure.ai.documentintelligence.models

Class BuildDocumentClassifierOptions

java.lang.Object
com.azure.ai.documentintelligence.models.BuildDocumentClassifierOptions
All Implemented Interfaces:
com.azure.json.JsonSerializable<BuildDocumentClassifierOptions>
public final class BuildDocumentClassifierOptions extends Object implements com.azure.json.JsonSerializable<BuildDocumentClassifierOptions>
Request body to build a new custom document classifier.

  • Constructor Details

    • BuildDocumentClassifierOptions

      public BuildDocumentClassifierOptions(String classifierId, Map<String,ClassifierDocumentTypeDetails> documentTypes)
      Creates an instance of BuildDocumentClassifierOptions class.
      Parameters:
      classifierId - the classifierId value to set.
      documentTypes - the documentTypes value to set.

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

    • setDescription

      public BuildDocumentClassifierOptions setDescription(String description)
      Set the description property: Document classifier description.
      Parameters:
      description - the description value to set.
      Returns:
      the BuildDocumentClassifierOptions object itself.

    • getBaseClassifierId

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

    • setBaseClassifierId

      public BuildDocumentClassifierOptions setBaseClassifierId(String baseClassifierId)
      Set the baseClassifierId property: Base classifierId on top of which to train the classifier.
      Parameters:
      baseClassifierId - the baseClassifierId value to set.
      Returns:
      the BuildDocumentClassifierOptions object itself.

    • getDocumentTypes

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

    • isAllowOverwrite

      public Boolean isAllowOverwrite()
      Get the allowOverwrite property: Allow overwriting an existing classifier with the same name.
      Returns:
      the allowOverwrite value.

    • setAllowOverwrite

      public BuildDocumentClassifierOptions setAllowOverwrite(Boolean allowOverwrite)
      Set the allowOverwrite property: Allow overwriting an existing classifier with the same name.
      Parameters:
      allowOverwrite - the allowOverwrite value to set.
      Returns:
      the BuildDocumentClassifierOptions 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<BuildDocumentClassifierOptions>
      Throws:
      IOException

    • fromJson

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