analyze_status

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

Overview

Name	analyze_status
Type	Resource
Id	azure.ai_text_analytics.analyze_status

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
analyze_status	exec	job_id, endpoint	showStats, $top, $skip	Get analysis status and results. Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are completed, the job will transition to the completed state and results will be available for each task.

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: )
job_id	string	Job ID for Analyze. Required.
$skip	integer	(Optional) Set the number of elements to offset in the response. When both $top and $skip are specified, $skip is applied first. Default value is 0.
$top	integer	(Optional) Set the maximum number of results per task. When both $top and $skip are specified, $skip is applied first. Default value is 20.
showStats	boolean	(Optional) if set to true, response will contain request and document level statistics. Default value is None.

Lifecycle Methods

analyze_status

Get analysis status and results. Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are completed, the job will transition to the completed state and results will be available for each task.

EXEC azure.ai_text_analytics.analyze_status.analyze_status 
@job_id='{{ job_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@showStats={{ showStats }}, 
@$top='{{ $top }}', 
@$skip='{{ $skip }}'
;