BuildDocumentClassifierOptions Class

Package:
com.azure.ai.documentintelligence.models
Maven Artifact:
com.azure:azure-ai-documentintelligence:1.0.7
  • java.lang.Object
    • com.azure.ai.documentintelligence.models.BuildDocumentClassifierOptions

Implements

JsonSerializable<BuildDocumentClassifierOptions>

public final class BuildDocumentClassifierOptions
implements JsonSerializable<BuildDocumentClassifierOptions>

Request body to build a new custom document classifier.

Constructor Summary

Constructor Description
BuildDocumentClassifierOptions(String classifierId, Map<String,ClassifierDocumentTypeDetails> documentTypes)

Creates an instance of BuildDocumentClassifierOptions class.

Method Summary

Modifier and Type Method and Description
static BuildDocumentClassifierOptions fromJson(JsonReader jsonReader)

Reads an instance of BuildDocumentClassifierOptions from the JsonReader.
String getBaseClassifierId()

Get the baseClassifierId property: Base classifierId on top of which to train the classifier.
String getClassifierId()

Get the classifierId property: Unique document classifier name.
String getDescription()

Get the description property: Document classifier description.
Map<String,ClassifierDocumentTypeDetails> getDocumentTypes()

Get the documentTypes property: List of document types to classify against.
Boolean isAllowOverwrite()

Get the allowOverwrite property: Allow overwriting an existing classifier with the same name.
BuildDocumentClassifierOptions setAllowOverwrite(Boolean allowOverwrite)

Set the allowOverwrite property: Allow overwriting an existing classifier with the same name.
BuildDocumentClassifierOptions setBaseClassifierId(String baseClassifierId)

Set the baseClassifierId property: Base classifierId on top of which to train the classifier.
BuildDocumentClassifierOptions setDescription(String description)

Set the description property: Document classifier description.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

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

fromJson

public static BuildDocumentClassifierOptions fromJson(JsonReader jsonReader)

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:

IOException

 - If the deserialized JSON object was missing any required properties.

getBaseClassifierId

public String getBaseClassifierId()

Get the baseClassifierId property: Base classifierId on top of which to train the classifier.

Returns:

the baseClassifierId value.

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.

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.

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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to