Condividi tramite


formrecognizer Pacchetto

Pacchetti

aio

Classi

AccountProperties

Riepilogo di tutti i modelli personalizzati nell'account.

Novità della versione 2.1: supporto per i metodi di to_dict e from_dict

AddressValue

Valore del campo indirizzo.

Novità della versione 2023-07-31: unità, city_district, state_district, periferia, casa e proprietà di livello .

AnalyzeResult

Risultato dell'analisi dei documenti.

AnalyzedDocument

Oggetto che descrive la posizione e il contenuto semantico di un documento.

BlobFileListSource

Origine contenuto per un elenco di file in Archiviazione BLOB di Azure.

BlobSource

Origine contenuto per Archiviazione BLOB di Azure.

BoundingRegion

Area di delimitazione corrispondente a una pagina.

ClassifierDocumentTypeDetails

Origine dati di training.

CurrencyValue

Elemento di valore di valuta.

Novità della versione 2023-07-31: proprietà del codice .

CustomDocumentModelsDetails

Dettagli relativi ai modelli personalizzati nella risorsa Riconoscimento modulo.

CustomFormModel

Rappresenta un modello sottoposto a training.

Novità della versione 2.1: le proprietà model_name e le proprietà, il supporto per i metodi di to_dict e from_dict

CustomFormModelField

Campo che il modello estrae dai moduli a cui analizza.

Novità della versione 2.1: supporto per i metodi di to_dict e from_dict

CustomFormModelInfo

Informazioni sul modello personalizzate.

Novità della versione 2.1: le proprietà model_name e le proprietà, il supporto per i metodi di to_dict e from_dict

CustomFormModelProperties

Proprietà facoltative del modello.

Novità della versione 2.1: supporto per i metodi di to_dict e from_dict

CustomFormSubmodel

Rappresenta un sottomodello che estrae i campi da un tipo specifico di modulo.

Novità della versione 2.1: la proprietà model_id, il supporto per i metodi di to_dict e from_dict

DocumentAnalysisClient

DocumentAnalysisClient analizza le informazioni di documenti e immagini e classifica i documenti. È l'interfaccia da usare per l'analisi con modelli predefiniti (ricevute, biglietti da visita, fatture, documenti di identità, tra gli altri), analisi del layout da documenti, analisi dei tipi di documenti generali e analisi di documenti personalizzati con modelli compilati (per visualizzare un elenco completo dei modelli supportati dal servizio, vedere: https://aka.ms/azsdk/formrecognizer/models). Fornisce metodi diversi in base agli input di un URL e agli input di un flusso.

Nota

DocumentAnalysisClient deve essere usato con le versioni dell'API

2022-08-31 e versioni in su. Per usare le versioni <api =v2.1, creare un'istanza di FormRecognizerClient.

Novità della versione 2022-08-31: DocumentAnalysisClient e i relativi metodi client.

DocumentAnalysisError

DocumentAnalysisError contiene i dettagli dell'errore restituito dal servizio.

DocumentAnalysisInnerError

Dettagli dell'errore interno per DocumentAnalysisError.

DocumentBarcode

Oggetto codice a barre.

DocumentClassifierDetails

Informazioni sul classificatore di documenti. Include i tipi di documento che il modello può classificare.

DocumentField

Oggetto che rappresenta il contenuto e la posizione di un valore di campo del documento.

Novità nella versione 2023-07-31: valore booleano value_type e bool

DocumentFormula

Oggetto formula.

DocumentKeyValueElement

Oggetto che rappresenta la chiave o il valore del campo in una coppia chiave-valore.

DocumentKeyValuePair

Oggetto che rappresenta un campo del documento con etichetta di campo distinta (chiave) e valore del campo (può essere vuoto).

DocumentLanguage

Oggetto che rappresenta la lingua rilevata per un intervallo di testo specificato.

DocumentLine

Oggetto riga di contenuto che rappresenta il contenuto trovato in una singola riga del documento.

DocumentModelAdministrationClient

DocumentModelAdministrationClient è l'interfaccia Riconoscimento modulo da usare per la creazione e la gestione di modelli.

Fornisce metodi per la creazione di modelli e classificatori, nonché metodi per la visualizzazione e l'eliminazione di modelli e classificatori, la visualizzazione di operazioni di modello e classificatore, l'accesso alle informazioni sull'account, la copia di modelli in un'altra risorsa Riconoscimento modulo e la composizione di un nuovo modello da una raccolta di modelli esistenti.

Nota

DocumentModelAdministrationClient deve essere usato con le versioni dell'API

2022-08-31 e versioni in su. Per usare le versioni <dell'API =v2.1, creare un'istanza di FormTrainingClient.

Novità della versione 2022-08-31: DocumentModelAdministrationClient e i relativi metodi client.

DocumentModelAdministrationLROPoller

Implementa un protocollo seguito da oggetti poller restituiti.

DocumentModelDetails

Informazioni sul modello di documento. Include i tipi di documento che il modello può analizzare.

Novità della versione 2023-07-31: proprietà expires_on .

DocumentModelSummary

Riepilogo delle informazioni sul modello di documento, tra cui l'ID modello, la relativa descrizione e la data di creazione del modello.

Novità della versione 2023-07-31: proprietà expires_on .

DocumentPage

Elementi di contenuto e layout estratti da una pagina dell'input.

Novità della versione 2023-07-31: i codici a barre e le proprietà delle formule .

DocumentParagraph

Oggetto paragraph costituito in genere da linee contigue con allineamento e spaziatura comuni.

Novità della versione 2023-07-31: ruolo formulaBlock .

DocumentSelectionMark

Oggetto del segno di selezione che rappresenta caselle di controllo, pulsanti di opzione e altri elementi che indicano una selezione.

DocumentSpan

Area contigua del contenuto della proprietà, specificata come offset e lunghezza.

DocumentStyle

Oggetto che rappresenta gli stili di testo osservati.

Novità della versione 2023-07-31: le proprietà similar_font_family, font_style, font_weight, colore e background_color .

DocumentTable

Oggetto tabella costituito da celle di tabella disposte in un layout rettangolare.

DocumentTableCell

Oggetto che rappresenta la posizione e il contenuto di una cella della tabella.

DocumentTypeDetails

DocumentTypeDetails rappresenta un tipo di documento che un modello può riconoscere, inclusi i relativi campi e tipi e la confidenza per tali campi.

DocumentWord

Oggetto parola costituito da una sequenza contigua di caratteri. Per le lingue delimitate da spazi, ad esempio cinese, giapponese e coreano, ogni carattere è rappresentato come parola propria.

FieldData

Contiene i dati per il campo modulo. Sono inclusi il testo, la posizione del testo nel form e una raccolta di elementi che costituiscono il testo.

Novità nella versione 2.1: FormSelectionMark viene aggiunto ai tipi restituiti nell'elenco di field_elements, il supporto per i metodi to_dict e from_dict

FormElement

Tipo di base che include le proprietà per un elemento del modulo.

Novità della versione 2.1: supporto per i metodi di to_dict e from_dict

FormField

Rappresenta un campo riconosciuto in un modulo di input.

Novità della versione 2.1: supporto per i metodi di to_dict e from_dict

FormLine

Oggetto che rappresenta una riga di testo estratta.

Novità della versione 2.1: proprietà appearance, supporto per i metodi di to_dict e from_dict

FormPage

Rappresenta una pagina riconosciuta dal documento di input. Contiene righe, parole, segni di selezione, tabelle e metadati di pagina.

Novità della versione 2.1: proprietà selection_marks, supporto per metodi to_dict e from_dict

FormPageRange

Intervallo di pagine in base 1 del modulo.

Novità della versione 2.1: supporto per i metodi di to_dict e from_dict

FormRecognizerClient

FormRecognizerClient estrae informazioni da moduli e immagini in dati strutturati. È l'interfaccia da usare per l'analisi con modelli predefiniti (ricevute, biglietti da visita, fatture, documenti di identità), riconoscimento di contenuto/layout da moduli e analisi di moduli personalizzati da modelli sottoposti a training. Fornisce metodi diversi in base agli input di un URL e agli input di un flusso.

Nota

FormRecognizerClient deve essere usato con le versioni <dell'API =v2.1.

Per usare le versioni API 2022-08-31 e successive, creare un'istanza di DocumentAnalysisClient.

FormRecognizerError

Rappresenta un errore che si è verificato durante il training.

Novità della versione 2.1: supporto per i metodi di to_dict e from_dict

FormSelectionMark

Informazioni sul segno di selezione estratto.

Novità della versione 2.1: supporto per i metodi di to_dict e from_dict

FormTable

Informazioni sulla tabella estratta contenuta in una pagina.

Novità della versione 2.1: la proprietà bounding_box, il supporto per i metodi di to_dict e from_dict

FormTableCell

Rappresenta una cella contenuta in una tabella riconosciuta dal documento di input.

Novità nella versione 2.1: FormSelectionMark viene aggiunto ai tipi restituiti nell'elenco di field_elements, il supporto per i metodi to_dict e from_dict

FormTrainingClient

FormTrainingClient è l'interfaccia Riconoscimento modulo da usare per la creazione e la gestione di modelli personalizzati. Fornisce metodi per il training dei modelli nei moduli forniti, nonché metodi per la visualizzazione e l'eliminazione di modelli, l'accesso alle proprietà dell'account, la copia di modelli in un'altra risorsa Riconoscimento modulo e la composizione di modelli da una raccolta di modelli esistenti sottoposti a training con etichette.

Nota

FormTrainingClient deve essere usato con le versioni <dell'API =v2.1.

Per usare le versioni API 2022-08-31 e successive, creare un'istanza di DocumentModelAdministrationClient.

FormWord

Rappresenta una parola riconosciuta dal documento di input.

Novità della versione 2.1: supporto per i metodi di to_dict e from_dict

OperationDetails

OperationDetails è costituito da informazioni sull'operazione del modello, incluso il risultato o l'errore dell'operazione se è stata completata.

Si noti che le informazioni sull'operazione vengono mantenute solo per 24 ore. Se l'operazione ha avuto esito positivo, è anche possibile accedere al modello usando le <xref:azure.ai.formrecognizer.get_document_model>API , <xref:azure.ai.formrecognizer.list_document_models>, <xref:azure.ai.formrecognizer.get_document_classifier><xref:azure.ai.formrecognizer.list_document_classifiers> .

Novità della versione 2023-07-31: tipo documentClassifierBuild e risultato di DocumentClassifierDetails .

OperationSummary

Informazioni sull'operazione del modello, inclusi il tipo e lo stato dell'operazione, al momento della creazione e altro ancora.

Si noti che le informazioni sull'operazione vengono mantenute solo per 24 ore. Se l'operazione ha avuto esito positivo, è possibile accedere al modello usando le <xref:azure.ai.formrecognizer.get_document_model>API , <xref:azure.ai.formrecognizer.list_document_models>, <xref:azure.ai.formrecognizer.get_document_classifier>. <xref:azure.ai.formrecognizer.list_document_classifiers> Per scoprire perché un'operazione non è riuscita, usare <xref:azure.ai.formrecognizer.get_operation> e fornire il operation_id.

Novità della versione 2023-07-31: tipo documentClassifierBuild .

Point

Coordinata x, y di un punto su un rettangolo di selezione o un poligono.

Novità della versione 2.1: supporto per i metodi di to_dict e from_dict

QuotaDetails

Quota usata, limite e data/ora di reimpostazione successiva.

RecognizedForm

Rappresenta un modulo riconosciuto da un modello sottoposto a training o predefinito. La proprietà fields contiene i campi modulo estratti dal modulo. Le tabelle, le righe di testo e i segni di selezione vengono estratti per pagina e trovati nella proprietà pages .

Novità della versione 2.1: le proprietà form_type_confidence e model_id, il supporto per i metodi to_dict e from_dict

ResourceDetails

Dettagli relativi alla risorsa Riconoscimento modulo.

Novità della versione 2023-07-31: proprietà neural_document_model_quota .

TextAppearance

Oggetto che rappresenta l'aspetto della riga di testo.

Novità della versione 2.1: supporto per i metodi di to_dict e from_dict

TrainingDocumentInfo

Report per un singolo documento utilizzato per il training di un modello personalizzato.

Novità della versione 2.1: la proprietà model_id, il supporto per i metodi di to_dict e from_dict

Enumerazioni

AnalysisFeature

Funzionalità di analisi dei documenti da abilitare.

CustomFormModelStatus

Stato che indica l'idoneità del modello per l'uso.

DocumentAnalysisApiVersion

Riconoscimento modulo versioni dell'API supportate da DocumentAnalysisClient e DocumentModelAdministrationClient.

FieldValueType

Tipo di dati semantico del valore del campo.

Novità nella versione 2.1: i valori selectionMark e countryRegion

FormContentType

Tipo di contenuto per il caricamento.

Novità nella versione 2.1: supporto per image/bmp

FormRecognizerApiVersion

Riconoscimento modulo versioni dell'API supportate da FormRecognizerClient e FormTrainingClient.

LengthUnit

Unità utilizzata dalle proprietà larghezza, altezza e rettangolo di selezione. Per le immagini, l'unità è "pixel". Per il PDF, l'unità è "inch".

ModelBuildMode

Modalità utilizzata durante la compilazione di modelli personalizzati.

Per altre informazioni, vedere https://aka.ms/azsdk/formrecognizer/buildmode.

TrainingStatus

Stato dell'operazione di training.