Document Classifiers - Classify Document
Classifies document with document classifier.
POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-11-30
POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-11-30&stringIndexType={stringIndexType}&split={split}&pages={pages}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
classifier
|
path | True |
string |
Unique document classifier name. Regex pattern: |
endpoint
|
path | True |
string uri |
The Document Intelligence service endpoint. |
api-version
|
query | True |
string |
The API version to use for this operation. |
pages
|
query |
string |
1-based page numbers to analyze. Ex. "1-3,5,7-9" Regex pattern: |
|
split
|
query |
Document splitting mode. |
||
string
|
query |
Method used to compute string offset and length. |
Request Body
Name | Type | Description |
---|---|---|
base64Source |
string |
Base64 encoding of the document to classify. Either urlSource or base64Source must be specified. |
urlSource |
string |
Document URL to classify. Either urlSource or base64Source must be specified. |
Responses
Name | Type | Description |
---|---|---|
202 Accepted |
The request has been accepted for processing, but processing has not yet completed. Headers
|
|
Other Status Codes |
An unexpected error response. |
Security
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
OAuth2Auth
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Token URL:
https://login.microsoftonline.com/common/oauth2/token
Scopes
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default |
Examples
Classify Document from Url
Sample request
POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/classifierId:analyze?_overload=classifyDocument&api-version=2024-11-30&stringIndexType=textElements
{
"urlSource": "http://host.com/doc.pdf"
}
Sample response
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/customClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-11-30
Definitions
Name | Description |
---|---|
Classify |
Document classification parameters. |
Document |
The error object. |
Document |
Error response object. |
Document |
An object containing more specific information about the error. |
Split |
File splitting behavior. |
String |
Method used to compute string offset and length. |
ClassifyDocumentRequest
Document classification parameters.
Name | Type | Description |
---|---|---|
base64Source |
string |
Base64 encoding of the document to classify. Either urlSource or base64Source must be specified. |
urlSource |
string |
Document URL to classify. Either urlSource or base64Source must be specified. |
DocumentIntelligenceError
The error object.
Name | Type | Description |
---|---|---|
code |
string |
One of a server-defined set of error codes. |
details |
An array of details about specific errors that led to this reported error. |
|
innererror |
An object containing more specific information than the current object about the error. |
|
message |
string |
A human-readable representation of the error. |
target |
string |
The target of the error. |
DocumentIntelligenceErrorResponse
Error response object.
Name | Type | Description |
---|---|---|
error |
Error info. |
DocumentIntelligenceInnerError
An object containing more specific information about the error.
Name | Type | Description |
---|---|---|
code |
string |
One of a server-defined set of error codes. |
innererror |
Inner error. |
|
message |
string |
A human-readable representation of the error. |
SplitMode
File splitting behavior.
Name | Type | Description |
---|---|---|
auto |
string |
Automatically split file into documents. |
none |
string |
Treat the entire file as a single document. |
perPage |
string |
Treat each page in the file as a separate document. |
StringIndexType
Method used to compute string offset and length.
Name | Type | Description |
---|---|---|
textElements |
string |
User-perceived display character, or grapheme cluster, as defined by Unicode 8.0.0. |
unicodeCodePoint |
string |
Character unit represented by a single unicode code point. Used by Python 3. |
utf16CodeUnit |
string |
Character unit represented by a 16-bit Unicode code unit. Used by JavaScript, Java, and .NET. |