Delen via


@azure/ai-form-recognizer package

Klassen

AzureKeyCredential

Een referentie op basis van statische sleutels die ondersteuning biedt voor het bijwerken van de onderliggende sleutelwaarde.

DocumentAnalysisClient

Een client voor interactie met de analysefuncties van de Form Recognizer-service.

Voorbeelden:

De Form Recognizer-service en clients ondersteunen twee verificatiemethoden:

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-sleutel (abonnementssleutel)

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

Een client voor interactie met de modelbeheerfuncties van de Form Recognizer-service, zoals het maken, lezen, weergeven, verwijderen en kopiëren van modellen.

Voorbeelden:

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-sleutel (abonnementssleutel)

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

Interfaces

AddressValue

Waarde van adresveld.

AnalyzeDocumentOptions

Opties voor de documentanalysebewerking.

AnalyzeResult

Het resultaat van een analysebewerking. Het type document kan worden bepaald door het model dat wordt gebruikt om de analyse uit te voeren.

AnalyzeResultCommon

De algemene velden van alle AnalyzeResult-achtige typen, zoals LayoutResult, ReadResult en GeneralDocumentResult.

AnalyzedDocument

Een geëxtraheerd documentobject.

Een GeanalyseerdDocument is een exemplaar van een van de documenttypen in een model. De velden komen overeen met het veldschema van het documenttype.

AzureBlobFileListSource

Een gegevensbron voor training die is gedefinieerd door een Azure Blob-container en een JSONL-bestandslijst in de container.

AzureBlobFileListSourceDetails

Lijst met bestanden in Azure Blob Storage.

AzureBlobSource

Een gegevensbron voor training die is gedefinieerd door een Azure Blob-container.

AzureBlobSourceDetails

Azure Blob Storage inhoud.

BeginBuildDocumentClassifierOptions

Opties voor de buildbewerking van de documentclassificatie.

BeginBuildDocumentModelOptions

Opties voor de buildbewerking van het model.

BeginComposeDocumentModelOptions

Opties voor de bewerking voor het opstellen van het model.

BeginCopyModelOptions

Opties voor de kopieermodelbewerking.

BoundingRegion

Begrenzing veelhoek op een specifieke pagina van de invoer.

ClassifierDocumentTypeDetails

Informatie over het type classificatiedocument.

ClassifyDocumentOptions

Opties voor de documentclassificatiebewerking.

CommonModelCreationOptions

Opties die gemeenschappelijk zijn voor alle bewerkingen waarmee nieuwe modellen worden gedefinieerd, zoals beginBuildDocumentModel, beginComposeDocumentModelen getCopyAuthorization.

CopyAuthorization

Autorisatie voor het kopiëren van een documentmodel naar de opgegeven doelresource en modelId.

CreateDocumentModelOptions

Opties voor het maken van het model.

CurrencyValue

Waarde van valutaveld.

CustomDocumentModelsDetails

Details met betrekking tot aangepaste documentmodellen.

DeleteDocumentModelOptions

Opties voor modelverwijdering.

DocumentAddressField

Een documentveld waarin een gestructureerd fysiek adres wordt beschreven.

DocumentAnalysisClientOptions

Configureerbare opties voor DocumentAnalysisClient.

DocumentAnalysisPollOperationState

De status van een analysebewerking, die uiteindelijk het resultaattype produceert dat overeenkomt met het model.

DocumentAnnotation

Een visueel aantekeningselement in het document, zoals een vinkje of kruisje.

DocumentArrayField

Een documentveld dat bestaat uit een matrix van geneste velden. Alle velden in de matrix hebben hetzelfde type.

DocumentBarcode

Een geëxtraheerde streepjescode.

DocumentBooleanField

Een DocumentField met een booleaanse waarde.

DocumentCaption

Een object dat de locatie en inhoud van een tabel vertegenwoordigt onderschrift.

DocumentClassifierBuildOperationDetails

Bewerkingsantwoordobject ophalen.

DocumentClassifierDetails

Informatie over documentclassificatie.

DocumentClassifierDocumentTypeSources

Een set bronnen die wordt gebruikt om een documentclassificatie te maken. Dit is een toewijzing van documenttypenamen aan bronnen die worden gebruikt om het model te trainen om documenten van het bijbehorende brontype te classificeren.

DocumentClassifierOperationState

De status van een bewerking voor het maken van een model.

DocumentCountryRegionField

Een documentveld met een waarde die een land of regio aangeeft, weergegeven als een tekenreeks.

DocumentCurrencyField

Een documentveld waarin een bedrag van een bepaalde valuta wordt beschreven.

DocumentDateField

Een documentveld met een datumwaarde.

DocumentFieldCommon

Velden die gemeenschappelijk zijn voor alle DocumentField-varianten.

DocumentFieldSchema

Beschrijving van het semantische veldschema met behulp van de syntaxis van een JSON-schema.

DocumentFootnote

Een object dat de locatie en inhoud van een voetnoot in een tabel vertegenwoordigt.

DocumentFormula

Een geëxtraheerde formule.

DocumentIntegerField

Een DocumentField met een geheel getal.

DocumentKeyValueElement

Een object dat de veldsleutel of -waarde in een sleutel-waardepaar vertegenwoordigt.

DocumentKeyValuePair

Een object dat een formulierveld vertegenwoordigt met een uniek veldlabel (sleutel) en veldwaarde (kan leeg zijn).

DocumentLanguage

Een object dat de gedetecteerde taal voor een bepaald tekstbereik vertegenwoordigt.

DocumentLine

Een inhoudslijnobject dat bestaat uit een aangrenzende reeks inhoudselementen, zoals woorden en selectiemarkeringen.

DocumentModel

Een bekende modelspecificatie die ondersteuning biedt voor het extraheren van gestructureerde documenten.

Zie de beginAnalyzeDocument methode van DocumentAnalysisClient, die ondersteuning biedt voor het gebruik van deze DocumentModel objecten in plaats van model-id-tekenreeksen om sterkere resultaattypen te bieden.

DocumentModelAdministrationClientOptions

Configureerbare opties voor DocumentModelAdministrationClient.

DocumentModelBuildOperationDetails

Bewerkingsantwoordobject ophalen.

DocumentModelComposeOperationDetails

Bewerkingsantwoordobject ophalen.

DocumentModelCopyToOperationDetails

Bewerkingsantwoordobject ophalen.

DocumentModelDetails

Documentmodelgegevens.

DocumentModelOperationState

De status van een bewerking voor het maken van een model.

DocumentModelSummary

Samenvatting van documentmodel.

DocumentNumberField

Een DocumentField met een numerieke waarde.

DocumentObjectField

Een documentveld dat bestaat uit verschillende benoemde eigenschappen die hun eigen DocumentField-waarden hebben.

DocumentPage

Inhouds- en indelingselementen die zijn geëxtraheerd uit een pagina uit de invoer.

DocumentParagraph

Een alineaobject dat bestaat uit aaneengesloten lijnen in het algemeen met gemeenschappelijke uitlijning en afstand.

DocumentPhoneNumberField

Een DocumentField met een telefoonnummerwaarde, weergegeven als een tekenreeks.

DocumentSelectionMark

Een selectiemarkeringsobject dat selectievakjes, keuzerondjes en andere elementen vertegenwoordigt waarmee een selectie wordt aangegeven.

DocumentSelectionMarkField

Een documentveld dat een waarde heeft die de status van een selectiemarkering aangeeft (zoals een selectievakje of keuzerondje), weergegeven als een tekenreeks.

DocumentSignatureField

Een documentveld dat de status van een handtekening aangeeft, weergegeven als een tekenreeks.

DocumentSpan

Aaneengesloten regio van de eigenschap van de samengevoegde inhoud, opgegeven als een verschuiving en lengte.

DocumentStringField

Een DocumentField met een tekenreekswaarde.

DocumentStyle

Een object dat geobserveerde tekststijlen vertegenwoordigt.

DocumentTable

Een tabelobject dat bestaat uit tabelcellen die zijn gerangschikt in een rechthoekige indeling.

DocumentTableCell

Een object dat de locatie en inhoud van een tabelcel vertegenwoordigt.

DocumentTimeField

Een DocumentField met een tijdwaarde, weergegeven als een tekenreeks.

DocumentTypeDetails

Informatie over documenttype.

DocumentValueField

Een eenvoudig veld met een primitieve waarde, zoals een tekenreeks, getal, enzovoort.

DocumentWord

Een woordobject dat bestaat uit een aaneengesloten reeks tekens. Voor niet-spaties gescheiden talen, zoals Chinees, Japans en Koreaans, wordt elk teken weergegeven als een eigen woord.

ErrorModel

Foutgegevens.

GetCopyAuthorizationOptions

Opties voor de autorisatiemethode get copy.

GetModelOptions

Opties voor het ophalen van modelgegevens.

GetOperationOptions

Opties voor het ophalen van een bewerkingsstatus.

GetResourceDetailsOptions

Opties voor het ophalen van Form Recognizer resourcegegevens.

HasBoundingPolygon

Eenvoudige documentelementen, zoals woorden, selectiemarkeringen en lijnen, worden begrensd door de veelhoek.

InnerError

Gedetailleerde fout.

ListModelsOptions

Opties voor het weergeven van modellen.

ListOperationsOptions

Opties voor het weergeven van bewerkingen.

ModelAdministrationOperationStateCommon

De set velden die gemeenschappelijk zijn voor alle beheerbewerkingen.

OperationDetails

Bewerkingsantwoordobject ophalen.

OperationSummary

Bewerkingsgegevens.

Point2D

Vertegenwoordigt een punt dat wordt gebruikt om begrenzingsveelhoeken te definiëren. De eenheid is pixel of inch (zie LengthUnit).

PollerOptions

Opties voor langlopende bewerkingen (pollers) in de Form Recognizer-clients.

QuotaDetails

Het gebruikte quotum, de limiet en de volgende resetdatum/-tijd.

ResourceDetails

Algemene informatie over de huidige resource.

Type-aliassen

AnalysisPoller

Een langlopende bewerking (poller) die de status van een analysebewerking bijhoudt en uiteindelijk het resultaattype produceert dat overeenkomt met het model.

AnalyzeResultOperationStatus

Definieert waarden voor AnalyzeResultOperationStatus.

DocumentBarcodeKind

Definieert waarden voor DocumentBarcodeKind.
KnownDocumentBarcodeKind kan door elkaar worden gebruikt met DocumentBarcodeKind. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

QRCode: QR-code, zoals gedefinieerd in ISO/IEC 18004:2015.
PDF417: PDF417, zoals gedefinieerd in ISO 15438.
UPCA: GS1 12-cijferige universele productcode.
UPCE: GS1 6-cijferige universele productcode.
Code39: Code 39 streepjescode, zoals gedefinieerd in ISO/IEC 16388:2007.
Code128: Code 128 streepjescode, zoals gedefinieerd in ISO/IEC 15417:2007.
EAN8: GS1 8-cijferig internationaal artikelnummer (Europees artikelnummer).
EAN13: GS1 13-cijferig internationaal artikelnummer (Europees artikelnummer).
DataBar: GS1 DataBar-streepjescode.
Code93: Code 93 streepjescode, zoals gedefinieerd in ANSI/AIM BC5-1995.
Codabar: Codabar-streepjescode, zoals gedefinieerd in ANSI/AIM BC3-1995.
DataBarExpanded: GS1 DataBar Expanded barcode.
ITF: Interleaved 2 van 5 streepjescode, zoals gedefinieerd in ANSI/AIM BC2-1995.
MicroQRCode: Micro QR-code, zoals gedefinieerd in ISO/IEC 23941:2022.
Aztec: Aztec-code, zoals gedefinieerd in ISO/IEC 24778:2008.
DataMatrix: Gegevensmatrixcode, zoals gedefinieerd in ISO/IEC 16022:2006.
MaxiCode: MaxiCode, zoals gedefinieerd in ISO/IEC 16023:2000.

DocumentBuildMode

Definieert waarden voor DocumentBuildMode.
KnownDocumentBuildMode kan door elkaar worden gebruikt met DocumentBuildMode. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

sjabloon: Richt documenten met vergelijkbare visuele sjablonen.
neurale: ondersteunt documenten met diverse visuele sjablonen.

DocumentClassifierPoller

Een langdurige bewerking (poller) waarmee de status van een aangepaste classificatiebewerking wordt bijgehouden en uiteindelijk een DocumentClassifierDetails wordt geproduceerd.

DocumentClassifierSource

Een inhoudsbron die kan worden gebruikt om een documentclassificatie te maken.

Een van de volgende:

  • BlobSource
  • BlobFileListSource
DocumentField

Een geëxtraheerd veld. De kind eigenschap identificeert (discrimineert) het type van de DocumentField.

DocumentFieldType

Definieert waarden voor DocumentFieldType.
KnownDocumentFieldType kan door elkaar worden gebruikt met DocumentFieldType. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

tekenreeks: tekst zonder opmaak.
datum: Datum, genormaliseerd naar ISO 8601-notatie (JJJJ-MM-DD).
tijd: Tijd, genormaliseerd naar ISO 8601-notatie (uu:mm:ss).
phoneNumber: Telefoonnummer, genormaliseerd naar E.164-indeling (+{CountryCode}{SubscriberNumber}).
getal: Drijvendekommanummer, genormaliseerd tot dubbele precisie drijvende komma.
geheel getal: geheel getal, genormaliseerd naar een 64-bits ondertekend geheel getal.
selectionMark: Is het veld geselecteerd?
countryRegio: Land/regio, genormaliseerd volgens ISO 3166-1 alfa-3-indeling (bijvoorbeeld VS).
signature: Is handtekening aanwezig?
matrix: lijst met subvelden van hetzelfde type.
object: benoemde lijst met subvelden van mogelijk verschillende typen.
valuta: Valutabedrag met optioneel valutasymbool en -eenheid.
adres: geparseerd adres.
Booleaanse waarde: Booleaanse waarde, genormaliseerd naar waar of onwaar.

DocumentFormulaKind

Definieert waarden voor DocumentFormulaKind.
KnownDocumentFormulaKind kan door elkaar worden gebruikt met DocumentFormulaKind. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

inline: een formule die is ingesloten in de inhoud van een alinea.
display: een formule in de weergavemodus die een hele regel in beslag neemt.

DocumentModelBuildMode

Ondersteunde modelbuildmodi. De modelbuild-modus selecteert de engine die de service gebruikt om het model te trainen op basis van de gelabelde trainingsgegevens.

De opties zijn:

  • 'neural', wat de hoogste kwaliteit van het model oplevert dat in staat is gegevens te extraheren uit documentenklassen met dezelfde gegevensstructuur, maar met verschillende indelingen (bijvoorbeeld W2-belastingformulieren, die per bedrijf kunnen verschillen, maar altijd dezelfde informatie bevatten).
  • 'sjabloon', waarvoor alle documenten dezelfde vaste indeling (sjabloon) moeten hebben.

Raadpleeg de volgende koppeling voor meer informatie: https://aka.ms/azsdk/formrecognizer/buildmode

DocumentModelPoller

Een langlopende bewerking (poller) die de status van een modelbewerking bijhoudt en uiteindelijk een DocumentModelDetails produceert.

DocumentModelSource

Een inhoudsbron die kan worden gebruikt om een documentmodel te bouwen.

Een van de volgende:

  • BlobSource
  • BlobFileListSource
DocumentSignatureType

Definieert waarden voor DocumentSignatureType.
KnownDocumentSignatureType kan door elkaar worden gebruikt met DocumentSignatureType. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

ondertekend: er is een handtekening gedetecteerd.
niet-ondertekend: er zijn geen handtekeningen gedetecteerd.

DocumentTableCellKind

Definieert waarden voor DocumentTableCellKind.
KnownDocumentTableCellKind kan door elkaar worden gebruikt met DocumentTableCellKind. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

content: bevat de belangrijkste inhoud/gegevens.
rowHeader: beschrijft de inhoud van de rij.
columnHeader: beschrijft de inhoud van de kolom.
stubHead: beschrijft de rijkoppen, meestal in de linkerbovenhoek van een tabel.
beschrijving: beschrijft de inhoud in (delen van) de tabel.

FontStyle

Definieert waarden voor FontStyle.
KnownFontStyle kan door elkaar worden gebruikt met FontStyle. Deze opsomming bevat de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

normaal: tekens worden normaal weergegeven.
cursief: tekens zijn visueel schuin naar rechts.

FontWeight

Definieert waarden voor FontWeight.
KnownFontWeight kan door elkaar worden gebruikt met FontWeight, deze opsomming bevat de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

normaal: tekens worden normaal weergegeven.
vet: tekens worden weergegeven met dikkere lijnen.

FormRecognizerFeature

Invoegtoepassingsmogelijkheden (functies) die kunnen worden ingeschakeld voor de aanvraag.

Zie de servicedocumentatie voor meer informatie over de functies die beschikbaar zijn in Form Recognizer:

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

FormRecognizerRequestBody

Een aanvraaginvoer die als binaire gegevens kan worden geüpload naar de Form Recognizer-service. Form Recognizer invoer als URL's behandeltstring, dus als u een tekenreeks als binaire invoer wilt verzenden, moet u eerst de tekenreeks converteren naar een van de volgende invoertypen.

LengthUnit

Definieert waarden voor LengthUnit.
KnownLengthUnit kan door elkaar worden gebruikt met LengthUnit. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

pixel: lengte-eenheid voor afbeeldingsbestanden.
inch: Lengte-eenheid voor PDF-bestanden.

OperationDetailsUnion

Details over verschillende typen Form Recognizer beheerbewerkingen.

OperationKind

Definieert waarden voor OperationKind.
KnownOperationKind kan door elkaar worden gebruikt met OperationKind. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

documentModelBuild: Bouw een nieuw aangepast documentmodel.
documentModelCompose: stel een nieuw aangepast documentmodel op uit bestaande modellen.
documentModelCopyTo: Kopieer een bestaand documentmodel naar een mogelijk andere resource, regio of abonnement.
documentClassifierBuild: Bouw een nieuw aangepast classificatiemodel.

OperationStatus

Definieert waarden voor OperationStatus.

ParagraphRole

Definieert waarden voor ParagraphRole.
KnownParagraphRole kan door elkaar worden gebruikt met ParagraphRole. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

pageHeader: tekst aan de bovenrand van de pagina.
pageFooter: tekst aan de onderkant van de pagina.
pageNumber: Paginanummer.
titel: titel op het hoogste niveau die het hele document beschrijft.
sectionHeading: Subkop die een sectie van het document beschrijft.
voetnoot: een opmerking die meestal wordt geplaatst na de hoofdinhoud op een pagina.
formulaBlock: een blok formules, vaak met gedeelde uitlijning.

SelectionMarkState

Definieert waarden voor SelectionMarkState.
KnownSelectionMarkState kan door elkaar worden gebruikt met SelectionMarkState. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

selected: De selectiemarkering wordt geselecteerd, vaak aangegeven door een vinkje ✓ of kruis X binnen de selectiemarkering.
niet geselecteerd: de selectiemarkering is niet geselecteerd.

StringIndexType

Geldige typen tekenreeksindexen die worden ondersteund door de Form Recognizer-service en SDK-clients.

Enums

KnownDocumentBarcodeKind

Bekende waarden van DocumentBarcodeKind die door de service worden geaccepteerd.

KnownDocumentBuildMode

Bekende waarden van DocumentBuildMode die door de service worden geaccepteerd.

KnownDocumentFieldType

Bekende waarden van DocumentFieldType die door de service worden geaccepteerd.

KnownDocumentFormulaKind

Bekende waarden van DocumentFormulaKind die door de service worden geaccepteerd.

KnownDocumentSignatureType

Bekende waarden van DocumentSignatureType die door de service worden geaccepteerd.

KnownDocumentTableCellKind

Bekende waarden van DocumentTableCellKind die door de service worden geaccepteerd.

KnownFontStyle

Bekende waarden van FontStyle die door de service worden geaccepteerd.

KnownFontWeight

Bekende waarden van FontWeight die door de service worden geaccepteerd.

KnownLengthUnit

Bekende waarden van LengthUnit die de service accepteert.

KnownOperationKind

Bekende waarden van OperationKind die door de service worden geaccepteerd.

KnownParagraphRole

Bekende waarden van ParagraphRole die door de service worden geaccepteerd.

KnownSelectionMarkState

Bekende waarden van SelectionMarkState die de service accepteert.