@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 import { DocumentAnalysisClient } from "@azure/ai-form-recognizer"; import { DefaultAzureCredential } from "@azure/identity"; const endpoint = "https://<resource name>.cognitiveservices.azure.com"; const credential = new DefaultAzureCredential(); const client = new DocumentAnalysisClient(endpoint, credential); Chiave API (chiave di sottoscrizione) import { DocumentAnalysisClient, AzureKeyCredential } from "@azure/ai-form-recognizer"; const endpoint = "https://<resource name>.cognitiveservices.azure.com"; const credential = new AzureKeyCredential("<api key>"); const client = new DocumentAnalysisClient(endpoint, credential);
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 import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer"; import { DefaultAzureCredential } from "@azure/identity"; const endpoint = "https://<resource name>.cognitiveservices.azure.com"; const credential = new DefaultAzureCredential(); const client = new DocumentModelAdministrationClient(endpoint, credential); Chiave API (chiave di sottoscrizione) import { DocumentModelAdministrationClient, AzureKeyCredential } from "@azure/ai-form-recognizer"; const endpoint = "https://<resource name>.cognitiveservices.azure.com"; const credential = new AzureKeyCredential("<api key>"); const client = new DocumentModelAdministrationClient(endpoint, credential);

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 beginBuildDocumentModel, beginComposeDocumentModele getCopyAuthorization.
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 beginAnalyzeDocument di DocumentAnalysisClient, che supporta l'utilizzo di questi oggetti DocumentModel anziché le stringhe ID modello per fornire tipi di risultati più avanzati.
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. KnownDocumentBarcodeKind può essere usato in modo intercambiabile con DocumentBarcodeKind, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio qrCode: codice a matrice, come definito in ISO/IEC 18004:2015. PDF417: PDF417, come definito in ISO 15438. UPCA: GS1 codice prodotto universale a 12 cifre. UPCE: GS1 codice prodotto universale a 6 cifre. Code39: codice a barre 39, come definito in ISO/IEC 16388:2007. Codice128: codice a barre 128, come definito in ISO/IEC 15417:2007. EAN8: GS1 numero articolo internazionale a 8 cifre (numero articolo europeo). EAN13: GS1 a 13 cifre numero articolo internazionale (numero articolo europeo). DataBar: codice a barre GS1 DataBar. Code93: codice a barre 93, come definito in ANSI/AIM BC5-1995. codabar: codice a barre codabar, come definito in ANSI/AIM BC3-1995. dataBarExpanded: codice a barre espanso GS1 DataBar. ITF: Interleaved 2 di 5 codice a barre, come definito in ANSI/AIM BC2-1995. MicroQRCode: codice a matrice micro, come definito in ISO/IEC 23941:2022. Azteco: codice azteco, come definito in ISO/IEC 24778:2008. DataMatrix: codice matrice di dati, come definito in ISO/IEC 16022:2006. MaxiCode: MaxiCode, come definito in ISO/IEC 16023:2000.
DocumentBuildMode	Definisce i valori per DocumentBuildMode. KnownDocumentBuildMode può essere usato in modo intercambiabile con DocumentBuildMode, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio modello: destinazione di documenti con modelli visivi simili. neurale: supporta i documenti con modelli visivi diversi.
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: BlobSource BlobFileListSource
DocumentField	Campo estratto. La proprietà kind identifica (discrimina) il tipo del DocumentField.
DocumentFieldType	Definisce i valori per DocumentFieldType. KnownDocumentFieldType può essere usato in modo intercambiabile con DocumentFieldType, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio stringa: testo normale. data: data normalizzata in formato ISO 8601 (AAAA-MM-DD). tempo: ora normalizzata in formato ISO 8601 (hh:mm:ss). phoneNumber: numero di telefono normalizzato in formato E.164 (+{CountryCode}{SubscriberNumber}). numero: numero a virgola mobile normalizzato in virgola mobile a precisione doppia. intero: numero intero normalizzato in intero con segno a 64 bit. selezioneMark: il campo è selezionato? countryRegion: Paese/area geografica, normalizzato in formato ISO 3166-1 alfa-3 (ad esempio USA). firma: è presente la firma? matrice: elenco di sottocampi dello stesso tipo. oggetto: elenco denominato di sottocampi di tipi potenzialmente diversi. valuta: importo valuta con simbolo di valuta e unità facoltativi. indirizzo: indirizzo analizzato. booleano : valore booleano, normalizzato in true o false.
DocumentFormulaKind	Definisce i valori per DocumentFormulaKind. KnownDocumentFormulaKind può essere usato in modo intercambiabile con DocumentFormulaKind, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio inline: formula incorporata nel contenuto di un paragrafo. visualizzare: formula in modalità di visualizzazione che occupa un'intera riga.
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: "neural", che produce la massima qualità del modello in grado di estrarre dati da classi di documenti che hanno la stessa struttura di dati, ma layout diversi (ad esempio, moduli fiscali W2, che possono variare da società a società, ma sempre contengono le stesse informazioni). "template", che richiede che tutti i documenti abbiano lo stesso layout fisso (modello). 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: BlobSource BlobFileListSource
DocumentSignatureType	Definisce i valori per DocumentSignatureType. KnownDocumentSignatureType può essere usato in modo intercambiabile con DocumentSignatureType, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio firmato: viene rilevata una firma. senza segno: non vengono rilevate firme.
DocumentTableCellKind	Definisce i valori per DocumentTableCellKind. KnownDocumentTableCellKind può essere usato in modo intercambiabile con DocumentTableCellKind, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio contenuto: contiene il contenuto/dati principale. rowHeader: descrive il contenuto della riga. columnHeader: descrive il contenuto della colonna. stubHead: descrive le intestazioni di riga, in genere posizionate nell'angolo superiore sinistro di una tabella. descrizione: descrive il contenuto in (parti della tabella).
FontStyle	Definisce i valori per FontStyle. KnownFontStyle può essere usato in modo intercambiabile con FontStyle, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio normale: i caratteri sono rappresentati normalmente. corsivo: i caratteri sono allineati visivamente verso destra.
FontWeight	Definisce i valori per FontWeight. KnownFontWeight può essere usato in modo intercambiabile con FontWeight, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio normale: i caratteri sono rappresentati normalmente. grassetto: i caratteri sono rappresentati con tratti più spessi.
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: https://aka.ms/azsdk/formrecognizer/features
FormRecognizerRequestBody	Input di richiesta che può essere caricato come dati binari nel servizio Riconoscimento modulo. Riconoscimento modulo considera string input come URL, in modo da inviare una stringa come input binario, convertire prima la stringa in uno dei tipi di input seguenti.
LengthUnit	Definisce i valori per LengthUnit. KnownLengthUnit può essere usato in modo intercambiabile con LengthUnit, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio pixel: unità di lunghezza per i file di immagine. pollice: unità di lunghezza per i file PDF.
OperationDetailsUnion	Informazioni dettagliate su diversi tipi di operazioni di gestione di Riconoscimento modulo.
OperationKind	Definisce i valori per OperationKind. KnownOperationKind può essere usato in modo intercambiabile con OperationKind, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio documentModelBuild: creare un nuovo modello di documento personalizzato. documentModelCompose: comporre un nuovo modello di documento personalizzato da modelli esistenti. documentModelCopyTo: copiare un modello di documento esistente in una risorsa, un'area o una sottoscrizione diversa. documentClassifierBuild: creare un nuovo modello di classificatore personalizzato.
OperationStatus	Definisce i valori per OperationStatus.
ParagraphRole	Definisce i valori per ParagraphRole. KnownParagraphRole può essere usato in modo intercambiabile con ParagraphRole, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio pageHeader: testo vicino al bordo superiore della pagina. pageFooter: testo vicino al bordo inferiore della pagina. pageNumber: Numero pagina. titolo: titolo di primo livello che descrive l'intero documento. sezioneHeading: sottotitolo che descrive una sezione del documento. nota a piè di pagina: nota in genere inserita dopo il contenuto principale di una pagina. formulaBlock: blocco di formule, spesso con allineamento condiviso.
SelectionMarkState	Definisce i valori per SelectionMarkState. KnownSelectionMarkState può essere usato in modo intercambiabile con SelectionMarkState, questa enumerazione contiene i valori noti supportati dal servizio. 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. deselezionata: il segno di selezione non è selezionato.
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.