@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	Adresveldwaarde.
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 typen AnalyzeResult,zoals LayoutResult, ReadResult en GeneralDocumentResult.
AnalyzedDocument	Een geëxtraheerd documentobject. Een AnalyzedDocument is een exemplaar van een van de documenttypen in een model. De velden komen overeen met het veldschema van het documenttype.
AzureBlobFileListSource	Een trainingsgegevensbron die is gedefinieerd door een Azure Blob-container en een lijst met JSONL-bestanden in de container.
AzureBlobFileListSourceDetails	Bestandslijst in Azure Blob Storage.
AzureBlobSource	Een trainingsgegevensbron die is gedefinieerd door een Azure Blob-container.
AzureBlobSourceDetails	Azure Blob Storage-inhoud.
BeginBuildDocumentClassifierOptions	Opties voor de buildbewerking voor documentclassificatie.
BeginBuildDocumentModelOptions	Opties voor de buildbewerking van het model.
BeginComposeDocumentModelOptions	Opties voor de bewerking voor het opstellen van modellen.
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 bewerking voor documentclassificatie.
CommonModelCreationOptions	Opties die gebruikelijk zijn voor alle bewerkingen die nieuwe modellen definiëren, 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	Valutaveldwaarde.
CustomDocumentModelsDetails	Details met betrekking tot aangepaste documentmodellen.
DeleteDocumentModelOptions	Opties voor modelverwijdering.
DocumentAddressField	Een documentveld dat een gestructureerd fysiek adres beschrijft.
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 kruis.
DocumentArrayField	Een DocumentField dat bestaat uit een matrix met 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 tabelbijschrift vertegenwoordigt.
DocumentClassifierBuildOperationDetails	Bewerkingsantwoordobject ophalen.
DocumentClassifierDetails	Informatie over documentclassificatie.
DocumentClassifierDocumentTypeSources	Een set bronnen die worden gebruikt om een documentclassificatie te maken. Dit is een kaart van documenttypenamen voor bronnen die worden gebruikt om het model te trainen voor het classificeren van documenten van het bijbehorende brontype.
DocumentClassifierOperationState	De status van een bewerking voor het maken van een model.
DocumentCountryRegionField	Een DocumentField met een waarde die een land of regio aangeeft, die wordt weergegeven als een tekenreeks.
DocumentCurrencyField	Een DocumentField waarmee een bedrag van een bepaalde valuta wordt beschreven.
DocumentDateField	Een DocumentField met een datumwaarde.
DocumentFieldCommon	Velden die gebruikelijk zijn voor alle DocumentField-varianten.
DocumentFieldSchema	Beschrijving van het semantische veldschema met behulp van een syntaxis van de JSON-schemastijl.
DocumentFootnote	Een object dat de locatie en inhoud van een tabel voetnoot 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 (mogelijk leeg).
DocumentLanguage	Een object dat de gedetecteerde taal vertegenwoordigt voor een bepaalde tekstspanne.
DocumentLine	Een inhoudsregelobject 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 getalwaarde.
DocumentObjectField	Een DocumentField 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, meestal met gemeenschappelijke uitlijning en afstand.
DocumentPhoneNumberField	Een DocumentField met een telefoonnummerwaarde, weergegeven als een tekenreeks.
DocumentSelectionMark	Een selectiemarkeringsobject met selectievakjes, keuzerondjes en andere elementen die een selectie aangeven.
DocumentSelectionMarkField	Een DocumentField met een waarde die de status van een selectiemarkering aangeeft (zoals een selectievakje of keuzerondje), weergegeven als een tekenreeks.
DocumentSignatureField	Een DocumentField dat de status van een handtekening aangeeft, die wordt weergegeven als een tekenreeks.
DocumentSpan	Aaneengesloten regio van de eigenschap samengevoegde inhoud, opgegeven als offset 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 die wordt 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	Foutinformatie.
GetCopyAuthorizationOptions	Opties voor de get copy authorization-methode.
GetModelOptions	Opties voor het ophalen van modelgegevens.
GetOperationOptions	Opties voor het ophalen van een bewerkingsstatus.
GetResourceDetailsOptions	Opties voor het ophalen van resourcegegevens van Form Recognizer.
HasBoundingPolygon	Eenvoudige documentelementen, zoals woorden, selectiemarkeringen en regels, worden gebonden 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 begrenzingspogonen 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 datum/tijd opnieuw instellen.
ResourceDetails	Algemene informatie over de huidige resource.

Type-aliassen

AnalysisPoller	Een langlopende bewerking (poller) die de status van een analysebewerking bijhoudt, waardoor uiteindelijk het resultaattype wordt geproduceerd dat overeenkomt met het model.
AnalyzeResultOperationStatus	Definieert waarden voor AnalyzeResultOperationStatus.
DocumentBarcodeKind	Definieert waarden voor DocumentBarcodeKind. KnownDocumentBarcodeKind kan door elkaar worden gebruikt met DocumentBarcodeKind, bevat deze opsomming de bekende waarden die de service ondersteunt. 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: streepjescode 39, zoals gedefinieerd in ISO/IEC 16388:2007. Code128: Streepjescode 128, 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: streepjescode 93, 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, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund sjabloon: doeldocumenten met vergelijkbare visuele sjablonen. neurale: ondersteuning voor documenten met diverse visuele sjablonen.
DocumentClassifierPoller	Een langlopende bewerking (poller) die de status van een aangepaste classificatiebewerking bijhoudt, waardoor uiteindelijk een DocumentClassifierDetailswordt geproduceerd.
DocumentClassifierSource	Een inhoudsbron die kan worden gebruikt om een documentclassificatie te bouwen. Een van de volgende: BlobSource BlobFileListSource
DocumentField	Een geëxtraheerd veld. De eigenschap kind identificeert (discrimineert) het type van de DocumentField.
DocumentFieldType	Definieert waarden voor DocumentFieldType. KnownDocumentFieldType kan door elkaar worden gebruikt met DocumentFieldType, bevat dit enum 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-indeling (JJJJ-MM-DD) . tijd: Tijd, genormaliseerd naar ISO 8601-indeling (uu:mm:ss). phoneNumber: telefoonnummer, genormaliseerd naar E.164-indeling (+{CountryCode}{SubscriberNumber}). getal: Drijvende-kommanummer, genormaliseerd tot dubbele precisie drijvende komma. geheel getal: geheel getal, genormaliseerd tot 64-bits ondertekend geheel getal. selectionMark: Is het veld geselecteerd? landregio: Land/regio, genormaliseerd naar ISO 3166-1 alfa-3-3-indeling (bijvoorbeeld VS). handtekening: Is de 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: Booleaanse waarde, genormaliseerd naar waar of onwaar.
DocumentFormulaKind	Definieert waarden voor DocumentFormulaKind. KnownDocumentFormulaKind kan door elkaar worden gebruikt met DocumentFormulaKind, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund inline: een formule die is ingesloten in de inhoud van een alinea. weergeven: een formule in de weergavemodus die een hele regel in beslag neemt.
DocumentModelBuildMode	Ondersteunde modelbuildmodi. De modelbuildmodus selecteert de engine die door de service wordt gebruikt om het model te trainen op basis van de gelabelde trainingsgegevens. De opties zijn: 'neural', wat resulteert in de hoogste kwaliteit van het model dat gegevens kan extraheren uit klassen documenten met dezelfde structuur van gegevens, maar verschillende indelingen (bijvoorbeeld W2-belastingformulieren, die kunnen variëren van bedrijf tot bedrijf, maar altijd dezelfde informatie bevatten). 'sjabloon', waarvoor alle documenten dezelfde vaste indeling (sjabloon) moeten hebben. Zie de volgende koppeling voor meer informatie: https://aka.ms/azsdk/formrecognizer/buildmode
DocumentModelPoller	Een langlopende bewerking (poller) die de status van een bewerking voor het maken van een model bijhoudt, waardoor uiteindelijk een DocumentModelDetails-wordt geproduceerd.
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, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund ondertekende: er wordt een handtekening gedetecteerd. niet-ondertekende: er worden geen handtekeningen gedetecteerd.
DocumentTableCellKind	Definieert waarden voor DocumentTableCellKind. KnownDocumentTableCellKind kan door elkaar worden gebruikt met DocumentTableCellKind, bevat dit enum de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund inhoud: bevat de hoofdinhoud/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, bevat deze opsomming de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund normale: tekens worden normaal weergegeven. cursief: tekens worden visueel naar rechts geslanteerd.
FontWeight	Definieert waarden voor FontWeight. KnownFontWeight kan door elkaar worden gebruikt met FontWeight, bevat deze opsomming de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund normale: tekens worden normaal weergegeven. vet: tekens worden weergegeven met dikkere stroken.
FormRecognizerFeature	Mogelijkheden voor invoegtoepassingen (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 kan worden geüpload als binaire gegevens naar de Form Recognizer-service. Form Recognizer behandelt string invoer als URL's, dus om een tekenreeks als een binaire invoer te verzenden, converteert u eerst de tekenreeks naar een van de volgende invoertypen.
LengthUnit	Definieert waarden voor LengthUnit. KnownLengthUnit kan door elkaar worden gebruikt met LengthUnit, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund pixel: lengteeenheid voor afbeeldingsbestanden. inch: lengteeenheid voor PDF-bestanden.
OperationDetailsUnion	Details over een van de verschillende typen beheerbewerkingen van Form Recognizer.
OperationKind	Definieert waarden voor OperationKind. KnownOperationKind kan door elkaar worden gebruikt met OperationKind, bevat dit enum de bekende waarden die de service ondersteunt. Bekende waarden die door de service worden ondersteund documentModelBuild: een nieuw aangepast documentmodel maken. documentModelCompose: een nieuw aangepast documentmodel opstellen op basis van bestaande modellen. documentModelCopyTo: Kopieer een bestaand documentmodel naar mogelijk een andere resource, regio of abonnement. documentClassifierBuild: bouw een nieuw aangepast classificatiemodel.
OperationStatus	Definieert waarden voor OperationStatus.
ParagraphRole	Definieert waarden voor AlineaRole. KnownParagraphRole kan door elkaar worden gebruikt met AlineaRole, bevat deze opsomming 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 waarin het hele document wordt beschreven. sectionHeading: Subkop die een sectie van het document beschrijft. voetnoot: een notitie die meestal na de hoofdinhoud op een pagina wordt geplaatst. formulaBlock: een blok formules, vaak met gedeelde uitlijning.
SelectionMarkState	Definieert waarden voor SelectionMarkState. KnownSelectionMarkState kan door elkaar worden gebruikt met SelectionMarkState, bevat dit enum de bekende waarden die door de service worden ondersteund. Bekende waarden die door de service worden ondersteund geselecteerde: het selectieteken wordt vaak geselecteerd door een vinkje ✓ of kruis X binnen het selectieteken. niet-geselecteerd: de selectiemarkering is niet geselecteerd.
StringIndexType	Geldige tekenreeksindextypen die worden ondersteund door de Form Recognizer-service en SDK-clients.

Enums

KnownDocumentBarcodeKind	Bekende waarden van DocumentBarcodeKind die de service accepteert.
KnownDocumentBuildMode	Bekende waarden van DocumentBuildMode die de service accepteert.
KnownDocumentFieldType	Bekende waarden van DocumentFieldType die de service accepteert.
KnownDocumentFormulaKind	Bekende waarden van DocumentFormulaKind die de service accepteert.
KnownDocumentSignatureType	Bekende waarden van DocumentSignatureType die de service accepteert.
KnownDocumentTableCellKind	Bekende waarden van DocumentTableCellKind die de service accepteert.
KnownFontStyle	Bekende waarden van FontStyle die de service accepteert.
KnownFontWeight	Bekende waarden van FontWeight die de service accepteert.
KnownLengthUnit	Bekende waarden van LengthUnit die de service accepteert.
KnownOperationKind	Bekende waarden van OperationKind die de service accepteert.
KnownParagraphRole	Bekende waarden van ParagraphRole die de service accepteert.
KnownSelectionMarkState	Bekende waarden van SelectionMarkState die de service accepteert.