@azure/ai-form-recognizer package

En statisk nyckelbaserad autentiseringsuppgift som stöder uppdatering av det underliggande nyckelvärdet.

En klient för att interagera med Formigenkänning-tjänstens analysfunktioner.

Exempel:

Formigenkänning-tjänsten och klienterna stöder två autentiseringsmetoder:

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);

API-nyckel (prenumerationsnyckel)

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);

En klient för att interagera med Formigenkänning-tjänstens modellhanteringsfunktioner, till exempel att skapa, läsa, lista, ta bort och kopiera modeller.

Exempel:

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);

API-nyckel (prenumerationsnyckel)

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);

Adressfältvärde.

Alternativ för dokumentanalysåtgärden.

Resultatet av en analysåtgärd. Typen av dokument kan bestämmas av den modell som används för att utföra analysen.

De vanliga fälten för alla AnalyzeResult-liknande typer, till exempel LayoutResult, ReadResult och GeneralDocumentResult.

Ett extraherat dokumentobjekt.

En AnalyzedDocument är en instans av en av dokumenttyperna i en modell. Dess fält motsvarar fältschemat för dokumenttypen.

En träningsdatakälla som definierats av en Azure Blob Container och en JSONL-fillista i containern.

Fillista i Azure Blob Storage.

En träningsdatakälla som definierats av en Azure Blob-container.

Azure Blob Storage innehåll.

Alternativ för dokumentklassificerarens byggåtgärd.

Alternativ för modellbyggåtgärden.

Alternativ för modellens sammansättningsåtgärd.

Alternativ för kopieringsmodellåtgärden.

Avgränsning av polygon på en specifik sida av indata.

Information om dokumenttyp för klassificerare.

Alternativ för dokumentklassificeringsåtgärden.

Alternativ som är gemensamma för alla åtgärder som definierar nya modeller, till exempel beginBuildDocumentModel, beginComposeDocumentModeloch getCopyAuthorization.

Auktorisering för att kopiera en dokumentmodell till den angivna målresursen och modelId.

Alternativ för modellskapandeåtgärden.

Valutafältvärde.

Information om anpassade dokumentmodeller.

Alternativ för borttagning av modell.

Ett dokumentfält som beskriver en strukturerad fysisk adress.

Konfigurerbara alternativ för DocumentAnalysisClient.

Tillståndet för en analysåtgärd, som så småningom skapar den resultattyp som motsvarar modellen.

Ett visuellt anteckningselement i dokumentet, till exempel en bockmarkering eller ett kors.

Ett DocumentField som består av en matris med kapslade fält. Alla fält i matrisen har samma typ.

En extraherad streckkod.

Ett DocumentField som har ett booleskt värde.

Ett objekt som representerar platsen och innehållet i en tabell bildtext.

Hämta åtgärdssvarsobjekt.

Information om dokumentklassificerare.

En uppsättning källor som används för att skapa en dokumentklassificerare. Det här är en karta över dokumenttypsnamn till källor som ska användas för att träna modellen att klassificera dokument av motsvarande källtyp.

Tillståndet för en modellskapandeåtgärd.

Ett DocumentField som har ett värde som anger ett land eller en region, representerat som en sträng.

Ett DocumentField som beskriver en viss valuta.

Ett DocumentField som har ett datumvärde.

Fält som är gemensamma för alla DocumentField-varianter.

Beskrivning av fältets semantiska schema med hjälp av en syntax för JSON-schemaformat.

Ett objekt som representerar platsen och innehållet i en tabells fotnot.

En extraherad formel.

Ett DocumentField som har ett heltalsvärde.

Ett objekt som representerar fältnyckeln eller värdet i ett nyckel/värde-par.

Ett objekt som representerar ett formulärfält med distinkt fältetikett (nyckel) och fältvärde (kan vara tomt).

Ett objekt som representerar det identifierade språket för ett visst textintervall.

Ett innehållsradsobjekt som består av en intilliggande sekvens med innehållselement, till exempel ord och markeringsmarkeringar.

En välkänd modellspecifikation som stöder extrahering av strukturerade dokument.

beginAnalyzeDocument Se metoden för DocumentAnalysisClient, som stöder användning av dessa DocumentModel objekt i stället för modell-ID-strängar för att ge starkare resultattyper.

Konfigurerbara alternativ för DocumentModelAdministrationClient.

Hämta åtgärdssvarsobjekt.

Hämta åtgärdssvarsobjekt.

Hämta åtgärdssvarsobjekt.

Dokumentmodellinformation.

Tillståndet för en modellskapandeåtgärd.

Sammanfattning av dokumentmodell.

Ett DocumentField som har ett talvärde.

Ett DocumentField som består av flera namngivna egenskaper som har egna DocumentField-värden.

Innehålls- och layoutelement som extraherats från en sida från indata.

Ett styckeobjekt som vanligtvis består av sammanhängande linjer med gemensam justering och avstånd.

Ett DocumentField som har ett telefonnummervärde, representerat som en sträng.

Ett markeringsmarkeringsobjekt som representerar kryssrutor, alternativknappar och andra element som anger en markering.

Ett DocumentField som har ett värde som anger ett markeringsmarkeringstillstånd (till exempel en kryssruta eller alternativknapp) som representeras som en sträng.

Ett DocumentField som anger tillståndet för en signatur, representerad som en sträng.

Sammanhängande region för den sammanfogade innehållsegenskapen, angiven som en förskjutning och längd.

Ett DocumentField som har ett strängvärde.

Ett objekt som representerar observerade textformat.

Ett tabellobjekt som består av tabellceller ordnade i en rektangulär layout.

Ett objekt som representerar platsen och innehållet i en tabellcell.

Ett DocumentField som har ett tidsvärde, representerat som en sträng.

Information om dokumenttyp.

Ett enkelt fält som har ett primitivt värde, till exempel en sträng, ett tal osv.

Ett ordobjekt som består av en sammanhängande sekvens med tecken. För icke-blankstegsavgränsade språk, till exempel kinesiska, japanska och koreanska, representeras varje tecken som sitt eget ord.

Felinformation.

Alternativ för metoden hämta kopieringsauktorisering.

Alternativ för att hämta modellinformation.

Alternativ för att hämta ett åtgärdstillstånd.

Alternativ för att hämta Formigenkänning resursinformation.

Enkla dokumentelement som ord, markeringsmarkeringar och rader begränsas av polygonen.

Detaljerat fel.

Alternativ för att lista modeller.

Alternativ för listningsåtgärder.

Den uppsättning fält som är gemensamma för alla administrationsåtgärder.

Hämta åtgärdssvarsobjekt.

Åtgärdsinformation.

Representerar en punkt som används för att definiera avgränsningspolygoner. Enheten är antingen pixel eller tum (se LengthUnit).

Alternativ för långvariga åtgärder (pollers) i Formigenkänning klienter.

Använd kvot, begränsa och nästa återställningsdatum/tid.

Allmän information om den aktuella resursen.

En tidskrävande åtgärd (poller) som spårar tillståndet för en analysåtgärd och så småningom producerar den resultattyp som motsvarar modellen.

Definierar värden för AnalyzeResultOperationStatus.

Definierar värden för DocumentBarcodeKind.
KnownDocumentBarcodeKind kan användas utbytbart med DocumentBarcodeKind. Den här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

QRCode: QR-kod enligt definitionen i ISO/IEC 18004:2015.
PDF417: PDF417, enligt definitionen i ISO 15438.
UPCA: GS1 12-siffrig universell produktkod.
UPCE: GS1 6-siffrig universell produktkod.
Code39: Kod 39-streckkod enligt definitionen i ISO/IEC 16388:2007.
Code128: Kod 128-streckkod enligt definitionen i ISO/IEC 15417:2007.
EAN8: GS1 8-siffrigt internationellt artikelnummer (europeiskt artikelnummer).
EAN13: GS1 13-siffrig internationell artikelnummer (europeiskt artikelnummer).
DataBar: GS1 DataBar-streckkod.
Code93: Kod 93-streckkod enligt definitionen i ANSI/AIM BC5-1995.
Codabar: Codabar-streckkod enligt definitionen i ANSI/AIM BC3-1995.
DataBarExpanded: GS1 DataBar Expanderad streckkod.
ITF: Interfolierad 2 av 5 streckkod enligt definitionen i ANSI/AIM BC2-1995.
MicroQRCode: QR-mikrokod enligt definitionen i ISO/IEC 23941:2022.
Aztec: Aztec-kod enligt definitionen i ISO/IEC 24778:2008.
DataMatrix: Datamatriskod enligt definitionen i ISO/IEC 16022:2006.
MaxiCode: MaxiCode, enligt definitionen i ISO/IEC 16023:2000.

Definierar värden för DocumentBuildMode.
KnownDocumentBuildMode kan användas utbytbart med DocumentBuildMode. Det här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

mall: Måldokument med liknande visuella mallar.
neural: Stöd för dokument med olika visuella mallar.

En tidskrävande åtgärd (poller) som spårar tillståndet för en anpassad åtgärd för att skapa klassificerare och så småningom skapar en DocumentClassifierDetails.

En innehållskälla som kan användas för att skapa en dokumentklassificerare.

Något av:

• BlobSource
• BlobFileListSource

Ett extraherat fält. Egenskapen kind identifierar (diskriminerar) typen av DocumentField.

Definierar värden för DocumentFieldType.
KnownDocumentFieldType kan användas utbytbart med DocumentFieldType. Det här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

sträng: Oformaterad text.
datum: Datum, normaliserat till ISO 8601-format (ÅÅÅÅ-MM-DD).
tid: Tid, normaliserad till ISO 8601-format (hh:mm:ss).
phoneNumber: Telefonnummer, normaliserat till formatet E.164 (+{CountryCode}{SubscriberNumber}).
tal: Flyttalsnummer, normaliserat till flyttal med dubbel precision.
heltal: Heltalsnummer, normaliserat till 64-bitars signerat heltal.
selectionMark: Är fältet markerat?
countryRegion: Land/region, normaliserat till ISO 3166-1 alfa-3-format (till exempel USA).
signatur: Finns signaturen?
matris: Lista över underfält av samma typ.
objekt: Namngiven lista över underfält av potentiellt olika typer.
valuta: Valutabelopp med valfri valutasymbol och enhet.
adress: Parsad adress.
booleskt värde: Booleskt värde, normaliserat till sant eller falskt.

Definierar värden för DocumentFormulaKind.
KnownDocumentFormulaKind kan användas synonymt med DocumentFormulaKind, den här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

infogad: En formel som är inbäddad i innehållet i ett stycke.
display: En formel i visningsläge som tar upp en hel rad.

Modellbygglägen som stöds. Modellbyggläget väljer den motor som tjänsten använder för att träna modellen baserat på märkta träningsdata.

Alternativen är:

• "neural", som ger den högsta kvaliteten på modellen som kan extrahera data från klasser av dokument som har samma datastruktur, men olika layouter (till exempel W2 skatteformulär, som kan variera från företag till företag, men alltid innehåller samma information).
• "template", som kräver att alla dokument har samma fasta layout (mall).

Mer information finns på följande länk: https://aka.ms/azsdk/formrecognizer/buildmode

En tidskrävande åtgärd (poller) som spårar tillståndet för en modellskapandeåtgärd och så småningom skapar en DocumentModelDetails.

En innehållskälla som kan användas för att skapa en dokumentmodell.

Något av:

• BlobSource
• BlobFileListSource

Definierar värden för DocumentSignatureType.
KnownDocumentSignatureType kan användas synonymt med DocumentSignatureType. Den här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

signerad: En signatur har identifierats.
osignerad: Inga signaturer identifieras.

Definierar värden för DocumentTableCellKind.
KnownDocumentTableCellKind kan användas synonymt med DocumentTableCellKind, den här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

content: Innehåller huvudinnehåll/data.
rowHeader: Beskriver innehållet i raden.
columnHeader: Beskriver innehållet i kolumnen.
stubHead: Beskriver radrubrikerna, som vanligtvis finns i det övre vänstra hörnet i en tabell.
description: Beskriver innehållet i (delar av) tabellen.

Definierar värden för FontStyle.
KnownFontStyle kan användas synonymt med FontStyle. Den här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

normal: Tecken representeras normalt.
kursiv stil: Tecken vinklas visuellt åt höger.

Definierar värden för FontWeight.
KnownFontWeight kan användas synonymt med FontWeight. Den här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

normal: Tecken representeras normalt.
fetstil: Tecken representeras med tjockare streck.

Tilläggsfunktioner (funktioner) som kan aktiveras för begäran.

Mer information om de funktioner som är tillgängliga i Formigenkänning finns i tjänstdokumentationen:

https://aka.ms/azsdk/formrecognizer/features

En begärandeinmatning som kan laddas upp som binära data till Formigenkänning-tjänsten. Formigenkänning behandlar string indata som URL:er, så om du vill skicka en sträng som en binär indata konverterar du först strängen till någon av följande indatatyper.

Definierar värden för LengthUnit.
KnownLengthUnit kan användas synonymt med LengthUnit. Den här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

pixel: Längdenhet för bildfiler.
tum: Längdenhet för PDF-filer.

Information om någon av flera olika typer av Formigenkänning hanteringsåtgärder.

Definierar värden för OperationKind.
KnownOperationKind kan användas synonymt med OperationKind. Den här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

documentModelBuild: Skapa en ny anpassad dokumentmodell.
documentModelCompose: Skapa en ny anpassad dokumentmodell från befintliga modeller.
documentModelCopyTo: Kopiera en befintlig dokumentmodell till en potentiellt annan resurs, region eller prenumeration.
documentClassifierBuild: Skapa en ny anpassad klassificerarmodell.

Definierar värden för OperationStatus.

Definierar värden för ParagraphRole.
KnownParagraphRole kan användas synonymt med ParagraphRole. Den här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

pageHeader: Text nära sidans övre kant.
pageFooter: Text nära sidans nederkant.
pageNumber: Sidnummer.
title: Rubrik på den översta nivån som beskriver hela dokumentet.
sectionHeading: Underrubrik som beskriver ett avsnitt i dokumentet.
fotnot: En anteckning placeras vanligtvis efter huvudinnehållet på en sida.
formulaBlock: Ett block med formler, ofta med delad justering.

Definierar värden för SelectionMarkState.
KnownSelectionMarkState kan användas synonymt med SelectionMarkState. Den här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

selected: Markeringen markeras, vilket ofta anges med en bock eller kryss X inuti markeringsmarkeringen.
omarkerad: Markeringsmarkeringen är inte markerad.

Giltiga strängindextyper som stöds av Formigenkänning-tjänsten och SDK-klienter.

Kända värden för DocumentBarcodeKind som tjänsten accepterar.

Kända värden för DocumentBuildMode som tjänsten accepterar.

Kända värden för DocumentFieldType som tjänsten accepterar.

Kända värden för DocumentFormulaKind som tjänsten accepterar.

Kända värden för DocumentSignatureType som tjänsten accepterar.

Kända värden för DocumentTableCellKind som tjänsten accepterar.

Kända värden för FontStyle som tjänsten accepterar.

Kända värden för FontWeight som tjänsten accepterar.

Kända värden för LengthUnit som tjänsten accepterar.

Kända värden för OperationKind som tjänsten accepterar.

Kända värden för ParagraphRole som tjänsten accepterar.

Kända värden för SelectionMarkState som tjänsten accepterar.