Package com.azure.ai.documentintelligence.models

Class BuildDocumentModelRequest

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

  • Constructor Details

    • BuildDocumentModelRequest

      public BuildDocumentModelRequest(String modelId, DocumentBuildMode buildMode)
      Creates an instance of BuildDocumentModelRequest class.
      Parameters:
      modelId - the modelId value to set.
      buildMode - the buildMode value to set.

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

    • setDescription

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

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

    • setAzureBlobSource

      public BuildDocumentModelRequest setAzureBlobSource(AzureBlobContentSource azureBlobSource)
      Set the azureBlobSource property: Azure Blob Storage location containing the training data. Either azureBlobSource or azureBlobFileListSource must be specified.
      Parameters:
      azureBlobSource - the azureBlobSource value to set.
      Returns:
      the BuildDocumentModelRequest object itself.

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

    • setAzureBlobFileListSource

      public BuildDocumentModelRequest setAzureBlobFileListSource(AzureBlobFileListContentSource azureBlobFileListSource)
      Set the azureBlobFileListSource property: Azure Blob Storage file list specifying the training data. Either azureBlobSource or azureBlobFileListSource must be specified.
      Parameters:
      azureBlobFileListSource - the azureBlobFileListSource value to set.
      Returns:
      the BuildDocumentModelRequest object itself.

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

    • setTags

      public BuildDocumentModelRequest setTags(Map<String,String> tags)
      Set the tags property: List of key-value tag attributes associated with the document model.
      Parameters:
      tags - the tags value to set.
      Returns:
      the BuildDocumentModelRequest object itself.

    • getMaxTrainingHours

      public Double getMaxTrainingHours()
      Get the maxTrainingHours property: Max number of V100-equivalent GPU hours to use for model training. Default=0.5.
      Returns:
      the maxTrainingHours value.

    • setMaxTrainingHours

      public BuildDocumentModelRequest setMaxTrainingHours(Double maxTrainingHours)
      Set the maxTrainingHours property: Max number of V100-equivalent GPU hours to use for model training. Default=0.5.
      Parameters:
      maxTrainingHours - the maxTrainingHours value to set.
      Returns:
      the BuildDocumentModelRequest object itself.

    • isAllowOverwrite

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

    • setAllowOverwrite

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

    • fromJson

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