Partilhar via

DocumentClassifierDetails Class

  • Reference
Package:
com.azure.ai.documentintelligence.models
Maven Artifact:
com.azure:azure-ai-documentintelligence:1.0.0
  • java.lang.Object
    • com.azure.ai.documentintelligence.models.DocumentClassifierDetails

Implements

JsonSerializable<DocumentClassifierDetails>

public final class DocumentClassifierDetails
implements JsonSerializable<DocumentClassifierDetails>

Document classifier info.

Method Summary

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

Reads an instance of DocumentClassifierDetails from the JsonReader.
String getApiVersion()

Get the apiVersion property: API version used to create this document classifier.
String getBaseClassifierId()

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

Get the classifierId property: Unique document classifier name.
OffsetDateTime getCreatedOn()

Get the createdOn property: Date and time (UTC) when the document classifier was created.
String getDescription()

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

Get the documentTypes property: List of document types to classify against.
OffsetDateTime getExpiresOn()

Get the expiresOn property: Date and time (UTC) when the document classifier will expire.
OffsetDateTime getModifiedOn()

Get the modifiedOn property: Date and time (UTC) when the document model was last modified.
List<DocumentIntelligenceWarning> getWarnings()

Get the warnings property: List of warnings encountered while building the classifier.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static DocumentClassifierDetails fromJson(JsonReader jsonReader)

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:

IOException

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

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.

getClassifierId

public String getClassifierId()

Get the classifierId property: Unique document classifier name.

Returns:

the classifierId value.

getCreatedOn

public OffsetDateTime getCreatedOn()

Get the createdOn property: Date and time (UTC) when the document classifier was created.

Returns:

the createdOn value.

getDescription

public String getDescription()

Get the description property: Document classifier description.

Returns:

the description value.

getDocumentTypes

public Map getDocumentTypes()

Get the documentTypes property: List of document types to classify against.

Returns:

the documentTypes 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.

getWarnings

public List getWarnings()

Get the warnings property: List of warnings encountered while building the classifier.

Returns:

the warnings value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to