Document Classifiers - Classify Document
Classifica o documento com o classificador de documento.
POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-02-29-preview
POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-02-29-preview&stringIndexType={stringIndexType}&split={split}
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
classifier
|
path | True |
string |
Nome do classificador de documento exclusivo. Padrão Regex: |
endpoint
|
path | True |
string |
O ponto de extremidade do serviço do Document Intelligence. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
split
|
query |
Modo de divisão de documentos. |
||
string
|
query |
Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres. |
Corpo da solicitação
Nome | Tipo | Description |
---|---|---|
base64Source |
string |
Codificação base64 do documento para classificar. UrlSource ou base64Source devem ser especificados. |
urlSource |
string |
URL do documento a ser classificada. UrlSource ou base64Source devem ser especificados. |
Respostas
Nome | Tipo | Description |
---|---|---|
202 Accepted |
A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído. Cabeçalhos
|
|
Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
Ocp-Apim-Subscription-Key
Tipo:
apiKey
Em:
header
OAuth2Auth
Tipo:
oauth2
Flow:
accessCode
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
URL do Token:
https://login.microsoftonline.com/common/oauth2/token
Escopos
Nome | Description |
---|---|
https://cognitiveservices.azure.com/.default |
Exemplos
Classify Document from Url
Solicitação de exemplo
POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/classifierId:analyze?_overload=classifyDocument&api-version=2024-02-29-preview&stringIndexType=textElements
{
"urlSource": "http://host.com/doc.pdf"
}
Resposta de exemplo
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/customClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-02-29-preview
Definições
Nome | Description |
---|---|
Classify |
Parâmetros de classificação de documentos. |
Error |
O objeto de erro. |
Error |
Objeto de resposta de erro. |
Inner |
Um objeto que contém informações mais específicas sobre o erro. |
Split |
Modo de divisão de documentos. |
String |
Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres. |
ClassifyDocumentRequest
Parâmetros de classificação de documentos.
Nome | Tipo | Description |
---|---|---|
base64Source |
string |
Codificação base64 do documento para classificar. UrlSource ou base64Source devem ser especificados. |
urlSource |
string |
URL do documento a ser classificada. UrlSource ou base64Source devem ser especificados. |
Error
O objeto de erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Um de um conjunto definido pelo servidor de códigos de erro. |
details |
Error[] |
Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado. |
innererror |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
message |
string |
Uma representação legível pelo homem do erro. |
target |
string |
O destino do erro. |
ErrorResponse
Objeto de resposta de erro.
Nome | Tipo | Description |
---|---|---|
error |
Informações de erro. |
InnerError
Um objeto que contém informações mais específicas sobre o erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Um de um conjunto definido pelo servidor de códigos de erro. |
innererror |
Erro interno. |
|
message |
string |
Uma representação legível pelo homem do erro. |
SplitMode
Modo de divisão de documentos.
Nome | Tipo | Description |
---|---|---|
auto |
string |
Divida automaticamente o arquivo em documentos. |
none |
string |
Trate todo o arquivo como um único documento. |
perPage |
string |
Trate cada página no arquivo como um documento separado. |
StringIndexType
Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.
Nome | Tipo | Description |
---|---|---|
textElements |
string |
Caractere de exibição percebido pelo usuário ou cluster grapheme, conforme definido pelo Unicode 8.0.0. |
unicodeCodePoint |
string |
Unidade de caracteres representada por um único ponto de código unicode. Usado pelo Python 3. |
utf16CodeUnit |
string |
Unidade de caracteres representada por uma unidade de código Unicode de 16 bits. Usado por JavaScript, Java e .NET. |