Document Classifiers - Classify Document

Serviço:

Azure AI Services

Versão da API:

2024-11-30

Classifica o documento com o classificador de documento.

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 de URI

Nome	Em	Obrigatório	Tipo	Description
classifierId	path	True	string	Nome do classificador de documento exclusivo. 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 do Document Intelligence.
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 a serem analisados. 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 da solicitação

Nome	Tipo	Description
base64Source	string	Codificação base64 do documento a ser classificado. 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 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
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

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 de exemplo

Código de status:

202

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

Definições

Nome	Description
ClassifyDocumentRequest	Parâmetros de classificação de documento.
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 arquivos.
StringIndexType	Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.

ClassifyDocumentRequest

Parâmetros de classificação de documento.

Nome	Tipo	Description
base64Source	string	Codificação base64 do documento a ser classificado. UrlSource ou base64Source devem ser especificados.
urlSource	string	URL do documento a ser classificada. UrlSource ou base64Source devem ser especificados.

DocumentIntelligenceError

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
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 pelo ser humano do erro.
target	string	O destino do erro.

DocumentIntelligenceErrorResponse

Objeto de resposta de erro.

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

DocumentIntelligenceInnerError

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	DocumentIntelligenceInnerError	Erro interno.
message	string	Uma representação legível pelo ser humano do erro.

SplitMode

Comportamento de divisão de arquivos.

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 caractere representada por um único ponto de código unicode. Usado pelo Python 3.
utf16CodeUnit	string	Unidade de caractere representada por uma unidade de código Unicode de 16 bits. Usado por JavaScript, Java e .NET.