合約綱目資訊

合約強化會套用至新增至專案之文件的 html 欄位。

在 Contracts enrichment 處理完文件後，服務會以下列模式產生 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。 索引號碼指出構成 HTML 中元素之字元的開始及結束位置。

  • text：元素的文字。

  • types：說明元素本質及其影響對象的陣列。

    • label：使用下列元素配對來定義類型的物件：

      • nature：句子所需的動作類型。 現行值為 Definition、Disclaimer、Exclusion、Obligation 及 Right。
      • party：一個字串，用於識別句子所適用的參與方。

    • provenance_ids：一個以上雜湊值的陣列，您可以將其傳送給 IBM 以提供意見或取得支援。

  • categories：列出元素所在功能種類的陣列；換句話說，就是元素的主題。

    • label：一個字串，用於列出所識別到的種類。 如需種類清單，請參閱 種類。
    • provenance_ids：一個以上雜湊值的陣列，您可以將其傳送給 IBM 以提供意見或取得支援。

  • attributes：識別文件屬性的陣列。 陣列中的每個物件都是由三個元素組成：

    • type：屬性的類型。 可能的值為 Currency、DateTime、Duration、Location、Number、Organization、Percentage 和 Person，如 Attributes 中所述。
    • 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：一個陣列，其中針對輸入文件中偵測到的每個區段或子區段包含一個物件。 區段和子區段不是依巢狀方式排列的， 而是依扁平方式排列。您可以使用元素的 begin 和 end 值以及區段的 level 值，重新按順序排列區段和子區段。

    • text：一個字串，用於列出區段標題（如果被偵測到）。
    • location：標題在輸入文件中的位置，如其 begin 和 end 索引所定義。
    • level：一個整數，用於指出區段在輸入文件中所處的層次。 例如，代表根層級區段，代表層級區段中的子節段。
    • element_locations：一個陣列，用於指定句子在區段中的 begin 和 end 值。

  • leading_sentences：包含清單或子區段之每個主題句一個物件的陣列，與 section_titles 和 paragraph 陣列平行。 物件詳述了符合區段或子區段中的主題句。 如同在 section_titles 陣列中，物件不是巢狀。 取而代之的是，它們會被壓平，並可透過使用 begin 和 end 值的元素或輸入文件中的任何層級標記，將它們按順序放回。

    • text：列出主題句的字串（如果偵測到的話）。
    • location：主題句在輸入文件中的位置，如其 begin 和 end 索引所定義。
    • element_locations：一個陣列，用於指定區段中主題句的 begin 和 end 值。

  • paragraphs:一個陣列，每個段落包含一個物件，與 section_titles 和 leading_sentences 陣列平行。 每個物件會列出對應段落的跨距（開始及結束位置）。

    • 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
      }
    },
    ...
  ]
}

元素

合約強化會產生合約中每一個已識別元素的分析。 下列各節說明所產生的每一種元素類型。