Package com.azure.ai.documentintelligence.models

Class DocumentModelDetails

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

  • Method Details

    • getModelId

      public String getModelId()
      Get the modelId property: Unique document model name.
      Returns:
      the modelId value.

    • getDescription

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

    • getCreatedOn

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

    • getExpiresOn

      public OffsetDateTime getExpiresOn()
      Get the expiresOn property: Date and time (UTC) when the document model 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 model.
      Returns:
      the apiVersion value.

    • getTags

      public Map<String,String> getTags()
      Get the tags property: List of key-value tag attributes associated with the document model.
      Returns:
      the tags value.

    • getBuildMode

      public DocumentBuildMode getBuildMode()
      Get the buildMode property: Custom document model build mode.
      Returns:
      the buildMode 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.

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

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

    • getSplit

      public SplitMode getSplit()
      Get the split property: For composed models, the file splitting behavior.
      Returns:
      the split value.

    • getDocumentTypes

      public Map<String,DocumentTypeDetails> getDocumentTypes()
      Get the documentTypes property: Supported document types.
      Returns:
      the documentTypes value.

    • getWarnings

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

    • getTrainingHours

      public Double getTrainingHours()
      Get the trainingHours property: Number of V100-equivalent GPU hours consumed for model training.
      Returns:
      the trainingHours value.

    • toJson

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

    • fromJson

      public static DocumentModelDetails fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the DocumentModelDetails.