analyze_form_results

Creates, updates, deletes, gets or lists an analyze_form_results resource.

Overview

Name	analyze_form_results
Type	Resource
Id	azure.ai_form_recognizer.analyze_form_results

Fields

The following fields are returned by SELECT queries:

get_analyze_form_result

Name	Datatype	Description
analyzeResult	object	Results of the analyze operation.
composedTrainResults	array	Training result for composed model.
createdDateTime	string (date-time)	Required. Date and time (UTC) when the analyze operation was submitted.
keys	object	Keys extracted by the custom model.
lastUpdatedDateTime	string (date-time)	Required. Date and time (UTC) when the status was last updated.
modelInfo	object	Basic custom model information. All required parameters must be populated in order to send to Azure.
status	string	Required. Operation status. Known values are: "notStarted", "running", "succeeded", "failed".
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_analyze_form_result	select	model_id, result_id, endpoint		Get Analyze Form Result. Obtain current status and the result of the analyze form operation.

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.
result_id	string	Analyze operation result identifier.

SELECT examples

get_analyze_form_result

Get Analyze Form Result. Obtain current status and the result of the analyze form operation.

SELECT
analyzeResult,
composedTrainResults,
createdDateTime,
keys,
lastUpdatedDateTime,
modelInfo,
status,
trainResult
FROM azure.ai_form_recognizer.analyze_form_results
WHERE model_id = '{{ model_id }}' -- required
AND result_id = '{{ result_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;