classify_documents
Creates, updates, deletes, gets or lists a classify_documents resource.
Overview
| Name | classify_documents |
| Type | Resource |
| Id | azure.ai_document_intelligence.classify_documents |
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 |
|---|---|---|---|---|
classify_document | exec | classifier_id, endpoint | stringIndexType, split, pages | Classifies document with 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: ) |
pages | string | 1-based page numbers to analyze. Ex. "1-3,5,7-9". Default value is None. |
split | string | Document splitting mode. Known values are: "auto", "none", and "perPage". Default value is None. |
stringIndexType | string | Method used to compute string offset and length. Known values are: "textElements", "unicodeCodePoint", and "utf16CodeUnit". Default value is None. |
Lifecycle Methods
- classify_document
Classifies document with document classifier.
EXEC azure.ai_document_intelligence.classify_documents.classify_document
@classifier_id='{{ classifier_id }}' --required,
@endpoint='{{ endpoint }}' --required,
@stringIndexType='{{ stringIndexType }}',
@split='{{ split }}',
@pages='{{ pages }}'
@@json=
'{
"urlSource": "{{ urlSource }}",
"base64Source": "{{ base64Source }}"
}'
;