analyze_batch_results

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

Overview

Name	analyze_batch_results
Type	Resource
Id	azure.ai_document_intelligence.analyze_batch_results

Fields

The following fields are returned by SELECT queries:

get_analyze_batch_result

Name	Datatype	Description
createdDateTime	string (date-time)	Date and time (UTC) when the operation was submitted. Required.
error	object	Encountered error during batch document analysis.
lastUpdatedDateTime	string (date-time)	Date and time (UTC) when the status was last updated. Required.
percentCompleted	integer	Operation progress (0-100).
result	object	Batch document analysis result.
resultId	string	Analyze batch operation result ID.
status	string	Operation status. notStarted, running, succeeded, or failed. Required. Known values are: "notStarted", "running", "failed", "succeeded", "canceled", and "skipped". (notStarted, running, failed, succeeded, canceled, skipped)

list_analyze_batch_results

Name	Datatype	Description
createdDateTime	string (date-time)	Date and time (UTC) when the operation was submitted. Required.
error	object	Encountered error during batch document analysis.
lastUpdatedDateTime	string (date-time)	Date and time (UTC) when the status was last updated. Required.
percentCompleted	integer	Operation progress (0-100).
result	object	Batch document analysis result.
resultId	string	Analyze batch operation result ID.
status	string	Operation status. notStarted, running, succeeded, or failed. Required. Known values are: "notStarted", "running", "failed", "succeeded", "canceled", and "skipped". (notStarted, running, failed, succeeded, canceled, skipped)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_analyze_batch_result	select	model_id, result_id, endpoint		Gets the result of batch document analysis.
list_analyze_batch_results	select	model_id, endpoint		List batch document analysis results.
delete_analyze_batch_result	delete	model_id, result_id, endpoint		Mark the batch document analysis result for deletion.

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.
result_id	string	Analyze batch operation result ID. Required.

SELECT examples

get_analyze_batch_result

Gets the result of batch document analysis.

SELECT
createdDateTime,
error,
lastUpdatedDateTime,
percentCompleted,
result,
resultId,
status
FROM azure.ai_document_intelligence.analyze_batch_results
WHERE model_id = '{{ model_id }}' -- required
AND result_id = '{{ result_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_analyze_batch_results

List batch document analysis results.

SELECT
createdDateTime,
error,
lastUpdatedDateTime,
percentCompleted,
result,
resultId,
status
FROM azure.ai_document_intelligence.analyze_batch_results
WHERE model_id = '{{ model_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

DELETE examples

delete_analyze_batch_result

Mark the batch document analysis result for deletion.

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