custom_models

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

Overview

Name	custom_models
Type	Resource
Id	azure.ai_form_recognizer.custom_models

Fields

The following fields are returned by SELECT queries:

get_custom_model

Name	Datatype	Description
composedTrainResults	array	Training result for composed model.
keys	object	Keys extracted by the custom model.
modelInfo	object	Basic custom model information. All required parameters must be populated in order to send to Azure.
trainResult	object	Custom model training result. All required parameters must be populated in order to send to Azure.

list_custom_models

Name	Datatype	Description
composedTrainResults	array	Training result for composed model.
keys	object	Keys extracted by the custom model.
modelInfo	object	Required. Basic custom model information.
modelList	array	Collection of trained custom models.
nextLink	string	Link to the next page of custom models.
summary	object	Summary of all trained custom models.
trainResult	object	Custom model training result. All required parameters must be populated in order to send to Azure.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_custom_model	select	model_id, endpoint	includeKeys	Get Custom Model. Get detailed information about a custom model.
list_custom_models	select	endpoint		List Custom Models. Get information about all custom models.
delete_custom_model	delete	model_id, endpoint		Delete Custom Model. Mark model for deletion. Model artifacts will be permanently removed within a predetermined period.

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). (default: )
model_id	string	Model identifier.
includeKeys	boolean	Include list of extracted keys in model information. Default value is False.

SELECT examples

get_custom_model

Get Custom Model. Get detailed information about a custom model.

SELECT
composedTrainResults,
keys,
modelInfo,
trainResult
FROM azure.ai_form_recognizer.custom_models
WHERE model_id = '{{ model_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND includeKeys = '{{ includeKeys }}'
;

list_custom_models

List Custom Models. Get information about all custom models.

SELECT
composedTrainResults,
keys,
modelInfo,
modelList,
nextLink,
summary,
trainResult
FROM azure.ai_form_recognizer.custom_models
WHERE endpoint = '{{ endpoint }}' -- required
;

DELETE examples

delete_custom_model

Delete Custom Model. Mark model for deletion. Model artifacts will be permanently removed within a predetermined period.

DELETE FROM azure.ai_form_recognizer.custom_models
WHERE model_id = '{{ model_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;