Analyzer - Get Analyze Id Document Result

Riferimento

Servizio:: Azure AI Services

Versione API:: 2.1

Tenere traccia dello stato di avanzamento e ottenere il risultato dell'operazione di analisi dell'ID.

GET {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyzeResults/{resultId}

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).
resultId	path	True	string uuid	Analizzare l'identificatore del risultato dell'operazione.

Intestazione della richiesta

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

Risposte

Nome	Tipo	Descrizione
200 OK	AnalyzeOperationResult	Operazione riuscita
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

Get analyze ID result

Esempio di richiesta

HTTP

GET {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

Risposta di esempio

Codice di stato:: 200

{
  "status": "running",
  "createdDateTime": "2019-05-01T10:53:21Z",
  "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
  "analyzeResult": {
    "version": "v2.1",
    "readResults": [],
    "pageResults": [],
    "documentResults": [],
    "errors": []
  }
}

Definizioni

Nome	Descrizione
AnalyzeOperationResult	Stato e risultato dell'operazione di analisi in coda.
AnalyzeResult	Analizzare il risultato dell'operazione.
Appearance	Oggetto che rappresenta l'aspetto della riga di testo.
DataTable	Informazioni sulla tabella estratta contenuta in una pagina.
DataTableCell	Informazioni sulla cella estratta in una tabella.
DocumentResult	Set di campi estratti corrispondenti al documento di input.
ErrorInformation
ErrorResponse
FieldValue	Valore del campo riconosciuto.
FieldValueType	Tipo di dati semantico del valore del campo.
KeyValueElement	Informazioni sulla chiave o il valore estratti in una coppia chiave-valore.
KeyValuePair	Informazioni sulla coppia chiave-valore estratta.
KeyValueType	Tipo di dati semantico dell'elemento chiave value.
LengthUnit	Unità utilizzata dalle proprietà width, height e boundingBox. Per le immagini, l'unità è "pixel". Per il PDF, l'unità è "inch".
OperationStatus	Stato dell'operazione in coda.
PageResult	Informazioni estratte da una singola pagina.
ReadResult	Testo estratto da una pagina nel documento di input.
SelectionMark	Informazioni sul segno di selezione estratto.
Style	Oggetto che rappresenta lo stile della riga di testo.
TextLine	Oggetto che rappresenta una riga di testo estratta.
TextStyle	Nome dello stile della riga di testo, inclusa la grafia e altre.
TextWord	Oggetto che rappresenta una parola.

AnalyzeOperationResult

Stato e risultato dell'operazione di analisi in coda.

Nome	Tipo	Descrizione
analyzeResult	AnalyzeResult	Risultati dell'operazione di analisi.
createdDateTime	string	Data e ora (UTC) in cui è stata inviata l'operazione di analisi.
lastUpdatedDateTime	string	Data e ora (UTC) dell'ultimo aggiornamento dello stato.
status	OperationStatus	Stato dell'operazione.

AnalyzeResult

Analizzare il risultato dell'operazione.

Nome	Tipo	Descrizione
documentResults	DocumentResult[]	Informazioni a livello di documento estratte dall'input.
errors	ErrorInformation[]	Elenco di errori segnalati durante l'operazione di analisi.
pageResults	PageResult[]	Informazioni a livello di pagina estratte dall'input.
readResults	ReadResult[]	Testo estratto dall'input.
version	string	Versione dello schema usata per questo risultato.

Appearance

Oggetto che rappresenta l'aspetto della riga di testo.

Nome	Tipo	Descrizione
style	Style	Oggetto che rappresenta lo stile della riga di testo.

DataTable

Informazioni sulla tabella estratta contenuta in una pagina.

Nome	Tipo	Descrizione
boundingBox	number[]	Rettangolo di selezione della tabella.
cells	DataTableCell[]	Elenco di celle contenute nella tabella.
columns	integer	Numero di colonne.
rows	integer	Numero di righe.

DataTableCell

Informazioni sulla cella estratta in una tabella.

Nome	Tipo	Valore predefinito	Descrizione
boundingBox	number[]		Rettangolo delimitatore della cella.
columnIndex	integer		Indice di colonna della cella.
columnSpan	integer	1	Numero di colonne estese da questa cella.
confidence	number		Valore di confidenza.
elements	string[]		Quando includeTextDetails è impostato su true, un elenco di riferimenti agli elementi di testo che costituiscono questa cella della tabella.
isFooter	boolean	False	La cella corrente è una cella piè di pagina?
isHeader	boolean	False	La cella corrente è una cella di intestazione?
rowIndex	integer		Indice di riga della cella.
rowSpan	integer	1	Numero di righe estese da questa cella.
text	string		Contenuto di testo della cella.

DocumentResult

Set di campi estratti corrispondenti al documento di input.

Nome	Tipo	Descrizione
docType	string	Tipo di documento.
docTypeConfidence	number	Attendibilità dei tipi di documento stimati.
fields	<string, FieldValue>	Dizionario dei valori dei campi denominati.
modelId	string	Identificatore del modello.
pageRange	integer[]	Primo e ultimo numero di pagina in cui viene trovato il documento.

ErrorInformation

Nome	Tipo	Descrizione
code	string
message	string

ErrorResponse

Nome	Tipo	Descrizione
error	ErrorInformation

FieldValue

Valore del campo riconosciuto.

Nome	Tipo	Descrizione
boundingBox	number[]	Rettangolo di selezione del valore del campo, se appropriato.
confidence	number	Punteggio di attendibilità.
elements	string[]	Quando includeTextDetails è impostato su true, un elenco di riferimenti agli elementi di testo che costituiscono questo campo.
page	integer	Numero di pagina in base 1 nel documento di input.
text	string	Contenuto di testo del campo estratto.
type	FieldValueType	Tipo di valore del campo.
valueArray	FieldValue[]	Matrice di valori di campo.
valueCountryRegion	string	Codice paese di 3 lettere (ISO 3166-1 alfa-3).
valueDate	string	Valore data.
valueInteger	integer	Valore intero.
valueNumber	number	Valore a virgola mobile.
valueObject	<string, FieldValue>	Dizionario dei valori dei campi denominati.
valuePhoneNumber	string	Valore del numero di telefono.
valueSelectionMark	enum: selected unselected	Valore del segno di selezione.
valueString	string	Valore stringa.
valueTime	string	Valore temporale.

FieldValueType

Tipo di dati semantico del valore del campo.

Nome	Tipo	Descrizione
array	string
countryRegion	string
date	string
integer	string
number	string
object	string
phoneNumber	string
selectionMark	string
string	string
time	string

KeyValueElement

Informazioni sulla chiave o il valore estratti in una coppia chiave-valore.

Nome	Tipo	Descrizione
boundingBox	number[]	Rettangolo di selezione della chiave o del valore.
elements	string[]	Quando includeTextDetails è impostato su true, un elenco di riferimenti agli elementi di testo che costituiscono questa chiave o valore.
text	string	Contenuto di testo della chiave o del valore.
type	KeyValueType	Tipo di dati semantico dell'elemento chiave value.

KeyValuePair

Informazioni sulla coppia chiave-valore estratta.

Nome	Tipo	Descrizione
confidence	number	Valore di confidenza.
key	KeyValueElement	Informazioni sulla chiave estratta in una coppia chiave-valore.
label	string	Etichetta definita dall'utente per la voce di coppia chiave/valore.
value	KeyValueElement	Informazioni sul valore estratto in una coppia chiave-valore.

KeyValueType

Tipo di dati semantico dell'elemento chiave value.

Nome	Tipo	Descrizione
selectionMark	string
string	string

LengthUnit

Unità utilizzata dalle proprietà width, height e boundingBox. Per le immagini, l'unità è "pixel". Per il PDF, l'unità è "inch".

Nome	Tipo	Descrizione
inch	string
pixel	string

OperationStatus

Stato dell'operazione in coda.

Nome	Tipo	Descrizione
failed	string
notStarted	string
running	string
succeeded	string

PageResult

Informazioni estratte da una singola pagina.

Nome	Tipo	Descrizione
clusterId	integer	Identificatore del cluster.
keyValuePairs	KeyValuePair[]	Elenco di coppie chiave-valore estratte dalla pagina.
page	integer	Numero di pagina.
tables	DataTable[]	Elenco di tabelle dati estratte dalla pagina.

ReadResult

Testo estratto da una pagina nel documento di input.

Nome	Tipo	Descrizione
angle	number	Orientamento generale del testo in senso orario, misurato in gradi compreso tra (-180, 180].
height	number	Altezza rispettivamente dell'immagine/PDF in pixel/pollici.
lines	TextLine[]	Quando includeTextDetails è impostato su true, viene visualizzato un elenco di righe di testo riconosciute. Il numero massimo di righe restituite è 300 per pagina. Le linee vengono ordinate dall'alto verso il basso, da sinistra a destra, anche se in alcuni casi la prossimità viene trattata con priorità più alta. Poiché l'ordinamento dipende dal testo rilevato, può cambiare tra le immagini e gli aggiornamenti della versione OCR. Pertanto, la logica di business deve essere basata sulla posizione della riga effettiva anziché sull'ordine.
page	integer	Numero di pagina in base 1 nel documento di input.
selectionMarks	SelectionMark[]	Elenco di segni di selezione estratti dalla pagina.
unit	LengthUnit	Unità utilizzata dalle proprietà width, height e boundingBox. Per le immagini, l'unità è "pixel". Per il PDF, l'unità è "inch".
width	number	Larghezza rispettivamente dell'immagine/PDF in pixel/pollici.

SelectionMark

Informazioni sul segno di selezione estratto.

Nome	Tipo	Descrizione
boundingBox	number[]	Rettangolo di selezione del rettangolo di selezione.
confidence	number	Valore di confidenza.
state	enum: selected unselected	Stato del segno di selezione.

Style

Oggetto che rappresenta lo stile della riga di testo.

Nome	Tipo	Descrizione
confidence	number	Attendibilità dello stile della linea di testo.
name	TextStyle	Nome dello stile della riga di testo, inclusa la grafia e altre.

TextLine

Oggetto che rappresenta una riga di testo estratta.

Nome	Tipo	Descrizione
appearance	Appearance	Proprietà dell'aspetto del testo.
boundingBox	number[]	Rettangolo di selezione di una linea estratta.
text	string	Contenuto di testo della riga.
words	TextWord[]	Elenco di parole nella riga di testo.

TextStyle

Nome dello stile della riga di testo, inclusa la grafia e altre.

Nome	Tipo	Descrizione
handwriting	string
other	string

TextWord

Oggetto che rappresenta una parola.

Nome	Tipo	Descrizione
boundingBox	number[]	Rettangolo delimitatore di una parola estratta.
confidence	number	Valore di confidenza.
text	string	Contenuto di testo della parola.

Condividi tramite