@azure/ai-form-recognizer package

Klassen

AzureKeyCredential	Eine auf statischen Schlüsseln basierende Anmeldeinformationen, die das Aktualisieren des zugrunde liegenden Schlüsselwerts unterstützen.
DocumentAnalysisClient	Ein Client für die Interaktion mit den Analysefeatures des Formularerkennung-Diensts. Beispiele: Der Formularerkennung-Dienst und Clients unterstützen zwei Methoden der Authentifizierung: 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-Schlüssel (Abonnementschlüssel) 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	Ein Client für die Interaktion mit den Modellverwaltungsfunktionen des Formularerkennung Diensts, z. B. Erstellen, Lesen, Auflisten, Löschen und Kopieren von Modellen. Beispiele: 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-Schlüssel (Abonnementschlüssel) 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);

Schnittstellen

AddressValue	Adressfeldwert.
AnalyzeDocumentOptions	Optionen für den Dokumentanalysevorgang.
AnalyzeResult	Das Ergebnis eines Analysevorgangs. Der Typ des Dokuments kann durch das Modell bestimmt werden, das zum Durchführen der Analyse verwendet wird.
AnalyzeResultCommon	Die allgemeinen Felder aller AnalyzeResult-ähnlichen Typen, z. B. LayoutResult, ReadResult und GeneralDocumentResult.
AnalyzedDocument	Ein extrahiertes Dokumentobjekt. Ein AnalyzedDocument ist eine instance eines der Dokumenttypen in einem Modell. Seine Felder entsprechen dem Feldschema des Dokumenttyps.
AzureBlobFileListSource	Eine Trainingsdatenquelle, die von einem Azure-Blobcontainer und einer JSONL-Dateiliste innerhalb des Containers definiert wird.
AzureBlobFileListSourceDetails	Dateiliste in Azure Blob Storage.
AzureBlobSource	Eine durch einen Azure-Blobcontainer definierte Trainingsdatenquelle.
AzureBlobSourceDetails	Azure Blob Storage Inhalt.
BeginBuildDocumentClassifierOptions	Optionen für den Buildvorgang der Dokumentklassifizierung.
BeginBuildDocumentModelOptions	Optionen für den Modellbuildvorgang.
BeginComposeDocumentModelOptions	Optionen für den Modellerstellungsvorgang.
BeginCopyModelOptions	Optionen für den Kopiermodellvorgang.
BoundingRegion	Umgebendes Polygon auf einer bestimmten Seite der Eingabe.
ClassifierDocumentTypeDetails	Informationen zum Klassifiziererdokumenttyp.
ClassifyDocumentOptions	Optionen für den Dokumentklassifizierungsvorgang.
CommonModelCreationOptions	Optionen, die allen Vorgängen gemeinsam sind, die neue Modelle definieren, z beginBuildDocumentModel. B. , beginComposeDocumentModelund getCopyAuthorization.
CopyAuthorization	Autorisierung zum Kopieren eines Dokumentmodells in die angegebene Zielressource und modelId.
CreateDocumentModelOptions	Optionen für den Modellerstellungsvorgang.
CurrencyValue	Währungsfeldwert.
CustomDocumentModelsDetails	Details zu benutzerdefinierten Dokumentmodellen.
DeleteDocumentModelOptions	Optionen für das Löschen des Modells.
DocumentAddressField	Ein Dokumentfeld, das eine strukturierte physische Adresse beschreibt.
DocumentAnalysisClientOptions	Konfigurierbare Optionen für DocumentAnalysisClient.
DocumentAnalysisPollOperationState	Der Zustand eines Analysevorgangs, der schließlich den Ergebnistyp erzeugt, der dem Modell entspricht.
DocumentAnnotation	Ein visuelles Anmerkungselement im Dokument, z. B. ein Häkchen oder ein Kreuz.
DocumentArrayField	Ein DocumentField, das aus einem Array geschachtelter Felder besteht. Alle Felder im Array weisen den gleichen Typ auf.
DocumentBarcode	Ein extrahierter Barcode.
DocumentBooleanField	Ein DocumentField mit einem booleschen Wert.
DocumentCaption	Ein Objekt, das die Position und den Inhalt einer Tabelle Untertitel darstellt.
DocumentClassifierBuildOperationDetails	Abrufen des Vorgangsantwortobjekts.
DocumentClassifierDetails	Dokumentklassifizierungsinformationen.
DocumentClassifierDocumentTypeSources	Eine Gruppe von Quellen, die zum Erstellen eines Dokumentklassifizierers verwendet werden. Dies ist eine Zuordnung von Dokumenttypnamen zu Quellen, die zum Trainieren des Modells zum Klassifizieren von Dokumenten des entsprechenden Quelltyps verwendet werden.
DocumentClassifierOperationState	Der Status eines Modellerstellungsvorgangs.
DocumentCountryRegionField	Ein DocumentField mit einem Wert, der ein Land oder eine Region angibt, dargestellt als Zeichenfolge.
DocumentCurrencyField	Ein DocumentField-Objekt, das einen Betrag einer bestimmten Währung beschreibt.
DocumentDateField	Ein DocumentField-Objekt, das über einen Date-Wert verfügt.
DocumentFieldCommon	Felder, die allen DocumentField-Varianten gemeinsam sind.
DocumentFieldSchema	Beschreibung des feldsemantischen Schemas unter Verwendung einer JSON-Schemastilsyntax.
DocumentFootnote	Ein -Objekt, das die Position und den Inhalt einer Tabellennote darstellt.
DocumentFormula	Eine extrahierte Formel.
DocumentIntegerField	Ein DocumentField mit einem ganzzahligen Wert.
DocumentKeyValueElement	Ein Objekt, das den Feldschlüssel oder -wert in einem Schlüssel-Wert-Paar darstellt.
DocumentKeyValuePair	Ein Objekt, das ein Formularfeld mit einer eindeutigen Feldbeschriftung (Schlüssel) und einem Feldwert darstellt (kann leer sein).
DocumentLanguage	Ein Objekt, das die erkannte Sprache für eine bestimmte Textspanne darstellt.
DocumentLine	Ein Inhaltszeilenobjekt, das aus einer angrenzenden Sequenz von Inhaltselementen wie Wörtern und Auswahlzeichen besteht.
DocumentModel	Eine bekannte Modellspezifikation, die das Extrahieren strukturierter Dokumente unterstützt. Weitere Informationen finden Sie unter der beginAnalyzeDocumentMethode von DocumentAnalysisClient, die die Verwendung dieser DocumentModel Objekte anstelle von Modell-ID-Zeichenfolgen unterstützt, um bessere Ergebnistypen bereitzustellen.
DocumentModelAdministrationClientOptions	Konfigurierbare Optionen für DocumentModelAdministrationClient.
DocumentModelBuildOperationDetails	Abrufen des Vorgangsantwortobjekts.
DocumentModelComposeOperationDetails	Abrufen des Vorgangsantwortobjekts.
DocumentModelCopyToOperationDetails	Abrufen des Vorgangsantwortobjekts.
DocumentModelDetails	Dokumentmodellinformationen.
DocumentModelOperationState	Der Status eines Modellerstellungsvorgangs.
DocumentModelSummary	Dokumentmodellzusammenfassung.
DocumentNumberField	Ein DocumentField-Objekt, das über einen Zahlenwert verfügt.
DocumentObjectField	Ein DocumentField, das aus mehreren benannten Eigenschaften besteht, die über eigene DocumentField-Werte verfügen.
DocumentPage	Inhalts- und Layoutelemente, die aus einer Seite aus der Eingabe extrahiert wurden.
DocumentParagraph	Ein Absatzobjekt, das aus zusammenhängenden Linien besteht, in der Regel mit gemeinsamer Ausrichtung und Abstand.
DocumentPhoneNumberField	Ein DocumentField mit einem Telefonnummernwert, der als Zeichenfolge dargestellt wird.
DocumentSelectionMark	Ein Auswahlmarkierungsobjekt, das Kontrollkästchen, Optionsfelder und andere Elemente darstellt, die eine Auswahl angeben.
DocumentSelectionMarkField	Ein DocumentField-Objekt, das über einen Wert verfügt, der einen Auswahlmarkierungsstatus angibt (z. B. ein Kontrollkästchen oder Optionsfeld), das als Zeichenfolge dargestellt wird.
DocumentSignatureField	Ein DocumentField, das den Zustand einer Signatur angibt, dargestellt als Zeichenfolge.
DocumentSpan	Zusammenhängender Bereich der verketteten Inhaltseigenschaft, angegeben als Offset und Länge.
DocumentStringField	Ein DocumentField mit einem Zeichenfolgenwert.
DocumentStyle	Ein Objekt, das beobachtete Textstile darstellt.
DocumentTable	Ein Tabellenobjekt, das tabellenzellen besteht, die in einem rechteckigen Layout angeordnet sind.
DocumentTableCell	Ein Objekt, das die Position und den Inhalt einer Tabellenzelle darstellt.
DocumentTimeField	Ein DocumentField mit einem Zeitwert, der als Zeichenfolge dargestellt wird.
DocumentTypeDetails	Dokumenttypinformationen.
DocumentValueField	Ein einfaches Feld, das über einen primitiven Wert verfügt, z. B. eine Zeichenfolge, eine Zahl usw.
DocumentWord	Ein Wortobjekt, das aus einer zusammenhängenden Sequenz von Zeichen besteht. Bei Sprachen ohne Leerzeichentrennzeichen, z. B. Chinesisch, Japanisch und Koreanisch, wird jedes Zeichen als eigenes Wort dargestellt.
ErrorModel	Fehlerinformationen.
GetCopyAuthorizationOptions	Optionen für die Methode zum Abrufen der Kopierautorisierung.
GetModelOptions	Optionen zum Abrufen von Modellinformationen.
GetOperationOptions	Optionen zum Abrufen eines Vorgangszustands.
GetResourceDetailsOptions	Optionen zum Abrufen Formularerkennung Ressourceninformationen.
HasBoundingPolygon	Einfache Dokumentelemente wie Wörter, Auswahlmarkierungen und Linien werden durch das Polygon begrenzt.
InnerError	Detaillierter Fehler.
ListModelsOptions	Optionen zum Auflisten von Modellen.
ListOperationsOptions	Optionen für Listenvorgänge.
ModelAdministrationOperationStateCommon	Der Satz von Feldern, die allen Verwaltungsvorgängen gemeinsam sind.
OperationDetails	Abrufen des Vorgangsantwortobjekts.
OperationSummary	Vorgangsinformationen.
Point2D	Stellt einen Punkt dar, der zum Definieren von umgebenden Polygonen verwendet wird. Die Einheit ist entweder "Pixel" oder "Zoll" (siehe LengthUnit).
PollerOptions	Optionen für zeitintensive Vorgänge (Poller) im Formularerkennung Clients.
QuotaDetails	Verwendetes Kontingent, Limit und Datum/Uhrzeit der nächsten Zurücksetzung.
ResourceDetails	Allgemeine Informationen zur aktuellen Ressource.

Typaliase

AnalysisPoller	Ein Zeitintensiver Vorgang (Poller), der den Status eines Analysevorgangs nachverfolgt und schließlich den Ergebnistyp erzeugt, der dem Modell entspricht.
AnalyzeResultOperationStatus	Definiert Werte für AnalyzeResultOperationStatus.
DocumentBarcodeKind	Definiert Werte für DocumentBarcodeKind. KnownDocumentBarcodeKind kann austauschbar mit DocumentBarcodeKind verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden QRCode: QR-Code, wie in ISO/IEC 18004:2015 definiert. PDF417: PDF417, wie in ISO 15438 definiert. UPCA: 12-stelliger universeller Produktcode GS1. UPCE: GS1 6-stelliger universeller Produktcode. Code39: Code 39 Barcode, wie in ISO/IEC 16388:2007 definiert. Code128: Code 128 Barcode, wie in ISO/IEC 15417:2007 definiert. EAN8: GS1 8-stellige internationale Artikelnummer (Europäische Artikelnummer). EAN13: GS1 13-stellige internationale Artikelnummer (Europäische Artikelnummer). DataBar: GS1 DataBar-Barcode. Code93: Code 93 Barcode, wie in ANSI/AIM BC5-1995 definiert. Codabar: Codabar-Barcode, wie in ANSI/AIM BC3-1995 definiert. DataBarExpanded: GS1 DataBar Erweiterter Barcode. ITF: Verschachtelte 2 von 5 Barcodes, wie in ANSI/AIM BC2-1995 definiert. MicroQRCode: Mikro-QR-Code, wie in ISO/IEC 23941:2022 definiert. Azteken: Aztekencode, wie in ISO/IEC 24778:2008 definiert. DataMatrix: Datenmatrixcode, wie in ISO/IEC 16022:2006 definiert. MaxiCode: MaxiCode, wie in ISO/IEC 16023:2000 definiert.
DocumentBuildMode	Definiert Werte für DocumentBuildMode. KnownDocumentBuildMode kann austauschbar mit DocumentBuildMode verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden template: Zieldokumente mit ähnlichen visuellen Vorlagen. neural: Unterstützung von Dokumenten mit verschiedenen visuellen Vorlagen.
DocumentClassifierPoller	Ein Zeitintensiver Vorgang (Poller), der den Status eines benutzerdefinierten Klassifizierererstellungsvorgangs nachverfolgt und schließlich einen DocumentClassifierDetails erzeugt.
DocumentClassifierSource	Eine Inhaltsquelle, die zum Erstellen eines Dokumentklassifizierers verwendet werden kann. Enthält einen der folgenden Werte: BlobSource BlobFileListSource
DocumentField	Ein extrahiertes Feld. Die kind -Eigenschaft identifiziert (diskriminiert) den Typ von DocumentField.
DocumentFieldType	Definiert Werte für DocumentFieldType. KnownDocumentFieldType kann austauschbar mit DocumentFieldType verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden string: Nur-Text. datum: Datum, normalisiert im Format ISO 8601 (JJJJ-MM-TT). time: Zeit, normalisiert im FORMAT ISO 8601 (hh:mm:ss). phoneNumber: Telefonnummer, normalisiert im Format E.164 (+{CountryCode}{SubscriberNumber}). number: Gleitkommazahl, normalisiert auf Gleitkomma mit doppelter Genauigkeit. integer: Ganze Zahl, normalisiert in 64-Bit-Ganzzahl mit Vorzeichen. selectionMark: Ist das Feld ausgewählt? countryRegion: Land/Region, normalisiert im ISO 3166-1 Alpha-3-Format (z. B. USA). Signatur: Ist die Signatur vorhanden? Array: Liste der Unterfelder desselben Typs. object: Benannte Liste von Unterfeldern mit potenziell unterschiedlichen Typen. währung: Währungsbetrag mit optionalem Währungssymbol und Einheit. address: Analysierte Adresse. Boolean: Boolescher Wert, normalisiert auf true oder false.
DocumentFormulaKind	Definiert Werte für DocumentFormulaKind. KnownDocumentFormulaKind kann austauschbar mit DocumentFormulaKind verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden inline: Eine Formel, die in den Inhalt eines Absatzes eingebettet ist. display: Eine Formel im Anzeigemodus, die eine ganze Zeile einnimmt.
DocumentModelBuildMode	Unterstützte Modellbuildmodi. Der Modellerstellungsmodus wählt die Engine aus, mit der der Dienst das Modell basierend auf den bezeichneten Trainingsdaten trainiert. Die Optionen sind: "neural", das die höchste Qualität des Modells ergibt, das in der Lage ist, Daten aus Klassen von Dokumenten zu extrahieren, die die gleiche Struktur von Daten haben, aber unterschiedliche Layouts (z. B. W2-Steuerformulare, die von Unternehmen zu Unternehmen variieren können, aber immer die gleichen Informationen enthalten). "Template", die erfordert, dass alle Dokumente das gleiche feste Layout (Vorlage) haben. Weitere Informationen finden Sie unter folgendem Link: https://aka.ms/azsdk/formrecognizer/buildmode
DocumentModelPoller	Ein Zeitintensiver Vorgang (Poller), der den Zustand eines Modellerstellungsvorgangs nachverfolgt und schließlich ein DocumentModelDetails erzeugt.
DocumentModelSource	Eine Inhaltsquelle, die zum Erstellen eines Dokumentmodells verwendet werden kann. Enthält einen der folgenden Werte: BlobSource BlobFileListSource
DocumentSignatureType	Definiert Werte für DocumentSignatureType. KnownDocumentSignatureType kann austauschbar mit DocumentSignatureType verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden signiert: Eine Signatur wird erkannt. unsigned: Es werden keine Signaturen erkannt.
DocumentTableCellKind	Definiert Werte für DocumentTableCellKind. KnownDocumentTableCellKind kann austauschbar mit DocumentTableCellKind verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden content: Enthält die Standard Inhalt/Daten. rowHeader: Beschreibt den Inhalt der Zeile. columnHeader: Beschreibt den Inhalt der Spalte. stubHead: Beschreibt die Zeilenüberschriften, die sich normalerweise in der oberen linken Ecke einer Tabelle befinden. description: Beschreibt den Inhalt in (Teilen) der Tabelle.
FontStyle	Definiert Werte für FontStyle. KnownFontStyle kann austauschbar mit FontStyle verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden normal: Zeichen werden normal dargestellt. Kursiv: Zeichen sind visuell nach rechts geneigt.
FontWeight	Definiert Werte für FontWeight. KnownFontWeight kann austauschbar mit FontWeight verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden normal: Zeichen werden normal dargestellt. fett: Zeichen werden mit dickeren Strichen dargestellt.
FormRecognizerFeature	Add-On-Funktionen (Features), die für die Anforderung aktiviert werden können. Weitere Informationen zu den in Formularerkennung verfügbaren Features finden Sie in der Dienstdokumentation: https://aka.ms/azsdk/formrecognizer/features
FormRecognizerRequestBody	Eine Anforderungseingabe, die als Binärdaten in den Formularerkennung-Dienst hochgeladen werden kann. Formularerkennung behandelt Eingaben string als URLs. Um eine Zeichenfolge als binäre Eingabe zu senden, konvertieren Sie die Zeichenfolge zunächst in einen der folgenden Eingabetypen.
LengthUnit	Definiert Werte für LengthUnit. KnownLengthUnit kann austauschbar mit LengthUnit verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden pixel: Längeneinheit für Bilddateien. zoll: Längeneinheit für PDF-Dateien.
OperationDetailsUnion	Details zu verschiedenen Arten von Formularerkennung Verwaltungsvorgängen.
OperationKind	Definiert Werte für OperationKind. KnownOperationKind kann austauschbar mit OperationKind verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden documentModelBuild: Erstellen Sie ein neues benutzerdefiniertes Dokumentmodell. documentModelCompose: Erstellen Sie ein neues benutzerdefiniertes Dokumentmodell aus vorhandenen Modellen. documentModelCopyTo: Kopieren Sie ein vorhandenes Dokumentmodell in eine möglicherweise andere Ressource, Region oder ein anderes Abonnement. documentClassifierBuild: Erstellen Sie ein neues benutzerdefiniertes Klassifizierermodell.
OperationStatus	Definiert Werte für OperationStatus.
ParagraphRole	Definiert Werte für ParagraphRole. KnownParagraphRole kann austauschbar mit ParagraphRole verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden pageHeader: Text am oberen Rand der Seite. pageFooter: Text am unteren Rand der Seite. pageNumber: Seitenzahl. title: Titel der obersten Ebene, der das gesamte Dokument beschreibt. sectionHeading: Unterüberschrift, die einen Abschnitt des Dokuments beschreibt. Fußnote: Eine Notiz, die normalerweise nach dem Standard Inhalt auf einer Seite platziert wird. formulaBlock: Ein Formelblock, häufig mit gemeinsamer Ausrichtung.
SelectionMarkState	Definiert Werte für SelectionMarkState. KnownSelectionMarkState kann austauschbar mit SelectionMarkState verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden selected: Das Auswahlzeichen ist ausgewählt, oft durch ein Häkchen ✓ oder kreuzt X innerhalb des Auswahlzeichens. nicht ausgewählt: Das Auswahlzeichen ist nicht ausgewählt.
StringIndexType	Gültige Zeichenfolgenindextypen, die vom Formularerkennung-Dienst und SDK-Clients unterstützt werden.

Enumerationen

KnownDocumentBarcodeKind	Bekannte Werte von DocumentBarcodeKind , die der Dienst akzeptiert.
KnownDocumentBuildMode	Bekannte Werte von DocumentBuildMode , die der Dienst akzeptiert.
KnownDocumentFieldType	Bekannte Werte von DocumentFieldType , die der Dienst akzeptiert.
KnownDocumentFormulaKind	Bekannte Werte von DocumentFormulaKind , die der Dienst akzeptiert.
KnownDocumentSignatureType	Bekannte Werte von DocumentSignatureType , die der Dienst akzeptiert.
KnownDocumentTableCellKind	Bekannte Werte von DocumentTableCellKind , die der Dienst akzeptiert.
KnownFontStyle	Bekannte Werte von FontStyle , die der Dienst akzeptiert.
KnownFontWeight	Bekannte Werte von FontWeight , die der Dienst akzeptiert.
KnownLengthUnit	Bekannte Werte von LengthUnit , die der Dienst akzeptiert.
KnownOperationKind	Bekannte Werte von OperationKind , die der Dienst akzeptiert.
KnownParagraphRole	Bekannte Werte von ParagraphRole , die der Dienst akzeptiert.
KnownSelectionMarkState	Bekannte Werte von SelectionMarkState , die der Dienst akzeptiert.