Document Classifiers - Classify Document

Serviço:

Azure AI Services

Versão da API:

2024-11-30

Classifica documento com classificador de documentos.

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-11-30

Com parâmetros opcionais:

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-11-30&stringIndexType={stringIndexType}&split={split}&pages={pages}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
classifierId	path	True	string	Nome exclusivo do classificador de documentos. Padrão Regex: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string uri	O ponto de extremidade do serviço de Inteligência de Documentos.
api-version	query	True	string	A versão da API a ser usada para esta operação.
pages	query		string	Números de página baseados em 1 para analisar. Ex. "1-3,5,7-9" Padrão Regex: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
split	query		SplitMode	Modo de divisão de documentos.
stringIndexType	query		StringIndexType	Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.

Corpo do Pedido

Name	Tipo	Description
base64Source	string	Codificação Base64 do documento a classificar. urlSource ou base64Source devem ser especificados.
urlSource	string	URL do documento a classificar. urlSource ou base64Source devem ser especificados.

Respostas

Name	Tipo	Description
202 Accepted		O pedido foi aceite para processamento, mas o processamento ainda não foi concluído. Cabeçalhos Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Âmbitos

Name	Description
https://cognitiveservices.azure.com/.default

Exemplos

Classify Document from Url

Pedido de amostra

HTTP

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"
}

Resposta da amostra

Código de estado:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/customClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-11-30

Definições

Name	Description
ClassifyDocumentRequest	Parâmetros de classificação de documentos.
DocumentIntelligenceError	O objeto de erro.
DocumentIntelligenceErrorResponse	Objeto de resposta de erro.
DocumentIntelligenceInnerError	Um objeto que contém informações mais específicas sobre o erro.
SplitMode	Comportamento de divisão de ficheiros.
StringIndexType	Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.

ClassifyDocumentRequest

Parâmetros de classificação de documentos.

Name	Tipo	Description
base64Source	string	Codificação Base64 do documento a classificar. urlSource ou base64Source devem ser especificados.
urlSource	string	URL do documento a classificar. urlSource ou base64Source devem ser especificados.

DocumentIntelligenceError

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	DocumentIntelligenceError[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	DocumentIntelligenceInnerError	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 por humanos do erro.
target	string	O alvo do erro.

DocumentIntelligenceErrorResponse

Objeto de resposta de erro.

Name	Tipo	Description
error	DocumentIntelligenceError	Informações de erro.

DocumentIntelligenceInnerError

Um objeto que contém informações mais específicas sobre o erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
innererror	DocumentIntelligenceInnerError	Erro interno.
message	string	Uma representação legível por humanos do erro.

SplitMode

Comportamento de divisão de ficheiros.

Name	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 do arquivo como um documento separado.

StringIndexType

Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.

Name	Tipo	Description
textElements	string	Caractere de exibição percebido pelo usuário ou cluster de grafemas, conforme definido pelo Unicode 8.0.0.
unicodeCodePoint	string	Unidade de caracteres representada por um único ponto de código unicode. Usado por Python 3.
utf16CodeUnit	string	Unidade de caracteres representada por uma unidade de código Unicode de 16 bits. Usado por JavaScript, Java e .NET.