@azure/ai-form-recognizer package
Classi
AzureKeyCredential |
Credenziali basate su chiavi statiche che supportano l'aggiornamento del valore della chiave sottostante. |
DocumentAnalysisClient |
Un client per interagire con le funzionalità di analisi del servizio Riconoscimento modulo. Esempi:Il servizio Riconoscimento modulo e i client supportano due mezzi di autenticazione: Azure Active Directory
Chiave API (chiave di sottoscrizione)
|
DocumentModelAdministrationClient |
Un client per interagire con le funzionalità di gestione dei modelli del servizio Riconoscimento modulo, ad esempio la creazione, la lettura, l'inserzione, l'eliminazione e la copia dei modelli. Esempi:Azure Active Directory
Chiave API (chiave di sottoscrizione)
|
Interfacce
AddressValue |
Valore del campo indirizzo. |
AnalyzeDocumentOptions |
Opzioni per l'operazione di analisi dei documenti. |
AnalyzeResult |
Risultato di un'operazione di analisi. Il tipo di documento può essere determinato dal modello utilizzato per eseguire l'analisi. |
AnalyzeResultCommon |
Campi comuni di tutti i tipi simili a AnalyzeResult, ad esempio LayoutResult, ReadResult e GeneralDocumentResult. |
AnalyzedDocument |
Oggetto documento estratto. AnalyzedDocument è un'istanza di uno dei tipi di documento all'interno di un modello. I relativi campi corrispondono allo schema del campo del tipo di documento. |
AzureBlobFileListSource |
Origine dati di training definita da un contenitore BLOB di Azure e da un elenco di file JSONL all'interno del contenitore. |
AzureBlobFileListSourceDetails |
Elenco di file in Archiviazione BLOB di Azure. |
AzureBlobSource |
Origine dati di training definita da un contenitore BLOB di Azure. |
AzureBlobSourceDetails |
Contenuto di Archiviazione BLOB di Azure. |
BeginBuildDocumentClassifierOptions |
Opzioni per l'operazione di compilazione del classificatore di documenti. |
BeginBuildDocumentModelOptions |
Opzioni per l'operazione di compilazione del modello. |
BeginComposeDocumentModelOptions |
Opzioni per l'operazione di composizione del modello. |
BeginCopyModelOptions |
Opzioni per l'operazione di copia del modello. |
BoundingRegion |
Poligono di delimitazione in una pagina specifica dell'input. |
ClassifierDocumentTypeDetails |
Informazioni sul tipo di documento del classificatore. |
ClassifyDocumentOptions |
Opzioni per l'operazione di classificazione dei documenti. |
CommonModelCreationOptions |
Opzioni comuni a tutte le operazioni che definiscono nuovi modelli, ad esempio |
CopyAuthorization |
Autorizzazione per copiare un modello di documento nella risorsa di destinazione e modelId specificati. |
CreateDocumentModelOptions |
Opzioni per l'operazione di creazione del modello. |
CurrencyValue |
Valore del campo Valuta. |
CustomDocumentModelsDetails |
Dettagli relativi ai modelli di documento personalizzati. |
DeleteDocumentModelOptions |
Opzioni per l'eliminazione del modello. |
DocumentAddressField |
Campo documento che descrive un indirizzo fisico strutturato. |
DocumentAnalysisClientOptions |
Opzioni configurabili per DocumentAnalysisClient. |
DocumentAnalysisPollOperationState |
Stato di un'operazione di analisi, che alla fine produrrà il tipo di risultato che corrisponde al modello. |
DocumentAnnotation |
Elemento di annotazione visiva nel documento, ad esempio un segno di spunta o una croce. |
DocumentArrayField |
Oggetto DocumentField costituito da una matrice di campi annidati. Tutti i campi nella matrice avranno lo stesso tipo. |
DocumentBarcode |
Codice a barre estratto. |
DocumentBooleanField |
Oggetto DocumentField con un valore booleano. |
DocumentCaption |
Oggetto che rappresenta la posizione e il contenuto di una didascalia di tabella. |
DocumentClassifierBuildOperationDetails |
Ottiene l'oggetto risposta operation. |
DocumentClassifierDetails |
Informazioni sul classificatore di documenti. |
DocumentClassifierDocumentTypeSources |
Set di origini utilizzate per creare un classificatore di documenti. Si tratta di una mappa dei nomi dei tipi di documento alle origini che verranno usate per eseguire il training del modello per classificare i documenti del tipo di origine corrispondente. |
DocumentClassifierOperationState |
Stato di un'operazione di creazione del modello. |
DocumentCountryRegionField |
Oggetto DocumentField con un valore che indica un paese o un'area geografica, rappresentato come stringa. |
DocumentCurrencyField |
Oggetto DocumentField che descrive un importo di una determinata valuta. |
DocumentDateField |
Oggetto DocumentField con un valore Date. |
DocumentFieldCommon |
Campi comuni a tutte le varianti di DocumentField. |
DocumentFieldSchema |
Descrizione dello schema semantico del campo usando una sintassi dello stile dello schema JSON. |
DocumentFootnote |
Oggetto che rappresenta la posizione e il contenuto di una nota a piè di pagina della tabella. |
DocumentFormula |
Formula estratta. |
DocumentIntegerField |
Oggetto DocumentField con un valore intero. |
DocumentKeyValueElement |
Oggetto che rappresenta la chiave o il valore del campo in una coppia chiave-valore. |
DocumentKeyValuePair |
Oggetto che rappresenta un campo modulo 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 linea contenuto costituito da una sequenza adiacente di elementi di contenuto, ad esempio parole e segni di selezione. |
DocumentModel |
Specifica del modello nota che supporta l'estrazione di documenti strutturati. Vedere il metodo |
DocumentModelAdministrationClientOptions |
Opzioni configurabili per DocumentModelAdministrationClient. |
DocumentModelBuildOperationDetails |
Ottiene l'oggetto risposta operation. |
DocumentModelComposeOperationDetails |
Ottiene l'oggetto risposta operation. |
DocumentModelCopyToOperationDetails |
Ottiene l'oggetto risposta operation. |
DocumentModelDetails |
Informazioni sul modello di documento. |
DocumentModelOperationState |
Stato di un'operazione di creazione del modello. |
DocumentModelSummary |
Riepilogo del modello di documento. |
DocumentNumberField |
Oggetto DocumentField con un valore numerico. |
DocumentObjectField |
Oggetto DocumentField costituito da diverse proprietà denominate con valori DocumentField personalizzati. |
DocumentPage |
Elementi di contenuto e layout estratti da una pagina dall'input. |
DocumentParagraph |
Oggetto paragrafo costituito da linee contigue in genere con allineamento e spaziatura comuni. |
DocumentPhoneNumberField |
Oggetto DocumentField con un valore di numero di telefono rappresentato come stringa. |
DocumentSelectionMark |
Oggetto del segno di selezione che rappresenta caselle di controllo, pulsanti di opzione e altri elementi che indicano una selezione. |
DocumentSelectionMarkField |
Un oggetto DocumentField con un valore che indica uno stato del segno di selezione (ad esempio una casella di controllo o un pulsante di opzione), rappresentato come stringa. |
DocumentSignatureField |
Oggetto DocumentField che indica lo stato di una firma, rappresentato come stringa. |
DocumentSpan |
Area contigua della proprietà del contenuto concatenata, specificata come offset e lunghezza. |
DocumentStringField |
Oggetto DocumentField con un valore stringa. |
DocumentStyle |
Oggetto che rappresenta gli stili di testo osservati. |
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. |
DocumentTimeField |
Oggetto DocumentField con un valore di ora, rappresentato come stringa. |
DocumentTypeDetails |
Informazioni sul tipo di documento. |
DocumentValueField |
Un campo semplice con un valore primitivo, ad esempio una stringa, un numero e così via. |
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. |
ErrorModel |
Informazioni sull'errore. |
GetCopyAuthorizationOptions |
Opzioni per il metodo get copy authorization. |
GetModelOptions |
Opzioni per il recupero delle informazioni sul modello. |
GetOperationOptions |
Opzioni per il recupero di uno stato dell'operazione. |
GetResourceDetailsOptions |
Opzioni per il recupero delle informazioni sulle risorse di Riconoscimento modulo. |
HasBoundingPolygon |
Gli elementi di documento semplici, ad esempio parole, segni di selezione e linee, sono delimitati dal poligono. |
InnerError |
Errore dettagliato. |
ListModelsOptions |
Opzioni per elencare i modelli. |
ListOperationsOptions |
Opzioni per elencare le operazioni. |
ModelAdministrationOperationStateCommon |
Set di campi comuni a tutte le operazioni di amministrazione. |
OperationDetails |
Ottiene l'oggetto risposta operation. |
OperationSummary |
Informazioni sull'operazione. |
Point2D |
Rappresenta un punto utilizzato per definire i poligoni di delimitazione. L'unità è "pixel" o "inch" (vedere LengthUnit). |
PollerOptions |
Opzioni per le operazioni a esecuzione prolungata (poller) nei client riconoscimento modulo. |
QuotaDetails |
Quota usata, limite e data/ora di reimpostazione successiva. |
ResourceDetails |
Informazioni generali sulla risorsa corrente. |
Alias tipo
AnalysisPoller |
Operazione a esecuzione prolungata (poller) che tiene traccia dello stato di un'operazione di analisi, generando infine il tipo di risultato che corrisponde al modello. |
AnalyzeResultOperationStatus |
Definisce i valori per AnalyzeResultOperationStatus. |
DocumentBarcodeKind |
Definisce i valori per DocumentBarcodeKind. Valori noti supportati dal servizio
qrCode: codice a matrice, come definito in ISO/IEC 18004:2015. |
DocumentBuildMode |
Definisce i valori per DocumentBuildMode. Valori noti supportati dal servizio
modello: destinazione di documenti con modelli visivi simili. |
DocumentClassifierPoller |
Operazione a esecuzione prolungata (poller) che tiene traccia dello stato di un'operazione di creazione del classificatore personalizzato, generando un DocumentClassifierDetails. |
DocumentClassifierSource |
Origine contenuto che può essere usata per compilare un classificatore di documenti. Uno dei seguenti:
|
DocumentField |
Campo estratto. La proprietà |
DocumentFieldType |
Definisce i valori per DocumentFieldType. Valori noti supportati dal servizio
stringa: testo normale. |
DocumentFormulaKind |
Definisce i valori per DocumentFormulaKind. Valori noti supportati dal servizio
inline: formula incorporata nel contenuto di un paragrafo. |
DocumentModelBuildMode |
Modalità di compilazione del modello supportate. La modalità di compilazione del modello seleziona il motore usato dal servizio per eseguire il training del modello in base ai dati di training etichettati. Le opzioni sono:
Per altre informazioni, vedere il collegamento seguente: https://aka.ms/azsdk/formrecognizer/buildmode |
DocumentModelPoller |
Operazione a esecuzione prolungata (poller) che tiene traccia dello stato di un'operazione di creazione del modello, generando una DocumentModelDetails. |
DocumentModelSource |
Origine contenuto che può essere usata per compilare un modello di documento. Uno dei seguenti:
|
DocumentSignatureType |
Definisce i valori per DocumentSignatureType. Valori noti supportati dal servizio
firmato: viene rilevata una firma. |
DocumentTableCellKind |
Definisce i valori per DocumentTableCellKind. Valori noti supportati dal servizio
contenuto: contiene il contenuto/dati principale. |
FontStyle |
Definisce i valori per FontStyle. Valori noti supportati dal servizio
normale: i caratteri sono rappresentati normalmente. |
FontWeight |
Definisce i valori per FontWeight. Valori noti supportati dal servizio
normale: i caratteri sono rappresentati normalmente. |
FormRecognizerFeature |
Funzionalità del componente aggiuntivo (funzionalità) che possono essere abilitate per la richiesta. Per altre informazioni sulle funzionalità disponibili in Riconoscimento modulo, vedere la documentazione del servizio: |
FormRecognizerRequestBody |
Input di richiesta che può essere caricato come dati binari nel servizio Riconoscimento modulo. Riconoscimento modulo considera |
LengthUnit |
Definisce i valori per LengthUnit. Valori noti supportati dal servizio
pixel: unità di lunghezza per i file di immagine. |
OperationDetailsUnion |
Informazioni dettagliate su diversi tipi di operazioni di gestione di Riconoscimento modulo. |
OperationKind |
Definisce i valori per OperationKind. Valori noti supportati dal servizio
documentModelBuild: creare un nuovo modello di documento personalizzato. |
OperationStatus |
Definisce i valori per OperationStatus. |
ParagraphRole |
Definisce i valori per ParagraphRole. Valori noti supportati dal servizio
pageHeader: testo vicino al bordo superiore della pagina. |
SelectionMarkState |
Definisce i valori per SelectionMarkState. Valori noti supportati dal servizio
selezionato: il segno di selezione è selezionato, spesso indicato da un segno di spunta ✓ o incrociato X all'interno del segno di selezione. |
StringIndexType |
Tipi di indice stringa validi supportati dal servizio Riconoscimento modulo e dai client SDK. |
Enumerazioni
KnownDocumentBarcodeKind |
Valori noti di DocumentBarcodeKind accettati dal servizio. |
KnownDocumentBuildMode |
Valori noti di DocumentBuildMode accettati dal servizio. |
KnownDocumentFieldType |
Valori noti di DocumentFieldType accettati dal servizio. |
KnownDocumentFormulaKind |
Valori noti di DocumentFormulaKind accettati dal servizio. |
KnownDocumentSignatureType |
Valori noti di DocumentSignatureType accettati dal servizio. |
KnownDocumentTableCellKind |
Valori noti di DocumentTableCellKind accettati dal servizio. |
KnownFontStyle |
Valori noti di FontStyle accettati dal servizio. |
KnownFontWeight |
Valori noti di FontWeight accettati dal servizio. |
KnownLengthUnit |
Valori noti di LengthUnit accettati dal servizio. |
KnownOperationKind |
Valori noti di OperationKind accettati dal servizio. |
KnownParagraphRole |
Valori noti di ParagraphRole accettati dal servizio. |
KnownSelectionMarkState |
Valori noti di SelectionMarkState accettati dal servizio. |