メソッド

[ドキュメント データを抽出] アクティビティの [データ型を生成] の設定によって、ドキュメント データの出力の種類が決まります。

1. [データを生成] がTrueされている場合、ドキュメント データはIDocumentData<ExtractorType>として出力されます。
2. [データを生成] がFalseされている場合、ドキュメント データはIDocumentData<DictionaryData>として出力されます。

IDocumentData<DictionaryData> 型を使用すると、特定のメソッドを使用してフィールド値を取得および変更できます。検証ステーションでドキュメントの種類を変更することもできます。

以降のセクションでは、DocumentData.Data で利用可能なメソッドを示します。

注:

fieldIdOrName パラメーターは、フィールドの ID と名前の両方として扱われます。

GetFields()

ドキュメントの種類内のフィールド (テーブル フィールド以外) からすべての情報を返します。

構文

GetFields()

戻り値

ResultsDataPoint[]

すべてのフィールドとそれらに関連する抽出値の配列です。

例

このメソッドの使用方法については、以下の例をご覧ください。

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

GetField(string)

指定されたフィールド ID または名前に基づいて、すべてのフィールド情報を返します。

構文

GetField(string fieldIdOrName)

パラメーター

• fieldIdOrName 文字列: 取得または設定するフィールドの ID または名前です。このメソッドは最初に ID を使用して、一致するものを検索します。一致するものが見つからない場合は、フィールド名と同じ値を使用して検索します。

  フィールド ID と名前は、以下の方法で確認できます。

  • プロジェクトの [構築] セクションに移動します。サンプル ドキュメントの [ドキュメントの種類マネージャー] を選択します。[フィールド] に進み、該当のフィールドの [詳細設定] を選択します。

  

  • 検証ステーションを開き、[ドキュメントの種類] で既存のフィールド名を検索します。
  • Document Understanding API を使用している場合は、Discovery サービス内の API を使用してフィールド名と ID を取得できます。利用可能な API 呼び出しを確認するには、「Discovery API を使用する」をご覧ください。

戻り値

ResultsDataPoint

フィールドとそれに関連する抽出値です。

例

目的のフィールド ID または名前が vendor の場合のメソッドの使用については、以下の例をご覧ください。

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

GetFieldValue(string)

指定されたフィールド ID または名前に基づいて、最初のフィールド値を返します。

構文

GetFieldValue(string fieldIdOrName)

パラメーター

• fieldIdOrName 文字列: 取得または設定するフィールドの ID または名前です。このメソッドは最初に ID を使用して、一致するものを検索します。一致するものが見つからない場合は、フィールド名と同じ値を使用して検索します。

  フィールド ID と名前は、以下の方法で確認できます。

  • プロジェクトの [構築] セクションに移動します。サンプル ドキュメントの [ドキュメントの種類マネージャー] を選択します。[フィールド] に進み、該当のフィールドの [詳細設定] を選択します。

  

  • 検証ステーションを開き、[ドキュメントの種類] で既存のフィールド名を検索します。
  • Document Understanding API を使用している場合は、Discovery サービス内の API を使用してフィールド名と ID を取得できます。利用可能な API 呼び出しを確認するには、「Discovery API を使用する」をご覧ください。

戻り値

ResultsValue

抽出結果のフィールドに対して報告される値です。

例外

fieldIdOrName が見つからない場合は、「Field {FieldIDOrName} not found (フィールド {FieldIDOrName} が見つかりません)」という例外がスローされます。

例

フィールド ID または名前が vendor の場合のメソッドの使用については、次の例をご覧ください。

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)

指定されたフィールド ID または名前、およびフィールド index に基づいてフィールド値を返し、値の配列から特定の値を返します。

このメソッドは、単純フィールドに適用されます。

構文

GetFieldValue(string fieldIdOrName, int index)

パラメーター

• fieldIdOrName 文字列: 取得または設定するフィールドの ID または名前です。このメソッドは最初に ID を使用して、一致するものを検索します。一致するものが見つからない場合は、フィールド名と同じ値を使用して検索します。

  フィールド ID と名前は、以下の方法で確認できます。

  • プロジェクトの [構築] セクションに移動します。サンプル ドキュメントの [ドキュメントの種類マネージャー] を選択します。[フィールド] に進み、該当のフィールドの [詳細設定] を選択します。

  

  • 検証ステーションを開き、[ドキュメントの種類] で既存のフィールド名を検索します。
  • Document Understanding API を使用している場合は、Discovery サービス内の API を使用してフィールド名と ID を取得できます。利用可能な API 呼び出しを確認するには、「Discovery API を使用する」をご覧ください。

• index int : 特定の値のインデックスです。

戻り値

ResultsValue

抽出結果のフィールドに対して報告される値です。

例外

• fieldIdOrName が見つからない場合は、「Field {FieldIDOrName} not found (フィールド {FieldIDOrName} が見つかりません)」という例外がスローされます。
• index が見つからない場合は、「インデックスは範囲外です。」という例外がスローされます。

例

フィールド ID が vendor で、目的の値のインデックスが 2 であるメソッドの使用については、以下の例をご覧ください。

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)

指定されたフィールド ID または名前に基づいて、ドキュメントの種類のフィールドのすべての値を返します。

このメソッドは複数値フィールドだけでなく、抽出モデルが代替値を提供するフィールドにも適用されます。つまり、本来は複数値フィールドではないフィールドでも、複数の代替値を持つことができます。

構文

GetFieldValues(string fieldIdOrName)

パラメーター

• fieldIdOrName 文字列: 取得または設定するフィールドの ID または名前です。このメソッドは最初に ID を使用して、一致するものを検索します。一致するものが見つからない場合は、フィールド名と同じ値を使用して検索します。

  フィールド ID と名前は、以下の方法で確認できます。

  • プロジェクトの [構築] セクションに移動します。サンプル ドキュメントの [ドキュメントの種類マネージャー] を選択します。[フィールド] に進み、該当のフィールドの [詳細設定] を選択します。

  

  • 検証ステーションを開き、[ドキュメントの種類] で既存のフィールド名を検索します。
  • Document Understanding API を使用している場合は、Discovery サービス内の API を使用してフィールド名と ID を取得できます。利用可能な API 呼び出しを確認するには、「Discovery API を使用する」をご覧ください。

戻り値

ResultsValue[]

抽出結果のフィールドについて報告される値の配列です。

例外

fieldIdOrName が見つからない場合は、「Field {FieldIDOrName} not found (フィールド {FieldIDOrName} が見つかりません)」という例外がスローされます。

例

フィールド ID が vendor の場合のメソッドの使用については、次の例をご覧ください。

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

GetTables()

ドキュメントの種類内のすべてのテーブルからすべてのフィールド情報を返します。

構文

GetTables()

戻り値

ResultsTable[]

配列として抽出された表フィールドです。1 つ以上の ResultsTableValues が含まれます (単一値の表と複数値の表がサポートされます)。各値には、ResultsTableCell の配列が含まれています。各セルには、単純フィールドに使用される標準値オブジェクトである ResultsValue の配列が含まれています。

例

このメソッドの使用方法については、以下の例をご覧ください。

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

GetTable(string)

指定された ID に基づいて、ドキュメントの種類内のテーブルからすべてのフィールド情報を返します。

構文

GetTable(string tableID)

パラメーター

• tableID string : 取得するテーブルの ID です。テーブル ID は、プロジェクトの [構築 ] セクションに移動することで確認できます。サンプル ドキュメントの [ ドキュメントの種類マネージャー ] を選択します。[フィールド] に進み、該当のテーブル フィールドの [詳細設定] を選択します。

戻り値

ResultsTable

抽出された表フィールドです。1 つ以上の ResultsTableValues が含まれます (単一値の表と複数値の表がサポートされます)。各値には、ResultsTableCell の配列が含まれています。各セルには、単純フィールドに使用される標準値オブジェクトである ResultsValue の配列が含まれています。

例

表 ID が prices の場合のメソッドの使用については、次の例をご覧ください。

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

SetFieldValue(string, ResultsValue)

フィールド ID で識別される値の配列全体を、指定した値で上書きします。

構文

SetFieldValue(string fieldID, ResultsValue value)

パラメーター

• fieldIdOrName 文字列: 取得または設定するフィールドの ID または名前です。このメソッドは最初に ID を使用して、一致するものを検索します。一致するものが見つからない場合は、フィールド名と同じ値を使用して検索します。

  フィールド ID と名前は、以下の方法で確認できます。

  • プロジェクトの [構築] セクションに移動します。サンプル ドキュメントの [ドキュメントの種類マネージャー] を選択します。[フィールド] に進み、該当のフィールドの [詳細設定] を選択します。

  

  • 検証ステーションを開き、[ドキュメントの種類] で既存のフィールド名を検索します。
  • Document Understanding API を使用している場合は、Discovery サービス内の API を使用してフィールド名と ID を取得できます。利用可能な API 呼び出しを確認するには、「Discovery API を使用する」をご覧ください。

• value ResultsValue : フィールドに設定する値です。

例外

fieldID が見つからない場合は、「Field {FieldIDOrName} not found (フィールド {FieldIDOrName} が見つかりません)」という例外がスローされます。

例

このメソッドの使用例では、最初にヘルパー メソッドResultsValue.CreateWithNoReference を使用してフィールド値を作成します。ヘルパー メソッドは、以下のパラメーターを受け取ります。

• 最初のパラメーターは値を表します。
• 2 番目のパラメーターは信頼度を表します。
• 3 番目のパラメーターは OCR の信頼度を表します。

フィールド値オブジェクト taxValue を作成した後、tax フィールドの既存の値 (存在する場合) を、taxValue オブジェクトのみを含む新しい配列に置き換えます。この場合は、SetFieldValue を使用して、tax フィールドに新しい値 10 が適用されます。

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

SetFieldValue(string, ResultsValue, int)

指定したフィールド ID または名前、およびフィールド インデックスに基づいて、フィールド値を設定します。

このメソッドは、単純フィールドに適用されます。

構文

SetFieldValue(string fieldID, ResultsValue value, int index)

パラメーター

• fieldIdOrName 文字列: 取得または設定するフィールドの ID または名前です。このメソッドは最初に ID を使用して、一致するものを検索します。一致するものが見つからない場合は、フィールド名と同じ値を使用して検索します。

  フィールド ID と名前は、以下の方法で確認できます。

  • プロジェクトの [構築] セクションに移動します。サンプル ドキュメントの [ドキュメントの種類マネージャー] を選択します。[フィールド] に進み、該当のフィールドの [詳細設定] を選択します。

  

  • 検証ステーションを開き、[ドキュメントの種類] で既存のフィールド名を検索します。
  • Document Understanding API を使用している場合は、Discovery サービス内の API を使用してフィールド名と ID を取得できます。利用可能な API 呼び出しを確認するには、「Discovery API を使用する」をご覧ください。

• value ResultsValue : フィールドに設定する値です。

• index int : 特定の値のインデックスです。

例外

• fieldID が見つからない場合は、「Field {FieldIDOrName} not found (フィールド {FieldIDOrName} が見つかりません)」という例外がスローされます。
• index が見つからない場合は、「インデックスは範囲外です。」という例外がスローされます。

例

このメソッドの使用例では、最初にヘルパー メソッドResultsValue.CreateWithNoReference を使用してフィールド値を作成します。ヘルパー メソッドは、以下のパラメーターを受け取ります。

• 最初のパラメーターは、値の配列を表します。
• 2 番目のパラメーターは信頼度を表します。
• 3 番目のパラメーターは OCR の信頼度を表します。

フィールド値オブジェクト taxValue を作成した後、フィールド配列 tax のインデックス 1 の値をこの新しい taxValue オブジェクトに置き換えます。ここでは、SetFieldValue メソッドを使用して、インデックス 1 の値を置き換えます。

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

SetFieldValues(string, ResultsValue[])

指定されたフィールド ID または名前に対して、値の配列全体を別の指定された値の配列に置き換えます。

構文

SetFieldValues(string fieldID, ResultsValue[] values)

パラメーター

• fieldIdOrName 文字列: 取得または設定するフィールドの ID または名前です。このメソッドは最初に ID を使用して、一致するものを検索します。一致するものが見つからない場合は、フィールド名と同じ値を使用して検索します。

  フィールド ID と名前は、以下の方法で確認できます。

  • プロジェクトの [構築] セクションに移動します。サンプル ドキュメントの [ドキュメントの種類マネージャー] を選択します。[フィールド] に進み、該当のフィールドの [詳細設定] を選択します。

  

  • 検証ステーションを開き、[ドキュメントの種類] で既存のフィールド名を検索します。
  • Document Understanding API を使用している場合は、Discovery サービス内の API を使用してフィールド名と ID を取得できます。利用可能な API 呼び出しを確認するには、「Discovery API を使用する」をご覧ください。

• values ResultsValue[] : フィールドに設定する値の配列です。

例外

fieldID が見つからない場合は、「Field {FieldIDOrName} not found (フィールド {FieldIDOrName} が見つかりません)」という例外がスローされます。

例

このメソッドの使用例では、最初に ResultsValue.CreateWithNoReference ヘルパーメソッド total1 と total2 を使用して 2 つのフィールド値オブジェクトを作成します。ヘルパー メソッドでは、次の 3 つのパラメーターを使用できます。

1. 最初のパラメーターは実際の値を表します。
2. 2 番目のパラメーターは信頼度の値を表します。
3. 3 番目のパラメーターは、OCR の信頼度の値を表します。

これらのフィールド値を作成した後、Total Amount という名前のフィールドの値を、total1 と total2 を含む配列に置き換えます。

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