Document - ABBYY Documentation

Document repräsentiert das aktuell verarbeitete Dokument in einem Skript einer Benutzerdefinierten Aktivität, einschließlich seiner Felder, Seiten, Klassifizierungsergebnisse, Quelldateien und Exportergebnisse.

Je nachdem, welche Verarbeitungsstufen bereits abgeschlossen sind, können einige Eigenschaften leere Werte zurückgeben. Beispielsweise sind vor Anwendung eines Skills nur DocumentId und SourceFiles verfügbar. ResultClass ist verfügbar, nachdem ein Klassifizierungs‑Skill ausgeführt wurde. Fields ist nach der Extraktion verfügbar.

Eigenschaften

Name	Typ	Zugriff	Beschreibung
ClassConfidences	ClassConfidenceModel[]	Schreibgeschützt	Die Konfidenzwerte für jede Klasse.
DocumentId	string	Schreibgeschützt	Die eindeutige ID des Dokuments.
DocumentSkillId	string	Schreibgeschützt	Die eindeutige Kennung des auf das Dokument angewendeten Document-Skills.
DocumentSkillName	string	Schreibgeschützt	Der Name des auf das Dokument angewendeten Document-Skills.
Fields	Field[]	Schreibgeschützt	Im Dokument erkannte Felder. Wird nur nach Ausführung eines Document-Skills befüllt.
IsResultClassConfident	bool	Schreibgeschützt	`true`, wenn die Klasse des Dokuments mit ausreichendem Konfidenzwert bestimmt wurde.
Pages	Page[]	Schreibgeschützt	Die Seiten des Dokuments.
ResultClass	string	Schreibgeschützt	Die vom Klassifizierungs‑Skill zugewiesene Klasse. Leer, wenn das Dokument nicht klassifiziert wurde.
RuleErrors	RuleError[]	Schreibgeschützt	Fehler bei den Validierungsregeln für die Feldextraktion.
SourceFiles	BinaryFile[]	Schreibgeschützt	Quelldateien des Dokuments. Enthält die Bilder vor der Vorverarbeitung. Quellmetadaten (einschließlich EXIF-Daten) bleiben bei JPEGs erhalten.
Exports	ResultFiles	Lese-/Schreibzugriff	Exportergebnisse des Dokuments.
RegistrationParameters	`Record<string, Parameter>`	Schreibgeschützt	Wörterbuch mit den Registrierungsparametern der Quelldatei für die erste Seite. Die Schlüssel sind Parameternamen, die Werte `Parameter`-Objekte.

ClassConfidences und IsResultClassConfident werden nur befüllt, wenn ein Klassifizierungs‑Skill angewendet wurde.

Methoden

ToJsonString

string ToJsonString();

Gibt die Dokumentdaten als JSON-formatierte string zurück.

GetField

Field GetField(string fieldName);

Gibt das Field-Objekt für das angegebene Feld zurück.