models

Creates, updates, deletes, gets or lists a models resource.

Overview

Name	models
Type	Resource
Id	azure.ai_document_intelligence.models

Fields

The following fields are returned by SELECT queries:

get_model

Name	Datatype	Description
apiVersion	string	API version used to create this document model.
azureBlobFileListSource	object	Azure Blob Storage file list specifying the training data. Either azureBlobSource or azureBlobFileListSource must be specified.
azureBlobSource	object	Azure Blob Storage location containing the training data. Either azureBlobSource or azureBlobFileListSource must be specified.
buildMode	string	Custom document model build mode. Known values are: "template" and "neural". (template, neural)
classifierId	string	For composed models, the custom classifier to split and classify the input file.
createdDateTime	string (date-time)	Date and time (UTC) when the document model was created. Required.
description	string	Document model description.
docTypes	object	Supported document types.
expirationDateTime	string (date-time)	Date and time (UTC) when the document model will expire.
modelId	string	Unique document model name. Required.
modifiedDateTime	string (date-time)	Date and time (UTC) when the document model was last modified.
split	string	For composed models, the file splitting behavior. Known values are: "auto", "none", and "perPage". (auto, none, perPage)
tags	object	List of key-value tag attributes associated with the document model.
trainingHours	number	Number of V100-equivalent GPU hours consumed for model training.
warnings	array	List of warnings encountered while building the model.

list_models

Name	Datatype	Description
apiVersion	string	API version used to create this document model.
azureBlobFileListSource	object	Azure Blob Storage file list specifying the training data. Either azureBlobSource or azureBlobFileListSource must be specified.
azureBlobSource	object	Azure Blob Storage location containing the training data. Either azureBlobSource or azureBlobFileListSource must be specified.
buildMode	string	Custom document model build mode. Known values are: "template" and "neural". (template, neural)
classifierId	string	For composed models, the custom classifier to split and classify the input file.
createdDateTime	string (date-time)	Date and time (UTC) when the document model was created. Required.
description	string	Document model description.
docTypes	object	Supported document types.
expirationDateTime	string (date-time)	Date and time (UTC) when the document model will expire.
modelId	string	Unique document model name. Required.
modifiedDateTime	string (date-time)	Date and time (UTC) when the document model was last modified.
split	string	For composed models, the file splitting behavior. Known values are: "auto", "none", and "perPage". (auto, none, perPage)
tags	object	List of key-value tag attributes associated with the document model.
trainingHours	number	Number of V100-equivalent GPU hours consumed for model training.
warnings	array	List of warnings encountered while building the model.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_model	select	model_id, endpoint		Gets detailed document model information.
list_models	select	endpoint		List all document models.
delete_model	delete	model_id, endpoint		Deletes document model.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
model_id	string	Unique document model name. Required.

SELECT examples

get_model

Gets detailed document model information.

SELECT
apiVersion,
azureBlobFileListSource,
azureBlobSource,
buildMode,
classifierId,
createdDateTime,
description,
docTypes,
expirationDateTime,
modelId,
modifiedDateTime,
split,
tags,
trainingHours,
warnings
FROM azure.ai_document_intelligence.models
WHERE model_id = '{{ model_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_models

List all document models.

SELECT
apiVersion,
azureBlobFileListSource,
azureBlobSource,
buildMode,
classifierId,
createdDateTime,
description,
docTypes,
expirationDateTime,
modelId,
modifiedDateTime,
split,
tags,
trainingHours,
warnings
FROM azure.ai_document_intelligence.models
WHERE endpoint = '{{ endpoint }}' -- required
;

DELETE examples

delete_model

Deletes document model.

DELETE FROM azure.ai_document_intelligence.models
WHERE model_id = '{{ model_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;