Methoden

Die Einstellung Datentyp generieren in der Aktivität „Extract Document Data“ bestimmt die Ausgabetypen der Dokumentdaten:

1. Wenn Daten generieren True festgelegt ist, werden Dokumentdaten als IDocumentData<ExtractorType> ausgegeben.
2. Wenn Daten generieren False festgelegt ist, werden Dokumentdaten als IDocumentData<DictionaryData> ausgegeben.

Der Typ IDocumentData<DictionaryData> ermöglicht es Ihnen, Feldwerte mithilfe bestimmter Methoden abzurufen und zu ändern. Sie können den Dokumenttyp auch in der Validierungsstation ändern.

Die folgenden Abschnitte zeigen die verfügbaren Methoden für DocumentData.Data.

Hinweis:

Der fieldIdOrName -Parameter wird sowohl als Bezeichner als auch als Name des Felds behandelt.

GetFields()

Gibt alle Informationen aus Feldern innerhalb eines Dokumenttyps mit Ausnahme von Tabellenfeldern zurück.

Syntax

GetFields()

Rückgabewert

ResultsDataPoint[]

Ein Array aller Felder und deren zugehörige extrahierte Werte.

Beispiel

Sehen Sie sich das folgende Beispiel für die Verwendung der Methode an:

ResultsDataPoint[] allFields = DocumentData.Data.GetFields()

GetField(string)

Gibt alle Feldinformationen basierend auf einer bestimmten Feld-ID oder einem bestimmten Namen zurück.

Syntax

GetField(string fieldIdOrName)

Parameter

• fieldIdOrName Zeichenfolge: Die ID oder der Name des Felds, das Sie abrufen oder festlegen möchten. Die Methode sucht zuerst nach einer Übereinstimmung mithilfe der ID. Wenn keine Übereinstimmung gefunden wird, wird mit dem gleichen Wert wie der Name des Feldes gesucht.

  Sie können die Feld-ID und den Namen auf folgende Arten ermitteln:

  • Navigieren Sie zum Abschnitt Erstellen Ihres Projekts. Wählen Sie Dokumenttypmanager für ein Beispieldokument aus. Fahren Sie mit Felder fort und wählen Sie dann Erweiterte Einstellungen für das relevante Feld aus.

  

  • Öffnen Sie die Validation Station und suchen Sie unter Dokumenttyp nach vorhandenen Feldnamen.
  • Wenn Sie Document Understanding-APIs verwenden, können Sie die APIs im Erkennungsdienst verwenden, um die Feldnamen und IDs abzurufen. Unter Verwenden der Erkennungs-APIs finden Sie die verfügbaren API-Aufrufe.

Rückgabewert

ResultsDataPoint

Das Feld und die zugehörigen extrahierten Werte.

Beispiel

Überprüfen Sie das folgende Beispiel für die Verwendung der Methode, wenn die gewünschte Feld-ID oder der gewünschte Name vendor ist:

ResultsDataPoint vendorData = DocumentData.Data.GetField("vendor");

GetFieldValue(string)

Gibt den ersten Feldwert basierend auf einer bestimmten Feld-ID oder einem bestimmten Namen zurück.

Syntax

GetFieldValue(string fieldIdOrName)

Parameter

• fieldIdOrName String Die ID oder der Name des Felds, das Sie abrufen oder festlegen möchten. Die Methode sucht zuerst nach einer Übereinstimmung mithilfe der ID. Wenn keine Übereinstimmung gefunden wird, wird mit dem gleichen Wert wie der Name des Feldes gesucht.

  Sie können die Feld-ID und den Namen auf folgende Arten ermitteln:

  • Navigieren Sie zum Abschnitt Erstellen Ihres Projekts. Wählen Sie Dokumenttypmanager für ein Beispieldokument aus. Fahren Sie mit Felder fort und wählen Sie dann Erweiterte Einstellungen für das relevante Feld aus.

  

  • Öffnen Sie die Validation Station und suchen Sie unter Dokumenttyp nach vorhandenen Feldnamen.
  • Wenn Sie Document Understanding-APIs verwenden, können Sie die APIs im Erkennungsdienst verwenden, um die Feldnamen und IDs abzurufen. Unter Verwenden der Erkennungs-APIs finden Sie die verfügbaren API-Aufrufe.

Rückgabewert

ResultsValue

Der Wert, der für ein Feld in einem Extraktionsergebnis gemeldet wird.

Ausnahmen

Wenn fieldIdOrName nicht gefunden wird, wird die folgende Ausnahme ausgelöst: Field {FieldIDOrName} nicht gefunden.

Beispiel

Überprüfen Sie das folgende Beispiel für die Verwendung der Methode, wenn die Feld-ID oder der Name vendor ist:

ResultsValue fieldValue = DocumentData.Data.GetFieldValue("vendor");
    // stores the value of the fieldValue object in a string variable
    string value = fieldValue.Value;
    // stores the confidence of the fieldValue object in a float variable
    float confidence = fieldValue.Confidence;

GetFieldValue(string, int)

Gibt einen Feldwert basierend auf einer bestimmten Feld-ID oder einem bestimmten Namen sowie dem Feld index zurück, um einen bestimmten Wert aus dem Wertearray zurückzugeben.

Diese Methode gilt für einfache Felder.

Syntax

GetFieldValue(string fieldIdOrName, int index)

Parameter

• fieldIdOrName String Die ID oder der Name des Felds, das Sie abrufen oder festlegen möchten. Die Methode sucht zuerst nach einer Übereinstimmung mithilfe der ID. Wenn keine Übereinstimmung gefunden wird, wird mit dem gleichen Wert wie der Name des Feldes gesucht.

  Sie können die Feld-ID und den Namen auf folgende Arten ermitteln:

  • Navigieren Sie zum Abschnitt Erstellen Ihres Projekts. Wählen Sie Dokumenttypmanager für ein Beispieldokument aus. Fahren Sie mit Felder fort und wählen Sie dann Erweiterte Einstellungen für das relevante Feld aus.

  

  • Öffnen Sie die Validation Station und suchen Sie unter Dokumenttyp nach vorhandenen Feldnamen.
  • Wenn Sie Document Understanding-APIs verwenden, können Sie die APIs im Erkennungsdienst verwenden, um die Feldnamen und IDs abzurufen. Unter Verwenden der Erkennungs-APIs finden Sie die verfügbaren API-Aufrufe.

• index Int : Der Index eines bestimmten Werts.

Rückgabewert

ResultsValue

Der Wert, der für ein Feld in einem Extraktionsergebnis gemeldet wird.

Ausnahmen

• Wenn fieldIdOrName nicht gefunden wird, wird die folgende Ausnahme ausgelöst: Field {fieldIdOrName} nicht gefunden.
• Wenn index nicht gefunden wird, wird die folgende Ausnahme ausgelöst: Index is out of range.

Beispiel

Überprüfen Sie das folgende Beispiel für die Verwendung der Methode, wobei die Feld-ID vendor und der Index für den gewünschten Wert 2 ist:

ResultsValue fieldValue = DocumentData.Data.GetFieldValue("vendor", 2);
    // store the retrieved value in a string variable
    string value = fieldValue.Value;
    // retrieve and store the confidence level of the field value
    float confidence = fieldValue.Confidence

GetFieldValues(string)

Gibt alle Werte eines Felds aus einem Dokumenttyp basierend auf einer bestimmten Feld-ID oder einem angegebenen Feldnamen zurück.

Diese Methode gilt nicht nur für Felder mit mehreren Werten, sondern auch für Felder, für die das Extraktionsmodell alternative Werte bereitstellt. Das bedeutet, dass ein Feld mehr als einen Wert für Alternativen haben kann, auch wenn es nicht von Natur aus ein mehrwertiges Feld ist.

Syntax

GetFieldValues(string fieldIdOrName)

Parameter

• fieldIdOrName String Die ID oder der Name des Felds, das Sie abrufen oder festlegen möchten. Die Methode sucht zuerst nach einer Übereinstimmung mithilfe der ID. Wenn keine Übereinstimmung gefunden wird, wird mit dem gleichen Wert wie der Name des Feldes gesucht.

  Sie können die Feld-ID und den Namen auf folgende Arten ermitteln:

  • Navigieren Sie zum Abschnitt Erstellen Ihres Projekts. Wählen Sie Dokumenttypmanager für ein Beispieldokument aus. Fahren Sie mit Felder fort und wählen Sie dann Erweiterte Einstellungen für das relevante Feld aus.

  

  • Öffnen Sie die Validation Station und suchen Sie unter Dokumenttyp nach vorhandenen Feldnamen.
  • Wenn Sie Document Understanding-APIs verwenden, können Sie die APIs im Erkennungsdienst verwenden, um die Feldnamen und IDs abzurufen. Unter Verwenden der Erkennungs-APIs finden Sie die verfügbaren API-Aufrufe.

Rückgabewert

ResultsValue[]

Das Werte-Array, das für ein Feld in einem Extraktionsergebnis gemeldet wird.

Ausnahmen

Wenn fieldIdOrName nicht gefunden wird, wird die folgende Ausnahme ausgelöst: Field {fieldIdOrName} nicht gefunden.

Beispiel

Sehen Sie sich das folgende Beispiel für die Verwendung der Methode mit der Feld-ID vendor an.

ResultsValue[] fieldValues = DocumentData.Data.GetFieldValues("vendor");

GetTables()

Gibt alle Feldinformationen aus allen Tabellen innerhalb eines Dokumenttyps zurück.

Syntax

GetTables()

Rückgabewert

ResultsTable[]

Das extrahierte Tabellenfeld als Array, das ein oder mehrere ResultsTableValues (zur Unterstützung von Einzel- bzw. Mehrfachwerttabellen) enthält. Jeder Wert hat ein Array von ResultsTableCells. Jede Zelle verfügt über ein Array von ResultsValue, welches das Standardwertobjekt ist, das für einfache Felder verwendet wird.

Beispiel

Sehen Sie sich das folgende Beispiel für die Verwendung der Methode an:

ResultsTable[] tableValues = DocumentData.Data.GetTables();

GetTable(string)

Gibt alle Feldinformationen aus einer Tabelle innerhalb eines Dokumenttyps basierend auf einer angegebenen ID zurück.

Syntax

GetTable(string tableID)

Parameter

• tableID Zeichenfolge : Die ID der Tabelle, die Sie abrufen möchten. Sie finden die Tabellen-ID, indem Sie zum Abschnitt Erstellen Ihres Projekts navigieren. Wählen Sie Dokumenttypmanager für das Beispieldokument aus. Fahren Sie mit Felder fort und wählen Sie dann Erweiterte Einstellungen für das relevante Tabellenfeld aus.

Rückgabewert

ResultsTable

Das extrahierte Tabellenfeld, das ein oder mehrere ResultsTableValues (zur Unterstützung von Einzel- bzw. Mehrfachwerttabellen) enthält. Jeder Wert hat ein Array von ResultsTableCells. Jede Zelle verfügt über ein Array von ResultsValue, welches das Standardwertobjekt ist, das für einfache Felder verwendet wird.

Beispiel

Überprüfen Sie das folgende Beispiel für die Verwendung der Methode, bei der die Tabellen-ID prices ist:

var tableValues = DocumentData.Data.GetTable("prices");

SetFieldValue(string, ResultsValue)

Überschreibt ein gesamtes Array von Werten, die durch die Feld-ID identifiziert werden, mit dem angegebenen Wert.

Syntax

SetFieldValue(string fieldID, ResultsValue value)

Parameter

• fieldIdOrName String Die ID oder der Name des Felds, das Sie abrufen oder festlegen möchten. Die Methode sucht zuerst nach einer Übereinstimmung mithilfe der ID. Wenn keine Übereinstimmung gefunden wird, wird mit dem gleichen Wert wie der Name des Feldes gesucht.

  Sie können die Feld-ID und den Namen auf folgende Arten ermitteln:

  • Navigieren Sie zum Abschnitt Erstellen Ihres Projekts. Wählen Sie Dokumenttypmanager für ein Beispieldokument aus. Fahren Sie mit Felder fort und wählen Sie dann Erweiterte Einstellungen für das relevante Feld aus.

  

  • Öffnen Sie die Validation Station und suchen Sie unter Dokumenttyp nach vorhandenen Feldnamen.
  • Wenn Sie Document Understanding-APIs verwenden, können Sie die APIs im Erkennungsdienst verwenden, um die Feldnamen und IDs abzurufen. Unter Verwenden der Erkennungs-APIs finden Sie die verfügbaren API-Aufrufe.

• value ResultsValue : Der Wert, den Sie für ein Feld festlegen möchten.

Ausnahmen

Wenn fieldID nicht gefunden wird, wird die folgende Ausnahme ausgelöst: Field {FieldIDOrName} nicht gefunden.

Beispiel

Sehen Sie sich das folgende Beispiel für die Verwendung der Methode an, bei der wir zuerst den Feldwert mit der ResultsValue.CreateWithNoReference-Hilfsmethode erstellen. Die Hilfsmethode verwendet die folgenden Parameter:

• Der erste Parameter stellt den Wert dar.
• Der zweite Parameter stellt die Konfidenz dar.
• Der dritte Parameter stellt die OCR-Konfidenz dar.

Nach der Erstellung des taxValue-Feldwertobjekts ersetzen wir die potenziellen bereits vorhandenen Werte des tax-Felds (falls vorhanden) durch ein neues Array, das nur das taxValue-Objekt enthält. In diesem Fall nimmt das Feld tax den neuen Wert 10 an, da wir SetFieldValue verwenden.

var taxValue = ResultsValue.CreateWithNoReference("10", 1, 1);
documentData.Data.SetFieldValue("tax", taxValue);

SetFieldValue(string, ResultsValue, int)

Legt einen Feldwert basierend auf einer bestimmten Feld-ID oder einem angegebenen Feldnamen und einem Feldindex fest.

Diese Methode gilt für einfache Felder.

Syntax

SetFieldValue(string fieldID, ResultsValue value, int index)

Parameter

• fieldIdOrName String Die ID oder der Name des Felds, das Sie abrufen oder festlegen möchten. Die Methode sucht zuerst nach einer Übereinstimmung mithilfe der ID. Wenn keine Übereinstimmung gefunden wird, wird mit dem gleichen Wert wie der Name des Feldes gesucht.

  Sie können die Feld-ID und den Namen auf folgende Arten ermitteln:

  • Navigieren Sie zum Abschnitt Erstellen Ihres Projekts. Wählen Sie Dokumenttypmanager für ein Beispieldokument aus. Fahren Sie mit Felder fort und wählen Sie dann Erweiterte Einstellungen für das relevante Feld aus.

  

  • Öffnen Sie die Validation Station und suchen Sie unter Dokumenttyp nach vorhandenen Feldnamen.
  • Wenn Sie Document Understanding-APIs verwenden, können Sie die APIs im Erkennungsdienst verwenden, um die Feldnamen und IDs abzurufen. Unter Verwenden der Erkennungs-APIs finden Sie die verfügbaren API-Aufrufe.

• value ResultsValue : Der Wert, den Sie für ein Feld festlegen möchten.

• index Int : Der Index eines bestimmten Werts.

Ausnahmen

• Wenn fieldID nicht gefunden wird, wird die folgende Ausnahme ausgelöst: Field {FieldIDOrName} nicht gefunden.
• Wenn index nicht gefunden wird, wird die folgende Ausnahme ausgelöst: Index is out of range.

Beispiel

Sehen Sie sich das folgende Beispiel für die Verwendung der Methode an, bei der wir zuerst den Feldwert mit der ResultsValue.CreateWithNoReference-Hilfsmethode erstellen. Die Hilfsmethode verwendet die folgenden Parameter:

• Der erste Parameter stellt das Werte-Array dar.
• Der zweite Parameter stellt die Konfidenz dar.
• Der dritte Parameter stellt die OCR-Konfidenz dar.

Nach dem Erstellen des Feldwertobjekts taxValue ersetzen wir den Wert bei Index 1 des tax-Feldarrays durch dieses neue taxValue-Objekt. Hier wird die SetFieldValue-Methode verwendet, um den Wert bei Index 1 zu ersetzen.

var taxValue = ResultsValue.CreateWithNoReference("10", 1, 1);
documentData.Data.SetFieldValue("tax", new [] {taxValue}, 1);

SetFieldValues(string, ResultsValue[])

Ersetzt das gesamte Werte-Array durch ein anderes angegebenes Werte-Array für eine bestimmte Feld-ID oder einen Namen.

Syntax

SetFieldValues(string fieldID, ResultsValue[] values)

Parameter

• fieldIdOrName String Die ID oder der Name des Felds, das Sie abrufen oder festlegen möchten. Die Methode sucht zuerst nach einer Übereinstimmung mithilfe der ID. Wenn keine Übereinstimmung gefunden wird, wird mit dem gleichen Wert wie der Name des Feldes gesucht.

  Sie können die Feld-ID und den Namen auf folgende Arten ermitteln:

  • Navigieren Sie zum Abschnitt Erstellen Ihres Projekts. Wählen Sie Dokumenttypmanager für ein Beispieldokument aus. Fahren Sie mit Felder fort und wählen Sie dann Erweiterte Einstellungen für das relevante Feld aus.

  

  • Öffnen Sie die Validation Station und suchen Sie unter Dokumenttyp nach vorhandenen Feldnamen.
  • Wenn Sie Document Understanding-APIs verwenden, können Sie die APIs im Erkennungsdienst verwenden, um die Feldnamen und IDs abzurufen. Unter Verwenden der Erkennungs-APIs finden Sie die verfügbaren API-Aufrufe.

• values ResultsValue[]: Das Werte-Array, das Sie für ein Feld festlegen möchten.

Ausnahmen

Wenn fieldID nicht gefunden wird, wird die folgende Ausnahme ausgelöst: Field {FieldIDOrName} nicht gefunden.

Beispiel

Sehen Sie sich das folgende Beispiel für die Verwendung dieser Methode an, in dem wir zunächst mit der Hilfsmethode ResultsValue.CreateWithNoReference zwei Feldwertobjekte erstellen: total1 und total2. Die Hilfsmethode akzeptiert drei Parameter:

1. Der erste Parameter stellt den tatsächlichen Wert dar.
2. Der zweite Parameter stellt den Konfidenzwert dar.
3. Der dritte Parameter stellt den OCR-Konfidenzwert dar.

Nach der Erstellung dieser Feldwerte ersetzen wir die Werte eines Felds namens Total Amount durch ein Array, das total1 und total2 enthält.

var total1 = ResultsValue.CreateWithNoReference("100", 1, 1);
    var total2 = ResultsValue.CreateWithNoReference("200", 1, 1);
    documentData.Data.SetFieldValues("Total Amount", new []{total1, total2});