Partager via

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

Implements

JsonSerializable<DocumentModelDetails>

public final class DocumentModelDetails
implements JsonSerializable<DocumentModelDetails>

Document model info.

Method Summary

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

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

Get the apiVersion property: API version used to create this document model.
AzureBlobFileListContentSource getAzureBlobFileListSource()

Get the azureBlobFileListSource property: Azure Blob Storage file list specifying the training data.
AzureBlobContentSource getAzureBlobSource()

Get the azureBlobSource property: Azure Blob Storage location containing the training data.
DocumentBuildMode getBuildMode()

Get the buildMode property: Custom document model build mode.
String getClassifierId()

Get the classifierId property: For composed models, the custom classifier to split and classify the input file.
OffsetDateTime getCreatedOn()

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

Get the description property: Document model description.
Map<String,DocumentTypeDetails> getDocumentTypes()

Get the documentTypes property: Supported document types.
OffsetDateTime getExpiresOn()

Get the expiresOn property: Date and time (UTC) when the document model will expire.
String getModelId()

Get the modelId property: Unique document model name.
OffsetDateTime getModifiedOn()

Get the modifiedOn property: Date and time (UTC) when the document model was last modified.
SplitMode getSplit()

Get the split property: For composed models, the file splitting behavior.
Map<String,String> getTags()

Get the tags property: List of key-value tag attributes associated with the document model.
Double getTrainingHours()

Get the trainingHours property: Number of V100-equivalent GPU hours consumed for model training.
List<DocumentIntelligenceWarning> getWarnings()

Get the warnings property: List of warnings encountered while building the model.
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 DocumentModelDetails fromJson(JsonReader jsonReader)

Reads an instance of DocumentModelDetails from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DocumentModelDetails 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 model.

Returns:

the apiVersion value.

getAzureBlobFileListSource

public AzureBlobFileListContentSource getAzureBlobFileListSource()

Get the azureBlobFileListSource property: Azure Blob Storage file list specifying the training data. Either azureBlobSource or azureBlobFileListSource must be specified.

Returns:

the azureBlobFileListSource value.

getAzureBlobSource

public AzureBlobContentSource getAzureBlobSource()

Get the azureBlobSource property: Azure Blob Storage location containing the training data. Either azureBlobSource or azureBlobFileListSource must be specified.

Returns:

the azureBlobSource value.

getBuildMode

public DocumentBuildMode getBuildMode()

Get the buildMode property: Custom document model build mode.

Returns:

the buildMode value.

getClassifierId

public String getClassifierId()

Get the classifierId property: For composed models, the custom classifier to split and classify the input file.

Returns:

the classifierId value.

getCreatedOn

public OffsetDateTime getCreatedOn()

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

Returns:

the createdOn value.

getDescription

public String getDescription()

Get the description property: Document model description.

Returns:

the description value.

getDocumentTypes

public Map getDocumentTypes()

Get the documentTypes property: Supported document types.

Returns:

the documentTypes value.

getExpiresOn

public OffsetDateTime getExpiresOn()

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

Returns:

the expiresOn value.

getModelId

public String getModelId()

Get the modelId property: Unique document model name.

Returns:

the modelId value.

getModifiedOn

public OffsetDateTime getModifiedOn()

Get the modifiedOn property: Date and time (UTC) when the document model was last modified.

Returns:

the modifiedOn value.

getSplit

public SplitMode getSplit()

Get the split property: For composed models, the file splitting behavior.

Returns:

the split value.

getTags

public Map getTags()

Get the tags property: List of key-value tag attributes associated with the document model.

Returns:

the tags value.

getTrainingHours

public Double getTrainingHours()

Get the trainingHours property: Number of V100-equivalent GPU hours consumed for model training.

Returns:

the trainingHours value.

getWarnings

public List getWarnings()

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

Returns:

the warnings value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to