classifiers

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

Overview

Name	classifiers
Type	Resource
Id	azure.ai_document_intelligence.classifiers

Fields

The following fields are returned by SELECT queries:

get_classifier

Name	Datatype	Description
apiVersion	string	API version used to create this document classifier. Required.
baseClassifierId	string	Base classifierId on top of which the classifier was trained.
classifierId	string	Unique document classifier name. Required.
createdDateTime	string (date-time)	Date and time (UTC) when the document classifier was created. Required.
description	string	Document classifier description.
docTypes	object	List of document types to classify against. Required.
expirationDateTime	string (date-time)	Date and time (UTC) when the document classifier will expire.
modifiedDateTime	string (date-time)	Date and time (UTC) when the document model was last modified.
warnings	array	List of warnings encountered while building the classifier.

list_classifiers

Name	Datatype	Description
apiVersion	string	API version used to create this document classifier. Required.
baseClassifierId	string	Base classifierId on top of which the classifier was trained.
classifierId	string	Unique document classifier name. Required.
createdDateTime	string (date-time)	Date and time (UTC) when the document classifier was created. Required.
description	string	Document classifier description.
docTypes	object	List of document types to classify against. Required.
expirationDateTime	string (date-time)	Date and time (UTC) when the document classifier will expire.
modifiedDateTime	string (date-time)	Date and time (UTC) when the document model was last modified.
warnings	array	List of warnings encountered while building the classifier.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_classifier	select	classifier_id, endpoint		Gets detailed document classifier information.
list_classifiers	select	endpoint		List all document classifiers.
delete_classifier	delete	classifier_id, endpoint		Deletes document classifier.

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
classifier_id	string	Unique document classifier name. Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )

SELECT examples

get_classifier

Gets detailed document classifier information.

SELECT
apiVersion,
baseClassifierId,
classifierId,
createdDateTime,
description,
docTypes,
expirationDateTime,
modifiedDateTime,
warnings
FROM azure.ai_document_intelligence.classifiers
WHERE classifier_id = '{{ classifier_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_classifiers

List all document classifiers.

SELECT
apiVersion,
baseClassifierId,
classifierId,
createdDateTime,
description,
docTypes,
expirationDateTime,
modifiedDateTime,
warnings
FROM azure.ai_document_intelligence.classifiers
WHERE endpoint = '{{ endpoint }}' -- required
;

DELETE examples

delete_classifier

Deletes document classifier.

DELETE FROM azure.ai_document_intelligence.classifiers
WHERE classifier_id = '{{ classifier_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;