合同模式信息

合同扩充项将应用于添加到项目的文档的 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。 索引号指示构成 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
      }
    },
    ...
  ]
}

元素

合同扩充项将生成对合同中每个已识别元素的分析。 以下部分描述了生成的每种类型的元素。