Condividi tramite

Analyzer - Analyze Id Document

  • Riferimento
Servizio:
Azure AI Services
Versione API:
2.1

Estrarre il testo del campo e i valori semantici da un documento ID specificato. Il documento di input deve essere di uno dei tipi di contenuto supportati: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' o 'image/bmp'. In alternativa, usare il tipo 'application/json' per specificare il percorso (Uri) del documento da analizzare.

POST {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyze
Con parametri facoltativi: 
POST {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyze?includeTextDetails={includeTextDetails}&pages={pages}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string

Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://westus2.api.cognitive.microsoft.com).
includeTextDetails
 query

boolean

Includere righe di testo e riferimenti agli elementi nel risultato.
pages
 query

string[]

Numeri di pagina personalizzati per documenti a più pagine (PDF/TIFF), immettere il numero delle pagine che si desidera ottenere il risultato OCR. Per un intervallo di pagine, usare un trattino. Separare ogni pagina o intervallo con una virgola.

Intestazione della richiesta

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Nome Necessario Tipo Descrizione
Ocp-Apim-Subscription-Key True

string

Corpo della richiesta

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Nome Tipo Descrizione
source

string

Percorso origine file.

Risposte

Nome Tipo Descrizione
202 Accepted

La richiesta viene accodata correttamente.

Intestazioni

Operation-Location: string
Other Status Codes

ErrorResponse

Entità di risposta associata a risposte non riuscite contenenti dettagli aggiuntivi sull'errore.

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

Esempio

Analyze ID

Esempio di richiesta

POST {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyze

Risposta di esempio

Codice di stato:
202 
Operation-Location: {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

Definizioni

Nome Descrizione
ErrorInformation
ErrorResponse
SourcePath

Uri o percorso locale per i dati di origine.

ErrorInformation

Nome Tipo Descrizione
code

string

message

string

ErrorResponse

Nome Tipo Descrizione
error

ErrorInformation

SourcePath

Uri o percorso locale per i dati di origine.

Nome Tipo Descrizione
source

string

Percorso origine file.