Document Classifiers - Classify Document

Service:

Azure AI Services

API Version:

2024-02-29-preview

Classifica il documento con il classificatore di documenti.

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

With optional parameters:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
classifierId	path	True	string	Nome univoco del classificatore di documenti. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string	Endpoint del servizio Document Intelligence.
api-version	query	True	string	Versione dell'API da usare per questa operazione.
split	query		SplitMode	Modalità di suddivisione dei documenti.
stringIndexType	query		StringIndexType	Metodo usato per calcolare l'offset e la lunghezza delle stringhe.

Corpo della richiesta

Nome	Tipo	Descrizione
base64Source	string	Codifica Base64 del documento da classificare. È necessario specificare urlSource o base64Source.
urlSource	string	URL del documento da classificare. È necessario specificare urlSource o base64Source.

Risposte

Nome	Tipo	Descrizione
202 Accepted		La richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

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

Nome	Descrizione
https://cognitiveservices.azure.com/.default

Esempio

Classify Document from Url

Sample Request

HTTP

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

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

Definizioni

Nome	Descrizione
ClassifyDocumentRequest	Parametri di classificazione dei documenti.
Error	Oggetto error.
ErrorResponse	Oggetto risposta di errore.
InnerError	Oggetto contenente informazioni più specifiche sull'errore.
SplitMode	Modalità di suddivisione dei documenti.
StringIndexType	Metodo usato per calcolare l'offset e la lunghezza delle stringhe.

ClassifyDocumentRequest

Parametri di classificazione dei documenti.

Nome	Tipo	Descrizione
base64Source	string	Codifica Base64 del documento da classificare. È necessario specificare urlSource o base64Source.
urlSource	string	URL del documento da classificare. È necessario specificare urlSource o base64Source.

Error

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno dei set definiti dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato questo errore segnalato.
innererror	InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto risposta di errore.

Nome	Tipo	Descrizione
error	Error	Informazioni sugli errori.

InnerError

Oggetto contenente informazioni più specifiche sull'errore.

Nome	Tipo	Descrizione
code	string	Uno dei set definiti dal server di codici di errore.
innererror	InnerError	Errore interno.
message	string	Rappresentazione leggibile dell'errore.

SplitMode

Modalità di suddivisione dei documenti.

Nome	Tipo	Descrizione
auto	string	Suddividere automaticamente il file in documenti.
none	string	Considerare l'intero file come un singolo documento.
perPage	string	Considera ogni pagina nel file come documento separato.

StringIndexType

Metodo usato per calcolare l'offset e la lunghezza delle stringhe.

Nome	Tipo	Descrizione
textElements	string	Carattere di visualizzazione percepito dall'utente o cluster grapheme, come definito da Unicode 8.0.0.
unicodeCodePoint	string	Unità di caratteri rappresentata da un singolo punto di codice Unicode. Usato da Python 3.
utf16CodeUnit	string	Unità di caratteri rappresentata da un'unità di codice Unicode a 16 bit. Usato da JavaScript, Java e .NET.