@azure/ai-form-recognizer package

Klasser

AzureKeyCredential	En statisk nyckelbaserad autentiseringsuppgift som stöder uppdatering av det underliggande nyckelvärdet.
DocumentAnalysisClient	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);
DocumentModelAdministrationClient	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);

Gränssnitt

AddressValue	Adressfältvärde.
AnalyzeDocumentOptions	Alternativ för dokumentanalysåtgärden.
AnalyzeResult	Resultatet av en analysåtgärd. Typen av dokument kan bestämmas av den modell som används för att utföra analysen.
AnalyzeResultCommon	De vanliga fälten för alla AnalyzeResult-liknande typer, till exempel LayoutResult, ReadResult och GeneralDocumentResult.
AnalyzedDocument	Ett extraherat dokumentobjekt. En AnalyzedDocument är en instans av en av dokumenttyperna i en modell. Dess fält motsvarar fältschemat för dokumenttypen.
AzureBlobFileListSource	En träningsdatakälla som definierats av en Azure Blob Container och en JSONL-fillista i containern.
AzureBlobFileListSourceDetails	Fillista i Azure Blob Storage.
AzureBlobSource	En träningsdatakälla som definierats av en Azure Blob-container.
AzureBlobSourceDetails	Azure Blob Storage innehåll.
BeginBuildDocumentClassifierOptions	Alternativ för dokumentklassificerarens byggåtgärd.
BeginBuildDocumentModelOptions	Alternativ för modellbyggåtgärden.
BeginComposeDocumentModelOptions	Alternativ för modellens sammansättningsåtgärd.
BeginCopyModelOptions	Alternativ för kopieringsmodellåtgärden.
BoundingRegion	Avgränsning av polygon på en specifik sida av indata.
ClassifierDocumentTypeDetails	Information om dokumenttyp för klassificerare.
ClassifyDocumentOptions	Alternativ för dokumentklassificeringsåtgärden.
CommonModelCreationOptions	Alternativ som är gemensamma för alla åtgärder som definierar nya modeller, till exempel beginBuildDocumentModel, beginComposeDocumentModeloch getCopyAuthorization.
CopyAuthorization	Auktorisering för att kopiera en dokumentmodell till den angivna målresursen och modelId.
CreateDocumentModelOptions	Alternativ för modellskapandeåtgärden.
CurrencyValue	Valutafältvärde.
CustomDocumentModelsDetails	Information om anpassade dokumentmodeller.
DeleteDocumentModelOptions	Alternativ för borttagning av modell.
DocumentAddressField	Ett dokumentfält som beskriver en strukturerad fysisk adress.
DocumentAnalysisClientOptions	Konfigurerbara alternativ för DocumentAnalysisClient.
DocumentAnalysisPollOperationState	Tillståndet för en analysåtgärd, som så småningom skapar den resultattyp som motsvarar modellen.
DocumentAnnotation	Ett visuellt anteckningselement i dokumentet, till exempel en bockmarkering eller ett kors.
DocumentArrayField	Ett DocumentField som består av en matris med kapslade fält. Alla fält i matrisen har samma typ.
DocumentBarcode	En extraherad streckkod.
DocumentBooleanField	Ett DocumentField som har ett booleskt värde.
DocumentCaption	Ett objekt som representerar platsen och innehållet i en tabell bildtext.
DocumentClassifierBuildOperationDetails	Hämta åtgärdssvarsobjekt.
DocumentClassifierDetails	Information om dokumentklassificerare.
DocumentClassifierDocumentTypeSources	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.
DocumentClassifierOperationState	Tillståndet för en modellskapandeåtgärd.
DocumentCountryRegionField	Ett DocumentField som har ett värde som anger ett land eller en region, representerat som en sträng.
DocumentCurrencyField	Ett DocumentField som beskriver en viss valuta.
DocumentDateField	Ett DocumentField som har ett datumvärde.
DocumentFieldCommon	Fält som är gemensamma för alla DocumentField-varianter.
DocumentFieldSchema	Beskrivning av fältets semantiska schema med hjälp av en syntax för JSON-schemaformat.
DocumentFootnote	Ett objekt som representerar platsen och innehållet i en tabells fotnot.
DocumentFormula	En extraherad formel.
DocumentIntegerField	Ett DocumentField som har ett heltalsvärde.
DocumentKeyValueElement	Ett objekt som representerar fältnyckeln eller värdet i ett nyckel/värde-par.
DocumentKeyValuePair	Ett objekt som representerar ett formulärfält med distinkt fältetikett (nyckel) och fältvärde (kan vara tomt).
DocumentLanguage	Ett objekt som representerar det identifierade språket för ett visst textintervall.
DocumentLine	Ett innehållsradsobjekt som består av en intilliggande sekvens med innehållselement, till exempel ord och markeringsmarkeringar.
DocumentModel	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.
DocumentModelAdministrationClientOptions	Konfigurerbara alternativ för DocumentModelAdministrationClient.
DocumentModelBuildOperationDetails	Hämta åtgärdssvarsobjekt.
DocumentModelComposeOperationDetails	Hämta åtgärdssvarsobjekt.
DocumentModelCopyToOperationDetails	Hämta åtgärdssvarsobjekt.
DocumentModelDetails	Dokumentmodellinformation.
DocumentModelOperationState	Tillståndet för en modellskapandeåtgärd.
DocumentModelSummary	Sammanfattning av dokumentmodell.
DocumentNumberField	Ett DocumentField som har ett talvärde.
DocumentObjectField	Ett DocumentField som består av flera namngivna egenskaper som har egna DocumentField-värden.
DocumentPage	Innehålls- och layoutelement som extraherats från en sida från indata.
DocumentParagraph	Ett styckeobjekt som vanligtvis består av sammanhängande linjer med gemensam justering och avstånd.
DocumentPhoneNumberField	Ett DocumentField som har ett telefonnummervärde, representerat som en sträng.
DocumentSelectionMark	Ett markeringsmarkeringsobjekt som representerar kryssrutor, alternativknappar och andra element som anger en markering.
DocumentSelectionMarkField	Ett DocumentField som har ett värde som anger ett markeringsmarkeringstillstånd (till exempel en kryssruta eller alternativknapp) som representeras som en sträng.
DocumentSignatureField	Ett DocumentField som anger tillståndet för en signatur, representerad som en sträng.
DocumentSpan	Sammanhängande region för den sammanfogade innehållsegenskapen, angiven som en förskjutning och längd.
DocumentStringField	Ett DocumentField som har ett strängvärde.
DocumentStyle	Ett objekt som representerar observerade textformat.
DocumentTable	Ett tabellobjekt som består av tabellceller ordnade i en rektangulär layout.
DocumentTableCell	Ett objekt som representerar platsen och innehållet i en tabellcell.
DocumentTimeField	Ett DocumentField som har ett tidsvärde, representerat som en sträng.
DocumentTypeDetails	Information om dokumenttyp.
DocumentValueField	Ett enkelt fält som har ett primitivt värde, till exempel en sträng, ett tal osv.
DocumentWord	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.
ErrorModel	Felinformation.
GetCopyAuthorizationOptions	Alternativ för metoden hämta kopieringsauktorisering.
GetModelOptions	Alternativ för att hämta modellinformation.
GetOperationOptions	Alternativ för att hämta ett åtgärdstillstånd.
GetResourceDetailsOptions	Alternativ för att hämta Formigenkänning resursinformation.
HasBoundingPolygon	Enkla dokumentelement som ord, markeringsmarkeringar och rader begränsas av polygonen.
InnerError	Detaljerat fel.
ListModelsOptions	Alternativ för att lista modeller.
ListOperationsOptions	Alternativ för listningsåtgärder.
ModelAdministrationOperationStateCommon	Den uppsättning fält som är gemensamma för alla administrationsåtgärder.
OperationDetails	Hämta åtgärdssvarsobjekt.
OperationSummary	Åtgärdsinformation.
Point2D	Representerar en punkt som används för att definiera avgränsningspolygoner. Enheten är antingen pixel eller tum (se LengthUnit).
PollerOptions	Alternativ för långvariga åtgärder (pollers) i Formigenkänning klienter.
QuotaDetails	Använd kvot, begränsa och nästa återställningsdatum/tid.
ResourceDetails	Allmän information om den aktuella resursen.

Typalias

AnalysisPoller	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.
AnalyzeResultOperationStatus	Definierar värden för AnalyzeResultOperationStatus.
DocumentBarcodeKind	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.
DocumentBuildMode	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.
DocumentClassifierPoller	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.
DocumentClassifierSource	En innehållskälla som kan användas för att skapa en dokumentklassificerare. Något av: BlobSource BlobFileListSource
DocumentField	Ett extraherat fält. Egenskapen kind identifierar (diskriminerar) typen av DocumentField.
DocumentFieldType	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.
DocumentFormulaKind	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.
DocumentModelBuildMode	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
DocumentModelPoller	En tidskrävande åtgärd (poller) som spårar tillståndet för en modellskapandeåtgärd och så småningom skapar en DocumentModelDetails.
DocumentModelSource	En innehållskälla som kan användas för att skapa en dokumentmodell. Något av: BlobSource BlobFileListSource
DocumentSignatureType	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.
DocumentTableCellKind	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.
FontStyle	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.
FontWeight	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.
FormRecognizerFeature	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
FormRecognizerRequestBody	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.
LengthUnit	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.
OperationDetailsUnion	Information om någon av flera olika typer av Formigenkänning hanteringsåtgärder.
OperationKind	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.
OperationStatus	Definierar värden för OperationStatus.
ParagraphRole	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.
SelectionMarkState	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.
StringIndexType	Giltiga strängindextyper som stöds av Formigenkänning-tjänsten och SDK-klienter.

Uppräkningar

KnownDocumentBarcodeKind	Kända värden för DocumentBarcodeKind som tjänsten accepterar.
KnownDocumentBuildMode	Kända värden för DocumentBuildMode som tjänsten accepterar.
KnownDocumentFieldType	Kända värden för DocumentFieldType som tjänsten accepterar.
KnownDocumentFormulaKind	Kända värden för DocumentFormulaKind som tjänsten accepterar.
KnownDocumentSignatureType	Kända värden för DocumentSignatureType som tjänsten accepterar.
KnownDocumentTableCellKind	Kända värden för DocumentTableCellKind som tjänsten accepterar.
KnownFontStyle	Kända värden för FontStyle som tjänsten accepterar.
KnownFontWeight	Kända värden för FontWeight som tjänsten accepterar.
KnownLengthUnit	Kända värden för LengthUnit som tjänsten accepterar.
KnownOperationKind	Kända värden för OperationKind som tjänsten accepterar.
KnownParagraphRole	Kända värden för ParagraphRole som tjänsten accepterar.
KnownSelectionMarkState	Kända värden för SelectionMarkState som tjänsten accepterar.