契約スキーマ情報

契約エンリッチメントは、プロジェクトに追加される文書の html フィールドに適用されます。

ドキュメントが契約エンリッチメントによって処理された後、サービスは以下のスキーマでJSON出力を生成します

{
  "elements": [
    {
      "location": {
        "begin": int,
        "end": int
      },
      "text": string,
      "types": [
        {
          "label": { "nature": string, "party": string },
          "provenance_ids": [string, string, ...]
            ...
          ]
        }
        ...
      ],
      "categories": [
        {
          "label": string,
          "provenance_ids": [string, string, ...]
        }
        ...
      ],
      "attributes": [
        {
          "type": string,
          "text": string,
          "location": { "begin": int, "end": int }
         }
      ]
    }
    ...
  ],
  "effective_dates": [
    {
      "confidence_level": string,
      "text": string,
      "text_normalized": string,
      "provenance_ids": [ string, string, ... ],
      "location": { "begin": int, "end": int }
     },
     ...
  ],
  "contract_amounts": [
    {
      "confidence_level": string,
      "text": string,
      "text_normalized": string,
      "interpretation": {
        "value": string,
        "numeric_value": number,
        "unit": string,
      },
      "provenance_ids": [ string, string, ... ],
      "location": { "begin": int, "end": int }
    },
    ...
  ],
  "termination_dates": [
    {
      "confidence_level": string,
      "text": string,
      "text_normalized": string,
      "provenance_ids": [ string, string, ... ],
      "location": { "begin": int, "end": int }
    },
    ...
  ],
  "contract_types": [
    {
      "confidence_level": string,
      "text": string,
      "provenance_ids": [ string, string, ... ],
      "location": { "begin": int, "end": int }
    },
    ...
  ],
  "contract_terms": [
    {
      "confidence_level": string,
      "text": string,
      "text_normalized": string,
      "interpretation": {
        "value": string,
        "numeric_value": number,
        "unit": string,
      },
      "provenance_ids": [ string, string, ... ],
      "location": { "begin": int, "end": int }
    },
    ...
  ],
  "payment_terms": [
    {
      "confidence_level": string,
      "text": string,
      "text_normalized": string,
      "interpretation": {
        "value": string,
        "numeric_value": number,
        "unit": string,
      },
      "provenance_ids": [ string, string, ... ],
      "location": { "begin": int, "end": int }
    },
    ...
  ],
  "contract_currencies": [
    {
      "confidence_level" : string,
      "text" : string,
      "text_normalized" : string,
      "provenance_ids": [string, string ..],
      "location": { "begin": int, "end": int }
    },
  ...
],
  "tables": [],
  "document_structure": {
    "section_titles": [
      {
        "text": string,
        "location": {
          "begin": int,
          "end": int
        },
        "level": int,
        "element_locations": [
          {
            "begin": int,
            "end": int
          },
          ...
        ]
      },
      ...
    ],
    "leading_sentences": [
      {
        "text": string,
        "location": {
          "begin": int,
          "end": int
        },
        "element_locations": [
          {
            "begin": int,
            "end": int
          },
          ...
        ],
    "paragraphs": [
      {
        "location": {
           "begin": int,
           "end": int
         }
      },
      ...
    ]
      },
      ...
    ]
  },
  "parties": [
    {
      "party": string,
      "role": string,
      "importance": string,
      "addresses": [
        {
          "text": string,
          "location": {
            "begin": int,
            "end": int
          }
        },
        ...
      ],
      "contacts": [
        {
          "name": string,
          "role": string
        },
        ...
      ],
      "mentions": [
        {
          "text": string,
          "location": {
            "begin": int,
            "end": int
          }
        },
        ...
      ]
    },
    ...
  ]
}

スキーマの構造

contracts スキーマの構造を以下に示します。

• elements: 本サービスによって検出された文書要素の配列。

  • location: 要素の位置を示すオブジェクト。 このオブジェクトには、begin と end の 2 つの指標番号が含まれます。 索引番号は、HTML 内のエレメントを構成する文字の開始位置と終了位置を示します。

  • text: 要素のテキスト。

  • types: 要素の種類とその影響を受ける対象者を記述した配列。

    • label: 以下の要素のペアを使用してタイプを定義するオブジェクト。

      • nature: センテンスに必要なアクションのタイプ。 現行値は、Definition、Disclaimer、Exclusion、Obligation、および Right です。
      • party: センテンスが適用されるパーティーを識別するストリング。

    • provenance_ids: フィードバックを提供したりサポートを受けたりするために IBM に送信できる 1 つ以上のハッシュ値の配列。

  • categories: 要素が分類される機能カテゴリー、つまり要素の主題をリストした配列。

    • label: 識別されたカテゴリーをリストしたストリング。 カテゴリーのリストについては、 カテゴリー を参照してください。
    • provenance_ids: フィードバックを提供したりサポートを受けたりするために IBM に送信できる 1 つ以上のハッシュ値の配列。

  • attributes: 文書の属性を識別する配列。 配列内の各オブジェクトは、以下の 3 つの要素で構成されます。

    • type: 属性のタイプ。 使用可能な値は、 Currency 、 DateTime 、 Duration 、 Location 、 Number 、 Organization 、 Percentage 、 Person です。 詳細は「属性」を参照してください。
    • text: 属性と関連付けられているテキスト。
    • location: 属性の begin 索引と end 索引によって定義される属性の位置。

• effective_dates: 文書の発行日を示す配列。

  • confidence_level: 発効日の識別についての信頼度レベル。 取り得る値は、High、Medium、Low です。
  • text: ストリングとしてリストされる発効日。
  • text_normalized: 正規形の発効日。文字列としてリストされます。 この要素はオプションです。つまり、正規化されたテキストが存在する場合にのみ、出力中にリストされます。
  • location: 日付の begin 指標と end 指標によって定義される日付の位置。
  • provenance_ids: ゼロ個以上のキーが入った配列。 それぞれのキーにはハッシュ値があり、これを IBM に送信して、フィードバックを送信したりサポートを受けたりすることができます。

• contract_amounts: あるパーティーが別のパーティーに支払う必要がある契約金の総額を示す金額の配列。

  • confidence_level: 契約金額の識別についての信頼度レベル。 取り得る値は、High、Medium、Low です。
  • text: ストリングとしてリストされる契約金額。
  • location: 金額の begin 索引と end 索引によって定義される金額の位置。
  • provenance_ids: ゼロ個以上のキーが入った配列。 それぞれのキーにはハッシュ値があり、これを IBM に送信して、フィードバックを送信したりサポートを受けたりすることができます。

• termination_dates: 文書の終了日を示す配列。

  • confidence_level: 終了日の識別についての信頼度レベル。 取り得る値は、High、Medium、Low です。
  • text: ストリングとしてリストされる終了日。
  • text_normalized: 正規形の終了日。文字列としてリストされます。 この要素はオプションです。つまり、正規化されたテキストが存在する場合にのみ、出力中にリストされます。
  • location: 日付の begin 指標と end 指標によって定義される日付の位置。
  • provenance_ids: ゼロ個以上のキーが入った配列。 それぞれのキーにはハッシュ値があり、これを IBM に送信して、フィードバックを送信したりサポートを受けたりすることができます。

• contract_types: 文書の契約タイプを示す配列。

  • confidence_level: 契約タイプの識別についての信頼度レベル。 取り得る値は、High、Medium、Low です。
  • text: 契約タイプ。文字列としてリストされます。
  • provenance_ids: ゼロ個以上のキーが入った配列。 それぞれのキーにはハッシュ値があり、これを IBM に送信して、フィードバックを送信したりサポートを受けたりすることができます。
  • location: begin 指標と end 指標で定義される契約タイプの位置。

• contract_terms: 契約の期間を示す配列。

  • confidence_level: 契約期間の識別についての信頼度レベル。 取り得る値は、High、Medium、Low です。
  • text: 契約期間。文字列としてリストされます。
  • provenance_ids: ゼロ個以上のキーが入った配列。 それぞれのキーにはハッシュ値があり、これを IBM に送信して、フィードバックを送信したりサポートを受けたりすることができます。
  • location: begin 指標と end 指標で定義される契約期間の位置。

• payment_terms: 文書の支払期間を示す配列。

  • confidence_level: 支払期間の識別についての信頼度レベル。 取り得る値は、High、Medium、Low です。

  • text: 支払期間。文字列としてリストされます。

  • text_normalized: 正規化されたテキスト (該当する場合)。

  • interpretation: 正規化されたテキストの詳細 (該当する場合)。

    • value: 正規化されたテキスト中で検出された値をリストした文字列。

    • numeric_value: value キーの数値を表す整数または倍精度数。

    • unit: 正規化されたテキストで検出された値の単位をリストした文字列。

      unit の値は 、通貨コード（ ISO-4217 ） で識別される通貨の金額です（例えば、 USD または EUR ）。 サービスが通貨記号 (例えば、 $ または £) を明確にできない場合、あいまいな記号自体は unit 値として保管されます。

  • provenance_ids: ゼロ個以上のキーが入った配列。 それぞれのキーにはハッシュ値があり、これを IBM に送信して、フィードバックを送信したりサポートを受けたりすることができます。

  • location: begin 指標と end 指標で定義される契約期間の位置。

• contract_currencies: ドキュメントの契約通貨を特定する配列。

  • confidence_level: 契約通貨の識別についての信頼度レベル。 取り得る値は、High、Medium、Low です。
  • text: 契約通貨。文字列としてリストされます。
  • text_normalized: 正規化されたテキスト (該当する場合)。 文字列としてフォーマットで表示されます。 ISO-4217 フォーマット
  • provenance_ids: ゼロ個以上のキーが入った配列。 それぞれのキーにはハッシュ値があり、これを IBM に送信して、フィードバックを送信したりサポートを受けたりすることができます。
  • location: begin 指標と end 指標で定義される契約通貨の位置。

• document_structure: 入力文書の構造を記述したオブジェクト。

  • section_titles: 入力文書内で検出されたセクションまたはサブセクションごとに 1 つのオブジェクトを含んだ配列。 セクションおよびサブセクションはネストされません。 代わりに、エレメントのbegin値とend値、およびセクションのlevel値を使用して、フラット化され、順序どおりに戻すことができます。

    • text: セクション・タイトルをリストしたストリング (検出された場合)。
    • location: タイトルの begin 索引と end 索引によって定義される、入力文書内でのタイトルの位置。
    • level: 入力文書内でセクションが配置されていたレベルを示す整数。 例えば、ルートレベルのセクションを表し、レベルセクション内のサブセクションを表します。
    • element_locations: セクション内のセンテンスの begin 値と end 値を示す配列。

  • leading_sentences: リストまたはサブセクションのリード文ごとに 1 つのオブジェクトが入った配列。section_titles 配列および paragraph 配列と並列に配置されます。 このオブジェクトには、対応するセクションまたはサブセクション内のリード文の詳細が入っています。 section_titles 配列の場合と同様に、オブジェクトはネストされません。 その代わり、それらは平坦化され、要素の begin および end 値、または入力文書内の任意のレベルマーカーを使用して元の順序に戻すことができます。

    • text: リード文をリストしたストリング (検出された場合)。
    • location: リード文の begin 索引と end 索引によって定義される、入力文書内でのリード文の位置。
    • element_locations: セクション内のリード文の begin 値と end 値を示す配列。

  • paragraphs: section_titles および leading_sentences の配列と並列に、段落ごとに1つのオブジェクトを含む配列。 各オブジェクトには、対応する段落の範囲 (開始位置と終了位置) がリストされます。

    • location: begin 指標と end 指標で定義される、段落の入力文書内での位置。

• parties: 本サービスによって識別されたパーティーを定義する配列。

  • party: パーティーの名前の正規形を示す文字列。

  • role: パーティーの役割を示す文字列。

  • importance: パーティーの重要度を表す文字列。 取り得る値は、Primary (主要なパーティー) および Unknown (主要でないパーティー) です。

  • addresses: アドレスを識別するオブジェクトの配列。

    • text: アドレスを含んだストリング。
    • location: アドレスの begin 索引と end 索引によって定義されるアドレスの位置。

  • contacts: 入力文書内で識別された連絡先の名前と役割を定義する配列。

    • name: 識別された連絡先の名前をリストしたストリング。
    • role: 識別された連絡先の役割をリストしたストリング。

  • mentions: パーティーの言及を示すオブジェクトの配列。

    • text: パーティーの名前をリストした文字列。
    • location: begin 指標と end 指標で定義される言及の位置。

{
  ...
  "location": {
    "begin": 2510,
    "end": 2519
  }
  ...
}

文書構造

Contractsエンリッチメントの出力には、入力文書の構造組成の詳細を示す document_structure オブジェクトが含まれます。 文書構造情報は、以下の JSON サンプルで表されています。 オブジェクトはルートレベルの tables 配列の直後に位置しています。

"document_structure": {
  "section_titles": [
    {
      "text": string,
      "location": {
        "begin": int,
        "end": int
      },
      "level": int
      "element_locations": [
        {
          "begin": int,
          "end": int
        },
        ...
      ]
    },
    ...
  ],
  "leading_sentences": [
    {
      "text": string,
      "location": {
        "begin": int,
        "end": int
      },
      "element_locations": [
        {
          "begin": int,
          "end": int
        },
        ...
      ]
    },
    ...
  ],
  "paragraphs": [
    {
      "location": {
        "begin": int,
        "end": int
      }
    },
    ...
  ]
}

エレメント

「契約」エンリッチメントは、契約内の識別された各要素の分析を生成します。 以下のセクションでは、生成されるエレメントの各タイプについて説明します。