@azure/ai-form-recognizer package

Classi

AzureKeyCredential	Credenziale basata su chiave statica che supporta l'aggiornamento del valore della chiave sottostante.
DocumentAnalysisClient	Un client per l'interazione con le funzionalità di analisi del servizio Riconoscimento modulo. Esempi: Il servizio Riconoscimento modulo e i client supportano due metodi 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'elenco, 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 del documento può essere determinato dal modello utilizzato per eseguire l'analisi.
AnalyzeResultCommon	I campi comuni di tutti i tipi di tipo 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	Archiviazione BLOB di Azure contenuto.
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 del documento che descrive un indirizzo fisico strutturato.
DocumentAnalysisClientOptions	Opzioni configurabili per DocumentAnalysisClient.
DocumentAnalysisPollOperationState	Stato di un'operazione di analisi, che genererà infine il tipo di risultato corrispondente 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 tabella didascalia.
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 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	DocumentField con valore integer.
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 distinto (chiave) e valore del campo (può essere vuoto).
DocumentLanguage	Oggetto che rappresenta la lingua rilevata per un determinato intervallo di testo.
DocumentLine	Oggetto linea contenuto costituito da una sequenza adiacente di elementi del contenuto, ad esempio parole e contrassegni di selezione.
DocumentModel	Specifica del modello nota che supporta l'estrazione di documenti strutturati. Vedere il metodo documentAnalysisClient, che supporta l'utilizzo beginAnalyzeDocument di questi DocumentModel oggetti anziché le stringhe ID modello per fornire tipi di risultati più forti.
DocumentModelAdministrationClientOptions	Opzioni configurabili per DocumentModelAdministrationClient.
DocumentModelBuildOperationDetails	Ottenere l'oggetto risposta operation.
DocumentModelComposeOperationDetails	Ottenere l'oggetto risposta operation.
DocumentModelCopyToOperationDetails	Ottenere 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	DocumentField con un valore numerico.
DocumentObjectField	DocumentField costituito da diverse proprietà denominate con valori DocumentField personalizzati.
DocumentPage	Contenuto e elementi di layout estratti da una pagina dall'input.
DocumentParagraph	Oggetto paragrafo costituito da linee contigue in genere con allineamento e spaziatura comuni.
DocumentPhoneNumberField	DocumentField con un valore di numero di telefono rappresentato come stringa.
DocumentSelectionMark	Oggetto contrassegno di selezione che rappresenta caselle di controllo, pulsanti di opzione e altri elementi che indicano una selezione.
DocumentSelectionMarkField	DocumentField con un valore che indica uno stato di contrassegno di selezione (ad esempio una casella di controllo o un pulsante di opzione), rappresentato come stringa.
DocumentSignatureField	DocumentField che indica lo stato di una firma, rappresentato come stringa.
DocumentSpan	Area contigua della proprietà contenuto concatenata, specificata come offset e lunghezza.
DocumentStringField	DocumentField con 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	DocumentField che ha un valore di tempo, rappresentato come stringa.
DocumentTypeDetails	Informazioni sul tipo di documento.
DocumentValueField	Un campo semplice che ha un valore primitivo, ad esempio una stringa, un numero e così via.
DocumentWord	Oggetto word costituito da una sequenza contigua di caratteri. Per le lingue delimitate da spazi, ad esempio cinese, giapponese e coreano, ogni carattere viene rappresentato come propria parola.
ErrorModel	Informazioni sull'errore.
GetCopyAuthorizationOptions	Opzioni per il metodo di autorizzazione di copia get.
GetModelOptions	Opzioni per il recupero delle informazioni sul modello.
GetOperationOptions	Opzioni per il recupero di uno stato dell'operazione.
GetResourceDetailsOptions	Opzioni per il recupero di informazioni sulle risorse Riconoscimento modulo.
HasBoundingPolygon	Elementi di documento semplici, ad esempio parole, segni di selezione e righe sono associati al 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 corrispondente 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 a 12 cifre Universal Product Code. UPCE: GS1 a 6 cifre Universal Product Code. Code39: codice a barre 39, come definito in ISO/IEC 16388:2007. Code128: 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 codici a barre, come definito in ANSI/AIM BC2-1995. MicroQRCode: codice a matrice micro, come definito in ISO/IEC 23941:2022. 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, che contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio template: specificare come destinazione i documenti con modelli di oggetto visivo simili. neural: 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 infine un Oggetto DocumentClassifierDetails.
DocumentClassifierSource	Origine di contenuto che può essere usata per compilare un classificatore di documenti. Uno dei valori possibili: BlobSource BlobFileListSource
DocumentField	Campo estratto. La kind proprietà identifica (discrimina) il tipo dell'oggetto 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. date: data, normalizzata in formato ISO 8601 (AAAA-MM-GG). time: 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. integer: numero intero, normalizzato in intero con segno a 64 bit. selectionMark: 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. object: elenco denominato di sottocampi di tipi potenzialmente diversi. valuta: importo valuta con simbolo di valuta facoltativo e unità. indirizzo: indirizzo analizzato. boolean: valore booleano, normalizzato su true o false.
DocumentFormulaKind	Definisce i valori per DocumentFormulaKind. NotoDocumentFormulaKind può essere usato in modo interscambiabile con DocumentFormulaKind, questo enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio inline: formula incorporata nel contenuto di un paragrafo. display: 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 disponibili sono le seguenti: "neurale", che restituisce la massima qualità del modello in grado di estrarre i dati dalle 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). "modello", 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 infine un Oggetto DocumentModelDetails.
DocumentModelSource	Origine contenuto che può essere usata per compilare un modello di documento. Uno dei valori possibili: BlobSource BLOBFileListSource
DocumentSignatureType	Definisce i valori per DocumentSignatureType. NotoDocumentSignatureType può essere usato in modo interscambiabile con DocumentSignatureType, questo 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. NotoDocumentTableCellKind può essere usato in modo interscambiabile con DocumentTableCellKind, questo enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio contenuto: contiene il contenuto/i dati principali. 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. NotoFontStyle 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 a destra.
FontWeight	Definisce i valori per FontWeight. NotoFontWeight 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 della richiesta che può essere caricato come dati binari nel servizio Riconoscimento modulo. Riconoscimento modulo considera string gli 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, che 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 di pagina. title: titolo di primo livello che descrive l'intero documento. sectionHeading: 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 da una X incrociata all'interno del segno di selezione. deselezionata: il segno di selezione non è selezionato.
StringIndexType	Tipi di indice stringa validi supportati dai client sdk e del servizio Riconoscimento modulo.

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.