Condividi tramite

Document Models - Analyze Document

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

Analizza il documento con il modello di documento.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-11-30
Con parametri facoltativi: 
POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-11-30&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}&output={output}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string

uri

Endpoint del servizio Document Intelligence.
modelId
 path True

string

Nome univoco del modello di documento.

Criterio di espressione regolare: ^[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 di lingua (ad esempio "en", "fr") o il tag di lingua BCP 47 (ad esempio "en-US").
output
 query

AnalyzeOutputOption[]

Output aggiuntivi da generare durante l'analisi.
outputContentFormat
 query

DocumentContentFormat

Formato del contenuto principale del risultato di analisi.
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+)?))*$
queryFields
 query

string[]

Elenco di campi aggiuntivi da estrarre. Ex. "NumberOfGuests,StoreNumber"
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 analizzare. È necessario specificare urlSource o base64Source.
urlSource

string

URL del 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.

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

Analyze Document from Base64
Analyze Document from Url

Analyze Document from Base64

Esempio di richiesta

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

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Risposta di esempio

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

Analyze Document from Url

Esempio di richiesta

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

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

Risposta di esempio

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

Definizioni

Nome Descrizione
AnalyzeDocumentRequest

Parametri di analisi dei documenti.
AnalyzeOutputOption

Output aggiuntivi da generare durante l'analisi.
DocumentAnalysisFeature

Funzionalità di analisi dei documenti da abilitare.
DocumentContentFormat

Formato del contenuto nel risultato analizzato.
DocumentIntelligenceError

Oggetto error.
DocumentIntelligenceErrorResponse

Oggetto risposta di errore.
DocumentIntelligenceInnerError

Oggetto contenente informazioni più specifiche sull'errore.
StringIndexType

Metodo utilizzato 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 del documento da analizzare. È necessario specificare urlSource o base64Source.

AnalyzeOutputOption

Output aggiuntivi da generare durante l'analisi.

Nome Tipo Descrizione
figures

string

Generare immagini ritagliate di figure rilevate.
pdf

string

Generare un output PDF ricercabile.

DocumentAnalysisFeature

Funzionalità di analisi dei documenti da abilitare.

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 del testo.
ocrHighResolution

string

Eseguire OCR con una risoluzione superiore per gestire i documenti con stampa fine.
queryFields

string

Abilitare l'estrazione di campi aggiuntivi tramite il parametro di query QueryFields.
styleFont

string

Abilitare il riconoscimento di vari stili di carattere.

DocumentContentFormat

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.

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.

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.