Document Classifiers - Classify Document From Stream

Service:

Azure AI Services

API Version:

2024-02-29-preview

Classifica o documento com o classificador de documentos.

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?api-version=2024-02-29-preview

With optional parameters:

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?api-version=2024-02-29-preview&stringIndexType={stringIndexType}&split={split}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
classifierId	path	True	string	Nome exclusivo do classificador de documentos. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string	O ponto final de serviço do Document Intelligence.
api-version	query	True	string	A versão da API a utilizar para esta operação.
split	query		SplitMode	Modo de divisão de documentos.
stringIndexType	query		StringIndexType	Método utilizado para calcular o desvio e o comprimento da cadeia.

Corpo do Pedido

Media Types: "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif", "text/html", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation"

Name	Tipo	Description
input	string	Conteúdo de entrada.

Respostas

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

Segurança

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

Exemplos

Classify Document from Url

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/classifierId:analyze?api-version=2024-02-29-preview&stringIndexType=textElements

"{binaryFile}"

Sample Response

Status code:

202

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

Definições

Name	Description
Error	O objeto de erro.
ErrorResponse	Objeto de resposta de erro.
InnerError	Um objeto que contém informações mais específicas sobre o erro.
SplitMode	Modo de divisão de documentos.
StringIndexType	Método utilizado para calcular o desvio e o comprimento da cadeia.

Error

O objeto de erro.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Error[]	Uma série de detalhes sobre erros específicos que levaram a este erro comunicado.
innererror	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 por humanos do erro.
target	string	O destino do erro.

ErrorResponse

Objeto de resposta de erro.

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

InnerError

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

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
innererror	InnerError	Erro interno.
message	string	Uma representação legível por humanos do erro.

SplitMode

Modo de divisão de documentos.

Name	Tipo	Description
auto	string	Dividir automaticamente o ficheiro em documentos.
none	string	Trate todo o ficheiro como um único documento.
perPage	string	Tratar cada página no ficheiro como um documento separado.

StringIndexType

Método utilizado para calcular o desvio e o comprimento da cadeia.

Name	Tipo	Description
textElements	string	Caráter de apresentação percebido pelo utilizador ou cluster de grafos, conforme definido pelo Unicode 8.0.0.
unicodeCodePoint	string	Unidade de carateres representada por um único ponto de código unicode. Utilizado pelo Python 3.
utf16CodeUnit	string	Unidade de carateres representada por uma unidade de código Unicode de 16 bits. Utilizado por JavaScript, Java e .NET.