Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2023-07-31

Analizza il documento con il modello di documento.

POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?api-version=2023-07-31

With optional parameters:

POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?pages={pages}&locale={locale}&stringIndexType={stringIndexType}&api-version=2023-07-31&features={features}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string url	Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://westus2.api.cognitive.microsoft.com).
modelId	path	True	string	Nome univoco del modello di documento. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	Versione dell'API richiesta.
features	query		DocumentAnalysisFeature[]	Elenco delle funzionalità di analisi facoltative.
locale	query		string	Hint per le impostazioni locali per il riconoscimento del testo e l'analisi dei documenti. Il valore può contenere solo il codice lingua (ad esempio "en", "fr") o il tag di lingua BCP 47 (ad esempio "en-US").
pages	query		string	Elenco di numeri di pagina basati su 1 da analizzare. Ex. "1-3,5,7-9" Regex pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
stringIndexType	query		StringIndexType	Metodo usato per calcolare l'offset e la lunghezza delle stringhe.

Intestazione della richiesta

Media Types: "application/json", "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"

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string	Chiave privata per la sottoscrizione di Servizi cognitivi di Azure.

Corpo della richiesta

Media Types: "application/json", "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"

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

Risposte

Nome	Tipo	Descrizione
202 Accepted		La richiesta viene accodata correttamente. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Errore rilevato.

Sicurezza

Ocp-Apim-Subscription-Key

Chiave privata per la sottoscrizione di Servizi cognitivi di Azure.

Type: apiKey
In: header

Esempio

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2023-07-31

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31

Analyze Document from Url

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2023-07-31

{
  "urlSource": "http://host.com/doc.pdf"
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31

Definizioni

Nome	Descrizione
AnalyzeDocumentRequest	Parametri di analisi dei documenti.
DocumentAnalysisFeature	Elenco delle funzionalità di analisi facoltative.
Error	Informazioni sugli errori.
ErrorResponse	Oggetto risposta di errore.
InnerError	Errore dettagliato.
StringIndexType	Metodo usato per calcolare l'offset e la lunghezza delle stringhe.

AnalyzeDocumentRequest

Parametri di analisi dei documenti.

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

DocumentAnalysisFeature

Elenco delle funzionalità di analisi facoltative.

Nome	Tipo	Descrizione
barcodes	string	Abilitare il rilevamento dei codici a barre nel documento.
formulas	string	Abilitare il rilevamento delle espressioni matematiche nel documento.
keyValuePairs	string	Abilitare il rilevamento delle coppie chiave-valore generale (campi modulo) nel documento.
languages	string	Abilitare il rilevamento della lingua del contenuto di testo.
ocrHighResolution	string	Eseguire OCR a una risoluzione superiore per gestire i documenti con stampa fine.
styleFont	string	Abilitare il riconoscimento di vari stili di carattere.

Error

Informazioni sugli errori.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	Error[]	Elenco degli errori dettagliati.
innererror	InnerError	Errore dettagliato.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto risposta di errore.

Nome	Tipo	Descrizione
error	Error	Informazioni sugli errori.

InnerError

Errore dettagliato.

Nome	Tipo	Descrizione
code	string	Codice di errore.
innererror	InnerError	Errore dettagliato.
message	string	Messaggio di errore.

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.