Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2024-02-29-preview

Analizza il documento con il modello di documento.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview

With optional parameters:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	Endpoint del servizio Document Intelligence.
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 da usare per questa operazione.
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").
outputContentFormat	query		ContentFormat	Formato del contenuto principale del risultato di analisi.
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+)?))*$
queryFields	query		string[]	Elenco di campi aggiuntivi da estrarre. Ex. "NumberOfGuests,StoreNumber"
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 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 è 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

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Sample Response

Status code:

202

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

Analyze Document from Url

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements

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

Sample Response

Status code:

202

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

Definizioni

Nome	Descrizione
AnalyzeDocumentRequest	Parametri di analisi dei documenti.
ContentFormat	Formato del contenuto nel risultato analizzato.
DocumentAnalysisFeature	Elenco delle funzionalità di analisi facoltative.
Error	Oggetto error.
ErrorResponse	Oggetto risposta di errore.
InnerError	Oggetto contenente informazioni più specifiche sull'errore.
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.

ContentFormat

Formato del contenuto nel risultato analizzato.

Nome	Tipo	Descrizione
markdown	string	Rappresentazione markdown del contenuto del documento con intestazioni di sezione, tabelle e così via.
text	string	Rappresentazione in testo normale del contenuto del documento senza formattazione.

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.
queryFields	string	Abilitare l'estrazione di campi aggiuntivi tramite il parametro queryFields.
styleFont	string	Abilitare il riconoscimento di vari stili di carattere.

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.

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.