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

Implements

JsonSerializable<BuildDocumentModelOptions>

public final class BuildDocumentModelOptions
implements JsonSerializable<BuildDocumentModelOptions>

Request body to build a new custom document model.

Constructor Summary

Constructor Description
BuildDocumentModelOptions(String modelId, DocumentBuildMode buildMode)

Creates an instance of BuildDocumentModelOptions class.

Method Summary

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

Reads an instance of BuildDocumentModelOptions from the JsonReader.
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 getDescription()

Get the description property: Document model description.
Double getMaxTrainingHours()

Get the maxTrainingHours property: Max number of V100-equivalent GPU hours to use for model training.
String getModelId()

Get the modelId property: Unique document model name.
Map<String,String> getTags()

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

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

Set the allowOverwrite property: Allow overwriting an existing model with the same name.
BuildDocumentModelOptions setAzureBlobFileListSource(AzureBlobFileListContentSource azureBlobFileListSource)

Set the azureBlobFileListSource property: Azure Blob Storage file list specifying the training data.
BuildDocumentModelOptions setAzureBlobSource(AzureBlobContentSource azureBlobSource)

Set the azureBlobSource property: Azure Blob Storage location containing the training data.
BuildDocumentModelOptions setDescription(String description)

Set the description property: Document model description.
BuildDocumentModelOptions setMaxTrainingHours(Double maxTrainingHours)

Set the maxTrainingHours property: Max number of V100-equivalent GPU hours to use for model training.
BuildDocumentModelOptions setTags(Map<String,String> tags)

Set the tags property: List of key-value tag attributes associated with the document model.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BuildDocumentModelOptions

public BuildDocumentModelOptions(String modelId, DocumentBuildMode buildMode)

Creates an instance of BuildDocumentModelOptions class.

Parameters:

modelId - the modelId value to set.
buildMode - the buildMode value to set.

Method Details

fromJson

public static BuildDocumentModelOptions fromJson(JsonReader jsonReader)

Reads an instance of BuildDocumentModelOptions from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

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.

getDescription

public String getDescription()

Get the description property: Document model description.

Returns:

the description value.

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.

getModelId

public String getModelId()

Get the modelId property: Unique document model name.

Returns:

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

isAllowOverwrite

public Boolean isAllowOverwrite()

Get the allowOverwrite property: Allow overwriting an existing model with the same name.

Returns:

the allowOverwrite value.

setAllowOverwrite

public BuildDocumentModelOptions 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 BuildDocumentModelOptions object itself.

setAzureBlobFileListSource

public BuildDocumentModelOptions 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 BuildDocumentModelOptions object itself.

setAzureBlobSource

public BuildDocumentModelOptions 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 BuildDocumentModelOptions object itself.

setDescription

public BuildDocumentModelOptions setDescription(String description)

Set the description property: Document model description.

Parameters:

description - the description value to set.

Returns:

the BuildDocumentModelOptions object itself.

setMaxTrainingHours

public BuildDocumentModelOptions 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 BuildDocumentModelOptions object itself.

setTags

public BuildDocumentModelOptions 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 BuildDocumentModelOptions object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to