@azure/ai-form-recognizer package

Klassen

AzureKeyCredential	Statische Schlüsselbasierte Anmeldeinformationen, die das Aktualisieren des zugrunde liegenden Schlüsselwerts unterstützen.
DocumentAnalysisClient	Ein Client für die Interaktion mit den Analysefunktionen des Formularerkennungsdiensts. Beispiele: Der Formularerkennungsdienst und Clients unterstützen zwei Authentifizierungswege: 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 Modellverwaltungsfeatures des Formularerkennungsdiensts, 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 zur Durchführung der Analyse verwendet wird.
AnalyzeResultCommon	Die gemeinsamen Felder aller AnalyzeResult-like-Typen, z. B. LayoutResult, ReadResult und GeneralDocumentResult.
AnalyzedDocument	Ein extrahiertes Dokumentobjekt. Ein AnalyzedDocument ist eine Instanz eines der Dokumenttypen innerhalb eines Modells. Die Felder entsprechen dem Feldschema des Dokumenttyps.
AzureBlobFileListSource	Eine Schulungsdatenquelle, die durch einen Azure Blob Container und eine JSONL-Dateiliste innerhalb des Containers definiert wird.
AzureBlobFileListSourceDetails	Dateiliste in Azure Blob Storage.
AzureBlobSource	Eine Schulungsdatenquelle, die durch einen Azure Blob-Container definiert wird.
AzureBlobSourceDetails	Azure Blob Storage-Inhalt.
BeginBuildDocumentClassifierOptions	Optionen für den Buildvorgang des Dokumentklassifizierers.
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	Allgemeine Optionen für alle Vorgänge, die neue Modelle definieren, z. B. beginBuildDocumentModel, 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 die Modelllöschung.
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 Kreuz.
DocumentArrayField	Ein DocumentField, das aus einem Array geschachtelter Felder besteht. Alle Felder im Array weisen denselben Typ auf.
DocumentBarcode	Ein extrahierter Barcode.
DocumentBooleanField	Ein DocumentField mit einem booleschen Wert.
DocumentCaption	Ein Objekt, das die Position und den Inhalt einer Tabellenbeschriftung darstellt.
DocumentClassifierBuildOperationDetails	Dient zum Abrufen des Operation-Antwortobjekts.
DocumentClassifierDetails	Dokumentklassifiziererinformationen.
DocumentClassifierDocumentTypeSources	Eine Reihe von Quellen, die zum Erstellen eines Dokumentklassifizierers verwendet werden. Dies ist eine Zuordnung von Dokumenttypnamen zu Quellen, die verwendet werden, um das Modell zu trainieren, um Dokumente des entsprechenden Quelltyps zu klassifizieren.
DocumentClassifierOperationState	Der Status eines Modellerstellungsvorgangs.
DocumentCountryRegionField	Ein DocumentField mit einem Wert, der ein Land oder eine Region angibt, dargestellt als Zeichenfolge.
DocumentCurrencyField	Ein DocumentField, das einen Betrag einer bestimmten Währung beschreibt.
DocumentDateField	Ein DocumentField mit einem Date-Wert.
DocumentFieldCommon	Felder, die für alle DocumentField-Varianten gemeinsam sind.
DocumentFieldSchema	Beschreibung des Feldsemantikschemas mithilfe einer JSON-Schemaformatsyntax.
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 eindeutiger Feldbeschriftung (Schlüssel) und Feldwert darstellt (kann leer sein).
DocumentLanguage	Ein Objekt, das die erkannte Sprache für einen bestimmten Textbereich darstellt.
DocumentLine	Ein Inhaltszeilenobjekt, das aus einer angrenzenden Abfolge von Inhaltselementen besteht, z. B. Wörter und Auswahlzeichen.
DocumentModel	Eine bekannte Modellspezifikation, die das Extrahieren strukturierter Dokumente unterstützt. Lesen Sie die beginAnalyzeDocument Methode von DocumentAnalysisClient-, die das Verwenden dieser DocumentModel Objekte anstelle von Modell-ID-Zeichenfolgen unterstützt, um stärkere Ergebnistypen bereitzustellen.
DocumentModelAdministrationClientOptions	Konfigurierbare Optionen für DocumentModelAdministrationClient.
DocumentModelBuildOperationDetails	Dient zum Abrufen des Operation-Antwortobjekts.
DocumentModelComposeOperationDetails	Dient zum Abrufen des Operation-Antwortobjekts.
DocumentModelCopyToOperationDetails	Dient zum Abrufen des Operation-Antwortobjekts.
DocumentModelDetails	Dokumentmodellinformationen.
DocumentModelOperationState	Der Status eines Modellerstellungsvorgangs.
DocumentModelSummary	Dokumentmodellzusammenfassung.
DocumentNumberField	Ein DocumentField mit einem Zahlenwert.
DocumentObjectField	Ein DocumentField, das aus mehreren benannten Eigenschaften besteht, die über eigene DocumentField-Werte verfügen.
DocumentPage	Inhalt und Layoutelemente, die aus einer Seite aus der Eingabe extrahiert wurden.
DocumentParagraph	Ein Absatzobjekt, das in der Regel mit zusammenhängenden Linien besteht, mit allgemeiner Ausrichtung und Abständen.
DocumentPhoneNumberField	Ein DocumentField mit einem Telefonnummernwert, dargestellt als Zeichenfolge.
DocumentSelectionMark	Ein Auswahlmarkierungsobjekt, das Kontrollkästchen, Optionsfelder und andere Elemente darstellt, die eine Auswahl angeben.
DocumentSelectionMarkField	Ein DocumentField mit einem Wert, der einen Auswahlzeichenstatus angibt (z. B. ein Kontrollkästchen oder optionsfeld), dargestellt als Zeichenfolge.
DocumentSignatureField	Ein DocumentField, das den Status 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 Textformatvorlagen 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, dargestellt als Zeichenfolge.
DocumentTypeDetails	Dokumenttypinformationen.
DocumentValueField	Ein einfaches Feld, das einen Grundtypwert aufweist, z. B. eine Zeichenfolge, eine Zahl usw.
DocumentWord	Ein Wortobjekt, das aus einer zusammenhängenden Abfolge von Zeichen besteht. Bei nicht leerzeichentrennten Sprachen, 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 von Ressourceninformationen zur Formularerkennung.
HasBoundingPolygon	Einfache Dokumentelemente wie Wörter, Auswahlzeichen und Linien werden durch das Polygon begrenzt.
InnerError	Detaillierter Fehler.
ListModelsOptions	Optionen für Auflistungsmodelle.
ListOperationsOptions	Optionen zum Auflisten von Vorgängen.
ModelAdministrationOperationStateCommon	Die Gruppe von Feldern, die allen Verwaltungsvorgängen gemeinsam sind.
OperationDetails	Dient zum Abrufen des Operation-Antwortobjekts.
OperationSummary	Vorgangsinformationen.
Point2D	Stellt einen Punkt dar, der zum Definieren umgebender Polygone verwendet wird. Die Einheit ist entweder "Pixel" oder "Inch" (Siehe LengthUnit).
PollerOptions	Optionen für lange ausgeführte Vorgänge (Poller) in den Formularerkennungsclients.
QuotaDetails	Verwendetes Kontingent, Limit und nächstes Zurücksetzen von Datum/Uhrzeit.
ResourceDetails	Allgemeine Informationen zur aktuellen Ressource.

Typaliase

AnalysisPoller	Ein lang ausgeführter Vorgang (Poller), der den Status eines Analysevorgangs verfolgt und schließlich den Ergebnistyp erzeugt, der dem Modell entspricht.
AnalyzeResultOperationStatus	Definiert Werte für AnalyzeResultOperationStatus.
DocumentBarcodeKind	Definiert Werte für DocumentBarcodeKind. KnownDocumentBarcodeKind austauschbar mit DocumentBarcodeKind verwendet werden kann, enthält diese Enumeration 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-: GS1 12-stelliger Universal-Produktcode. 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 Expanded barcode. ITF-: Interleaved 2 of 5 barcode, as defined in ANSI/AIM BC2-1995. MicroQRCode: Mikro-QR-Code, wie in ISO/IEC 23941:2022 definiert. Aztec: Aztec-Code gemäß ISO/IEC 24778:2008. DataMatrix-: Datenmatrixcode, wie in ISO/IEC 16022:2006 definiert. MaxCode: MaxCode, wie in ISO/IEC 16023:2000 definiert.
DocumentBuildMode	Definiert Werte für DocumentBuildMode. KnownDocumentBuildMode- austauschbar mit DocumentBuildMode verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Vorlage: Zieldokumente mit ähnlichen visuellen Vorlagen. neurale: Unterstützen Sie Dokumente mit verschiedenen visuellen Vorlagen.
DocumentClassifierPoller	Ein lang ausgeführter Vorgang (Poller), der den Zustand eines benutzerdefinierten Klassifizierungserstellungsvorgangs nachverfolgt und schließlich eine DocumentClassifierDetailserzeugt.
DocumentClassifierSource	Eine Inhaltsquelle, die zum Erstellen eines Dokumentklassifizierers verwendet werden kann. Einer von: BlobSource BlobFileListSource
DocumentField	Ein extrahiertes Feld. Die kind-Eigenschaft identifiziert (diskriminiert) den Typ des DocumentField.
DocumentFieldType	Definiert Werte für DocumentFieldType. KnownDocumentFieldType- austauschbar mit DocumentFieldType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Zeichenfolge: Nur-Text. Datum: Datum, normalisiert auf ISO 8601 (JJJJ-MM-DD) Format. Zeit: Zeit, normalisiert auf ISO 8601 (hh:mm:ss)-Format. phoneNumber-: Telefonnummer, normalisiert auf E.164 (+{CountryCode}{SubscriberNumber}) Format. Zahl: Gleitkommazahl, normalisiert auf Gleitkommazahl mit doppelter Genauigkeit. ganze Zahl: Ganze Zahl, normalisiert auf 64-Bit-Ganzzahl. SelectionMark-: Ist das Feld ausgewählt? LandRegion: Land/Region, normalisiert auf ISO 3166-1 Alpha-3-Format (z. B. USA). Signatur: Ist die Signatur vorhanden? Array-: Liste der Unterfelder desselben Typs. Objekt: Benannte Liste von Unterfeldern potenziell unterschiedlicher Typen. Währung: Währungsbetrag mit optionalem Währungssymbol und Einheit. Adresse: Analysierte Adresse. booleschen: Boolescher Wert, normalisiert auf "true" oder "false".
DocumentFormulaKind	Definiert Werte für DocumentFormulaKind. KnownDocumentFormulaKind austauschbar mit DocumentFormulaKind verwendet werden kann, enthält diese Enumeration 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. anzeigen: Eine Formel im Anzeigemodus, die eine ganze Zeile einnimmt.
DocumentModelBuildMode	Unterstützte Modellbuildmodi. Der Modellbuildmodus wählt das Modul aus, das der Dienst verwendet, um das Modell basierend auf den bezeichneten Schulungsdaten zu trainieren. Die Optionen sind: "neural", das die höchste Qualität des Modells liefert, das Daten aus Dokumentenklassen extrahieren kann, die dieselbe Datenstruktur haben, aber unterschiedliche Layouts (z. B. W2 Steuerformulare, die von Unternehmen zu Unternehmen variieren können, aber immer dieselben Informationen enthalten). "template", die erfordert, dass alle Dokumente das gleiche feste Layout (Vorlage) aufweisen. Weitere Informationen finden Sie unter folgendem Link: https://aka.ms/azsdk/formrecognizer/buildmode
DocumentModelPoller	Ein lang ausgeführter Vorgang (Poller), der den Zustand eines Modellerstellungsvorgangs nachverfolgt und schließlich eine DocumentModelDetailserzeugt.
DocumentModelSource	Eine Inhaltsquelle, die zum Erstellen eines Dokumentmodells verwendet werden kann. Einer von: BlobSource BlobFileListSource
DocumentSignatureType	Definiert Werte für DocumentSignatureType. KnownDocumentSignatureType austauschbar mit DocumentSignatureType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden signierten: Eine Signatur wird erkannt. nicht signierte: Es werden keine Signaturen erkannt.
DocumentTableCellKind	Definiert Werte für DocumentTableCellKind. KnownDocumentTableCellKind austauschbar mit DocumentTableCellKind verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Inhalt: Enthält den Hauptinhalt/die Hauptdaten. 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. Beschreibung: Beschreibt den Inhalt in (Teilen) der Tabelle.
FontStyle	Definiert Werte für FontStyle. KnownFontStyle- austauschbar mit FontStyle verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden normale: Zeichen werden normal dargestellt. kursiv: Zeichen sind visuell nach rechts geneigt.
FontWeight	Definiert Werte für FontWeight. KnownFontWeight austauschbar mit FontWeight verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden normale: Zeichen werden normal dargestellt. fett formatierte: Zeichen werden mit dickeren Strichen dargestellt.
FormRecognizerFeature	Add-On-Funktionen (Features), die für die Anforderung aktiviert werden können. Weitere Informationen zu den features, die in der Formularerkennung verfügbar sind, finden Sie in der Dienstdokumentation: https://aka.ms/azsdk/formrecognizer/features
FormRecognizerRequestBody	Eine Anforderungseingabe, die als Binärdaten in den Formularerkennungsdienst hochgeladen werden kann. Die Formularerkennung behandelt string Eingaben als URLs. Wenn Sie also eine Zeichenfolge als binäre Eingabe senden möchten, konvertieren Sie die Zeichenfolge zuerst in einen der folgenden Eingabetypen.
LengthUnit	Definiert Werte für LengthUnit. KnownLengthUnit austauschbar mit LengthUnit verwendet werden kann, enthält diese Enumeration 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 Typen von Formularerkennungsverwaltungsvorgängen.
OperationKind	Definiert Werte für OperationKind. KnownOperationKind austauschbar mit OperationKind verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden documentModelBuild-: Erstellen eines neuen benutzerdefinierten Dokumentmodells. documentModelCompose: Verfassen Sie ein neues benutzerdefiniertes Dokumentmodell aus vorhandenen Modellen. documentModelCopyTo: Kopieren Eines vorhandenen Dokumentmodells in potenziell eine andere Ressource, Region oder ein anderes Abonnement. documentClassifierBuild-: Erstellen eines neuen benutzerdefinierten Klassifizierermodells.
OperationStatus	Definiert Werte für OperationStatus.
ParagraphRole	Definiert Werte für ParagraphRole. KnownParagraphRole austauschbar mit ParagraphRole verwendet werden kann, enthält diese Enumeration 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. Titel: Titel der obersten Ebene, der das gesamte Dokument beschreibt. SectionHeading: Unterüberschrift, die einen Abschnitt des Dokuments beschreibt. Fußnoten-: Eine Notiz, die in der Regel nach dem Hauptinhalt auf einer Seite platziert wurde. formulaBlock-: Ein Formelblock, häufig mit freigegebener Ausrichtung.
SelectionMarkState	Definiert Werte für SelectionMarkState. KnownSelectionMarkState- austauschbar mit SelectionMarkState verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden ausgewählt: Das Auswahlzeichen wird ausgewählt, häufig durch ein Häkchen oder X innerhalb des Auswahlzeichens angegeben. nicht ausgewählte: Das Auswahlzeichen ist nicht ausgewählt.
StringIndexType	Gültige Zeichenfolgenindextypen, die vom Formularerkennungsdienst 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.