Condividi tramite

Document Classifiers - Classify Document

  • Riferimento
Servizio:
Azure AI Services
Versione API:
2024-11-30

Classifica il documento con classificatore di documenti.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
classifierId
 path True

string

Nome univoco del classificatore di documenti.

Criterio di espressione regolare: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint
 path True

string

uri

Endpoint del servizio Document Intelligence.
api-version
 query True

string

Versione dell'API da usare per questa operazione.
pages
 query

string

Numeri di pagina basati su 1 da analizzare. Ex. "1-3,5,7-9"

Criterio di espressione regolare: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
split
 query

SplitMode

Modalità di suddivisione dei documenti.
stringIndexType
 query

StringIndexType

Metodo utilizzato 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.

Intestazioni

  • Operation-Location: string
  • Retry-After: integer
Other Status Codes

DocumentIntelligenceErrorResponse

Risposta di errore imprevista.

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Ambiti

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

Esempio

Classify Document from Url

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
ClassifyDocumentRequest

Parametri di classificazione dei documenti.
DocumentIntelligenceError

Oggetto error.
DocumentIntelligenceErrorResponse

Oggetto risposta di errore.
DocumentIntelligenceInnerError

Oggetto contenente informazioni più specifiche sull'errore.
SplitMode

Comportamento di suddivisione dei file.
StringIndexType

Metodo utilizzato 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.

DocumentIntelligenceError

Oggetto error.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.
details

DocumentIntelligenceError[]

Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror

DocumentIntelligenceInnerError

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message

string

Rappresentazione leggibile dell'errore.
target

string

Destinazione dell'errore.

DocumentIntelligenceErrorResponse

Oggetto risposta di errore.

Nome Tipo Descrizione
error

DocumentIntelligenceError

Informazioni sull'errore.

DocumentIntelligenceInnerError

Oggetto contenente informazioni più specifiche sull'errore.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.
innererror

DocumentIntelligenceInnerError

Errore interno.
message

string

Rappresentazione leggibile dell'errore.

SplitMode

Comportamento di suddivisione dei file.

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 del file come documento separato.

StringIndexType

Metodo utilizzato 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.