Freigeben über


formrecognizer Paket

Pakete

aio

Klassen

AccountProperties

Zusammenfassung aller benutzerdefinierten Modelle für das Konto.

Neu in Version 2.1: Unterstützung für to_dict- und from_dict-Methoden

AddressValue

Ein Adressfeldwert.

Neu in Version 2023-07-31: Die Eigenschaften Einheit, city_district, state_district, Vorort, Haus und Ebene .

AnalyzeResult

Ergebnis der Dokumentanalyse.

AnalyzedDocument

Ein Objekt, das den Speicherort und den semantischen Inhalt eines Dokuments beschreibt.

BlobFileListSource

Inhaltsquelle für eine Dateiliste in Azure Blob Storage.

BlobSource

Inhaltsquelle für Azure Blob Storage.

BoundingRegion

Der begrenzungsgebundene Bereich, der einer Seite entspricht.

ClassifierDocumentTypeDetails

Trainingsdatenquelle.

CurrencyValue

Ein Währungswertelement.

Neu in Version 2023-07-31: Die Codeeigenschaft .

CustomDocumentModelsDetails

Details zu den benutzerdefinierten Modellen unter der Formularerkennung-Ressource.

CustomFormModel

Stellt ein trainiertes Modell dar.

Neu in Version 2.1: Die Eigenschaften model_name und Eigenschaften , Unterstützung für to_dict - und from_dict methoden

CustomFormModelField

Ein Feld, das das Modell aus den von es analysierten Formularen extrahiert.

Neu in Version 2.1: Unterstützung für to_dict- und from_dict-Methoden

CustomFormModelInfo

Benutzerdefinierte Modellinformationen.

Neu in Version 2.1: Die Eigenschaften model_name und Eigenschaften , Unterstützung für to_dict - und from_dict methoden

CustomFormModelProperties

Optionale Modelleigenschaften.

Neu in Version 2.1: Unterstützung für to_dict- und from_dict-Methoden

CustomFormSubmodel

Stellt ein Untermodell dar, das Felder aus einem bestimmten Formulartyp extrahiert.

Neu in Version 2.1: Die model_id-Eigenschaft, Unterstützung für to_dict- und from_dict-Methoden

DocumentAnalysisClient

DocumentAnalysisClient analysiert Informationen aus Dokumenten und Bildern und klassifiziert Dokumente. Es ist die Schnittstelle, die für die Analyse mit vordefinierten Modellen (Belege, Visitenkarten, Rechnungen, Identitätsdokumente usw.), die Analyse des Layouts aus Dokumenten, die Analyse allgemeiner Dokumenttypen und die Analyse benutzerdefinierter Dokumente mit erstellten Modellen verwendet werden kann (eine vollständige Liste der vom Dienst unterstützten Modelle finden Sie unter : https://aka.ms/azsdk/formrecognizer/models). Es bietet verschiedene Methoden basierend auf Eingaben von einer URL und Eingaben aus einem Stream.

Hinweis

DocumentAnalysisClient sollte mit API-Versionen verwendet werden

31.08.2022 und höher. Um API-Versionen <=v2.1 zu verwenden, instanziieren Sie einen FormRecognizerClient.

Neu in Version 2022-08-31: Der DocumentAnalysisClient und seine Clientmethoden.

DocumentAnalysisError

DocumentAnalysisError enthält die Details des vom Dienst zurückgegebenen Fehlers.

DocumentAnalysisInnerError

Innere Fehlerdetails für documentAnalysisError.

DocumentBarcode

Ein Barcodeobjekt.

DocumentClassifierDetails

Dokumentklassifiziererinformationen. Enthält die Dokumenttypen, die das Modell klassifizieren kann.

DocumentField

Ein Objekt, das den Inhalt und die Position eines Dokumentfeldwerts darstellt.

Neu in Version 2023-07-31: Der boolesche value_type- und Boolwert

DocumentFormula

Ein Formelobjekt.

DocumentKeyValueElement

Ein Objekt, das den Feldschlüssel oder -wert in einem Schlüssel-Wert-Paar darstellt.

DocumentKeyValuePair

Ein Objekt, das ein Dokumentfeld mit unterschiedlicher Feldbezeichnung (Schlüssel) und Feldwert (möglicherweise leer) darstellt.

DocumentLanguage

Ein Objekt, das die erkannte Sprache für eine bestimmte Textspanne darstellt.

DocumentLine

Ein Inhaltszeilenobjekt, das den Inhalt darstellt, der in einer einzelnen Zeile des Dokuments gefunden wird.

DocumentModelAdministrationClient

DocumentModelAdministrationClient ist die Formularerkennung Schnittstelle, die zum Erstellen und Verwalten von Modellen verwendet werden soll.

Es bietet Methoden zum Erstellen von Modellen und Klassifizierern sowie Methoden zum Anzeigen und Löschen von Modellen und Klassifizierern, anzeigen von Modell- und Klassifizierervorgängen, zugreifen auf Kontoinformationen, Kopieren von Modellen in eine andere Formularerkennung Ressource und Erstellen eines neuen Modells aus einer Sammlung vorhandener Modelle.

Hinweis

DocumentModelAdministrationClient sollte mit API-Versionen verwendet werden

31.08.2022 und höher. Um API-Versionen <=v2.1 zu verwenden, instanziieren Sie einen FormTrainingClient.

Neu in Version 2022-08-31: Der DocumentModelAdministrationClient und seine Clientmethoden.

DocumentModelAdministrationLROPoller

Implementiert ein Protokoll, gefolgt von zurückgegebenen Pollerobjekten.

DocumentModelDetails

Dokumentmodellinformationen. Enthält die Dokumenttypen, die das Modell analysieren kann.

Neu in Version 2023-07-31: Die eigenschaft expires_on .

DocumentModelSummary

Eine Zusammenfassung der Dokumentmodellinformationen, einschließlich der Modell-ID, ihrer Beschreibung und des Zeitpunkts der Erstellung des Modells.

Neu in Version 2023-07-31: Die eigenschaft expires_on .

DocumentPage

Inhalts- und Layoutelemente, die aus einer Seite der Eingabe extrahiert werden.

Neu in Version 2023-07-31: Die Barcodes- und Formeleigenschaften .

DocumentParagraph

Ein Absatzobjekt, das im Allgemeinen aus zusammenhängenden Linien mit allgemeiner Ausrichtung und Abständen besteht.

Neu in Version 2023-07-31: Die FormulaBlock-Rolle .

DocumentSelectionMark

Ein Auswahlmarkierungsobjekt, das Kontrollkästchen, Optionsfelder und andere Elemente darstellt, die eine Auswahl angibt.

DocumentSpan

Zusammenhängender Bereich des Inhalts der Eigenschaft, der als Offset und Länge angegeben wird.

DocumentStyle

Ein Objekt, das beobachtete Textstile darstellt.

Neu in Version 2023-07-31: Die Eigenschaften similar_font_family, font_style, font_weight, Farbe und background_color .

DocumentTable

Ein Tabellenobjekt, das aus Tabellenzellen besteht, die in einem rechteckigen Layout angeordnet sind.

DocumentTableCell

Ein Objekt, das die Position und den Inhalt einer Tabellenzelle darstellt.

DocumentTypeDetails

DocumentTypeDetails stellt einen Dokumenttyp dar, den ein Modell erkennen kann, einschließlich seiner Felder und Typen und der Zuverlässigkeit für diese Felder.

DocumentWord

Ein Wortobjekt, das aus einer zusammenhängenden Sequenz von Zeichen besteht. Für Sprachen ohne Leerzeichen, z. B. Chinesisch, Japanisch und Koreanisch, wird jedes Zeichen als eigenes Wort dargestellt.

FieldData

Enthält die Daten für das Formularfeld. Dies umfasst den Text, die Position des Texts im Formular und eine Auflistung der Elemente, aus denen der Text besteht.

Neu in Version 2.1: FormSelectionMark wird den in der Liste der field_elements zurückgegebenen Typen hinzugefügt, unterstützung für to_dict und from_dict Methoden

FormElement

Basistyp, der Eigenschaften für ein Formularelement enthält.

Neu in Version 2.1: Unterstützung für to_dict- und from_dict-Methoden

FormField

Stellt ein in einem Eingabeformular erkanntes Feld dar.

Neu in Version 2.1: Unterstützung für to_dict- und from_dict-Methoden

FormLine

Ein Objekt, das eine extrahierte Textzeile darstellt.

Neu in Version 2.1: Appearance-Eigenschaft, Unterstützung für to_dict- und from_dict-Methoden

FormPage

Stellt eine Seite dar, die aus dem Eingabedokument erkannt wird. Enthält Zeilen, Wörter, Auswahlmarkierungen, Tabellen und Seitenmetadaten.

Neu in Version 2.1: selection_marks-Eigenschaft, Unterstützung für to_dict- und from_dict-Methoden

FormPageRange

Der 1-basierte Seitenbereich des Formulars.

Neu in Version 2.1: Unterstützung für to_dict- und from_dict-Methoden

FormRecognizerClient

FormRecognizerClient extrahiert Informationen aus Formularen und Bildern in strukturierte Daten. Es ist die Schnittstelle, die für die Analyse mit vordefinierten Modellen (Belege, Visitenkarten, Rechnungen, Identitätsdokumente), das Erkennen von Inhalten/Layouts aus Formularen und die Analyse benutzerdefinierter Formulare aus trainierten Modellen verwendet werden kann. Es bietet verschiedene Methoden basierend auf Eingaben von einer URL und Eingaben aus einem Stream.

Hinweis

FormRecognizerClient sollte mit API-Versionen <=v2.1 verwendet werden.

Um API-Versionen 2022-08-31 und höher zu verwenden, instanziieren Sie einen DocumentAnalysisClient.

FormRecognizerError

Stellt einen Fehler dar, der während des Trainings aufgetreten ist.

Neu in Version 2.1: Unterstützung für to_dict- und from_dict-Methoden

FormSelectionMark

Informationen zur extrahierten Auswahlmarke.

Neu in Version 2.1: Unterstützung für to_dict- und from_dict-Methoden

FormTable

Informationen zur extrahierten Tabelle, die auf einer Seite enthalten ist.

Neu in Version 2.1: Die bounding_box-Eigenschaft, Unterstützung für to_dict- und from_dict-Methoden

FormTableCell

Stellt eine Zelle dar, die in einer Tabelle enthalten ist, die aus dem Eingabedokument erkannt wird.

Neu in Version 2.1: FormSelectionMark wird den in der Liste der field_elements zurückgegebenen Typen hinzugefügt, unterstützung für to_dict und from_dict Methoden

FormTrainingClient

FormTrainingClient ist die Formularerkennung-Schnittstelle, die zum Erstellen und Verwalten benutzerdefinierter Modelle verwendet werden soll. Sie bietet Methoden zum Trainieren von Modellen für die von Ihnen bereitgestellten Formulare sowie Methoden zum Anzeigen und Löschen von Modellen, zum Zugreifen auf Kontoeigenschaften, zum Kopieren von Modellen in eine andere Formularerkennung Ressource und zum Erstellen von Modellen aus einer Sammlung vorhandener Modelle, die mit Bezeichnungen trainiert wurden.

Hinweis

FormTrainingClient sollte mit API-Versionen <=v2.1 verwendet werden.

Um API-Versionen 2022-08-31 und höher zu verwenden, instanziieren Sie einen DocumentModelAdministrationClient.

FormWord

Stellt ein Wort dar, das aus dem Eingabedokument erkannt wird.

Neu in Version 2.1: Unterstützung für to_dict- und from_dict-Methoden

OperationDetails

OperationDetails besteht aus Informationen zum Modellvorgang, einschließlich des Ergebnisses oder Fehlers des Vorgangs, wenn er abgeschlossen wurde.

Beachten Sie, dass Vorgangsinformationen nur 24 Stunden lang beibehalten werden. Wenn der Vorgang erfolgreich war, kann auch mithilfe der APIs , <xref:azure.ai.formrecognizer.list_document_models>, <xref:azure.ai.formrecognizer.get_document_classifier>auf <xref:azure.ai.formrecognizer.list_document_classifiers> das <xref:azure.ai.formrecognizer.get_document_model>Modell zugegriffen werden.

Neu in Version 2023-07-31: Das Ergebnis documentClassifierBuild undDocumentClassifierDetails .

OperationSummary

Modellvorgangsinformationen, einschließlich der Art und status des Vorgangs, wann er erstellt wurde, und vieles mehr.

Beachten Sie, dass Vorgangsinformationen nur 24 Stunden lang beibehalten werden. Wenn der Vorgang erfolgreich war, kann mithilfe der APIs , <xref:azure.ai.formrecognizer.list_document_models>, <xref:azure.ai.formrecognizer.get_document_classifier>auf <xref:azure.ai.formrecognizer.list_document_classifiers> das <xref:azure.ai.formrecognizer.get_document_model>Modell zugegriffen werden. Um herauszufinden, warum ein Vorgang fehlgeschlagen ist, verwenden <xref:azure.ai.formrecognizer.get_operation> Sie die operation_id, und geben Sie sie an.

Neu in Version 2023-07-31: Die documentClassifierBuild-Art .

Point

Die x-, y-Koordinate eines Punkts auf einem begrenzungsenden Feld oder Polygon.

Neu in Version 2.1: Unterstützung für to_dict- und from_dict-Methoden

QuotaDetails

Verwendetes Kontingent, Limit und Datum/Uhrzeit des nächsten Zurücksetzens.

RecognizedForm

Stellt ein Formular dar, das von einem trainierten oder vordefinierten Modell erkannt wurde. Die fields-Eigenschaft enthält die Formularfelder, die aus dem Formular extrahiert wurden. Tabellen, Textzeilen/Wörter und Auswahlzeichen werden pro Seite extrahiert und in der pages-Eigenschaft gefunden.

Neu in Version 2.1: Die Eigenschaften form_type_confidence und model_id , Unterstützung für to_dict und from_dict Methoden

ResourceDetails

Details zur Formularerkennung Ressource.

Neu in Version 2023-07-31: Die neural_document_model_quota-Eigenschaft .

TextAppearance

Ein Objekt, das die Darstellung der Textzeile darstellt.

Neu in Version 2.1: Unterstützung für to_dict- und from_dict-Methoden

TrainingDocumentInfo

Bericht für ein einzelnes Dokument, das zum Trainieren eines benutzerdefinierten Modells verwendet wird.

Neu in Version 2.1: Die model_id-Eigenschaft, Unterstützung für to_dict- und from_dict-Methoden

Enumerationen

AnalysisFeature

Zu aktivierende Dokumentanalysefeatures.

CustomFormModelStatus

Status, der die Bereitschaft des Modells zur Verwendung angibt.

DocumentAnalysisApiVersion

Formularerkennung API-Versionen, die von DocumentAnalysisClient und DocumentModelAdministrationClient unterstützt werden.

FieldValueType

Semantischer Datentyp des Feldwerts.

Neu in Version 2.1: Die Werte selectionMark und countryRegion

FormContentType

Inhaltstyp für den Upload.

Neu in Version 2.1: Unterstützung für image/bmp

FormRecognizerApiVersion

Formularerkennung API-Versionen, die von FormRecognizerClient und FormTrainingClient unterstützt werden.

LengthUnit

Die Einheit, die von den Eigenschaften Breite, Höhe und Begrenzungsrahmen verwendet wird. Bei Bildern ist die Einheit "Pixel". Für PDF ist die Einheit "Inch".

ModelBuildMode

Der Modus, der beim Erstellen benutzerdefinierter Modelle verwendet wird.

Weitere Informationen finden Sie unter https://aka.ms/azsdk/formrecognizer/buildmode.

TrainingStatus

Status des Trainingsvorgangs.